ssh_key.md

ssh_key

Manage a Linode SSH key.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- name: Create a basic SSH key
  linode.cloud.ssh_key:
    label: my-ssh-key
    state: present

- name: Delete a SSH key
  linode.cloud.ssh_key:
    label: my-ssh-key
    state: absent

Parameters

Field	Type	Required	Description
label	str	Required	This SSH key's unique label.
state	str	Required	The state of this SSH key. (Choices: present, absent)
ssh_key	str	Optional	The SSH public key value. (Updatable)

Return Values

• ssh_key - The created SSH key in JSON serialized form.

  • Sample Response:

    {
      "created": "2018-01-01T00:01:01",
      "id": 42,
      "label": "My SSH Key",
      "ssh_key": "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"
    }

  • See the Linode API response documentation for a list of returned fields