os_project_access - Manage OpenStack compute flavors acceess

New in version 2.5.

Synopsis

  • Add or remove flavor, volume_type or other resources access from OpenStack.

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
The availability zone of the resource.
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.
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.
region_name
Name of the region.
resource_name
The resource name (eg. tiny).
resource_type
The resource type (eg. nova_flavor, cinder_volume_type).
state
    Choices:
  • present ←
  • absent
Indicate desired state of the resource.
target_project_id
required
Project id.
timeout Default:
180
How long should ansible wait for the requested resource.
verify
bool
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
bool
    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

- name: "Enable access to tiny flavor to your tenant."
  os_project_access:
    cloud: mycloud
    state: present
    target_project_id: f0f1f2f3f4f5f67f8f9e0e1
    resource_name: tiny
    resource_type: nova_flavor


- name: "Disable access to the given flavor to project"
  os_project_access:
    cloud: mycloud
    state: absent
    target_project_id: f0f1f2f3f4f5f67f8f9e0e1
    resource_name: tiny
    resource_type: nova_flavor

Return Values

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

Key Returned Description
flavor
complex
 On success when state is 'present'
Dictionary describing the flavor.
id
string
 success
Flavor ID.

Sample:
515256b8-7027-4d73-aa54-4e30a4a4a339
name
string
 success
Flavor name.

Sample:
tiny


Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Roberto Polli (@ioggstream)

Hint

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

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