sshkeys

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

Overview

Name	sshkeys
Type	Resource
Id	ovh.cloud.sshkeys

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	SSH key id
name	string	SSH key name
finger_print	string	SSH key fingerprint (wire: fingerPrint)
public_key	string	SSH public key (wire: publicKey)
regions	array	SSH key regions

list

SshKey

Name	Datatype	Description
id	string	SSH key id
name	string	SSH key name
public_key	string	SSH public key (wire: publicKey)
regions	array	SSH key regions

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	key_id, service_name		Get SSH key
list	select	service_name	region	Get SSH keys
create	insert	service_name, name, public_key		Create SSH key
delete	delete	key_id, service_name		Delete SSH key

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"}})
key_id	string	Key ID (wire: keyId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
region	string	Region

SELECT examples

get

Get SSH key

SELECT
id,
name,
finger_print,
public_key,
regions
FROM ovh.cloud.sshkeys
WHERE key_id = '{{ key_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Get SSH keys

SELECT
id,
name,
public_key,
regions
FROM ovh.cloud.sshkeys
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND region = '{{ region }}'
;

INSERT examples

create

Create SSH key

INSERT INTO ovh.cloud.sshkeys (
name,
public_key,
region,
service_name
)
SELECT 
'{{ name }}' /* required */,
'{{ public_key }}' /* required */,
'{{ region }}',
'{{ service_name }}'
RETURNING
id,
name,
finger_print,
public_key,
regions
;

Manifest

# Description fields are for documentation purposes
- name: sshkeys
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the sshkeys resource.
  - name: name
    value: "{{ name }}"
    description: |
      SSH key name
  - name: public_key
    value: "{{ public_key }}"
    description: |
      SSH public key
  - name: region
    value: "{{ region }}"
    description: |
      Region to create SSH key

DELETE examples

delete

Delete SSH key

DELETE FROM ovh.cloud.sshkeys
WHERE key_id = '{{ key_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;