Enable KMIP Server

Request

Method

URI

PATCH

v5/system_settings/kmipsrv_info

Content Type

application/json

Privileges Required

SEC_ADMIN.

Parameters

Name

Type

Example

host

string

10.238.66.235

KMIP Server IP address.

loglevel

string

"All"

The log level to use for the KMIP server.

Allowable values: ALL, CREATE-GET, OFF

nbio

string

"0"

Whether the KMIP server requires non-blocking I/O.

Allowable values: 0 (not required), 1 (required)

port

string

5696

The KMIP server port.

protocol

string

"0x1"

Allowable values:

"0x1" - KMIP version 1.

"0x200" - KMIP version 1.1

"0x10000" - KMIP version 1.2

"0x40000" - KMIP version 1.3

"0x800000" - KMIP version 1.4

reconnect

string

"0"

Allowable values: 0 (disables automatic reconnection), 1 (enables automatic reconnection)

restrict_tls

string

true

If this option is set to true, clients must connect to this server using TLS 1.2 The default is false.

Allowable values: true, false

state

string

"ENABLED"

Allowable values: ENABLED, DISABLED

timeout

string

"0"

The length of time, in seconds, after which a client request will time out. Specify 0 to indicate that requests should never time out.

verify

string

"yes"

Whether the KMIP client identity is verified before the server handles its request. We recommend that you always set this option to "yes".

Allowable values: yes, no

Response

Name

Type

Example

result

string

success

Errors

Reason

Example

Invalid protocol

protocol myst be a known value or custom hex

Invalid Log Level

Invalid args - loglevel %s

Invalid nbio

Invalid args - nbio %s

Invalid verify

Invalid args - nbio %s