openstack.cloud.keypair module – Add/Delete a keypair from OpenStack
Note
This module is part of the openstack.cloud collection (version 2.2.0).
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 openstack.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.keypair
.
Synopsis
Add or Remove key pair from OpenStack
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name that has to be given to the key pair |
|
The public key that would be uploaded to nova and injected into VMs upon creation. |
|
Path to local file containing ssh public key. Mutually exclusive with public_key. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Should the resource be present or absent. If state is replace and the key exists but has different content, delete it and recreate it with the new content. Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAME
may be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
# Creates a key pair with the running users public key
- openstack.cloud.keypair:
cloud: mordred
state: present
name: ansible_key
public_key_file: /home/me/.ssh/id_rsa.pub
# Creates a new key pair and the private key returned after the run.
- openstack.cloud.keypair:
cloud: rax-dfw
state: present
name: ansible_key
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the keypair. Returned: On success when state is ‘present’ |
|
Date the keypair was created Returned: success |
|
The short fingerprint associated with the public_key for this keypair. Returned: success |
|
Unique UUID. Returned: success |
|
Whether the keypair is deleted or not Returned: success |
|
Name given to the keypair. Returned: success |
|
The private key value for the keypair. Returned: Only when a keypair is generated for the user (e.g., when creating one and a public key is not specified). |
|
The public key value for the keypair. Returned: success |
|
The type of keypair Returned: success |
|
The user id for a keypair Returned: success |