Documentation

os_nova_flavor - Manage OpenStack compute flavors

New in version 2.0.

Synopsis

  • Add or remove flavors from OpenStack.

Options

parameter required default choices comments
api_timeout
no None
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
no
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
no password
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
no
Ignored. Present for backwards compatability
cacert
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
no None
A path to a client certificate to use as part of the SSL transaction.
cloud
no
Named cloud to operate against. 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.
disk
no
Size of local disk, in GB.
endpoint_type
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
ephemeral
no
Ephemeral space size, in GB.
extra_specs
(added in 2.3)
no None
Metadata dictionary
flavorid
no auto
ID for the flavor. This is optional as a unique UUID will be assigned if a value is not specified.
is_public
no True
Make flavor accessible to the public.
key
no None
A path to a client key to use as part of the SSL transaction.
name
yes
Flavor name.
ram
no
Amount of memory, in MB.
region_name
no
Name of the region.
rxtx_factor
no 1.0
RX/TX factor.
state
no present
  • 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
no
Swap space size, in MB.
timeout
no 180
How long should ansible wait for the requested resource.
validate_certs
no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
vcpus
no
Number of virtual CPUs.
wait
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
flavor Dictionary describing the flavor. On success when I(state) is 'present' complex
contains:
name description returned type sample
name Flavor name. success string tiny
ram Amount of memory, in MB. success int 1024
ephemeral Ephemeral space size, in GB. success int 10
vcpus Number of virtual CPUs. success int 2
extra_specs Flavor metadata success dict {'aggregate_instance_extra_specs:pinned': False, 'quota:disk_read_iops_sec': 5000}
swap Swap space size, in MB. success int 100
is_public Make flavor accessible to the public. success bool True
disk Size of local disk, in GB. success int 10
id Flavor ID. success string 515256b8-7027-4d73-aa54-4e30a4a4a339


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

Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.