Retrieve the SSH server configuration for all SVMs
Retrieves the SSH server configuration for all storage virtual machines (SVMs) to review or manage SSH settings across your environment.
HTTP method and endpoint
GET /security/ssh/svms
Introduced in
ONTAP 9.10
Usage notes
Retrieves the SSH server configuration for all the SVMs.
Related ONTAP commands
-
security ssh
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
mac_algorithms |
string |
query |
False |
Filter by mac_algorithms |
max_authentication_retry_count |
integer |
query |
False |
Filter by max_authentication_retry_count
|
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
key_exchange_algorithms |
string |
query |
False |
Filter by key_exchange_algorithms |
ciphers |
string |
query |
False |
Filter by ciphers |
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[svm_ssh_server] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ciphers": [
"aes256_ctr",
"aes192_ctr",
"aes128_ctr"
],
"key_exchange_algorithms": [
"diffie_hellman_group_exchange_sha256",
"diffie_hellman_group14_sha1"
],
"mac_algorithms": [
"hmac_sha1",
"hmac_sha2_512_etm"
],
"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 |
svm
SVM name and UUID for which the SSH server is configured.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
svm_ssh_server
| Name | Type | Description |
|---|---|---|
_links |
||
ciphers |
array[string] |
Ciphers for encrypting the data. |
key_exchange_algorithms |
array[string] |
Key exchange algorithms. |
mac_algorithms |
array[string] |
MAC algorithms. |
max_authentication_retry_count |
integer |
Maximum authentication retries allowed before closing the connection. |
svm |
SVM name and UUID for which the SSH server is configured. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
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. |