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
Related ONTAP commands
-
'security cluster-network show'
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
status |
string |
query |
False |
Filter by status
|
ipsec_status |
string |
query |
False |
Filter by ipsec_status
|
mode |
string |
query |
False |
Filter by mode
|
enabled |
boolean |
query |
False |
Filter by enabled
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
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.
|
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 |
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 |
self_link
| Name | Type | Description |
|---|---|---|
self |
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. |