This plugin is part of the openstack.cloud collection (version 1.5.1).
You might already have this collection installed if you are using the
ansible package. It is not included in
ansible-core. To check whether it is installed, run
ansible-galaxy collection list.
To install it, use:
ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify:
The below requirements are needed on the host that executes this module.
| 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 (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 |
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
| ca_cert |
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
| client_cert |
A path to a client certificate to use as part of the SSL transaction.
| client_key |
A path to a client key 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 |
The description of the Identity Provider.
| domain_id |
The ID of a domain that is associated with the Identity Provider. Federated users that authenticate with the Identity Provider will be created under the domain specified.
Required when creating a new Identity Provider.
| enabled |
| || |
Whether the Identity Provider is enabled or not.
Will default to
| interface |
| || |
Endpoint URL type to fetch from the service catalog.
| name |
string / required
The name of the Identity Provider.
| region_name |
Name of the region.
| remote_ids |
list / elements=string
List of the unique Identity Provider's remote IDs.
Will default to an empty list when creating a new Identity Provider.
| state |
| || |
Whether the Identity Provider should be
| timeout |
| Default: |
How long should ansible wait for the requested resource.
| validate_certs |
| || |
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to
| wait |
| || |
Should ansible wait until the requested resource is complete.
OS_USERNAMEmay be used instead of providing explicit values.
- name: Create an identity provider openstack.cloud.federation_idp: cloud: example_cloud name: example_provider domain_id: 0123456789abcdef0123456789abcdef description: 'My example IDP' remote_ids: - 'https://auth.example.com/auth/realms/ExampleRealm' - name: Delete an identity provider openstack.cloud.federation_idp: cloud: example_cloud name: example_provider state: absent
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.