Skip to main content
A newer release of this product is available.

Update a primary key server

Contributors
PDFs

PATCH /security/key-managers/{uuid}/key-servers/{server}

Introduced In: 9.6

Updates a primary key server.

  • security key-manager external modify-server

Parameters

Name Type In Required Description

uuid

string

path

True

External key manager UUID

server

string

path

True

Primary key server configured in the external key manager.

Request Body

Name Type Description

_links

_links

password

string

Password credentials for connecting with the key server. This is not audited.

records

array[records]

An array of key servers specified to add multiple key servers to a key manager in a single API call. Valid in POST only and not valid if server is provided.

secondary_key_servers

array[string]

A list of the secondary key servers associated with the primary key server.

server

string

External key server for key management. If no port is provided, a default port of 5696 is used. Not valid in POST if records is provided.

timeout

integer

I/O timeout in seconds for communicating with the key server.

username

string

KMIP username credentials for connecting with the key server.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "password": "password",
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "password": "password",
      "server": "bulkkeyserver.com:5698",
      "timeout": 60,
      "username": "username"
    }
  ],
  "secondary_key_servers": [
    "secondary1.com",
    "10.1.2.3"
  ],
  "server": "keyserver1.com:5698",
  "timeout": 60,
  "username": "username"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65536600

Cannot modify a key server while a node is out quorum.

65536822

Multitenant key management is not supported in the current cluster version.

65536824

Multitenant key management is not supported in MetroCluster configurations.

65536828

External key management is not enabled for the SVM.

65536843

The key management server is not configured for the SVM.

65536845

Missing username.

65536846

Missing password.

65537400

Exceeded maximum number of secondary key servers.

65538407

A secondary key server is a duplicate of the associated primary key server.

65538408

The list of secondary key servers contains duplicates.

65538413

A secondary key server address is not formatted correctly.

65538502

A secondary key server is also a primary key server.

65538503

Support for adding secondary key servers requires an ECV of ONTAP 9.11.1 or later.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

records

Name Type Description

_links

_links

password

string

Password credentials for connecting with the key server. This is not audited.

server

string

External key server for key management. If no port is provided, a default port of 5696 is used. Not valid in POST if records is provided.

timeout

integer

I/O timeout in seconds for communicating with the key server.

username

string

KMIP username credentials for connecting with the key server.

key_server

Name Type Description

_links

_links

password

string

Password credentials for connecting with the key server. This is not audited.

records

array[records]

An array of key servers specified to add multiple key servers to a key manager in a single API call. Valid in POST only and not valid if server is provided.

secondary_key_servers

array[string]

A list of the secondary key servers associated with the primary key server.

server

string

External key server for key management. If no port is provided, a default port of 5696 is used. Not valid in POST if records is provided.

timeout

integer

I/O timeout in seconds for communicating with the key server.

username

string

KMIP username credentials for connecting with the key server.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.