GET_SNMP_IM_SETTINGS return messages

The GET_SNMP_IM_SETTINGS command requests the respective iLO SNMP IM settings. For this command to parse correctly, the GET_SNMP_IM_SETTINGS command must appear within a RIB_INFO command block, and RIB_INFO MODE can be set to read or write.

For example:

GET_SNMP_IM_SETTINGS parameters

None

GET_SNMP_IM_SETTINGS runtime errors

None

A possible GET_SNMP_IM_SETTINGS return message is:

<GET_SNMP_IM_SETTINGS>

<SNMP_ACCESS VALUE="Enable"/> <SNMP_ADDRESS_1 VALUE=""/>

<SNMP_ADDRESS_1_ROCOMMUNITY VALUE=""/>

<SNMP_ADDRESS_1_TRAPCOMMUNITY VERSION="" VALUE=""/> <SNMP_ADDRESS_2 VALUE=""/>

<SNMP_ADDRESS_2_ROCOMMUNITY VALUE=""/>

<SNMP_ADDRESS_2_TRAPCOMMUNITY VERSION="" VALUE=""/> <SNMP_ADDRESS_3 VALUE=""/>

<SNMP_ADDRESS_3_ROCOMMUNITY VALUE=""/>

<SNMP_ADDRESS_3_TRAPCOMMUNITY VERSION="" VALUE=""/> <SNMP_V3_ENGINE_ID VALUE=""/>

<SNMP_PORT VALUE="161"/> <SNMP_TRAP_PORT VALUE="162"/>

<TRAP_SOURCE_IDENTIFIER VALUE="iLO Hostname"/> <RIB_TRAPS VALUE="Y"/> <OS_TRAPS VALUE="Y"/> <COLD_START_TRAP_BROADCAST VALUE="Y"/> <SNMP_V1_TRAPS VALUE="Y"/> <SNMP_PASSTHROUGH_STATUS VALUE="N"/> <WEB_AGENT_IP_ADDRESS VALUE="WIN-DPOHJLI9DO8.hp.com"/> <CIM_SECURITY_MASK VALUE="3"/> <SNMP_SYS_CONTACT VALUE=""/> <SNMP_SYS_LOCATION VALUE=""/> <AGENTLESS_MANAGEMENT_ENABLE VALUE="Y"/> <SNMP_SYSTEM_ROLE VALUE=""/> <SNMP_SYSTEM_ROLE_DETAIL VALUE=""/> <SNMP_USER_PROFILE INDEX="1"> <SECURITY_NAME VALUE=""/> <AUTHN_PROTOCOL VALUE="0"/>

<AUTHN_PASSPHRASE VALUE=""/> <PRIVACY_PROTOCOL VALUE="0"/> <PRIVACY_PASSPHRASE VALUE=""/> </SNMP_USER_PROFILE> <SNMP_USER_PROFILE INDEX="2"> <SECURITY_NAME VALUE=""/> <AUTHN_PROTOCOL VALUE="0"/> <AUTHN_PASSPHRASE VALUE=""/> <PRIVACY_PROTOCOL VALUE="0"/> <PRIVACY_PASSPHRASE VALUE=""/> </SNMP_USER_PROFILE> <SNMP_USER_PROFILE INDEX="3"> <SECURITY_NAME VALUE=""/> <AUTHN_PROTOCOL VALUE="0"/> <AUTHN_PASSPHRASE VALUE=""/> <PRIVACY_PROTOCOL VALUE="0"/> <PRIVACY_PASSPHRASE VALUE=""/> </SNMP_USER_PROFILE> </GET_SNMP_IM_SETTINGS>

MOD_SNMP_IM_SETTINGS

MOD_SNMP_IM_SETTINGS is used to modify SNMP and Insight Manager settings. For this command to parse correctly, the command must appear within a RIB_INFO command block, and RIB_INFO MODE must be set to write. The user must have the Configure iLO Settings privilege to execute this command.

For example:

<SNMP_ADDRESS_1_TRAPCOMMUNITY VERSION="v1" VALUE="trapcomm1"/> <SNMP_ADDRESS_2_ROCOMMUNITY VALUE="public2"/>

<SNMP_ADDRESS_2_TRAPCOMMUNITY VERSION="v2c" VALUE="trapcomm2"/> <SNMP_ADDRESS_3_ROCOMMUNITY VALUE="public3"/>

<SNMP_ADDRESS_3_TRAPCOMMUNITY VERSION="1" VALUE="trapcomm3"/> <AGENTLESS_MANAGEMENT_ENABLE value="Yes"/>

<SNMP_SYS_CONTACT VALUE="Mr. System Administrator"/> <SNMP_SYS_LOCATION VALUE="HP Data Center, Hockley, TX"/>

<SNMP_SYSTEM_ROLE VALUE="Brief Role Description [60 characters]"/>

<SNMP_SYSTEM_ROLE_DETAIL VALUE="Extended role description [500 characters]"/> <COLD_START_TRAP_BROADCAST value="No"/>

<TRAP_SOURCE_IDENTIFIER value = "iLO Hostname"/>

<SNMP_ACCESS_ENABLED value = "Y"/>

<SNMP_PORT value="161"/> <SNMP_TRAP_PORT value="162"/> <SNMP_V1_TRAPS VALUE="Yes"/>

<SNMP_V3_ENGINE_ID VALUE="0x12345678"/> <SNMP_USER_PROFILE INDEX = "1">

<SECURITY_NAME VALUE="Security Name 1"/> <AUTHN_PROTOCOL VALUE="0"/>

