os_nova_flavor - Manage OpenStack compute flavors

New in version 2.0.

Synopsis

  • Add or remove flavors from OpenStack.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • shade

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
Ignored. Present for backwards compatibility
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.
disk Default:
None
Size of local disk, in GB.
ephemeral Default:
0
Ephemeral space size, in GB.
extra_specs
(added in 2.3)
Default:
None
Metadata dictionary
flavorid Default:
auto
ID for the flavor. This is optional as a unique UUID will be assigned if a value is not specified.
interface
(added in 2.3)
    Choices:
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
is_public Default:
yes
Make flavor accessible to the public.
key
A path to a client key to use as part of the SSL transaction.
name
required
Flavor name.
ram Default:
None
Amount of memory, in MB.
region_name
Name of the region.
rxtx_factor Default:
1.0
RX/TX factor.
state
    Choices:
  • present
  • absent
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.
swap Default:
0
Swap space size, in MB.
timeout Default:
180
How long should ansible wait for the requested resource.
vcpus Default:
None
Number of virtual CPUs.
verify
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
    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: "Create 'tiny' flavor with 1024MB of RAM, 1 virtual CPU, and 10GB of local disk, and 10GB of ephemeral."
  os_nova_flavor:
    cloud: mycloud
    state: present
    name: tiny
    ram: 1024
    vcpus: 1
    disk: 10
    ephemeral: 10

- name: "Delete 'tiny' flavor"
  os_nova_flavor:
    cloud: mycloud
    state: absent
    name: tiny

- name: Create flavor with metadata
  os_nova_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 Returned Description
flavor
complex
On success when state is 'present'
Dictionary describing the flavor.

name
string
success
Flavor name.

Sample:
tiny
ram
int
success
Amount of memory, in MB.

Sample:
1024
ephemeral
int
success
Ephemeral space size, in GB.

Sample:
10
vcpus
int
success
Number of virtual CPUs.

Sample:
2
extra_specs
dict
success
Flavor metadata

Sample:
{'aggregate_instance_extra_specs:pinned': False, 'quota:disk_read_iops_sec': 5000}
swap
int
success
Swap space size, in MB.

Sample:
100
is_public
bool
success
Make flavor accessible to the public.

Sample:
True
disk
int
success
Size of local disk, in GB.

Sample:
10
id
string
success
Flavor ID.

Sample:
515256b8-7027-4d73-aa54-4e30a4a4a339


Status

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

Author

  • David Shrewsbury (@Shrews)

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.5/modules/os_nova_flavor_module.html