1.3.8 Members of authentication information used by collectors
This section explains the Members of authentication information used by collectors (CollectorCredential resource).
| Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by) |
|---|---|---|---|---|---|
| requireHostAddress | boolean |
A flag that determines if an IP address or host name is required - true: An IP address is required. An access-target identification key is not required. - false: An IP address is not required. An access-target identification key is required. This is used for the HTTP protocol. |
Y | N | N |
| instanceID | long | ID for identifying instances | N | N | N |
| ipAddress | string | IP address or host name used for connections to management software | N | N | N |
| accessTargetIdentification | string | Access-target identification key (when no IP address is specified) | Y | Y | Y |
| userId | string | User ID used for connections to management software. Specify a string of 255 or fewer bytes. | Y | N | N |
| password | string | Password used for connections to management software. Encode a string of 255 or fewer bytes in Base64. | Y | N | N |
| updatePassword | boolean | Whether to change the password used for connections to management software.
|
Y | N | N |
| portNumber | int | Port number used for connections to management software | Y | N | N |
| optionalInformation1 | string | Option information for information acquisition that can be used in the plug-in. The value set for the first option. Encode a string in Base64. | N | N | N |
| updateOptionalInformation1 | boolean | To change option 1, set "true". Use this only for updates. | Y | N | N |
| optionalInformation2 | string | Option information for information acquisition that can be used in the plug-in. The value set for the second option. Encode a string in Base64. | N | N | N |
| updateOptionalInformation2 | boolean | To change option 2, set "true". Use this only for updates. | Y | N | N |
| optionalInformation3 | string |
Option information for information acquisition that can be used in the plug-in. The value set for the third option. Encode a string in Base64. |
N | N | N |
| updateOptionalInformation3 | boolean | To change option 3, set "true". Use this only for updates. | Y | N | N |
| hypertextTransferProtocolType | enum | Whether to use SSL (HTTPS) for connections to management software.For details about the specifiable values, see the table HypertextTransferProtocolType in 1.6 List of enumerators. If this member is omitted, false is set. | N | N | N |
| domainName | string | Domain name: Used for application linkage when Windows is selected. | Y | N | N |
| rootPassword | string | root password: Used for application linkage when Unix is selected. | Y | N | N |
| updateRootPassword | boolean | To change the password, set true. Use only for updates. | Y | N | N |
| useAdministrativeShares | boolean | To share management, set true. | Y | N | N |
| shareName | string | share Name | Y | N | N |
| sharedFolder | string | shared Folder | Y | N | N |
| logicalHostName | string | Logical Host Name | Y | N | N |
| useLogicalHostName | boolean | To use logical host name, set true. | Y | N | N |
| useProxy | boolean | Specify true when connecting to a custom collector via a proxy. | Y | N | N |
| proxyHostAddr | string | Proxy host address when using a proxy | Y | N | N |
| proxyPort | int | Proxy port when using a proxy | Y | N | N |
| proxyUser | string | The authenticated user of the proxy when using the proxy | Y | N | N |
| updateProxyPassword | boolean | Set true to the proxy password. Used only when updating. | Y | N | N |
| proxyPassword | string | Proxy authentication password when using a proxy. Encode a string in Base64. | Y | N | N |