vm_encryption_kms

Creates, updates, deletes, gets or lists a vm_encryption_kms resource.

Overview

Name	vm_encryption_kms
Type	Resource
Id	ovh.dedicated_cloud.vm_encryption_kms

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
kms_id	integer	Id of the VM Encryption KMS (wire: kmsId)
description	string	Description of your option access network
ip	string (ipv4)	IP address of the remote service (example: 192.0.2.0)
kms_tcp_port	integer	VM Encryption KMS TCP port (wire: kmsTcpPort)
ssl_thumbprint	string	SSL thumbprint of the remote service (wire: sslThumbprint)
state	string	State of the option (creating, deleting, delivered, error, toCreate, toDelete, toUpdate, unknown, updating)

list

Virtual machine encryption KMS server

Name	Datatype	Description
kms_id	integer	Id of the VM Encryption KMS (wire: kmsId)
description	string	Description of your option access network
ip	string (ipv4)	IP address of the remote service (example: 192.0.2.0)
kms_tcp_port	integer	VM Encryption KMS TCP port (wire: kmsTcpPort)
ssl_thumbprint	string	SSL thumbprint of the remote service (wire: sslThumbprint)
state	string	State of the option (creating, deleting, delivered, error, toCreate, toDelete, toUpdate, unknown, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	kms_id, service_name		Get a KMS server. Returns the KMS server: IP address, TCP port, SSL thumbprint, description and state.
list	select	service_name	x_pagination_mode	List KMS servers
create	insert	service_name, ip, ssl_thumbprint		Create a KMS server. Registers a KMS server by IP address and SSL thumbprint. Returns a task to track progress.
delete	delete	kms_id, service_name		Delete a KMS server
change_properties	exec	kmsId, serviceName, sslThumbprint		Update a KMS server. Updates the SSL thumbprint or the description of the KMS server. Returns a task to track progress.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
kmsId	integer	Id of the VM Encryption KMS
kms_id	integer	Id of the VM Encryption KMS (wire: kmsId)
serviceName	string	Domain of the service
service_name	string	Domain of the service (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a KMS server. Returns the KMS server: IP address, TCP port, SSL thumbprint, description and state.

SELECT
kms_id,
description,
ip,
kms_tcp_port,
ssl_thumbprint,
state
FROM ovh.dedicated_cloud.vm_encryption_kms
WHERE kms_id = '{{ kms_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List KMS servers

SELECT
kms_id,
description,
ip,
kms_tcp_port,
ssl_thumbprint,
state
FROM ovh.dedicated_cloud.vm_encryption_kms
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a KMS server. Registers a KMS server by IP address and SSL thumbprint. Returns a task to track progress.

INSERT INTO ovh.dedicated_cloud.vm_encryption_kms (
description,
ip,
ssl_thumbprint,
service_name
)
SELECT 
'{{ description }}',
'{{ ip }}' /* required */,
'{{ ssl_thumbprint }}' /* required */,
'{{ service_name }}'
RETURNING
name,
datacenter_id,
filer_id,
host_id,
network_access_id,
order_id,
parent_task_id,
task_id,
user_id,
vlan_id,
created_by,
created_from,
description,
end_date,
execution_date,
last_modification_date,
maintenance_date_from,
maintenance_date_to,
network,
progress,
state,
type
;

Manifest

# Description fields are for documentation purposes
- name: vm_encryption_kms
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the vm_encryption_kms resource.
  - name: description
    value: "{{ description }}"
    description: |
      Description of your option access network
  - name: ip
    value: "{{ ip }}"
    description: |
      IP address of the remote service, e.g. 123.100.200.0
  - name: ssl_thumbprint
    value: "{{ ssl_thumbprint }}"
    description: |
      SSL thumbprint of the remote service, e.g. A7:61:68:...:61:91:2F

DELETE examples

delete

Delete a KMS server

DELETE FROM ovh.dedicated_cloud.vm_encryption_kms
WHERE kms_id = '{{ kms_id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_properties

Update a KMS server. Updates the SSL thumbprint or the description of the KMS server. Returns a task to track progress.

EXEC ovh.dedicated_cloud.vm_encryption_kms.change_properties 
@kmsId='{{ kmsId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"description": "{{ description }}", 
"sslThumbprint": "{{ sslThumbprint }}"
}'
;