os_keystone_service - Manage OpenStack Identity services

New in version 2.2.

Synopsis

  • Create, update, or delete OpenStack Identity service. If a service with the supplied name already exists, it will be updated with the new description and enabled attributes.

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade

Options

parameter required default choices comments
api_timeout
 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.
auth
 no
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
 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.
availability_zone
 no
Ignored. Present for backwards compatibility
cacert
 no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
 no None
A path to a client certificate to use as part of the SSL transaction.
cloud
 no
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.
description
 no None
Description of the service
enabled
 no True
Is the service enabled
endpoint_type
 no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
key
 no None
A path to a client key to use as part of the SSL transaction.
name
 yes
Name of the service
region_name
 no
Name of the region.
service_type
 yes
The type of service
state
 no present
  • present
  • absent
Should the resource be present or absent.
timeout
 no 180
How long should ansible wait for the requested resource.
validate_certs
 no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: verify
wait
 no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.

Examples

# Create a service for glance
- os_keystone_service:
     cloud: mycloud
     state: present
     name: glance
     service_type: image
     description: OpenStack Image Service
# Delete a service
- os_keystone_service:
     cloud: mycloud
     state: absent
     name: glance
     service_type: image

Return Values

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

name description returned type sample
id
The service ID.
 On success when I(state) is 'present' string 3292f020780b4d5baf27ff7e1d224c44
service
Dictionary describing the service.
 On success when I(state) is 'present' complex
contains:
name description returned type sample
service_type
Service type.
 string image
enabled
Service status.
 boolean True
description
Service description.
 string OpenStack Image Service
name
Service name.
 string glance
id
Service ID.
 string 3292f020780b4d5baf27ff7e1d224c44

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

Status

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

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_keystone_service_module.html