os_group – Manage OpenStack Identity Groups

New in version 2.1.

Synopsis

  • Manage OpenStack Identity Groups. Groups can be created, deleted or updated. Only the description value can be updated.

Requirements

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

  • openstacksdk
  • python >= 2.7

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.
description
-
Group description
domain_id
-
added in 2.3
Domain id to create the group in if the cloud supports domains.
interface
-
added in 2.3
    Choices:
  • 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
Group name
region_name
-
Name of the region.
state
-
    Choices:
  • present ←
  • absent
Should the resource be present or absent.
timeout
-
Default:
180
How long should ansible wait for the requested resource.
verify
boolean
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
boolean
    Choices:
  • 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

# Create a group named "demo"
- os_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Demo Group"
    domain_id: demoid

# Update the description on existing "demo" group
- os_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Something else"
    domain_id: demoid

# Delete group named "demo"
- os_group:
    cloud: mycloud
    state: absent
    name: demo

Return Values

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

Key Returned Description
group
complex
 On success when state is 'present'.
Dictionary describing the group.
  description
string
Group description

Sample:
Demo Group
  domain_id
string
Domain for the group

Sample:
default
  id
string
Unique group ID

Sample:
ee6156ff04c645f481a6738311aea0b0
  name
string
Group name

Sample:
demo


Status

Authors

  • Monty Taylor (@emonty), David Shrewsbury (@Shrews)

Hint

If you notice any issues in this documentation you can edit this document to improve it.