Skip to main content

Commands for managing the SP from ONTAP

ONTAP provides commands for managing the SP, including the SP network configuration, SP firmware image, SSH access to the SP, and general SP administration.

Commands for managing the SP network configuration​

If you want to...Run this ONTAP command...
Enable the SP automatic network configuration for the SP to use the IPv4 or IPv6 address family of the specified subnetsystem service-processor network auto-configuration enable
Disable the SP automatic network configuration for the IPv4 or IPv6 address family of the subnet specified for the SPsystem service-processor network auto-configuration disable
Display the SP automatic network configurationsystem service-processor network auto-configuration show
Manually configure the SP network for a node, including the following:

  • The IP address family (IPv4 or IPv6)

  • Whether the network interface of the specified IP address family should be enabled

  • If you are using IPv4, whether to use the network configuration from the DHCP server or the network address that you specify

  • The public IP address for the SP

  • The netmask for the SP (if using IPv4)

  • The network prefix-length of the subnet mask for the SP (if using IPv6)

  • The gateway IP address for the SP

system service-processor network modify
Display the SP network configuration, including the following:

  • The configured address family (IPv4 or IPv6) and whether it is enabled

  • The remote management device type

  • The current SP status and link status

  • Network configuration, such as IP address, MAC address, netmask, prefix-length of subnet mask, router-assigned IP address, link local IP address, and gateway IP address

  • The time the SP was last updated

  • The name of the subnet used for SP automatic configuration

  • Whether the IPv6 router-assigned IP address is enabled

  • SP network setup status

  • Reason for the SP network setup failure

system service-processor network show

Displaying complete SP network details requires the -instance parameter.

Modify the SP API service configuration, including the following:

  • Changing the port used by the SP API service

  • Enabling or disabling the SP API service

system service-processor api-service modify

(advanced privilege level)

Display the SP API service configuration

system service-processor api-service show

(advanced privilege level)

Renew the SSL and SSH certificates used by the SP API service for internal communication

system service-processor api-service renew-certificates

(advanced privilege level)

Commands for managing the SP firmware image​

If you want to...Run this ONTAP command...
Display the details of the currently installed SP firmware image, including the following:

  • The remote management device type

  • The image (primary or backup) that the SP is booted from, its status, and firmware version

  • Whether the firmware automatic update is enabled and the last update status

system service-processor image show

The -is-current parameter indicates the image (primary or backup) that the SP is currently booted from, not whether the installed firmware version is most current.

Enable or disable the SP automatic firmware updatesystem service-processor image modify

By default, the SP firmware is automatically updated with the update of ONTAP or when a new version of the SP firmware is manually downloaded. Disabling the automatic update is not recommended because doing so can result in suboptimal or nonqualified combinations between the ONTAP image and the SP firmware image.

Manually download an SP firmware image on a nodesystem node image get
Note
Before you run the system node image commands, you must set the privilege level to advanced (set -privilege advanced), entering y when prompted to continue.

The SP firmware image is packaged with ONTAP. You do not need to download the SP firmware manually, unless you want to use an SP firmware version that is different from the one packaged with ONTAP.

Manually update the SP firmware, by specifying the following:

  • The SP firmware package to use

    You can have the SP use a specific SP firmware package by specifying the package file name. The system node image package show command displays all package files (including the files for the SP firmware package) that are available on a node.

  • The installation baseline

    You can update the SP firmware to the baseline version that is bundled with the currently running version of ONTAP.

  • Whether to update the entire firmware image or only the changed portions, using the network interface or the serial interface

  • If updating the entire firmware image, whether to also reset log settings to the factory default and clear contents of all logs maintained by the SP, including the event logs, IPMI logs, and forensics logs

system service-processor image update
Display the status for the latest SP firmware update triggered from ONTAP, including the following information:

  • The start and end time for the latest SP firmware update

  • Whether an update is in progress and the percentage that is complete

system service-processor image update-progress show

Commands for managing SSH access to the SP​

If you want to...Run this ONTAP command...
Grant SP access to only the specified IP addressessystem service-processor ssh add-allowed-addresses
Block the specified IP addresses from accessing the SPsystem service-processor ssh remove-allowed-addresses
Display the IP addresses that can access the SPsystem service-processor ssh show

Commands for general SP administration​

If you want to...Run this ONTAP command...
Display general SP information, including the following:

  • The remote management device type

  • The current SP status

  • Whether the SP network is configured

  • Network information, such as the public IP address and the MAC address

  • The SP firmware version and Intelligent Platform Management Interface (IPMI) version

  • Whether the SP firmware automatic update is enabled

system service-processor show

Displaying complete SP information requires the -instance parameter.

Reboot the SP on a node and optionally specify the SP firmware image (primary or backup) to usesystem service-processor reboot-sp
Attention
You should avoid booting the SP from the backup image. Booting from the backup image is reserved for troubleshooting and recovery purposes only. It might require that the SP automatic firmware update be disabled, which is not a recommended setting. You should contact Technical Support before attempting to boot the SP from the backup image.
Generate and send an AutoSupport message that includes the SP log files collected from a specified nodesystem node autosupport invoke-splog
Display the allocation map of the collected SP log files in the cluster, including the sequence numbers for the SP log files that reside in each collecting nodesystem service-processor log show-allocations