Docs4dev
Docs
ansible / 2.10 / collections / community / general / scaleway_sshkey_module.html

community.general.scaleway_sshkey – Scaleway SSH keys management module

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.scaleway_sshkey.

Synopsis

Parameters

Parameter Choices/Defaults Comments
api_timeout
integer
Default:
30
HTTP timeout to Scaleway API in seconds.

aliases: timeout
api_token
string / required
Scaleway OAuth token.

aliases: oauth_token
api_url
string
Default:
"https://account.scaleway.com"
Scaleway API URL

aliases: base_url
query_parameters
dictionary
Default:
{}
List of parameters passed to the query string.
ssh_pub_key
string / required
The public SSH key as a string to add.
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the SSH key.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Scaleway API.

Notes

Note

  • Also see the API documentation on https://developer.scaleway.com/
  • If api_token is not set within the module, the following environment variables can be used in decreasing order of precedence SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN or SCW_API_TOKEN.
  • If one wants to use a different api_url one can also set the SCW_API_URL environment variable.

Examples

- name: "Add SSH key"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"

- name: "Delete SSH key"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "absent"

- name: "Add SSH key with explicit token"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"
    oauth_token: "6ecd2c9b-6f4f-44d4-a187-61a92078d08c"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data
dictionary
when state=present
This is only present when state=present

Sample:
{'ssh_public_keys': [{'key': 'ssh-rsa AAAA....'}]}


Authors

  • Remy Leone (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/scaleway_sshkey_module.html