Skip to main content

system service-processor api-service modify

Contributors
Suggest changes
PDFs

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 the Service Processor (SP) or Baseboard Management Controller (BMC) API service and web service configuration. The SP API and web is a secure network API that enables ONTAP to communicate with the SP or BMC over the network.

Parameters

{ [-sp-api-enabled {true|false}] - Is SP API Service Enabled (privilege: advanced)

This parameter enables or disables the SP API service of the SP or BMC. When the SP 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.

[-sp-api-port <integer>] - SP API Service Port (privilege: advanced)

This parameter specifies the port number on the SP or BMC used for the SP API service. By default, port 50000 is used.

[-sp-api-limit-access {true|false}] - Only Cluster Members Can Access the API Service (privilege: advanced)

This parameter restricts SP API service access to cluster members only. By default, it is enabled.

| [-web-enabled {true|false}] - Is SP Web Service Enabled (privilege: advanced)

This parameter enables or disables the web service of the SP or BMC. When the web 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.

[-web-limit-access {true|false}] - Only Cluster Members Can Access the Web Service (privilege: advanced) }

This parameter restricts web 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 -sp-api-enabled true -sp-api-port 50001 -sp-api-limit-access true

cluster1::*>system service-processor api-service show
 Service Processor API service configuration
     SP API Enabled: true
        SP API Port: 50001
SP API Limit Access: true
        Web Enabled: true
   Web Limit Access: true
 Server Certificate: -internal-
 Client Certificate: -internal-
     CA Certificate: -internal-
cluster1::*>system service-processor api-service modify -sp-api-enabled false -sp-api-port 50001 -sp-api-limit-access true

cluster1::*>system service-processor api-service show
 Service Processor API service configuration
     SP API Enabled: false
        SP API Port: 50001
SP API Limit Access: true
        Web Enabled: true
   Web Limit Access: true
 Server Certificate: -internal-
 Client Certificate: -internal-
     CA Certificate: -internal-

The following example disables the SP Web service.

cluster1::*>system service-processor api-service modify -web-enabled false -web-limit-access true

cluster1::*>system service-processor api-service show
 Service Processor API service configuration
     SP API Enabled: false
        SP API Port: 50001
SP API Limit Access: true
        Web Enabled: false
   Web Limit Access: true
 Server Certificate: -internal-
 Client Certificate: -internal-
     CA Certificate: -internal-