os_stack - Add/Remove Heat Stack

New in version 2.2.

Synopsis

  • Add or Remove a Stack to an OpenStack Heat

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade

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 compatibility
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.
endpoint_type
 no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
environment
 no None
List of environment files that should be used for the stack creation
key
 no None
A path to a client key to use as part of the SSL transaction.
name
 yes
Name of the stack that should be created, name could be char and digit, no space
parameters
 no None
Dictionary of parameters for the stack creation
region_name
 no
Name of the region.
rollback
 no
Rollback stack creation
state
 no present
  • present
  • absent
Indicate desired state of the resource
template
 no None
Path of the template file to use for the stack creation
timeout
 no 3600
Maximum number of seconds to wait for the stack creation
validate_certs
 no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: verify
wait
 no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.

Examples

---
- name: create stack
  ignore_errors: True
  register: stack_create
  os_stack:
    name: "{{ stack_name }}"
    state: present
    template: "/path/to/my_stack.yaml"
    environment:
    - /path/to/resource-registry.yaml
    - /path/to/environment.yaml
    parameters:
        bmc_flavor: m1.medium
        bmc_image: CentOS
        key_name: default
        private_net: "{{ private_net_param }}"
        node_count: 2
        name: undercloud
        image: CentOS
        my_flavor: m1.large
        external_net: "{{ external_net_param }}"

Return Values

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

name description returned type sample
id
Stack ID.
 always string 97a3f543-8136-4570-920e-fd7605c989d6
stack
stack info
 always complex
contains:
name description returned type sample
identifier
Identifier of the current Stack action.
 string test-stack/97a3f543-8136-4570-920e-fd7605c989d6
description
Description of the Stack provided in the heat template.
 string HOT template to create a new instance and networks
links
Links to the current Stack.
 list of dict [{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6']
outputs
Output returned by the Stack.
 list of dict {'description': 'IP address of server1 in private network', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'}
creation_time
Time when the action has been made.
 string 2016-07-05T17:38:12Z
action
Action, could be Create or Update.
 string CREATE
parameters
Parameters of the current Stack
 dict {'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack_name': 'test-stack', 'stack_status': 'CREATE_COMPLETE', 'stack_status_reason': 'Stack CREATE completed successfully', 'status': 'COMPLETE', 'template_description': 'HOT template to create a new instance and networks', 'timeout_mins': 60, 'updated_time': null}
id
Stack ID.
 string 97a3f543-8136-4570-920e-fd7605c989d6
name
Name of the Stack
 string test-stack

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.

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

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