2.2.3 探索範囲の作成
探索範囲を新規に作成します。
権限
Admin
APIのバージョン
v1
リクエスト形式
POST http[s]://host:port/Analytics/version/objects/IpAddrRanges
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。IPAddrRange
{ "name":"...", "ipAddrRange":["...", ...], "usePing":"...", "useAllCredential":"...", "selectedCredentials":[{ "name":"...", "credentialType":"...", "userId":"...", "password":"...", "passwordNotRequired":"...", "portNumber":"...", "rootPassword":"...", "updatePassword":"...", "updateRootPassword":"...", "ssl":"...", "domainname":"...", "namespace":"...", "community":"...", "snmpVersion":"...", "userName":"...", "authenticationEnabled":"...", "authenticationPassphrase":"...", "updateAuthenticationPassphrase":"...", "authenticationProtocol":"...", "privacyEnabled":"...", "privacyPassphrase":"...", "updatePrivacyPassphrase":"...", "privacyProtocol":"..." }, : ], "deviceClassificationLabel":"..." }
IPAddrRange (Type: IPAddrRange)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
探索範囲の名称 |
ipAddrRange |
string[] |
探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。 |
usePing |
boolean |
探索実行時に、対象機器に対してpingを実施するかどうかを指定します。 ・true: pingを使用します。 ・false: pingを使用しません |
useAllCredential |
boolean |
すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。 |
selectedCredentials |
Credential[] |
探索に使用する認証情報のリスト |
deviceClassificationLabel |
string |
機器に割り当てられた分類ラベル |
selectedCredentials (Type: Credential)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
認証情報の名称 |
credentialType |
enum |
監視対象への接続に使用するプロトコル。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
userId |
string |
認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合,”username”メンバーの値が設定されます。 |
password |
string |
認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。更新する場合は、updatePasswordにtrueを指定します。 |
passwordNotRequired |
boolean |
認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。 ・true:パスワードは必要ない。 ・false:パスワードが必要である。 |
portNumber |
int |
ポート番号。監視対象への接続に使用するプロトコルが「ssh」,「SMI-S WBEM」,「SNMP」の場合のみ設定されます。 |
rootPassword |
string |
認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。 監視対象への接続に「ssh」を使用する場合のみ有効です。更新する場合は、updateRootPasswordにtrueを指定します。 |
updatePassword |
boolean |
パスワード(password)を変更するかどうか。 ・true:パスワードの変更を行う。 ・false:パスワードの変更を行わない。 省略時はfalseが指定されます。 |
updateRootPassword |
boolean |
rootパスワード(rootPassword)を変更するかどうか。 ・true:パスワードの変更を行う。 ・false:パスワードの変更を行わない。 省略時はfalseが指定されます。 監視対象への接続に「ssh」を使用する場合のみ有効です。 |
ssl |
boolean |
監視対象への接続時にSSL(https)を使用するかどうか。 ・true:SSLを使用する。 ・false:SSLを使用する。 省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。 |
domainname |
string |
ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。 |
namespace |
string |
ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。 |
community |
string |
コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 |
snmpVersion |
enum |
SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
userName |
string |
認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationEnabled |
boolean |
SMTP認証を行うかどうか。 ・true:認証を有効にする。 ・false:認証を無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationPassphrase |
string |
認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updateAuthenticationPassphraseにtrueを指定します。 |
updateAuthenticationPassphrase |
boolean |
認証パスフレーズを変更するかどうか。 ・true:認証パスフレーズの変更を行う。 ・false:認証パスフレーズの変更を行わない。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationProtocol |
enum |
認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
privacyEnabled |
boolean |
プライバシーを有効にするかどうか。 ・true:プライバシーを有効にする。 ・false:プライバシーを無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyPassphrase |
string |
プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updatePrivacyPassphraseにtrueを指定します。 |
updatePrivacyPassphrase |
boolean |
プライバシーのためのパスフレーズを変更するかどうか。 ・true:パスフレーズを変更する。 ・false:パスフレーズを変更しない。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyProtocol |
enum |
プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。IPAddrRange
{ "instanceID":"...", "name":"...", "ipAddrRange":["...", ...], "usePing":"...", "useAllCredential":"...", "selectedCredentials":[{ "instanceID":"...", "name":"...", "credentialType":"...", "userId":"...", "passwordNotRequired":"...", "portNumber":"...", "ssl":"...", "domainname":"...", "namespace":"...", "community":"...", "snmpVersion":"...", "userName":"...", "authenticationEnabled":"...", "authenticationProtocol":"...", "privacyEnabled":"...", "privacyProtocol":"...", "numOfRelatedResources":"..." }, : ], "deviceClassificationLabel":"..." }
IPAddrRange (Type: IPAddrRange)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
name |
string |
探索範囲の名称 |
ipAddrRange |
string[] |
探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。 |
usePing |
boolean |
探索実行時に、対象機器に対してpingを実施するかどうかを指定します。 ・true: pingを使用します。 ・false: pingを使用しません |
useAllCredential |
boolean |
すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。 |
selectedCredentials |
Credential[] |
探索に使用する認証情報のリスト |
deviceClassificationLabel |
string |
機器に割り当てられた分類ラベル |
selectedCredentials (Type: Credential)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
name |
string |
認証情報の名称 |
credentialType |
enum |
監視対象への接続に使用するプロトコル。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
userId |
string |
認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合,”username”メンバーの値が設定されます。 |
passwordNotRequired |
boolean |
認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。 ・true:パスワードは必要ない。 ・false:パスワードが必要である。 |
portNumber |
int |
ポート番号。監視対象への接続に使用するプロトコルが「ssh」,「SMI-S WBEM」,「SNMP」の場合のみ設定されます。 |
ssl |
boolean |
監視対象への接続時にSSL(https)を使用するかどうか。 ・true:SSLを使用する。 ・false:SSLを使用する。 省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。 |
domainname |
string |
ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。 |
namespace |
string |
ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。 |
community |
string |
コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 |
snmpVersion |
enum |
SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
userName |
string |
認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationEnabled |
boolean |
SMTP認証を行うかどうか。 ・true:認証を有効にする。 ・false:認証を無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationProtocol |
enum |
認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
privacyEnabled |
boolean |
プライバシーを有効にするかどうか。 ・true:プライバシーを有効にする。 ・false:プライバシーを無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyProtocol |
enum |
プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
numOfRelatedResources |
int |
認証情報を用いて発見されたリソースの数。 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
201 |
Created |
正常終了 |
400 |
Bad Request |
リクエストボディ形式不正 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
更新権限がない |
409 |
Conflict |
nameが一致するリソースが存在する |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] POST http://localhost:22015/Analytics/v1/objects/IpAddrRanges/ HTTP/1.1 Host: localhost:22015 User-Agent: curl/7.33.0 Accept: application/json Accept-Language: ja Content-Type: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= [Request Body] { "name":"IP Addr Range 03", "ipAddrRange":["192.168.1.0","192.168.1.110"], "usePing":false, "useAllCredential":false, "selectedCredentials":[ {"instanceID":14,"name":"ssh_dev_env"} ], "deviceClassificationLabel":"Linux Development Env" } [Response Header] HTTP/1.1 201 Created Date: Wed, 07 Dec 2016 10:01:12 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 6e512042356e389d5b981969d46d963c5ef24a_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810 Location: http://localhost:22015/Analytics/v1/objects/IpAddrRanges//50 X-Frame-Options: SAMEORIGIN Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Content-Type: application/json [Response Body] { "instanceID" : 3, "name" : "IP Addr Range 03", "ipAddrRange" : [ "192.168.1.0", "192.168.1.110" ], "usePing" : false, "useAllCredential" : false, "selectedCredentials" : [ { "instanceID" : 14, "name" : "ssh_dev_env", "credentialType" : "SSH", "userId" : "root", "portNumber" : 22, "numOfRelatedResources" : 2 } ], "deviceClassificationLabel" : "LInux Development Env" }