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

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

"ManagerNetworkService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/NetworkService

See Resource Map for more details.

This resource is used to obtain or modify the network services managed by this manager.

iLO 4 automatically resets when the following properties are PATCHed:

  • "HTTP/Port"
  • "HTTPS/Port"
  • "SSH/Enabled"
  • "SSH/Port"

Client software should PATCH these properties together in one PATCH operation at a time where an iLO reset is best accomodated.

iLO 4 responds with "ResetRequired" when the following properties are PATCHed:

  • "VirtualMedia/Port"
  • "KVMIP/Port"
  • "SNMP/Enabled"
  • "SNMP/Port"
  • "Oem/Hp/SNMPTrapPort"
  • "HostName"

Client software must reset iLO 4 for these changes to take effect.

"ManagerNetworkService" defines the following properties:

"FQDN"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The fully-qualified domain name of the manager that is obtained by DNS and includes the host name and top-level domain name.
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.

"HTTP/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether HTTP is enabled or disabled.
JSON type:
Boolean ('true' or 'false')

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.

"HTTP/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The HTTP port number. NOTE: When this field is modified, the Manager will reset automatically.

iLO 4 automatically resets when this property is PATCHed.   Client software should PATCH this property together with other properties that cause an iLO reset as the last operation before iLO becomes unavailable for a few seconds as it reboots. A new session must be created after iLO resets.

JSON type:
Integer from 1 to 65535.

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:

{"HTTP": {"Port": <integer-value>}}

The property "HTTP/Port" on resource type ManagerNetworkService 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.

"HTTPS/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether HTTPS/SSL is enabled or disabled.
JSON type:
Boolean ('true' or 'false')

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.

"HTTPS/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The HTTPS/SSL port number. NOTE: When this field is modified, the Manager will reset automatically.

iLO 4 automatically resets when this property is PATCHed.   Client software should PATCH this property together with other properties that cause an iLO reset as the last operation before iLO becomes unavailable for a few seconds as it reboots. A new session must be created after iLO resets.

JSON type:
Integer from 1 to 65535.

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:

{"HTTPS": {"Port": <integer-value>}}

The property "HTTPS/Port" on resource type ManagerNetworkService 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.

"HostName"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The host name of the manager that is obtained by DNS and does not include any domain information.
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:

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

The property "HostName" on resource type ManagerNetworkService 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.

"IPMI/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether IPMI over LAN is enabled for the manager.
JSON type:
Boolean ('true' or 'false')

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:

{"IPMI": {"Enabled": true}}

The property "IPMI/Enabled" on resource type ManagerNetworkService 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.

"IPMI/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The IPMI over LAN port number.
JSON type:
Integer from 1 to 65535.

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.

"KVMIP/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether KVM-IP is enabled for the manager.
JSON type:
Boolean ('true' or 'false')

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.

"KVMIP/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The KVM-IP port number.
JSON type:
Integer from 1 to 65535.

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:

{"KVMIP": {"Port": <integer-value>}}

The property "KVMIP/Port" on resource type ManagerNetworkService 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/AlertMailEmail"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The destination email address for email alerts.
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:

{"Oem": {"Hp": {"AlertMailEmail": "<string-value>"}}}

The property "Oem/Hp/AlertMailEmail" on resource type ManagerNetworkService 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/AlertMailEnabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether AlertMail is enabled. This can be enabled only when the properties AlertMailEmail, AlertMailSenderDomain and AlertMailSMTPServer are set or not empty.
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": {"AlertMailEnabled": true}}}

The property "Oem/Hp/AlertMailEnabled" on resource type ManagerNetworkService 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/AlertMailSMTPPort"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The SMTP server port number.
JSON type:
Integer from 1 to 65535.

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": {"AlertMailSMTPPort": <integer-value>}}}

