Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.15 KB

ssh_key_info.md

File metadata and controls

52 lines (38 loc) · 2.15 KB

ssh_key_info

Get info about a Linode SSH Key.

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: Get info about a SSH key by label
  linode.cloud.ssh_key_info:
    label: my-ssh-key
- name: Get info about a SSH key by ID
  linode.cloud.ssh_key_info:
    id: 12345

Parameters

Field Type Required Description
id int Optional The ID of the SSH Key to resolve. (Conflicts With: label)
label str Optional The label of the SSH Key to resolve. (Conflicts With: id)

Return Values

  • ssh_key - The returned SSH Key.

    • 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