openstack.cloud.compute_flavor module – Manage OpenStack compute flavors
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.compute_flavor
.
Synopsis
Add or remove flavors from OpenStack.
Requirements
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36, < 0.99.0
python >= 3.6
Parameters
Parameter |
Comments |
---|---|
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. |
|
Size of local disk, in GB. Default: |
|
Ephemeral space size, in GB. Default: |
|
Metadata dictionary |
|
ID for the flavor. This is optional as a unique UUID will be assigned if a value is not specified. Default: |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Make flavor accessible to the public. Choices:
|
|
Flavor name. |
|
Amount of memory, in MB. |
|
Name of the region. |
|
RX/TX factor. Default: |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Indicate desired state of the resource. When state is ‘present’, then ram, vcpus, and disk are all required. There are no default values for those parameters. Choices:
|
|
Swap space size, in MB. Default: |
|
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:
|
|
Number of virtual CPUs. |
|
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
- name: "Create 'tiny' flavor with 1024MB of RAM, 1 virtual CPU, and 10GB of local disk, and 10GB of ephemeral."
openstack.cloud.compute_flavor:
cloud: mycloud
state: present
name: tiny
ram: 1024
vcpus: 1
disk: 10
ephemeral: 10
- name: "Delete 'tiny' flavor"
openstack.cloud.compute_flavor:
cloud: mycloud
state: absent
name: tiny
- name: Create flavor with metadata
openstack.cloud.compute_flavor:
cloud: mycloud
state: present
name: tiny
ram: 1024
vcpus: 1
disk: 10
extra_specs:
"quota:disk_read_iops_sec": 5000
"aggregate_instance_extra_specs:pinned": false
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the flavor. Returned: On success when state is ‘present’ |
|
Size of local disk, in GB. Returned: success Sample: |
|
Ephemeral space size, in GB. Returned: success Sample: |
|
Flavor metadata Returned: success Sample: |
|
Flavor ID. Returned: success Sample: |
|
Make flavor accessible to the public. Returned: success Sample: |
|
Flavor name. Returned: success Sample: |
|
Amount of memory, in MB. Returned: success Sample: |
|
Swap space size, in MB. Returned: success Sample: |
|
Number of virtual CPUs. Returned: success Sample: |