Retrieve IPsec CA certificates configured for the cluster and all SVMs
Accesses the collection of IPsec CA certificates configured for the cluster and all SVMs. This helps you manage and verify the security certificates used for IPsec communications within your network.
HTTP method and endpoint
GET /security/ipsec/ca-certificates
Introduced in
ONTAP 9.10
Usage notes
Retrieves the collection of IPsec CA certificates configured for cluster and all SVMs.
Related ONTAP commands
-
security ipsec ca-certificate show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
certificate.uuid |
string |
query |
False |
Filter by certificate.uuid |
scope |
string |
query |
False |
Filter by scope |
svm.name |
string |
query |
False |
Filter by svm.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[ipsec_ca_certificate] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"certificate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"scope": "string",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
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 |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
certificate
IPsec CA certificate UUID
| Name | Type | Description |
|---|---|---|
_links |
||
uuid |
string |
Certificate UUID |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
ipsec_ca_certificate
| Name | Type | Description |
|---|---|---|
certificate |
IPsec CA certificate UUID |
|
scope |
string |
Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster". |
svm |
SVM, applies only to SVM-scoped objects. |
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. |