PATCH /api/lunasa/ssh

This resource updates SSH server configuration.

User Privileges

Users with the following role privileges can perform this command:

admin
operator

Parameters

cipherList

cipherList is the cipher suite the SSH service is to accept for the shell sessions being requested.

Note:

REST API accepts colon separated cipher list.

Allowed SSH cipher suites are :

3des-cbc: blowfish-cbc: cast128-cbc: arcfour: arcfour128: arcfour256: aes128-cbc: aes192-cbc: aes256-cbc: rijndael-cbc@lysator.liu.se: aes128-ctr: aes192-ctr: aes256-ctr: aes128-gcm@openssh.com: aes256-gcm@openssh.com: chacha20-poly1305@openssh.com

Use: Not Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 1024
   pattern: [a-zA-Z0-9.:@-]

isPasswordAuthenticationEnabled

This parameter enables password authentication.

Use: Not Required

JSON Schema:

    Object
    type:boolean

isKeyAuthenticationEnabled

This parameter enables public key authentication.

Use: Not Required

JSON Schema:

    Object
    type:boolean

port

This parameter specifies the SSH server port.

Note:

Allowed port values are :

22
1024-65535

Use: Not Required

JSON Schema:

    Object
    type:integer

networkDevices

This parameter specifies the list of network devices to use for the SSH server.
Valid values: eth0,eth1,eth2,eth3,bond0,bond1,all.

Use: Not Required

JSON Schema:

    Object
    type: array
        networkDevice: Object
            type: string

Responses

204

Success

400

SSH_FAILED_TO_SET_CIPHERS

Unable to set/update the provided ciphers.

400

SSH_OPERATION_FAILED

Unable to perform operation.

Example Request

    PATCH
    https://1.2.3.4:8443/api/lunasa/ssh
    {
        "port": 22
    }

Example Response

{}