os_keypair - Add/Delete a keypair from OpenStack

New in version 2.0.


  • Add or Remove key pair from OpenStack


parameter required default choices comments
no None
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 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.
no password
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.
Ignored. Present for backwards compatability
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
no None
A path to a client certificate to use as part of the SSL transaction.
Named cloud to operate against. 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.
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
no None
A path to a client key to use as part of the SSL transaction.
yes None
Name that has to be given to the key pair
no None
The public key that would be uploaded to nova and injected into VMs upon creation.
no None
Path to local file containing ssh public key. Mutually exclusive with public_key.
Name of the region.
no present
  • present
  • absent
Should the resource be present or absent.
no 180
How long should ansible wait for the requested resource.
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.


# Creates a key pair with the running users public key
- os_keypair:
      cloud: mordred
      state: present
      name: ansible_key
      public_key_file: /home/me/.ssh/

# Creates a new key pair and the private key returned after the run.
- os_keypair:
      cloud: rax-dfw
      state: present
      name: ansible_key

Return Values

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

name description returned type sample
public_key The public key value for the keypair. success string
private_key The private key value for the keypair. Only when a keypair is generated for the user (e.g., when creating one and a public key is not specified). string
id Unique UUID. success string
name Name given to the keypair. success string



  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, 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


This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.


This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.