openstack.cloud.neutron_rbac_policy module – Create or delete a Neutron policy to apply a RBAC rule against an object.
Note
This module is part of the openstack.cloud collection (version 1.10.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.neutron_rbac_policy
.
Synopsis
Create a policy to apply a RBAC rule against a network, security group or a QoS Policy or update/delete an existing policy.
If a
policy_id
was provided but not found, this module will attempt to create a new policy rather than error out when updating an existing rule.Accepts same arguments as OpenStackSDK network proxy
find_rbac_policy
andrbac_policies
functions which are ultimately passed over toRBACPolicy
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 0.36, < 0.99.0
Parameters
Parameter |
Comments |
---|---|
Can be either of the following options Cannot be changed when updating an existing policy Required when creating a RBAC policy rule, ignored when deleting a policy Choices:
|
|
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. |
|
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. |
|
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. |
|
Ignored. Present for backwards compatibility |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
The object ID (the subject of the policy) to which the RBAC rule applies Cannot be changed when updating an existing policy Required when creating a RBAC policy rule, ignored when deleting a policy |
|
Can be one of the following object types Cannot be changed when updating an existing policy Required when creating a RBAC policy rule, ignored when deleting a policy Choices:
|
|
The RBAC policy ID Required when deleting or updating an existing RBAC policy rule, ignored otherwise |
|
The project to which the object_id belongs Cannot be changed when updating an existing policy Required when creating a RBAC policy rule, ignored when deleting a policy |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Whether the RBAC rule should be Choices:
|
|
The project to which access to be allowed or revoked/disallowed Can be specified/changed when updating an existing policy Required when creating or updating a RBAC policy rule, ignored when deleting a policy |
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
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
# Ensure network RBAC policy exists
- name: Create a new network RBAC policy
neutron_rbac_policy:
object_id: '7422172b-2961-475c-ac68-bd0f2a9960ad'
object_type: 'network'
target_project_id: 'a12f9ce1de0645e0a0b01c2e679f69ec'
project_id: '84b8774d595b41e89f3dfaa1fd76932d'
# Update network RBAC policy
- name: Update an existing network RBAC policy
neutron_rbac_policy:
policy_id: 'f625242a-6a73-47ac-8d1f-91440b2c617f'
target_project_id: '163c89e065a94e069064e551e15daf0e'
# Delete an existing RBAC policy
- name: Delete RBAC policy
openstack.cloud.openstack.neutron_rbac_policy:
policy_id: 'f625242a-6a73-47ac-8d1f-91440b2c617f'
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A hash representing the policy Returned: always |
|
The access model specified by the RBAC rules Returned: success Sample: |
|
The ID of the RBAC rule/policy Returned: success Sample: |
|
A dictionary of the project details to which access is granted Returned: success Sample: |
|
The name of the RBAC rule; usually null Returned: success |
|
The UUID of the object to which the RBAC rules apply Returned: success Sample: |
|
The object type to which the RBACs apply Returned: success Sample: |
|
The UUID of the project to which access is granted Returned: success Sample: |
|
The UUID of the target project Returned: success Sample: |