Retrieve the SSH server configuration for an SVM
Retrieves the SSH server configuration for a specific data SVM to review or manage its settings.
HTTP method and endpoint
GET /security/ssh/svms/{svm.uuid}
Introduced in
ONTAP 9.10
Usage notes
Retrieves the SSH server configuration for the specified data SVM.
Related ONTAP commands
-
security ssh
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
svm.uuid |
string |
path |
True |
SVM UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
ciphers |
array[string] |
Ciphers for encrypting the data. |
host_key_algorithms |
array[string] |
Host key algorithms. The host key algorithms 'ssh_ed25519' and 'ssh_rsa' can be configured only in non-FIPS mode. |
is_rsa_in_publickey_algorithms_enabled |
boolean |
Enables or disables the ssh-rsa signature scheme, which uses the SHA-1 hash algorithm, for RSA keys in public key algorithms. If this flag is false, older SSH implementations might fail to authenticate using RSA keys. This flag should be enabled only as a temporary measure until legacy SSH client implementations can be upgraded or reconfigured with another key type, for example: ECDSA. |
key_exchange_algorithms |
array[string] |
Key exchange algorithms. |
login_grace_time |
integer |
The login grace time allowed for SSH connection request timeout. |
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. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ciphers": [
"aes256_ctr",
"aes192_ctr",
"aes128_ctr"
],
"host_key_algorithms": [
"ecdsa_sha2_nistp256",
"ssh_ed25519",
"ssh_rsa",
"rsa_sha2_256",
"rsa_sha2_512"
],
"key_exchange_algorithms": [
"diffie_hellman_group_exchange_sha256",
"ecdh_sha2_nistp256"
],
"mac_algorithms": [
"hmac_sha2_512",
"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 |
|---|---|---|
self |
svm
SVM name and UUID for which the SSH server is configured.
| 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. |
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. |