# ssh.update

Update settings of SSH daemon service.

If bindiface is empty it will listen for all available addresses.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Type: object

Updated SSH service configuration.

No Additional Properties

##

#### 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.

##

#### SSHEntry

Type: object

The updated SSH service configuration.

No Additional Properties

##

#### 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.

##

#### Privatekey

Type: string

SSH host private key data.

##

#### Host Dsa Key

DSA host private key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Dsa Key Pub

DSA host public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Dsa Key Cert Pub

DSA host certificate public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Ecdsa Key

ECDSA host private key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Ecdsa Key Pub

ECDSA host public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Ecdsa Key Cert Pub

ECDSA host certificate public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Ed25519 Key

Ed25519 host private key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Ed25519 Key Pub

Ed25519 host public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Ed25519 Key Cert Pub

Ed25519 host certificate public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Key

Legacy SSH host private key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Key Pub

Legacy SSH host public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Rsa Key

RSA host private key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Rsa Key Pub

RSA host public key. `null` if not configured.

## Any of

Type: string
Type: null

##

#### Host Rsa Key Cert Pub

RSA host certificate public key. `null` if not configured.

## Any of

Type: string
Type: null

Required roles: SSH_WRITE