APIs in Category: service-processor | Cluster-Mode API version 1.21

service-processor-get service-processor-image-get service-processor-image-modify service-processor-image-update service-processor-image-update-progress-get service-processor-network-get service-processor-network-modify service-processor-reboot | These APIs enable applications to get information about the Service Processor of any node in the cluster or modifying its configuration. A Service Processor (SP) device provides remote management capabilities including console redirection, logging and power control. It also extends AutoSupport by sending additional system event alerts. The AutoSupport settings are used for sending these alerts via email over the SP LAN interface.

NetApp Manage ONTAP

service-processor-get | [top]

> Get basic information about the device

> Input Name | Range | Type | Description
> desired-attributes |  | service-processor-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> node |  | node-name | Node on which the device is located
> Output Name | Range | Type | Description
> attributes |  | service-processor-info | The attributes of the service-processor.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-image-get | [top]

> Get information about installed firmware images

> Input Name | Range | Type | Description
> desired-attributes |  | service-processor-image optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> firmware-image |  | sp-fw-type | Is this image primary or backup firmware for the device Possible values: "primary" - Firmware which the device boots into by default, "backup" - Firmware which the device boots into if primary fails
> node |  | node-name | Node on which the device is located
> Output Name | Range | Type | Description
> attributes |  | service-processor-image | The attributes of the service-processor.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-image-modify | [top]

> Enable or disable automatic firmware update

> Input Name | Range | Type | Description
> is-autoupdate-enabled |  | boolean optional | Is firmware autoupdate enabled on the device
> node |  | node-name | Node on which the device is located

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-image-update | [top]

> Install new firmware image

> Input Name | Range | Type | Description
> clear-logs |  | boolean optional | Clear logs on the device after update. Default value is true
> install-baseline-image |  | boolean optional | Install the version packaged with ONTAP if this parameter is set to true. Otherwise, -package must be used to specify the package to install
> node |  | node-name | Node on which the device is located
> package |  | string optional | Name of the package file containing the firmware to be installed. Not required when -baseline is true
> update-type |  | sp-fw-update-type | Type of firmware update to be performed

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-image-update-progress-get | [top]

> Get firmware update progress

> Input Name | Range | Type | Description
> desired-attributes |  | service-processor-image-update-progress-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> node |  | node-name | Node on which the device is located
> Output Name | Range | Type | Description
> attributes |  | service-processor-image-update-progress-info | The attributes of the service-processor.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-network-get | [top]

> Get the network configuration

> Input Name | Range | Type | Description
> address-type |  | sp-ip-address-type | Network configuration that is being addressed i.e. IPv4 or IPv6 Possible values: "ipv4" - Internet Protocol version 4, "ipv6" - Internet Protocol version 6
> desired-attributes |  | service-processor-network-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> node |  | node-name | Node on which the device is located
> Output Name | Range | Type | Description
> attributes |  | service-processor-network-info | The attributes of the service-processor.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-network-modify | [top]

> Modify the network configuration

> Input Name | Range | Type | Description
> address-type |  | sp-ip-address-type | Network configuration that is being addressed i.e. IPv4 or IPv6 Possible values: "ipv4" - Internet Protocol version 4, "ipv6" - Internet Protocol version 6
> dhcp |  | sp-dhcp-status optional | DHCP status for the configuration Possible values: "v4" - DHCP for IPv4, "none" - DHCP not enabled
> gateway-ip-address |  | ip-address optional | IP address of the network gateway
> ip-address |  | ip-address optional | IP address currently held by the device
> is-enabled |  | boolean optional | Is this address configuration enabled
> netmask |  | ip-address optional | Netmask for the device
> node |  | node-name | Node on which the device is located
> prefix-length | [0..64] | integer optional | Prefix length of subnet mask

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

service-processor-reboot | [top]

> Reboot the Service Processor

> Input Name | Range | Type | Description
> firmware-image |  | sp-fw-type optional | Image to boot upon reboot. Default is primary
> node |  | node-name | Node on which the device is located

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: service-processor-image | [top]

