Skip to main content
REST API reference

Update the cluster network security configuration

PATCH /security/cluster-network

Introduced In: 9.18

Updates the cluster network security configuration.

Optional properties

  • 'enabled' - Indicates whether cluster network security is enabled.

  • 'mode' - The cluster network security mode.

  • 'security cluster-network modify'

Request Body

Name Type Description

enabled

boolean

Indicates whether cluster network security is enabled.

mode

string

The cluster network security mode.

status

string

The status of the cluster network security configuration.

Example request
{
  "mode": "string",
  "status": "ENABLING | DISABLING | READY"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

70320128

Modifying the cluster network security configuration requires an effective cluster version of ONTAP 9.18.1 or later.

70320131

Cluster network security does not support MetroCluster configurations.

70320132

The cluster has an out of quorum node, wait until all nodes are in quorum before modifying the cluster network security configuration.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

security_cluster_network

Manages the cluster network security configuration.

Name Type Description

enabled

boolean

Indicates whether cluster network security is enabled.

mode

string

The cluster network security mode.

status

string

The status of the cluster network security configuration.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.