scaleway_sshkey - Scaleway SSH keys management module
New in version 2.6.
Synopsis
- This module manages SSH keys on Scaleway account https://developer.scaleway.com
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| base_url | Default:
"https://account.scaleway.com"
|
Base URL for account API
|
| oauth_token
required
|
Scaleway OAuth token.
|
|
| ssh_pub_key
required
|
The public SSH key as a string to add.
|
|
| state
required
|
|
Indicate desired state of the SSH key.
|
| timeout | Default:
30
|
Timeout for API calls
|
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
dict
|
when state=present |
This is only present when state=present
Sample:
{'ssh_public_keys': [{'key': 'ssh-rsa AAAA....'}]}
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- 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.6/modules/scaleway_sshkey_module.html