iLO 4 REST API Data Model (SnmpServic Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki

HP RESTful API Data Model Reference for iLO 4—Redfish 1.0 Conformance (Cont)

"SnmpService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SnmpService

See Resource Map for more details.

"SnmpService" defines the following properties:

"AlertsEnabled"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The alert conditions that the management processor detects independently of the host operating system can be sent to specified SNMP alert destinations, such as HP SIM.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"AlertsEnabled": true}

The property "AlertsEnabled" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Contact"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The string of up to 49 characters that specifies the system administrator or server owner. The string can include a name, email address, or phone number.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Contact": "<string-value>"}

The property "Contact" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Location"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The string of up to 49 characters that specifies the physical location of the server.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Location": "<string-value>"}

The property "Location" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Mode"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
Agentless Management Mode (default): Use SNMP agents running on the management processor to manage the server. SNMP Pass-thru Mode: Use SNMP agents running on the host operating system to manage the server. This setting does not affect alerts.
JSON type:
String containing one of the following supported values: "Agentless" "Passthru"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Mode": "Passthru"}

The property "Mode" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPColdStartTrapBroadcast"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
If set to true, the Cold Start Trap will be enabled. The Cold Start Trap is broadcast to a subnet broadcast address if there are no trap destinations configured in the SNMP Alert Destination(s) boxes.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPColdStartTrapBroadcast": true}}}

The property "Oem/Hp/SNMPColdStartTrapBroadcast" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPForwardInsightManagerAgentAlerts"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
If set to true, the alert conditions detected by the host management agents are forwarded to SNMP alert destinations through the management processor. These alerts are generated by the Insight Management Agents, which are available for each supported operating system. Insight Management Agents must be installed on the host server to receive these alerts.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPForwardInsightManagerAgentAlerts": true}}}

The property "Oem/Hp/SNMPForwardInsightManagerAgentAlerts" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Role"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The string of up to 64 characters that describes the server role or function.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Role": "<string-value>"}

The property "Role" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"RoleDetail"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The string of up to 512 characters that describes specific tasks that the server might perform.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"RoleDetail": "<string-value>"}

The property "RoleDetail" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMPv1Traps"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
When enabled, SNMPv1 traps are sent to the remote management systems configured in the SNMP Alert Destination(s) boxes.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMPv1Traps": true}

The property "SNMPv1Traps" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMPv3EngineID"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The SNMPv3 Engine ID is the unique identifier of an SNMP engine that belongs to an SNMP agent entity. This value must be a hexadecimal string with an even number of 6 to 32 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMPv3EngineID": "<string-value>"}

The property "SNMPv3EngineID" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of SnmpService

This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
This indicates the known state of the resource, such as if it is enabled.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled" "Offline" "InTest" "Starting" "Absent"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"TrapSourceHostname"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
Determines the host name that is used in the SNMP-defined sysName variable when the management processor generates SNMP traps.
JSON type:
String containing one of the following supported values: "Manager" "System"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"TrapSourceHostname": "System"}

The property "TrapSourceHostname" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/AuthPassphrase"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"AuthPassphrase": "<string-value>"}|null, ...]}

The property "Users[]/AuthPassphrase" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/AuthProtocol"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
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 is included as part of the message sent to the recipient. Select MD5 (Message Digest) or SHA (Secure Hash Algorithm).
JSON type:
String containing one of the following supported values: "MD5" "SHA"

h4>HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"AuthProtocol": "SHA"}|null, ...]}

The property "Users[]/AuthProtocol" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/PrivacyPassphrase"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
Sets the passphrase to use for encrypt operations. Enter a value of 8 to 49 characters.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"PrivacyPassphrase": "<string-value>"}|null, ...]}

The property "Users[]/PrivacyPassphrase" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/PrivacyProtocol"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. Select AES (Advanced Encryption Standard) or DES (Data Encryption Standard).
JSON type:
String containing one of the following supported values: "DES" "AES"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"PrivacyProtocol": "AES"}|null, ...]}

The property "Users[]/PrivacyProtocol" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/SecurityName"

This property is a member of [SnmpService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SnmpServic-Resource-Type)#snmpservice-resource-type)
The user profile name. Enter an alphanumeric string of 1 to 32 characters.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"SecurityName": "<string-value>"}|null, ...]}

The property "Users[]/SecurityName" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

POST Action "SendSNMPTestAlert"

Causes iLO 4 to send a test SNMP trap to registered trap destinations.

Example

HTTP POST to resource with request JSON:

{ "Action": "SendSNMPTestAlert"}
⚠️ **GitHub.com Fallback** ⚠️