os_flavor_facts – Retrieve facts about one or more flavors — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# os_flavor_facts – Retrieve facts about one or more flavors

New in version 2.1.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Retrieve facts about available OpenStack instance flavors. By default, facts about ALL flavors are retrieved. Filters can be applied to get facts for only matching flavors. For example, you can filter on the amount of RAM available to the flavor, or the number of virtual CPUs available to the flavor, or both. When specifying multiple filters, ALL filters must match on a flavor before that flavor is returned as a fact.

## Requirements

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

- openstacksdk
- python >= 2.7

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
api_timeout integer |  | 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 |  | 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, os_user_domain_name or os_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.
auth_type string |  | 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
ca_cert string |  | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string |  | A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string |  | A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw |  | 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.
ephemeral boolean added in 2.3 | Choices: no ← yes | A string used for filtering flavors based on the amount of ephemeral storage. Format is the same as the ram parameter
interface string added in 2.3 | Choices: admin internal public ← | Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
limit - |  | Limits the number of flavors returned. All matching flavors are returned by default.
name - |  | A flavor name. Cannot be used with ram or vcpus or ephemeral.
ram boolean | Choices: no ← yes | A string used for filtering flavors based on the amount of RAM (in MB) desired. This string accepts the following special values: 'MIN' (return flavors with the minimum amount of RAM), and 'MAX' (return flavors with the maximum amount of RAM). A specific amount of RAM may also be specified. Any flavors with this exact amount of RAM will be returned. A range of acceptable RAM may be given using a special syntax. Simply prefix the amount of RAM with one of these acceptable range values: '<', '>', '<=', '>='. These values represent less than, greater than, less than or equal to, and greater than or equal to, respectively.
region_name string |  | Name of the region.
timeout integer | Default: 180 | How long should ansible wait for the requested resource.
validate_certs boolean | Choices: no ← yes | Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify
vcpus boolean | Choices: no ← yes | A string used for filtering flavors based on the number of virtual CPUs desired. Format is the same as the ram parameter.
wait boolean | Choices: no yes ← | Should ansible wait until the requested resource is complete.

## Notes

Note

- This module creates a new top-level `openstack_flavors` fact, which contains a list of unsorted flavors.
- 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

    # Gather facts about all available flavors
    - os_flavor_facts:
        cloud: mycloud

    # Gather facts for the flavor named "xlarge-flavor"
    - os_flavor_facts:
        cloud: mycloud
        name: "xlarge-flavor"

    # Get all flavors that have exactly 512 MB of RAM.
    - os_flavor_facts:
        cloud: mycloud
        ram: "512"

    # Get all flavors that have 1024 MB or more of RAM.
    - os_flavor_facts:
        cloud: mycloud
        ram: ">=1024"

    # Get a single flavor that has the minimum amount of RAM. Using the 'limit'
    # option will guarantee only a single flavor is returned.
    - os_flavor_facts:
        cloud: mycloud
        ram: "MIN"
        limit: 1

    # Get all flavors with 1024 MB of RAM or more, AND exactly 2 virtual CPUs.
    - os_flavor_facts:
        cloud: mycloud
        ram: ">=1024"
        vcpus: "2"

    # Get all flavors with 1024 MB of RAM or more, exactly 2 virtual CPUs, and
    # less than 30gb of ephemeral storage.
    - os_flavor_facts:
        cloud: mycloud
        ram: ">=1024"
        vcpus: "2"
        ephemeral: "<30"

## Return Values

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

Key | Returned | Description
--- | --- | ---
openstack_flavors complex | On success. | Dictionary describing the flavors.
| disk integer | success | Size of local disk, in GB. Sample: 10
| ephemeral integer | success | Ephemeral space size, in GB. Sample: 10
| id string | success | Flavor ID. Sample: 515256b8-7027-4d73-aa54-4e30a4a4a339
| is_public boolean | success | Make flavor accessible to the public. Sample: True
| name string | success | Flavor name. Sample: tiny
| ram integer | success | Amount of memory, in MB. Sample: 1024
| swap integer | success | Swap space size, in MB. Sample: 100
| vcpus integer | success | Number of virtual CPUs. Sample: 2

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- David Shrewsbury (@Shrews)

Hint

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