ansible / ansible.builtin / v2.9.18 / module / vultr_ssh_key Manages ssh keys on Vultr. | "added in version" 2.5 of ansible.builtin" Authors: René Moser (@resmo) preview | supported by communityansible.builtin.vultr_ssh_key (v2.9.18) — module
pip
Install with pip install ansible==2.9.18
Create, update and remove ssh keys.
- name: ensure an SSH key is present vultr_ssh_key: name: my ssh key ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent vultr_ssh_key: name: my ssh key state: absent
name: description: - Name of the ssh key. required: true type: str state: choices: - present - absent default: present description: - State of the ssh key. type: str api_key: description: - API key of the Vultr API. - The ENV variable C(VULTR_API_KEY) is used as default, when defined. type: str ssh_key: description: - SSH public key. - Required if C(state=present). type: str api_account: default: default description: - Name of the ini section in the C(vultr.ini) file. - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. type: str api_retries: description: - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - Fallback value is 5 retries if not specified. type: int api_timeout: description: - HTTP timeout to Vultr API. - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - Fallback value is 60 seconds if not specified. type: int api_endpoint: description: - URL to API endpint (without trailing slash). - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - Fallback value is U(https://api.vultr.com) if not specified. type: str validate_certs: default: true description: - Validate SSL certs of the Vultr API. type: bool api_retry_max_delay: description: - Retry backoff delay in seconds is exponential up to this max. value, in seconds. - The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined. - Fallback value is 12 seconds. type: int
vultr_api: contains: api_account: description: Account used in the ini file to select the key returned: success sample: default type: str api_endpoint: description: Endpoint used for the API requests returned: success sample: https://api.vultr.com type: str api_retries: description: Amount of max retries for the API requests returned: success sample: 5 type: int api_retry_max_delay: description: Exponential backoff delay in seconds between retries up to this max delay value. returned: success sample: 12 type: int version_added: '2.9' version_added_collection: ansible.builtin api_timeout: description: Timeout used for the API requests returned: success sample: 60 type: int description: Response from Vultr API with a few additions/modification returned: success type: complex vultr_ssh_key: contains: date_created: description: Date the ssh key was created returned: success sample: '2017-08-26 12:47:48' type: str id: description: ID of the ssh key returned: success sample: 5904bc6ed9234 type: str name: description: Name of the ssh key returned: success sample: my ssh key type: str ssh_key: description: SSH public key returned: success sample: ssh-rsa AA... someother@example.com type: str description: Response from Vultr API returned: success type: complex