> Service processor firmware information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> firmware-image |  | sp-fw-type optional | Is this image primary or backup firmware for the device Attributes: key, non-creatable, non-modifiable Possible values: "primary" - Firmware which the device boots into by default, "backup" - Firmware which the device boots into if primary fails
> is-autoupdate-enabled |  | boolean optional | Is firmware autoupdate enabled on the device Attributes: non-creatable, non-modifiable
> is-current |  | boolean optional | Is device currently booted from this image Attributes: non-creatable, non-modifiable
> last-update-status |  | sp-pass-fail optional | Did last firmware install on the device pass or fail Attributes: non-creatable, non-modifiable Possible values: "failed" - Operation failed, "passed" - Operation was successful
> node |  | node-name optional | Node on which the device is located Attributes: key, non-creatable, non-modifiable
> status |  | sp-fw-status optional | Status of this firmware image Attributes: non-creatable, non-modifiable Possible values: "installed" - Firmware installed and in normal state, "corrupt" - Firmware is corrupt, "updating" - Firmware is undergoing a manual update, "auto_updating" - Firmware is undergoing an automatic update, "none" - Firmware status not known
> type |  | sp-type optional | Type of device Attributes: non-creatable, non-modifiable Possible values: "rlm" - Remote LAN Module, "sp" - Service Processor, "none" - None
> version |  | string optional | Firmware version in this image Attributes: non-creatable, non-modifiable

Element definition: service-processor-image-update-progress-info | [top]

> Service processor image update progress information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> end-time |  | datetime optional | Time when the firmware finished (if complete, else empty) Attributes: non-creatable, non-modifiable
> is-in-progress |  | boolean optional | Is a firmware update in progress Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Node on which the device is located Attributes: key, non-creatable, non-modifiable
> percent-done | [0..100] | integer optional | Current progress of the firmware update percentage Attributes: non-creatable, non-modifiable
> start-time |  | datetime optional | Time when the firmware update started Attributes: non-creatable, non-modifiable

Element definition: service-processor-info | [top]

> Service processor information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> device-revision |  | string optional | Device revision. Applicable for RLM only Attributes: non-creatable, non-modifiable
> firmware-version |  | string optional | Firmware version installed on the device Attributes: non-creatable, non-modifiable
> ip-address |  | ip-address[] optional | Public IP addresses of the device Attributes: non-creatable, non-modifiable
> ipmi-version |  | string optional | IPMI version supported by the device Attributes: non-creatable, non-modifiable
> is-autoupdate-enabled |  | boolean optional | Is firmware autoupdate enabled for the device Attributes: non-creatable, non-modifiable
> is-ip-configured |  | boolean optional | Is network configured on the device to have at least one public IP address Attributes: non-creatable, non-modifiable
> mac-address |  | mac-address optional | MAC address of the device Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Node on which the device is located Attributes: key, non-creatable, non-modifiable
> part-num |  | string optional | Part number of the device. Applicable for RLM only Attributes: non-creatable, non-modifiable
> serial-num |  | string optional | Serial number of the device. Applicable for RLM only Attributes: non-creatable, non-modifiable
> status |  | sp-status optional | Current status of the device Attributes: non-creatable, non-modifiable Possible values: "online" - Device is up and running fine, "offline" - Device is out of communication, "sp_daemon_offline" - Daemon which communicates with the device is not running, "node_offline" - Node that hosts the device is out of communication, "degraded" - Node that hosts the device is missing heartbeat signals from the device, "rebooting" - Device is rebooting, "unknown" - Device status could not be determined
> type |  | sp-type optional | Type of device Attributes: non-creatable, non-modifiable Possible values: "rlm" - Remote LAN Module, "sp" - Service Processor, "none" - None

Element definition: service-processor-network-info | [top]

