# kmip.update

Update KMIP Server Configuration.

The system authenticates to the remote KMIP server with a TLS handshake and synchronizes ZFS/SED keys between the local database and the server according to the configuration.

This method is a job.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: kmip_update

#### kmip_update

Type: object

KMIPUpdateArgs parameters.

No Additional Properties

##

#### Enabled

Type: boolean

Whether to enable KMIP functionality.

##

#### Manage Sed Disks

Type: boolean

Whether to use KMIP for managing SED (Self-Encrypting Drive) keys.

##

#### Manage Zfs Keys

Type: boolean

Whether to use KMIP for managing ZFS encryption keys.

##

#### Certificate

ID of the client certificate for KMIP authentication or `null`.

## Any of

Type: integer
Type: null

##

#### Certificate Authority

ID of the certificate authority for server verification or `null`.

## Any of

Type: integer
Type: null

##

#### Port

Type: integer

TCP port number for the KMIP server connection.

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

##

#### Server

Hostname or IP address of the KMIP server or `null` if not configured.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Ssl Version

Type: enum (of string)

SSL/TLS protocol version to use for KMIP connections.

##### Must be one of:

- "PROTOCOL_TLSv1"
- "PROTOCOL_TLSv1_1"
- "PROTOCOL_TLSv1_2"

##

#### Force Clear

Type: boolean

Whether to force clear existing keys when disabling KMIP.

##

#### Change Server

Type: boolean

Whether the KMIP server configuration is being changed.

##

#### Validate

Type: boolean

Whether to validate the KMIP server connection before saving.

##

#### KMIPEntry

Type: object

The updated KMIP configuration.

No Additional Properties

##

#### Id

Type: integer

Unique identifier for the KMIP configuration.

##

#### Enabled

Type: boolean

Whether KMIP (Key Management Interoperability Protocol) is enabled.

##

#### Manage Sed Disks

Type: boolean

Whether to use KMIP for managing SED (Self-Encrypting Drive) keys.

##

#### Manage Zfs Keys

Type: boolean

Whether to use KMIP for managing ZFS encryption keys.

##

#### Certificate

ID of the client certificate for KMIP authentication or `null`.

## Any of

Type: integer
Type: null

##

#### Certificate Authority

ID of the certificate authority for server verification or `null`.

## Any of

Type: integer
Type: null

##

#### Port

Type: integer

TCP port number for the KMIP server connection.

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

##

#### Server

Hostname or IP address of the KMIP server or `null` if not configured.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Ssl Version

Type: enum (of string)

SSL/TLS protocol version to use for KMIP connections.

##### Must be one of:

- "PROTOCOL_TLSv1"
- "PROTOCOL_TLSv1_1"
- "PROTOCOL_TLSv1_2"

Required roles: KMIP_WRITE