2.3.4 Updating Retrieval Ranges
This API updates the specified retrieval ranges.
Execution permission
Admin
API version
v1
Request format
PUT http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}
Request body
The structure of the request body and the object attributes are as follows:{ "name":"...", "ipAddrRange":["...", ...], "usePing":"...", "aliveMonitoring":"...", "useAllCredential":"...", "selectedCredentials":[{ "instanceID":"..." }, : ], "useAllPlugin":"...", "selectedPlugins":[{ "instanceID":"..." }, : ], "deviceClassificationLabel":"..." }
IPAddrRange (Type: IPAddrRange)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of a retrieval range |
ipAddrRange |
string[] |
Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1. |
usePing |
boolean |
Specify whether to execute ping on the target devices during retrieval. - true: Use ping. - false: Do not use ping. If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential. |
aliveMonitoring |
boolean |
Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets. - true: Register as alive-monitoring targets. - false: Do not register as alive-monitoring targets. If you specify true for this item, specify true for usePing. |
useAllCredential |
boolean |
Flag indicating whether all the credentials are to be used. To use all the credentials, specify true. |
selectedCredentials |
Credential[] |
List of the authentication information to be used for retrieval |
useAllPlugin |
boolean |
Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true. |
selectedPlugins |
Plugin[] |
A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false. |
deviceClassificationLabel |
string |
Name of the classification label assigned to the device |
selectedCredentials (Type: Credential)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID for identifying instances. |
selectedPlugins (Type: Plugin)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID for identifying instances |
Response body
The structure of the response body and the object attributes are as follows:{ "instanceID":"...", "name":"...", "ipAddrRange":["...", ...], "usePing":"...", "aliveMonitoring":"...", "useAllCredential":"...", "selectedCredentials":[{ "instanceID":"...", "name":"...", "credentialType":"...", "userId":"...", "passwordNotRequired":"...", "portNumber":"...", "ssl":"...", "domainname":"...", "namespace":"...", "community":"...", "snmpVersion":"...", "userName":"...", "authenticationEnabled":"...", "authenticationProtocol":"...", "privacyEnabled":"...", "privacyProtocol":"...", "numOfRelatedResources":"..." }, : ], "useAllPlugin":"...", "selectedPlugins":[{ "instanceID":"...", "name":"...", "pluginId":"...", "protocolType":"...", "formatversion":"...", "pluginversion":"...", "pluginType":"...", "numOfRelatedResources":"...", "isCollector":"...", "status":"..." }, : ], "deviceClassificationLabel":"...", "numOfRelatedPluginResources":"..." }
IPAddrRange (Type: IPAddrRange)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID for identifying instances. |
name |
string |
Name of a retrieval range |
ipAddrRange |
string[] |
Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1. |
usePing |
boolean |
Specify whether to execute ping on the target devices during retrieval. - true: Use ping. - false: Do not use ping. If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential. |
aliveMonitoring |
boolean |
Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets. - true: Register as alive-monitoring targets. - false: Do not register as alive-monitoring targets. If you specify true for this item, specify true for usePing. |
useAllCredential |
boolean |
Flag indicating whether all the credentials are to be used. To use all the credentials, specify true. |
selectedCredentials |
Credential[] |
List of the authentication information to be used for retrieval |
useAllPlugin |
boolean |
Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true. |
selectedPlugins |
Plugin[] |
A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false. |
deviceClassificationLabel |
string |
Name of the classification label assigned to the device |
numOfRelatedPluginResources |
int |
Number of plug-in resources found by using retrieval range. |
selectedCredentials (Type: Credential)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID for identifying instances. |
name |
string |
Name of authentication information |
credentialType |
enum |
Protocol used for connections to monitoring targets. (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows:
|
userId |
string |
Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set. |
passwordNotRequired |
boolean |
Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target. ・true: A password is not needed ・false: A password is needed |
portNumber |
int |
Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP. |
ssl |
boolean |
Whether to use SSL (HTTPS) for connections to monitoring targets. ・true: SSL is used ・false: SSL is not used If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets. |
domainname |
string |
Domain name. This member is only enabled when WMI is used for connections to monitoring targets. |
namespace |
string |
Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets. |
community |
string |
Community name. This member is only enabled when SNMP is used for connections to monitoring targets. |
snmpVersion |
enum |
SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets. (For details about the specifiable values, see the table SnmpVersion in List of enumerators.) The specifiable values are as follows:
|
userName |
string |
User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets. |
authenticationEnabled |
boolean |
Whether to perform SMTP authentication. ・true: SMTP authentication is enabled ・false: SMTP authentication is disabled If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets. |
authenticationProtocol |
enum |
Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets. (For details about the specifiable values, see the table AuthenticationProtocol in List of enumerators.) The specifiable values are as follows:
|
privacyEnabled |
boolean |
Whether to enable privacy. ・true: Privacy is enabled ・false: Privacy is disabled If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets. |
privacyProtocol |
enum |
Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets. (For details about the specifiable values, see the table PrivacyProtocol in List of enumerators.) The specifiable values are as follows:
|
numOfRelatedResources |
int |
Number of resources found by using authentication information. |
selectedPlugins (Type: Plugin)
Attribute |
Type |
Description |
---|---|---|
instanceID |
long |
ID for identifying instances |
name |
string |
Name of the plug-in |
pluginId |
string |
ID for identifying the plug-in |
protocolType |
enum |
Protocol used for connections to monitoring targets (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows:
|
formatversion |
string |
Format version of the plug-in |
pluginversion |
string |
Version of the plug-in |
pluginType |
enum |
Type of the plug-in (For details about the specifiable values, see the table PluginType in List of enumerators.) The specifiable values are as follows:
|
numOfRelatedResources |
int |
Number of resources found by using the plug-in |
isCollector |
boolean |
Whether it is Collector |
status |
enum |
Status of the plug-in (For details about the specifiable values, see the table PluginStatusType in List of enumerators.) |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
400 |
Bad Request |
A format of request body is invalid. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No update privilege. |
404 |
Not Found |
The resource was not found. |
409 |
Conflict |
A resource with the same name exists. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] PUT /Analytics/v1/objects/IpAddrRanges/101 HTTP/1.1 Host: JP1OAServer:22015 User-Agent: curl/7.63.0 Content-Type: application/json Accept: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= Accept-Language: ja [Request Body] { "name": "yy_system_Resources", "ipAddrRange": [ "10.197.53.1", "10.197.53.100" ], "usePing": true, "aliveMonitoring": true, "useAllCredential": false, "selectedCredentials": [ { "instanceID": 51 }, { "instanceID": 52 } ], "useAllPlugin": false, "selectedPlugins": [ { "instanceID": 3 } ], "deviceClassificationLabel": "YY SYSTEM" } [Response Header] HTTP/1.1 201 Created Date: Fri, 06 Sep 2019 09:36:53 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 6854c0241fe8687e5c5260973a74212b7f61527f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810 Location: http://JP1OAServer:22015/Analytics/v1/objects/IpAddrRanges/101 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Transfer-Encoding: chunked [Response Body] { "instanceID": 101, "name": "yy_system_Resources", "ipAddrRange": [ "10.197.53.1", "10.197.53.100" ], "usePing": true, "aliveMonitoring": true, "useAllCredential": false, "selectedCredentials": [ { "instanceID": 51, "name": "yy_system_linux", "credentialType": "SSH", "userId": "operator", "portNumber": 22, "numOfRelatedResources": 0 }, { "instanceID": 52, "name": "yy_system_windows", "credentialType": "WMI", "userId": "admin", "passwordNotRequired": false, "domainname": "workspace", "numOfRelatedResources": 0 } ], "useAllPlugin": false, "selectedPlugins": [ { "instanceID": 3, "name": "YY system embeded OS", "pluginId": "com.hitachi.software.ias.sample.host.embeded", "protocolType": "SNMP", "formatversion": "0001", "pluginversion": "0001", "pluginType": "NODE_PLUGIN", "numOfRelatedResources": 0 } ], "deviceClassificationLabel": "YY SYSTEM" }