> Service processor network configuration When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> address-type |  | sp-ip-address-type optional | Network configuration that is being addressed i.e. IPv4 or IPv6 Attributes: key, non-creatable, non-modifiable Possible values: "ipv4" - Internet Protocol version 4, "ipv6" - Internet Protocol version 6
> device-type |  | sp-type optional | Type of device Attributes: non-creatable, non-modifiable Possible values: "rlm" - Remote LAN Module, "sp" - Service Processor, "none" - None
> dhcp |  | sp-dhcp-status optional | DHCP status for the configuration Attributes: non-creatable, modifiable Possible values: "v4" - DHCP for IPv4, "none" - DHCP not enabled
> gateway-ip-address |  | ip-address optional | IP address of the network gateway Attributes: non-creatable, modifiable
> ip-address |  | ip-address optional | IP address currently held by the device Attributes: non-creatable, modifiable
> is-enabled |  | boolean optional | Is this address configuration enabled Attributes: non-creatable, modifiable
> link-local-ip-address |  | ip-address optional | Link local IP address Attributes: non-creatable, non-modifiable
> link-status |  | sp-link-status optional | Current status of the underlying network link used by this address Attributes: non-creatable, non-modifiable Possible values: "up" - Link is connected, "down" - Link is severed, "disabled" - Link has been disabled by user, "unknown" - Link status is no known
> mac-address |  | mac-address optional | MAC address of the device Attributes: non-creatable, non-modifiable
> netmask |  | ip-address optional | Netmask for the device Attributes: non-creatable, modifiable
> node |  | node-name optional | Node on which the device is located Attributes: key, non-creatable, non-modifiable
> prefix-length | [0..64] | integer optional | Prefix length of subnet mask Attributes: non-creatable, modifiable
> router-ip-address |  | ip-address optional | Router assigned IP address Attributes: non-creatable, non-modifiable
> status |  | sp-status optional | Current status of the device Attributes: non-creatable, non-modifiable Possible values: "online" - Device is up and running fine, "offline" - Device is out of communication, "sp_daemon_offline" - Daemon which communicates with the device is not running, "node_offline" - Node that hosts the device is out of communication, "degraded" - Node that hosts the device is missing heartbeat signals from the device, "rebooting" - Device is rebooting, "unknown" - Device status could not be determined

Element definition: sp-dhcp-status | [top]

> Possible configurations for DHCP protocol Possible values: "v4" - DHCP for IPv4, "none" - DHCP not enabled

> [none]

Element definition: sp-fw-type | [top]

> Choices for the two firmware images installed on a SP/RLM device Possible values: "primary" - Firmware which the device boots into by default, "backup" - Firmware which the device boots into if primary fails

> [none]

Element definition: sp-fw-update-type | [top]

> Possible choices for a firmware update type Possible values: "full" - Replace the fimrware completely with new package, "differential" - Replace only parts of firmware which have changed in new package

> [none]

Element definition: sp-ip-address-type | [top]

> Choices for which IP version to use Possible values: "ipv4" - Internet Protocol version 4, "ipv6" - Internet Protocol version 6

> [none]

Element definition: datetime | [top]

> The number of seconds since January 1, 1970. Range : [0..2^31-1].

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: mac-address | [top]

> MAC Address

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: sp-fw-status | [top]

> Possible states the firmware of a SP/RLM device can be in Possible values: "installed" - Firmware installed and in normal state, "corrupt" - Firmware is corrupt, "updating" - Firmware is undergoing a manual update, "auto_updating" - Firmware is undergoing an automatic update, "none" - Firmware status not known

> [none]

Element definition: sp-link-status | [top]

> Possible states for the underlying physical link for a network insterface Possible values: "up" - Link is connected, "down" - Link is severed, "disabled" - Link has been disabled by user, "unknown" - Link status is no known

> [none]

Element definition: sp-pass-fail | [top]

> Possible completion states of a task Possible values: "failed" - Operation failed, "passed" - Operation was successful

> [none]

Element definition: sp-status | [top]

> Possible states a Service Processor or Remote LAN Module can be in Possible values: "online" - Device is up and running fine, "offline" - Device is out of communication, "sp_daemon_offline" - Daemon which communicates with the device is not running, "node_offline" - Node that hosts the device is out of communication, "degraded" - Node that hosts the device is missing heartbeat signals from the device, "rebooting" - Device is rebooting, "unknown" - Device status could not be determined

> [none]

Element definition: sp-type | [top]

> Types of remote management device that can be found in a node Possible values: "rlm" - Remote LAN Module, "sp" - Service Processor, "none" - None

> [none]