Skip to main content
REST API reference

Update the HA network security configuration

PDFs

PATCH /security/ha-network

Introduced In: 9.18

Updates the HA network security configuration.

Optional properties

  • 'enabled' - Indicates if HA network security for NVLog traffic is enabled.

  • 'security ha-network modify'

Parameters

Name Type In Required Description

enabled

boolean

query

False

Specifies if HA network security is enabled.

Request Body

Name Type Description

enabled

boolean

Indicates if HA network security is enabled.

node.name

node.name

Node name
Example request 
{
  "node.name": {
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

70385664

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

70385666

Failed to get node information for node "\".

70385667

Failed to enable encryption on node "\".

70385671

Failed to disable encryption on node "\".

70385673

HA network security does not support MetroCluster configurations.

70385677

Failed to modify HA network security because the "enabled" field was not specified.

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

_links

node.name

Node name

Name Type Description

name

string

uuid

string

security_ha_network

Manages the HA network security configuration.

Name Type Description

enabled

boolean

Indicates if HA network security is enabled.

node.name

node.name

Node name

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.