os_keystone_endpoint – Manage OpenStack Identity service endpoints

From Get docs
Ansible/docs/2.8/modules/os keystone endpoint module


os_keystone_endpoint – Manage OpenStack Identity service endpoints

New in version 2.5.


Synopsis

  • Create, update, or delete OpenStack Identity service endpoints. If a service with the same combination of service, interface and region exist, the url and state (present or absent) will be updated.

Requirements

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

  • openstacksdk
  • openstacksdk >= 0.13.0
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments

api_timeout

integer

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

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, os_user_domain_name or os_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.

auth_type

string

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.

ca_cert

string

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


aliases: cacert

client_cert

string

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


aliases: cert

client_key

string

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


aliases: key

cloud

raw

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.

enabled

boolean

  • no
  • yes

Is the service enabled.

interface

string / required

added in 2.3

  • admin
  • public

  • internal

Interface of the service.


aliases: endpoint_type

region

-

Region that the service belongs to. Note that region_name is used for authentication.

region_name

string

Name of the region.

service

- / required

Name or id of the service.

state

-

  • present

  • absent

Should the resource be present or absent.

timeout

integer

Default:

180

How long should ansible wait for the requested resource.

url

- / required

URL of the service.

validate_certs

boolean

  • no

  • yes

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.


aliases: verify

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 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

- name: Create a service for glance
  os_keystone_endpoint:
     cloud: mycloud
     service: glance
     endpoint_interface: public
     url: http://controller:9292
     region: RegionOne
     state: present

- name: Delete a service for nova
  os_keystone_endpoint:
     cloud: mycloud
     service: nova
     endpoint_interface: public
     region: RegionOne
     state: absent

Return Values

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

Key Returned Description

endpoint

complex

On success when state is present

Dictionary describing the endpoint.


enabled

boolean

Service status.


Sample:

True

id

string

Endpoint ID.


Sample:

3292f020780b4d5baf27ff7e1d224c44

interface

string

Endpoint Interface.


Sample:

public

region

string

Region Name.


Sample:

RegionOne

service_id

string

Service ID.


Sample:

b91f1318f735494a825a55388ee118f3

url

string

Service URL.


Sample:




Status

Authors

  • Mohammed Naser (@mnaser)
  • Alberto Murillo (@albertomurillo)

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.8/modules/os_keystone_endpoint_module.html