You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.scaleway_sshkey module – Scaleway SSH keys management module

Note

This module is part of the community.general collection (version 7.5.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis 

This module manages SSH keys on Scaleway account https://developer.scaleway.com.

Aliases: cloud.scaleway.scaleway_sshkey

Parameters 

Parameter	Comments
api_timeout aliases: timeout integer	HTTP timeout to Scaleway API in seconds. Default: `30`
api_token aliases: oauth_token string / required	Scaleway OAuth token.
api_url aliases: base_url string	Scaleway API URL. Default: `"https://account.scaleway.com"`
query_parameters dictionary	List of parameters passed to the query string. Default: `{}`
ssh_pub_key string / required	The public SSH key as a string to add.
state string	Indicate desired state of the SSH key. Choices: `"present"` ← (default) `"absent"`
validate_certs boolean	Validate SSL certs of the Scaleway API. Choices: `false` `true` ← (default)

Attributes 

Attribute	Support	Description
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

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	Description
data dictionary	This is only present when `state=present`. Returned: when `state=present` Sample: `{"ssh_public_keys": [{"key": "ssh-rsa AAAA...."}]}`

Authors

Remy Leone (@remyleone)

community.general.scaleway_sshkey module – Scaleway SSH keys management module

Synopsis

Parameters

Attributes

Notes

Examples

Return Values