Id

Type: integer

Unique identifier for the SSH service configuration.

Bindiface

Type: array of string

Array of network interface names to bind the SSH service to.

No Additional Items

Each item of this array must be:

Type: string

Tcpport

Type: integer

TCP port number for SSH connections.

Value must be greater or equal to 1 and lesser or equal to 65535

Password Login Groups

Type: array of string

Array of group names allowed to authenticate with passwords.

No Additional Items

Each item of this array must be:

Type: string

Passwordauth

Type: boolean

Whether password authentication is enabled.

Kerberosauth

Type: boolean

Whether Kerberos authentication is enabled.

Tcpfwd

Type: boolean

Whether TCP forwarding is enabled.

Compression

Type: boolean

Whether compression is enabled for SSH connections.

Sftp Log Level

Type: enum (of string)

Logging level for SFTP subsystem (empty string means default).

Must be one of:

""
"QUIET"
"FATAL"
"ERROR"
"INFO"
"VERBOSE"
"DEBUG"
"DEBUG2"
"DEBUG3"

Sftp Log Facility

Type: enum (of string)

Syslog facility for SFTP logging (empty string means default).

Must be one of:

""
"DAEMON"
"USER"
"AUTH"
"LOCAL0"
"LOCAL1"
"LOCAL2"
"LOCAL3"
"LOCAL4"
"LOCAL5"
"LOCAL6"
"LOCAL7"

Weak Ciphers

Type: array of enum (of string)

Array of weak ciphers to enable for compatibility with legacy clients.

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

"AES128-CBC"
"NONE"

Options

Type: string

Additional SSH daemon configuration options.

Only a user with the FULL_ADMIN role may set or change this field.

Must be at most 2147483647 characters long

Privatekey

Type: string

SSH host private key data.

Must be at most 2147483647 characters long

Host Dsa Key

DSA host private key. null if not configured.

Type: string

Must be at most 2147483647 characters long

Type: null

Host Dsa Key Pub

DSA host public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Dsa Key Cert Pub

DSA host certificate public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Ecdsa Key

ECDSA host private key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Ecdsa Key Pub

ECDSA host public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Ecdsa Key Cert Pub

ECDSA host certificate public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Ed25519 Key

Ed25519 host private key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Ed25519 Key Pub

Ed25519 host public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Ed25519 Key Cert Pub

Ed25519 host certificate public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Key

Legacy SSH host private key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Key Pub

Legacy SSH host public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Rsa Key

RSA host private key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Rsa Key Pub

RSA host public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Host Rsa Key Cert Pub

RSA host certificate public key. null if not configured.

Any of

Option 1
Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

Call parameters

Return value

SSHEntry

id Required

Id

bindiface Required

Bindiface

Each item of this array must be:

tcpport Required

Tcpport

password_login_groups Required

Password Login Groups

Each item of this array must be:

passwordauth Required

Passwordauth

kerberosauth Required

Kerberosauth

tcpfwd Required

Tcpfwd

compression Required

Compression

sftp_log_level Required

Sftp Log Level

Must be one of:

sftp_log_facility Required

Sftp Log Facility

Must be one of:

weak_ciphers Required

Weak Ciphers

Each item of this array must be:

Must be one of:

options Required

Options

privatekey Required

Privatekey

host_dsa_key Required

Host Dsa Key

Any of

host_dsa_key_pub Required

Host Dsa Key Pub

Any of

host_dsa_key_cert_pub Required

Host Dsa Key Cert Pub

Any of

host_ecdsa_key Required

Host Ecdsa Key

Any of

host_ecdsa_key_pub Required

Host Ecdsa Key Pub

Any of

host_ecdsa_key_cert_pub Required

Host Ecdsa Key Cert Pub

Any of

host_ed25519_key Required

Host Ed25519 Key

Any of

host_ed25519_key_pub Required

Host Ed25519 Key Pub

Any of

host_ed25519_key_cert_pub Required

Host Ed25519 Key Cert Pub

Any of

host_key Required

Host Key

Any of

host_key_pub Required

Host Key Pub

Any of

host_rsa_key Required

Host Rsa Key

Any of

host_rsa_key_pub Required

Host Rsa Key Pub

Any of

host_rsa_key_cert_pub Required

Host Rsa Key Cert Pub

Any of