Skip to main content
REST API reference

Retrieve the cluster network security configuration

Retrieves the cluster network security configuration to review the current security settings and ensure that your cluster's network communications are protected according to your organization's policies.

HTTP method and endpoint

GET /security/cluster-network

Introduced in

ONTAP 9.18

  • 'security cluster-network show'

Parameters

Name Type In Required Description

status

string

query

False

Filter by status

  • Introduced in: 9.19

ipsec_status

string

query

False

Filter by ipsec_status

  • Introduced in: 9.19

mode

string

query

False

Filter by mode

  • Introduced in: 9.19

enabled

boolean

query

False

Filter by enabled

  • Introduced in: 9.19

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

enabled

boolean

Indicates whether cluster network security is enabled.

ipsec_status

string

The IPsec status of the cluster network security configuration.

mode

string

The cluster network security mode.

  • tls: Protect cluster traffic using TLS.

  • tls_ipsec: CSM traffic uses TLS, all other cluster network traffic uses IPsec.

status

string

The certificate and TLS status of the cluster network security configuration.

Example response
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ipsec_status": "ENABLING | DISABLING | READY",
  "mode": "string",
  "status": "ENABLING | DISABLING | READY"
}

Error

Status: Default, Error
Name Type Description

error

returned_error

Example error
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

Name Type Description

self

href

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.