The property "Oem/Hp/AlertMailSMTPPort" on resource type ManagerNetworkService 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/AlertMailSMTPServer"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The IP address or DNS name of the SMTP server or the Mail Submission Agent (MSA).
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:

{"Oem": {"Hp": {"AlertMailSMTPServer": "<string-value>"}}}

The property "Oem/Hp/AlertMailSMTPServer" on resource type ManagerNetworkService 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/AlertMailSenderDomain"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The domain name for the sender email address.
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:

{"Oem": {"Hp": {"AlertMailSenderDomain": "<string-value>"}}}

The property "Oem/Hp/AlertMailSenderDomain" on resource type ManagerNetworkService 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/ConfigurationSettings"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
State of the currently displayed configuration settings.
JSON type:
String containing one of the following supported values: "Current" "SomePendingReset"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/EnforceAES3DESEncryption"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether AES/3DES encryption is enforced for the management processor. When enabled, the management processor accepts only those connections that use AES or 3DES ciphers. The management processor will automatically reset when this field is modified.
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": {"EnforceAES3DESEncryption": true}}}

The property "Oem/Hp/EnforceAES3DESEncryption" on resource type ManagerNetworkService 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/FederationEnabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether management processor federation management is enabled or disabled.
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": {"FederationEnabled": true}}}

The property "Oem/Hp/FederationEnabled" on resource type ManagerNetworkService 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/FederationSupported"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether management processor federation is supported.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/HPSystemManagementHomepageAddress"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The IP address or FQDN of the HP System Management Homepage (HP SMH) server.
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:

{"Oem": {"Hp": {"HPSystemManagementHomepageAddress": "<string-value>"}}}

The property "Oem/Hp/HPSystemManagementHomepageAddress" on resource type ManagerNetworkService 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/RemoteSyslogEnabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether Remote Syslog is enabled. When enabled, management processor sends notification messages to the specified Syslog server. This can be enabled only when the property RemoteSyslogServer is set or not empty.
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": {"RemoteSyslogEnabled": true}}}

The property "Oem/Hp/RemoteSyslogEnabled" on resource type ManagerNetworkService 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/RemoteSyslogPort"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The port number through which the Syslog server is listening.
JSON type:
Integer from 1 to 65535.

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": {"RemoteSyslogPort": <integer-value>}}}

The property "Oem/Hp/RemoteSyslogPort" on resource type ManagerNetworkService 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/RemoteSyslogServer"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The IP address, FQDN, IPv6 name, or short name of the server running the Syslog service.
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:

{"Oem": {"Hp": {"RemoteSyslogServer": "<string-value>"}}}

The property "Oem/Hp/RemoteSyslogServer" on resource type ManagerNetworkService 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/SNMPTrapPort"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The SNMP trap port number.
JSON type:
Integer from 1 to 65535.

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": {"SNMPTrapPort": <integer-value>}}}

The property "Oem/Hp/SNMPTrapPort" on resource type ManagerNetworkService 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/SerialOverLanLogging"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether Serial Over LAN (SOL) or Virtual Serial Port (VSP) logging is enabled.
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": {"SerialOverLanLogging": true}}}

The property "Oem/Hp/SerialOverLanLogging" on resource type ManagerNetworkService 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/XMLResponseEnabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Determines whether management processor responds to anonymous XML discovery requests.
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": {"XMLResponseEnabled": true}}}

The property "Oem/Hp/XMLResponseEnabled" on resource type ManagerNetworkService 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.

"SNMP/Enabled"

This property is a member of ManagerNetworkService

Indicates whether SNMP is enabled for the manager.
JSON type:
Boolean ('true' or 'false')

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:

{"SNMP": {"Enabled": true}}

The property "SNMP/Enabled" on resource type ManagerNetworkService 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.

"SNMP/Port"

This property is a member of ManagerNetworkService

The SNMP port number.
JSON type:
Integer from 1 to 65535.

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:

{"SNMP": {"Port": <integer-value>}}