<AUTHN_PASSPHRASE VALUE="Authentication Pass Phrase 1"/> <PRIVACY_PROTOCOL VALUE="0"/>

<PRIVACY_PASSPHRASE VALUE="Privacy Pass Phrase 1"/> </SNMP_USER_PROFILE>

<SNMP_USER_PROFILE INDEX = "2">

<SECURITY_NAME VALUE="Security Name 2"/> <AUTHN_PROTOCOL VALUE="0"/>

<AUTHN_PASSPHRASE VALUE="Authentication Pass Phrase 2"/> <PRIVACY_PROTOCOL VALUE="0"/>

<PRIVACY_PASSPHRASE VALUE="Privacy Pass Phrase 20"/> </SNMP_USER_PROFILE>

<SNMP_USER_PROFILE INDEX = "3">

<SECURITY_NAME VALUE="Security Name 3"/> <AUTHN_PROTOCOL VALUE="0"/>

<AUTHN_PASSPHRASE VALUE="Authentication Pass Phrase 3"/> <PRIVACY_PROTOCOL VALUE="0"/>

<PRIVACY_PASSPHRASE VALUE="Privacy Pass Phrase 3"/> </SNMP_USER_PROFILE> </MOD_SNMP_IM_SETTINGS> </RIB_INFO> </LOGIN> </RIBCL>

MOD_SNMP_IM_SETTINGS parameters

All of the following parameters are optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.

SNMP_ADDRESS_1, SNMP_ADDRESS_2, and SNMP_ADDRESS_3 are the addresses that receive traps sent to the user. Each of these parameters can be any valid IP address.

SNMP_ADDRESS_1_ROCOMMUNITY, SNMP_ADDRESS_2_ROCOMMUNITY, and

SNMP_ADDRESS_3_ROCOMMUNITY configure the SNMP read-only community string. Values can include a community string, optionally followed by an IP address or FQDN.

SNMP_ADDRESS_1_TRAPCOMMUNITY, SNMP_ADDRESS_2_TRAPCOMMUNITY, and SNMP_ADDRESS_3_TRAPCOMMUNITY configures the SNMP trap community string.

OS_TRAPS determines if the user is allowed to receive SNMP traps that are generated by the operating system. The possible values are YesandNo. By default, the value is set toNo.

RIB_TRAPS determines if the user is allowed to receive SNMP traps that are generated by the RIB. The possible values areYesandNo. By default, the value is set toNo.

AGENTLESS_MANAGEMENT_ENABLE enables or disables agentless management. Valid values areYesorNo.

WEB_AGENT_IP_ADDRESS is the address for the Web-enabled agents. The value for this element has a maximum length of 255 characters. The value must be a valid IP address or FQDN. If an empty string is entered, the current value is deleted.

SNMP_PASSTHROUGH_STATUS determines if iLO can receive and send SNMP requests to and from the host OS. By default, the value is set toYes.

SNMP_SYS_CONTACT specifies the system administrator or server owner. The string can be a maximum of 49 characters long, and can include information such as a name, email address, or phone number.

SNMP_SYS_LOCATION specifies the physical location of the server. The string can be a maximum of 49 characters long.

SNMP_SYSTEM_ROLE describes the server role or function, and can be a maximum of 64 characters long.

SNMP_SYSTEM_ROLE_DETAIL describes specific tasks the server might perform, and can be a maximum of 512 characters long.

CIM_SECURITY_MASK accepts the integers 0, 1, or 3. The possible values are:

• 0—No change

• 1—None (no data is returned)

• 3—Enabled

COLD_START_TRAP_BROADCAST specifies whether to broadcast to the subnet broadcast IP address if there are no trap destinations configured for SNMP_ADDRESS_1, SNMP_ADDRESS_2, or SNMP_ADDRESS_3. Valid values are YesorNo.

TRAP_SOURCE_IDENTIFIER allows the substitution of the OS Hostname for the sysName when SNMP traps are generated from iLO. Value must be a valid iLO hostname or OS hostname. SNMP_ACCESS_ENABLED enables SNMP access. Valid values areY(enabled) andN(disabled). SNMP_PORT sets the port on which SNMP should communicate.

SNMP_TRAP_PORT sets the port on which SNMP traps are sent.

SNMP_V1_TRAPS sets whether SNMPv1 traps are sent. Valid values areYandN.

SNMP_V3_ENGINE_ID sets the unique identifier of an SNMP engine belonging to a SNMP agent entity. Value must be hexadecimal string, between 6 and 32 characters long (for example,

0x01020304abcdef). The value must be an even length, excluding the preceding “0x.” SNMP_USER_PROFILE INDEX sets the number(1, 2, or 3)for one of three available user profiles for SNMPv3 authentication, and includes the following:

• SECURITY_NAME sets the user profile name. Value must be 1 to 32 alphanumeric characters long.

• AUTHN_PROTOCOL sets the message digest algorithm to use for encoding the authorization passphrase. The message digest is calculated over an appropriate portion of an SNMP message and included as part of the message sent to the recipient. Valid values are0(for MD5) or1(for SHA).

• AUTHN_PASSPHRASE sets the passphrase to be used for sign operations. Value must be 8 to 49 characters long.

• PRIVACY_PROTOCOL sets the encryption algorithm to be used for encoding the privacy passphrase. A portion of an SNMP message in encrypted before transmission. Valid values are0(for DES) or1(for AES).

• PRIVACY_PASSPHRASE sets the passphrase used for encrypt operations. Value must be 8 to 49 characters long. If this value is omitted, the value for AUTHN_PASSPHRASE is used.

In document HP ilo 4 Scripting and Command Line Guide (Page 100-103)