ネットワーク構成情報のXML定義は以下のとおりです。
ネットワークデバイスを個別作成する場合のXML定義
<?xml version="1.0" encoding="utf-8"?> <Netdevice ip="管理IPアドレス" name="機器名"> <Location>ロケーション</Location> <Types> <Type>種別</Type> </Types> <Maintenance>保守モード</Maintenance> <AutoConfiguration>ネットワークデバイスの自動設定の可否</AutoConfiguration> <DeviceInfo> <SysObjectId>sysObjectID</SysObjectId> <Vendor>ベンダー名</Vendor> <ProductName>装置名</ProductName> <ModelName>モデル名</ModelName> <Firmware>ファームウェア</Firmware> </DeviceInfo> <Redundancy group_id="グループID"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>コミュニティー名</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="プロトコル"auth_type="認証情報の管理方法" authority="管理者権限" check="アカウント確認"> <IpAddress>接続先IPアドレス</IpAddress> <Port>接続先ポート番号</Port> <User>アカウント</User> <Password>パスワード</Password> <PrivilegedPassword>管理者パスワード</PrivilegedPassword> <PasswordEncryption>パスワードの暗号化</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>監視方法</Method> </Methods> <Interval>監視間隔</Interval> <RetryCount>リトライ回数</RetryCount> <Timeout>タイムアウト時間</Timeout> </Monitoring> <MgmtURL>Web管理画面URL</MgmtURL> </MgmtInfos> <Ports> <Port name="ポート名"> <Description>ポートの概要</Description> <PhysicalState>通信状態</PhysicalState> <Link ip="結線先機器の管理IPアドレス" port="結線先のポート名" kind="結線先機器の種別" /> </Port> </Ports> </Netdevice> |
複数のネットワークデバイスを一括作成する場合のXML定義
<?xml version="1.0" encoding="utf-8"?> <NetConfig> <Netdevices> <Mode>登録モード</Mode> <Netdevice ip="管理IPアドレス" name="機器名"> <Location>ロケーション</Location> <Types> <Type>種別</Type> </Types> <Maintenance>保守モード</Maintenance> <AutoConfiguration>ネットワークデバイスの自動設定の可否</AutoConfiguration> <DeviceInfo> <SysObjectId>sysObjectID</SysObjectId> <Vendor>ベンダー名</Vendor> <ProductName>装置名</ProductName> <ModelName>モデル名</ModelName> <Firmware>ファームウェア</Firmware> </DeviceInfo> <Redundancy group_id="グループID"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>コミュニティー名</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="プロトコル"auth_type="認証情報の管理方法" authority="管理者権限" check="アカウント確認"> <IpAddress>接続先IPアドレス</IpAddress> <Port>接続先ポート番号</Port> <User>アカウント</User> <Password>パスワード</Password> <PrivilegedPassword>管理者パスワード</PrivilegedPassword> <PasswordEncryption>パスワードの暗号化</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>監視方法</Method> </Methods> <Interval>監視間隔</Interval> <RetryCount>リトライ回数</RetryCount> <Timeout>タイムアウト時間</Timeout> </Monitoring> <MgmtURL>Web管理画面URL</MgmtURL> </MgmtInfos> <Ports> <Port name="ポート名"> <Description>ポートの概要</Description> <PhysicalState>通信状態</PhysicalState> <Link ip="結線先機器の管理IPアドレス" port="結線先のポート名" kind="結線先機器の種別" /> </Port> </Ports> </Netdevice> </Netdevices> <Links> <Mode>結線情報の登録モード</Mode> <Link> <Devices> <Device ip="機器1の管理IPアドレス" name="機器1のリソース名" kind="機器1の種別"> <Port>機器1の接続ポート名</Port> </Device> <Device ip="機器2の管理IPアドレス" name="機器2のリソース名" kind="機器2の種別"> <Port>機器2の接続ポート名</Port> </Device> </Devices> </Link> </Links> </NetConfig> |
要素名 | 説明 | 取り得る値、または例 | 指定要否 | exportでの出力 | |||
---|---|---|---|---|---|---|---|
個別登録時 | 個別変更時 | 一括登録時 | 一括変更時 | ||||
ネットワーク構成情報(NetConfig) | ネットワーク構成情報の集合 | - | 不可 | 不可 | 必須 | 必須 | ○ |
ネットワークデバイス情報 (Netdevices) | ネットワークデバイス情報の集合 | 1つ以上のNetdeviceタグを指定します。 複数台のネットワーク機器を同時にネットワークデバイスとして登録する場合は省略できません。 | 不可 | 不可 | 可 | 可 | ○ (注1) |
登録モード (Mode) | 登録モード | ネットワークデバイスの登録モードを指定します。 以下のどちらかを指定します。
省略時は、"add"が指定されます。 | 不可 | 不可 | 可 | 必須 | × |
管理IPアドレス (Netdevice ip) | ネットワークデバイスの管理IPアドレス | IPv4アドレスを指定します。 | 必須 | 可 | 必須 | 必須 | ○ |
機器名 (Netdevice name) | ネットワークデバイスの名称 | 半角英数字、アンダースコア("_")、ハイフン("-")およびピリオド(".")で構成された32文字以内の文字列を指定します。 省略時は、ネットワーク機器から取得したホスト名またはIPアドレスが指定されます。 ネットワーク機器から取得したホスト名に半角英数字、アンダースコア("_")、ハイフン("-")およびピリオド(".")以外の文字が含まれていた場合、該当文字はアンダースコア("_")に置き換えられます。なお、取得した値が33文字以上の場合、先頭から32文字までが指定されます。 | 可 | 可 | 可 | 可 | ○ |
ロケーション (Location) | ロケーション | 半角英数字、アンダースコア("_")およびハイフン("-")で構成された32文字以内の文字列を指定します。 省略時は、ネットワーク機器から取得した設置場所が指定されます。 ネットワーク機器から取得した設置場所に半角英数字、アンダースコア("_")およびハイフン("-")以外の文字が含まれていた場合、該当文字はアンダースコア("_")に置き換えられます。なお、取得した値が33文字以上の場合、先頭から32文字までが指定されます。 | 可 | 可 | 可 | 可 | ○ (注2) |
種別情報 (Types) | 種別情報の集合 | 1つ以上のTypeタグを指定します。 | 可 | 可 | 可 | 可 | ○ (注1) |
種別 (Type) | ネットワークデバイスの種別 | ネットワークデバイスの種別を指定します。 以下を指定します。
省略時は、ネットワークデバイスのモデル定義から取得した種別が指定されます。 | 可 | 可 | 可 | 可 | ○ (注2) |
保守モード (Maintenance) | 保守モードの設定 | 保守モードの状態を指定します。 以下のどちらかを指定します。
省略時は、"false"が指定されます。 | 可 | - | 可 | - | ○ |
ネットワークデバイスへの自動設定 (AutoConfiguration) | ネットワークデバイスへの自動設定の可否 | ネットワークデバイスを自動設定の対象として選択可能とするかを指定します。 以下のどちらかを指定します。
省略時は、"true"が指定されます。 ネットワークデバイスの動作状態が"error"の場合、"false"に変更することはできません。 | 可 | 可 | 可 | 可 | × |
機器情報 (DeviceInfo) | 機器情報 | ネットワークデバイスの機種についての情報を指定します。 | 可 | - | 可 | - | ○ |
SysObjectId (SysObjectId) | SysObjectId | SNMPで監視する場合は、自動収集されたSysObjectIdが数値・ドット形式のOIDで指定されます。 | - | - | - | - | ○ |
ベンダー名 (Vendor) | ベンダー名 | 先頭半角英数字で、半角英数字、アンダースコア("_")およびハイフン("-")で構成された32文字以内の文字列を指定します。 ネットワークリソース用(ネットワークデバイス固有)のルールセット登録用フォルダーのベンダー名と同じ、任意の名前を指定します。 省略時は、ネットワークデバイスのモデル定義から取得したベンダー名が指定されます。 | 可 | - | 可 | - | ○ |
装置名 (ProductName) | 装置名(製品名) | 先頭半角英数字で、半角英数字、アンダースコア("_")およびハイフン("-")で構成された32文字以内の文字列を指定します。 ネットワークリソース用(ネットワークデバイス固有)のルールセット登録用フォルダーの装置名またはモデル名と同じ、任意の名前を指定します。 省略時は、ネットワークデバイスのモデル定義から取得した装置名が指定されます。 | 可 | - | 可 | - | ○ |
モデル名 (ModelName) | モデル名 | 先頭半角英数字で、半角英数字、アンダースコア("_")およびハイフン("-")で構成された32文字以内の文字列を指定します。 ネットワークリソース用(ネットワークデバイス固有)のルールセット登録用フォルダーの装置名またはモデル名と同じ、任意の名前を指定します。 省略時は、ネットワークデバイスのモデル定義から取得したモデル名が指定されます。 | 可 | - | 可 | - | ○ |
ファームウェア (Firmware) | ファームウェアまたはIOSバージョン | 文字列が指定されます。 ネットワーク機器から自動収集するため、指定する必要はありません。 | - | - | - | - | ○ |
グループID (Redundancy group_id) | グループID | 先頭半角英数字で、半角英数字、アンダースコア("_")およびハイフン("-")で構成された32文字以内の文字列を指定します。 同じグループIDに所属するネットワークデバイスは、同じベンダー名と装置名にしてください。 | 可 | 可 | 可 | 可 | ○ (注2) |
管理情報 (MgmtInfos) | 管理情報の集合 | 1つ以上のSnmpsタグ、LoginInfoタグなどを指定します。 | 必須 | 可 | 必須 | 可 | ○ |
SNMP情報 (Snmps) | SNMP情報の集合 | 1つのReadCommunityタグを指定します。 | 可 | 可 | 可 | 可 | ○ |
コミュニティー名 (ReadCommunity) | コミュニティー名 (SNMP情報を指定時は、省略不可) | 半角英数字、アンダースコア("_")およびハイフン("-")で構成された32文字以内の文字列を指定します。 | 可 (注10) | 可 | 可 (注10) | 可 | ○ |
ログイン情報 (LoginInfos) | ログイン情報の集合 | 1つ以上のLoginInfoタグを指定します。 | 可 | 可 | 可 | 可 | ○ (注1) |
プロトコル (LoginInfo protocol) | プロトコル | ログイン情報を利用してログインする場合のプロトコルを指定します。 以下のどれかを指定します。
省略時は、"remote_login"が指定されます。 | 可 | 可 | 可 | 可 | ○ |
認証情報の管理方法 (LoginInfo auth_type) | 認証情報の管理方法 | 認証情報の管理方法を指定します。 ネットワークデバイス内で管理する場合、"local password"を指定します。 省略時は、自動的に指定されます。 | 可 | 可 | 可 | 可 | ○ (注3) |
管理者権限 (LoginInfo authority) | 管理者権限の有無 | アカウントの権限を指定します。 以下のどちらかを指定します。
省略時は、"user"が指定されます。 | 可 | 可 | 可 | 可 | ○ (注3) |
アカウント確認 (LoginInfo check) | アカウント情報の確認有無 | 登録時または変更時にアカウント情報を確認するかを指定します。 以下のどちらかを指定します。
省略時は、"false"が指定されます。 | 可 | 可 | 可 | 可 | × |
接続先IPアドレス (IpAddress) | 接続先IPアドレス | IPv4形式のIPアドレスを指定します。 ネットワークデバイスへの自動設定およびアカウント情報の確認(アカウント確認(LoginInfo check)に"true"を指定)を、管理IPアドレス(Netdevice ip)以外のIPアドレスに対して行う場合に指定します。 異なるIPアドレスが指定された場合または一部省略されている場合、管理者権限(LoginInfo authority)に"user"が指定されたログイン情報の接続先IPアドレス(IpAddress)に対して、ネットワークデバイスへの自動設定およびアカウント情報の確認を行います。 省略時は、管理IPアドレス(Netdevice ip)が指定されます。 | 可 | 可 | 可 | 可 | ○ (注3) |
接続先ポート番号 (Port) | 接続先への接続プロトコルのポート番号 | 1~65535までの整数を指定します。 ネットワークデバイスへの自動設定およびアカウント情報の確認(アカウント確認(LoginInfo check)に"true"を指定)を行うネットワーク機器のポート番号を指定します。 異なるポート番号が指定された場合または一部省略されている場合、管理者権限(LoginInfo authority)に"user"が指定されたログイン情報のポート番号に対し、ネットワークデバイスへの自動設定、およびアカウント情報の確認を行います。 省略時は、プロトコル(LoginInfo protocol)に指定した値に応じ、以下が指定されます。
| 可 | 可 | 可 | 可 | ○ (注3) |
アカウント (User) | 接続時のアカウント | 管理者権限(LoginInfo authority)で"user"を指定した場合、利用者権限のアカウントを指定します。 | 可 (注11) | 可 (注11) | 可 (注11) | 可 (注11) | ○ (注3) |
パスワード (Password) | 接続時のパスワード | 半角英数字、記号(!$%()*+,-./:;=@[]^_`{|}~および半角スペース)で構成された64文字以内の文字列を指定します。 | 必須 | 可 (注11) | 必須 | 可 (注11) | ○ (注3) |
管理者パスワード (PrivilegedPassword) | 管理者パスワード | 半角英数字、記号(!$%()*+,-./:;=@[]^_`{|}~および、半角スペース)で構成された64文字以内の文字列を指定します。 なお、管理者権限(LoginInfo authority)で"admin"を指定した場合、管理者パスワードは無効となります。 | 可 | 可 | 可 | 可 | ○ (注3) |
パスワードの暗号化 (PasswordEncryption) | パスワードの暗号化有無 | ネットワークデバイスのパスワードが暗号化されているかを指定します。 以下のどちらかを指定します。
省略時は、"false"が指定されます。 なお、初回登録時は平文でパスワードを入力するため、"false"を指定してください。 | 可 | 可 | 可 | 可 | ○ (注3) |
監視情報 (Monitoring) | 監視情報 | 監視情報のタグを指定します。 | 可 | 可 | 可 | 可 | ○ |
監視方法の情報 (Methods) | 監視方法の情報の集合 | 1つ以上のMethodタグを指定することで、監視方法を指定します。 本タグが省略されている場合、以下が指定されます。
| 可 | 可 | 可 | 可 | ○ |
監視方法 (Method) | 監視方法 | ネットワークデバイスの監視方法について指定します。 以下のどれかを指定します。
省略時は、ネットワークデバイスの監視は"監視なし"が指定されます。 なお、複数の監視方法を設定する場合、本要素を複数指定します。 | 可 | 可 | 可 | 可 | ○ |
監視間隔 (Interval) (注5) | 監視間隔(秒) (監視方法の変更時は、省略不可) | 1~86400までの整数を指定します。 省略時は、"300"が設定されます。 | 可 | 可 | 可 | 可 | ○ |
リトライ回数 (RetryCount) (注5) | リトライ回数 (監視方法の変更時は、省略不可) | 1~10までの整数を指定します。 省略時は、"3"が指定されます。 | 可 | 可 | 可 | 可 | ○ |
タイムアウト時間 (Timeout) (注5) | タイムアウト時間(秒) (監視方法の変更時は、省略不可) | 1~300までの整数を指定します。 省略時は、"30"が指定されます。 | 可 | 可 | 可 | 可 | ○ |
Web管理画面URL (MgmtURL) | Web管理画面のURL | Web管理画面のURLを指定します。 当該ネットワーク機器のWeb管理機能が提供されている場合に指定できます。 省略時は、"http://管理IPアドレス/"が指定されます。 | 可 | 可 | 可 | 可 | ○ |
ポート情報 (Ports) | ポート情報の集合 | 1つ以上のPortタグが指定されます。 | 可 | 可 | 可 | 可 | ○ (注1) |
ポート名 (Port name) | ポート名 | ネットワーク機器に設定されているポート名を64文字以内の文字列で指定します。 指定可能な文字列は半角英数字および記号(ASCII文字コード:0x20~0x7e)です。 省略した場合、ネットワーク機器から取得したポート名の値が指定されます。 ポート名の確認方法については、「設計ガイド CE」の「9.4.8.1 ネットワーク構成情報(XML定義)を作成する場合」を参照してください。 | 可 (注19) | 可 (注19) | 可 (注19) | 可 (注19) | ○ |
ポートの概要 (description) | ポートの概要 | ポートの概要(description)が指定されます。 ネットワーク機器から自動収集するため、指定する必要はありません。 | - | - | - | - | ○ |
通信状態 (PhysicalState) | 通信状態 | 回線速度と通信モードが指定されます。 指定形式:回線速度(bps)/通信モード 通信モードには、以下のどれかが指定されます。
ネットワーク機器から自動収集するため、指定する必要はありません。 | - | - | - | - | ○ |
結線先の管理IPアドレス (Link ip) | 結線先機器の管理IPアドレス | IPv4形式のIPアドレスが指定されます。 | - | - | - | - | ○ (注2) |
結線先のポート名 (Link port) | 物理インターフェースの結線先のポート名 | 結線先のポート名が指定されます。 | - | - | - | - | ○ (注2) |
結線先機器の種別 (Link kind) | 結線先機器の種別 | 結線先の機器の種別が指定されます。 以下のどちらかが指定されます。
| - | - | - | - | ○ (注2) |
結線情報 (Links) | 結線情報の定義 | 1つ以上のLinkタグで構成されます。 <Links><Link></Link></Links> | 不可 | 不可 | 可 | 可 | ○ (注1) |
結線情報の登録モード (Mode) | 結線情報の登録モード | 結線情報の登録モードを指定します。 以下のどちらかを指定します。
省略時は、"modify"が指定されます。 | 不可 | 不可 | 可 | 可 | × |
結線 (Link) | 結線の定義 (結線情報を指定時は、省略不可) | 1つのDevicesタグを指定します。 | 不可 | 不可 | 可 | 可 | ○ (注1) |
機器情報 (Devices) | 機器情報の定義 (結線の指定時は、省略不可) | 2つのDeviceタグを指定します。 | 不可 | 不可 | 可 | 可 | ○ (注1) |
機器の管理IPアドレス (Device ip) | 機器の管理IPアドレス | IPv4形式のIPアドレスを指定します。 | 不可 | 不可 | 可 (注12) | 可 (注12) | ○ |
機器の名称 (Device name) | 機器の名称 (指定不要) | 機器の管理IPアドレスから登録されているネットワークデバイスの名称が指定されます。 ネットワークデバイス以外の機器の場合は、自動設定機能などで接続先となっている機器の名称が補完されます。 | - | - | - | - | ○ |
機器の種別 (Device kind) | 機器の種別 | 機器の種別を指定します。 以下のどれかを指定します。
省略時は、"netdevice"が指定されます。 | 不可 | 不可 | 可 | 可 | ○ |
機器の接続ポート名 (Port) | 機器の接続ポート名 | 文字列を指定します。
| 不可 | 不可 | 可 (注12) | 可 (注12) | ○ |
-: 登録または変更時に指定する必要はありません。自動設定などによって補完される要素です。ネットワーク構成情報をエクスポートした場合に通知されます。
○: ネットワーク構成情報のexport時に出力される要素です。
×: ネットワーク構成情報のexport時に出力されない要素です。
注1) 要素の配下のタグが定義されている場合だけ出力される要素です。
注2) 要素に対して値が設定されている場合だけ出力される要素です。
注3) ログイン情報が設定されている場合だけ出力される要素です。ログイン情報が設定されていない場合、省略時の値が存在する要素は省略値が出力されます。
注4) 以下のすべての条件を満たしているネットワークデバイスだけアカウント確認が行われます。
ベンダー名 | 機種名 | プロンプトの種類 | プロンプト文字 |
---|---|---|---|
Fujitsu | SR-X | ログインプロンプト | Login: |
パスワードプロンプト | Password: | ||
コマンドプロンプト | 任意の文字列# | ||
任意の文字列> | |||
Cisco | Catalyst | ログインプロンプト | Username: |
パスワードプロンプト | Password: | ||
コマンドプロンプト | 任意の文字列# | ||
任意の文字列> | |||
Nexus | ログインプロンプト | login: | |
パスワードプロンプト | Password: | ||
コマンドプロンプト | 任意の文字列# | ||
任意の文字列> | |||
Brocade | VDX | ログインプロンプト | Login: |
パスワードプロンプト | Password: | ||
コマンドプロンプト | 任意の文字列# | ||
任意の文字列> |
コマンドプロンプトでは、任意の文字列に続く"#"または">"までをプロンプト文字として扱います。
注5) 特別な要件がある場合だけ、値を設定してください。
注10) 監視方法(Method)に"SNMP"を指定した場合、必須項目となります。
注11) ログイン情報(LoginInfos)を指定した場合、必須項目となります。
注12) 機器情報(Devices)を指定した場合、必須項目となります。
注19) ポート情報(Ports)を指定した場合、必須項目となります。