os_keypair – Add/Delete a keypair from OpenStack

From Get docs
Ansible/docs/2.7/modules/os keypair module


os_keypair – Add/Delete a keypair from OpenStack

New in version 2.0.


Synopsis

  • Add or Remove key pair from OpenStack

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • openstacksdk

Parameters

Parameter Choices/Defaults Comments

api_timeout

-

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.

auth

-

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.

auth_type

-

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.

availability_zone

-

Ignored. Present for backwards compatibility

cacert

-

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

cert

-

A path to a client certificate to use as part of the SSL transaction.

cloud

-

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.

interface

-

added in 2.3

  • public

  • internal
  • admin

Endpoint URL type to fetch from the service catalog.


aliases: endpoint_type

key

-

A path to a client key to use as part of the SSL transaction.

name

- / required

Name that has to be given to the key pair

public_key

-

The public key that would be uploaded to nova and injected into VMs upon creation.

public_key_file

-

Path to local file containing ssh public key. Mutually exclusive with public_key.

region_name

-

Name of the region.

state

-

  • present

  • absent

Should the resource be present or absent.

timeout

-

Default:

180

How long should ansible wait for the requested resource.

verify

boolean

  • no
  • yes

Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.


aliases: validate_certs

wait

boolean

  • no
  • yes

Should ansible wait until the requested resource is complete.



Notes

Note

  • 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 http://docs.openstack.org/developer/os-client-config


Examples

# 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/id_rsa.pub

# 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, the following are the fields unique to this module:

Key Returned Description

id

string

success

Unique UUID.


name

string

success

Name given to the keypair.


private_key

string

Only when a keypair is generated for the user (e.g., when creating one and a public key is not specified).

The private key value for the keypair.


public_key

string

success

The public key value for the keypair.





Status

Authors

  • Benno Joy (@bennojoy)

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/os_keypair_module.html