scaleway_sshkey – Scaleway SSH keys management module

From Get docs
Ansible/docs/2.7/modules/scaleway sshkey module


scaleway_sshkey – Scaleway SSH keys management module

New in version 2.6.


Synopsis

Parameters

Parameter Choices/Defaults Comments

api_timeout

-

Default:

30

HTTP timeout to Scaleway API in seconds.


aliases: timeout

api_token

-

Scaleway OAuth token.


aliases: oauth_token

api_url

-

Default:

Scaleway API URL


aliases: base_url

ssh_pub_key

- / required

The public SSH key as a string to add.

state

-

  • present

  • absent

Indicate desired state of the SSH key.

validate_certs

boolean

  • 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"
  scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "Present"

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

- name: "Add SSH key with explicit token"
  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....'}]}




Status

Authors

  • Remy Leone (@sieben)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


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