1.8.1 Creating authentication information
This section describes the format of requests to be used for creating authentication information and the method for creating a request body.
Procedure
-
Determine the protocol (such as WMI or SSH) for the authentication information to be created.
-
Acquire authentication information that has the same protocol as the authentication information that you want to create, so that the acquired authentication information can be used as a template. Issue the request in the following format:
GET http://host:port/Analytics/version/objects/Credentials
-
Edit the authentication information (Credential resource) acquired in step 2 according to the table below.
Table 1‒1: Changes to the Credential resource Member to change
Whether to change
Description
name
Required
Change the name to the name of the authentication information to be created.
You must specify a name that does not exist in the authentication information that is already registered.
userId
Required
The user ID to be specified for authentication. When the SNMP v3 protocol is used, the value specified for userName is set.
password
Required
The password to be used for authentication
passwordNotRequired
Optional
Specify true if no password is required for authentication. This item is enabled only when the WMI protocol is used.
portNumber
Optional
The port number to be used for authentication. This item is enabled only when the SSH, SMI-S WBEM, or SNMP protocol is used to connect the management target.
rootPassword
Required
The root password to be used for authentication. This item is enabled only when the SSH protocol is used.
ssl
Optional
Whether SSL (HTTPS) is to be used when connecting the monitoring target. This item is enabled only when SMI-S WBEM is used.
domainname
Optional
The domain name to be used for authentication. This item is enabled only when WMI is used.
namespace
Optional
The namespace to be used for authentication. This item is used only when SMI-S WBEM is used.
community
Optional
The community name to be used for authentication. This item is enabled only when SNMP is used.
snmpVersion
Optional
The version of SNMP. This item is enabled only when SNMP is used.
userName
Optional
The user name to be used for authentication. This item is enabled only when SNMP v3 is used.
authenticationEnabled
Optional
To perform an SMTP authentication, specify true. This item is enabled only when SNMP v3 is used.
authenticationPassphrase
Optional
The passphrase to be used for authentication. This item is enabled only when SNMP v3 is used.
authenticationProtocol
Optional
The protocol to be used for authentication. This item is enabled only when SNMP v3 is used.
privacyEnabled
Optional
To enable the privacy function for authentication, specify true. This item is enabled only when SNMP v3 is used.
privacyPassphrase
Optional
The passphrase to be specified when the privacy function is used for authentication. This item is enabled only when SNMP v3 is used.
privacyProtocol
Optional
This item is enabled only when SNMP v3 is used.
-
Issue the request in the format shown below. Specify the authentication information you edited in step 3 in the request body.
POST http://host:port/Analytics/version/objects/Credentials