service-processor
Suggest changes
PDFs
service-processor-api-service-disable-installed-certificates
This ONTAPI call does not have an equivalent REST API call.
service-processor-api-service-enable-installed-certificates
This ONTAPI call does not have an equivalent REST API call.
service-processor-api-service-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
sp-api-enabled |
service_processor.api_service.enabled |
|
sp-api-limit-access |
service_processor.api_service.limit_access |
|
sp-api-port |
service_processor.api_service.port |
|
web-enabled |
service_processor.web_service.enabled |
|
web-limit-access |
service_processor.web_service.limit_access |
service-processor-api-service-modify
This ONTAPI call does not have an equivalent REST API call.
service-processor-api-service-renew-internal-certificates
This ONTAPI call does not have an equivalent REST API call.
service-processor-asup-config-get
This ONTAPI call does not have an equivalent REST API call.
service-processor-asup-config-set
This ONTAPI call does not have an equivalent REST API call.
service-processor-asup-invoke
This ONTAPI call does not have an equivalent REST API call.
service-processor-auto-configuration-disable
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-family |
auto_config.ipv6_subnet |
Set this field to null or an empty string "" for the address family for which auto-config needs to be disabled |
service-processor-auto-configuration-enable
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-family |
No REST Equivalent |
|
subnet-name |
auto_config.ipv6_subnet |
Give the subnet name for the respective address family for which auto-config needs to be enabled |
service-processor-auto-configuration-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
subnet-name-v4 |
auto_config.ipv4_subnet |
|
subnet-name-v6 |
auto_config.ipv6_subnet |
service-processor-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
device-revision |
No REST Equivalent |
|
firmware-version |
service_processor.firmware_version |
|
ip-address |
service_processor.ipv4_interface.address |
If IPv6 networking is enabled, retrieve the IPv6 address at service_processor.ipv6_interface.address. |
is-autoupdate-enabled |
service_processor.autoupdate_enabled |
|
is-ip-configured |
service_processor.is_ip_configured |
|
mac-address |
service_processor.mac_address |
|
node |
name |
|
part-num |
No REST Equivalent |
|
serial-num |
No REST Equivalent |
|
status |
service_processor.state |
|
type |
service_processor.type |
|
node |
name |
service-processor-get-iter
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
device-revision |
No REST Equivalent |
|
firmware-version |
service_processor.firmware_version |
|
ip-address |
service_processor.ipv4_interface.address |
If IPv6 networking is enabled, retrieve the IPv6 address at service_processor.ipv6_interface.address. |
is-autoupdate-enabled |
service_processor.autoupdate_enabled |
|
is-ip-configured |
service_processor.is_ip_configured |
|
mac-address |
service_processor.mac_address |
|
node |
name |
|
part-num |
No REST Equivalent |
|
serial-num |
No REST Equivalent |
|
status |
service_processor.state |
|
type |
service_processor.type |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
service-processor-image-get
GET /api/cluster/nodes/{uuid}
Note: In the REST API, service processor image information is reported directly under "service_processor.primary" or "service_processor.backup" rather than firmware-image.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
firmware-image |
No REST Equivalent |
In the REST API, service processor image information is reported directly under "service_processor.primary" or "service_processor.backup" rather than firmware-image. |
is-autoupdate-enabled |
service_processor.autoupdate_enabled |
|
is-current |
service_processor.primary.is_current |
In the REST API, service processor backup "is_current" is retrieved using "service_processor.backup.is_current". |
last-update-status |
service_processor.last_update_state |
|
node |
No REST Equivalent |
|
status |
service_processor.primary.state |
In the REST API, service processor backup "status" is retrieved using "service_processor.backup.state". |
type |
service_processor.type |
|
version |
service_processor.primary.version |
In the REST API, service processor backup version is retrieved using "service_processor.backup.version". |
firmware-image |
No REST Equivalent |
In the REST API, service processor image information is reported directly under "service_processor.primary" or "service_processor.backup" rather than firmware-image. |
node |
No REST Equivalent |
service-processor-image-modify
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-autoupdate-enabled |
service_processor.autoupdate_enabled |
|
node |
No REST Equivalent |
service-processor-image-update
This ONTAPI call does not have an equivalent REST API call.
service-processor-image-update-progress-get
This ONTAPI call does not have an equivalent REST API call.
service-processor-log-allocation-get
This ONTAPI call does not have an equivalent REST API call.
service-processor-log-allocation-get-iter
This ONTAPI call does not have an equivalent REST API call.
service-processor-network-get
GET /api/cluster/nodes/{uuid}
Note: In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-type |
No REST Equivalent |
In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type. |
device-type |
service_processor.type |
|
dhcp |
service_processor.dhcp_enabled |
|
gateway-ip-address |
service_processor.ipv4_interface.gateway |
If IPv6 networking is enabled, retrieve the IPv6 gateway address at "service_processor.ipv6_interface.gateway". |
ip-address |
service_processor.ipv4_interface.address |
If IPv6 networking is enabled, retrieve the IPv6 address at "service_processor.ipv6_interface.address". |
is-enabled |
No REST Equivalent |
In the REST API, if service_processor.ipvX_interface fields are present, is-enabled is "true". |
is-ipv6-ra-enabled |
service_processor.ipv6_interface.is_ipv6_ra_enabled |
|
link-local-ip-address |
service_processor.ipv6_interface.link_local_ip |
|
link-status |
No REST Equivalent |
|
mac-address |
service_processor.mac_address |
|
netmask |
service_processor.ipv4_interface.netmask |
|
node |
name |
|
prefix-length |
service_processor.ipv6_interface.netmask |
|
router-ip-address |
service_processor.ipv6_interface.router_ip |
|
setup-failure-reason |
No REST Equivalent |
|
setup-status |
service_processor.ipv4_interface.setup_state |
If IPv6 networking is enabled, retrieve the IPv6 setup status at "service_processor.ipv6_interface.setup_state". |
status |
service_processor.state |
|
subnet-name |
No REST Equivalent |
|
node |
name |
service-processor-network-get-iter
GET /api/cluster/nodes/{uuid}
Note: In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-type |
No REST Equivalent |
In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type. |
device-type |
service_processor.type |
|
dhcp |
service_processor.dhcp_enabled |
|
gateway-ip-address |
service_processor.ipv4_interface.gateway |
If IPv6 networking is enabled, retrieve the IPv6 gateway address at "service_processor.ipv6_interface.gateway". |
ip-address |
service_processor.ipv4_interface.address |
If IPv6 networking is enabled, retrieve the IPv6 address at "service_processor.ipv6_interface.address". |
is-enabled |
service_processor.ipv4_interface.enabled |
In the REST API, if service_processor.ipvX_interface fields are present, is-enabled is "true". |
is-ipv6-ra-enabled |
service_processor.ipv6_interface.is_ipv6_ra_enabled |
|
link-local-ip-address |
service_processor.ipv6_interface.link_local_ip |
|
link-status |
No REST Equivalent |
|
mac-address |
service_processor.mac_address |
|
netmask |
service_processor.ipv4_interface.netmask |
|
node |
name |
|
prefix-length |
service_processor.ipv6_interface.netmask |
|
router-ip-address |
service_processor.ipv6_interface.router_ip |
|
setup-failure-reason |
No REST Equivalent |
|
setup-status |
service_processor.ipv4_interface.setup_state |
If IPv6 networking is enabled, retrieve the IPv6 setup status at "service_processor.ipv6_interface.setup_state". |
status |
service_processor.state |
|
subnet-name |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
service-processor-network-modify
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-type |
No REST Equivalent |
|
dhcp |
service_processor.dhcp_enabled |
|
gateway-ip-address |
service_processor.ipv4_interface.gateway |
Use the service_processor.ipv6_interface.gateway field to modify the IPv6 gateway address. |
ip-address |
service_processor.ipv4_interface.address |
Use the service_processor.ipv6_interface.address field to modify the IPv6 address. |
is-enabled |
service_processor.ipv4_interface.enabled |
Use the service_processor.ipv4_interface.enabled field to enable or disable IPv4 addresses and use the service_processor.ipv6_interface.enabled field to enable or disable IPv6 addresses. |
netmask |
service_processor.ipv4_interface.netmask |
|
node |
name |
It is a query-only field. |
prefix-length |
service_processor.ipv6_interface.netmask |
service-processor-network-modify-iter
PATCH /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-type |
No REST Equivalent |
In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type. |
device-type |
No REST Equivalent |
|
dhcp |
service_processor.dhcp_enabled |
|
gateway-ip-address |
service_processor.ipv4_interface.gateway |
Use the service_processor.ipv6_interface.gateway field to set the IPv6 gateway address. |
ip-address |
service_processor.ipv4_interface.address |
Use the service_processor.ipv6_interface.address field to set the IPv6 address. |
is-enabled |
service_processor.ipv4_interface.enabled |
Use the service_processor.ipv4_interface.enabled field to enable or disable IPv4 addresses and use the service_processor.ipv6_interface.enabled field to enable or disable IPv6 addresses. |
is-ipv6-ra-enabled |
No REST Equivalent |
|
link-local-ip-address |
No REST Equivalent |
|
link-status |
No REST Equivalent |
|
mac-address |
No REST Equivalent |
|
netmask |
service_processor.ipv4_interface.netmask |
|
node |
name |
It is a query-only field. |
prefix-length |
service_processor.ipv6_interface.netmask |
|
router-ip-address |
No REST Equivalent |
|
setup-failure-reason |
No REST Equivalent |
|
setup-status |
No REST Equivalent |
|
status |
No REST Equivalent |
|
subnet-name |
No REST Equivalent |
|
continue-on-failure |
No REST Equivalent |
|
max-failure-count |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
return-failure-list |
No REST Equivalent |
|
return-success-list |
No REST Equivalent |
service-processor-reboot
PATCH /api/cluster/nodes/{uuid}
Note: The URL should include "?service_processor.action=reboot" to reboot the service processor. The URL can include "?service_processor.firmware_image=" as either "primary" or "backup" to specify the image to boot from after a reboot and "?name=" to specify the node name.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
firmware-image |
No REST Equivalent |
|
node |
No REST Equivalent |
service-processor-ssh-add-allowed-addresses
This ONTAPI call does not have an equivalent REST API call.
service-processor-ssh-get
GET /api/cluster/nodes/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
service-processor-ssh-info |
service_processor.ssh_info |
Service processor SSH allowed IP addresses configuration applied across the cluster |
service-processor-ssh-remove-allowed-addresses
This ONTAPI call does not have an equivalent REST API call.