The property "SNMP/Port" on resource type ManagerNetworkService 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.

"SSDP/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
JSON type:
Boolean ('true' or 'false')

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:

{"SSDP": {"Enabled": true}}

The property "SSDP/Enabled" on resource type ManagerNetworkService 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.

"SSDP/NotifyIPv6Scope"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The scope for IPv6 Notify messages for SSDP.
JSON type:
String containing one of the following supported values: "Link" "Site" "Organization"

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:

{"SSDP": {"NotifyIPv6Scope": "Site"}}

The property "SSDP/NotifyIPv6Scope" on resource type ManagerNetworkService 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.

"SSDP/NotifyMulticastIntervalSeconds"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates how often multicast is performed for SSDP.
JSON type:
Integer greater than or equal to 0.

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:

{"SSDP": {"NotifyMulticastIntervalSeconds": <integer-value>}}

The property "SSDP/NotifyMulticastIntervalSeconds" on resource type ManagerNetworkService 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.

"SSDP/NotifyTTL"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The Time to Live (TTL) hop count for SSDP Notify messages.
JSON type:
Integer greater than or equal to 1.

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:

{"SSDP": {"NotifyTTL": <integer-value>}}

The property "SSDP/NotifyTTL" on resource type ManagerNetworkService 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.

"SSDP/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The SSDP port number.
JSON type:
Integer from 1 to 65535.

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.

"SSH/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether SSH is enabled for the manager. NOTE: When this field is modified, the Manager will reset automatically.

iLO 4 automatically resets when this property is PATCHed.   Client software should PATCH this property together with other properties that cause an iLO reset as the last operation before iLO becomes unavailable for a few seconds as it reboots. A new session must be created after iLO resets.

JSON type:
Boolean ('true' or 'false')

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:

{"SSH": {"Enabled": true}}

The property "SSH/Enabled" on resource type ManagerNetworkService 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.

"SSH/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The SSH port number. NOTE: When this field is modified, the Manager will reset automatically.

iLO 4 automatically resets when this property is PATCHed.   Client software should PATCH this property together with other properties that cause an iLO reset as the last operation before iLO becomes unavailable for a few seconds as it reboots. A new session must be created after iLO resets. 

</div>
JSON type:
Integer from 1 to 65535.

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:

{"SSH": {"Port": <integer-value>}}

The property "SSH/Port" on resource type ManagerNetworkService 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.

"SessionTimeoutMinutes"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The session timeout (minutes). A zero value indicates infinite timeout.
JSON type:
Integer greater than or equal to 0.

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:

{"SessionTimeoutMinutes": <integer-value>}

The property "SessionTimeoutMinutes" on resource type ManagerNetworkService 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 [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates the health state of this resource without considering 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.

"Status/HealthRollUp"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates the known state of this resource (for example, if the resource is enabled). Enabled indicates that the resource is available. Disabled indicates that the resource has been made unavailable intentionally, but it can be enabled. Offline indicates that the resource is unavailable intentionally and requires action to be made available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates that the resource is physically unavailable.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled" "Offline" "InTest" "Starting"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"VirtualMedia/Enabled"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
Indicates whether Virtual Media is enabled for the manager.
JSON type:
Boolean ('true' or 'false')

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.

"VirtualMedia/Port"

This property is a member of [ManagerNetworkService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ManagerNetworkService-Resource-Type)#managernetworkservice-resource-type)
The Virtual Media port number.
JSON type:
Integer from 1 to 65535.

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:

{"VirtualMedia": {"Port": <integer-value>}}

The property "VirtualMedia/Port" on resource type ManagerNetworkService 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 "SendTestSyslog"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "SendTestSyslog", "Target": "/Oem/Hp"}

POST Action "SendTestAlertMail"

Sends test alert mail to configured AlertMail email address.

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "SendTestAlertMail", "Target": "/Oem/Hp"}
⚠️ **GitHub.com Fallback** ⚠️