1.3.1 Members of the authentication information

This section explains the Members of the authentication information (Credentials resource).

Member name	Data type	Description	Whether to change	Whether applicable to filter conditions ($query)	Whether applicable to sort conditions ($order-by)
instanceID	long	ID for identifying instances	N	Y	Y
name	string	Name of authentication information	Y	Y	Y
credentialType	enum	Protocol used for connections to monitoring targets. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators. The specifiable values are as follows: WMI SSH WBEM SNMP	N	Y (only to eq, ne, in, not in)	N
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.	Y	Y	N
password	string	Password used for authentication.Specify a Base64 encoded string of 255 or fewer bytes.	Y	N	N
passwordNotRequired	boolean	Whether a password is needed for authentication. true: A password is not needed false: A password is needed If this member is omitted, false is set.This setting takes effect only if WMI is used for connection to the monitoring target.	Y	N	N
portNumber	integer	Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.	Y	N	N
rootPassword	string	Root password used for authentication. Specify a Base64 encoded string of 255 or fewer bytes.This member is only enabled when SSH is used for connections to monitoring targets.	Y	N	N
updatePassword	boolean	Whether to change the password (password). true: Password is changed false: Password is not changed If this member is omitted, false is set.	Y	N	N
updateRootPassword	boolean	Whether to change the root password (rootPassword). true: Root password is changed false: Root password is not changed If this member is omitted, false is set.This member is only enabled when SSH is used for connections to monitoring targets.	Y	N	N
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.	Y	N	N
domainname	string	Domain name. This member is only enabled when WMI is used for connections to monitoring targets.	Y	N	N
namespace	string	Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.	Y	N	N
community	string	Community name. This member is only enabled when SNMP is used for connections to monitoring targets.	Y	N	N
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 1.6 List of enumerators.	Y	N	N
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.	Y	N	N
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.	Y	N	N
authenticationPassphrase	string	Authentication pass phrase. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets.	Y	N	N
updateAuthenticationPassphrase	boolean	Whether to change the authentication pass phrase. true: Authentication pass phrase is changed false: Authentication pass phrase is not changed If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.	Y	N	N
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 1.6 List of enumerators.	Y	N	N
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.	Y	N	N
privacyPassphrase	string	Pass phrase for privacy. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets.	Y	N	N
updatePrivacyPassphrase	boolean	Whether to change the pass phrase for privacy. true: Pass phrase is changed false: Pass phrase is not changed If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.	Y	N	N
privacyProtocol	string	Protocol for privacy. DES: DES is used AES128: AES128 is used Only specify this member when using SNMP v3 for connections to monitoring targets.	Y	N	N
numOfRelatedResources	integer	Number of resources found by using authentication information	N	N	N

(Legend) Y: Applicable, N: Not applicable

To Page Top