system service-processor api-service modify

Modify service processor API service configuration

Availability: This command is available to cluster administrators at the advanced privilege level.

Description

The system service-processor api-service modify command modifies SP API service configuration. The SP API is a secure network API that enables Data ONTAP to communicate with the Service Processor over the network.

Parameters

[-is-enabled {true|false}] - Is SP API Service Enabled
This parameter enables or disables the API service of the Service Processor (SP) or baseboard management controller (BMC). When the API service is disabled, features like network-based firmware updates and network-based down node log collection will not be available, and the slower serial-interface will be used for firmware updates and down node log collection.
[-port <integer>] - SP API Service Port
This parameter specifies the port number on the Service Processor used for the API service. By default, port 50000 is used.
[-limit-access {true|false}] - Only Cluster Members Can Access the Service
This parameter restricts API service access to cluster members only. By default, it is enabled.

Examples

The following example modifies the port number used for the SP API service and then disables the SP API service.
cluster1::*>system service-processor api-service modify -port 50001

cluster1::*>system service-processor api-service show
 Service Processor API service configuration
is-enabled: true
      port: 50001
	    
cluster1::*>system service-processor api-service modify -is-enabled false

cluster1::*>system service-processor api-service show
 Service Processor API service configuration
is-enabled: false
      port: 50001