openstack.cloud.federation_mapping – Manage a federation mapping¶
Note
This plugin is part of the openstack.cloud collection (version 1.4.0).
To install it use: ansible-galaxy collection install openstack.cloud
.
To use it in a playbook, specify: openstack.cloud.federation_mapping
.
Requirements¶
The below requirements are needed on the host that executes this module.
openstacksdk >= 0.12.0
openstacksdk >= 0.44
python >= 3.6
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, user_domain_name or 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.
|
||
availability_zone
string
|
Ignored. Present for backwards compatibility
|
||
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.
|
||
interface
string
|
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type |
|
name
string
/ required
|
The name of the mapping to manage.
aliases: id |
||
region_name
string
|
Name of the region.
|
||
rules
list
/ elements=dictionary
|
The rules that comprise the mapping. These are pairs of local and remote definitions. For more details on how these work please see the OpenStack documentation https://docs.openstack.org/keystone/latest/admin/federation/mapping_combinations.html.
Required if state=present
|
||
local
list
/ elements=dictionary / required
|
Information on what local attributes will be mapped.
|
||
remote
list
/ elements=dictionary / required
|
Information on what remote attributes will be mapped.
|
||
state
string
|
|
Whether the mapping should be
present or absent . |
|
timeout
integer
|
Default: 180
|
How long should ansible wait for the requested resource.
|
|
validate_certs
boolean
|
|
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to
yes .aliases: verify |
|
wait
boolean
|
|
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 new mapping
openstack.cloud.federation_mapping:
cloud: example_cloud
name: example_mapping
rules:
- local:
- user:
name: '{0}'
- group:
id: '0cd5e9'
remote:
- type: UserName
- type: orgPersonType
any_one_of:
- Contractor
- SubContractor
- name: Delete a mapping
openstack.cloud.federation_mapping:
name: example_mapping
state: absent
Authors¶
OpenStack Ansible SIG