avi_autoscalelaunchconfig – Module for setup of AutoScaleLaunchConfig Avi RESTful Object

From Get docs
Ansible/docs/2.7/modules/avi autoscalelaunchconfig module


avi_autoscalelaunchconfig – Module for setup of AutoScaleLaunchConfig Avi RESTful Object

New in version 2.6.


Synopsis

Requirements

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

  • avisdk

Parameters

Parameter Choices/Defaults Comments

api_context

-

added in 2.5

Avi API context that includes current session ID and CSRF Token.

This allows user to perform single login and re-use the session.

api_version

-

Default:

"16.4.4"

Avi API version of to use for Avi API and objects.

avi_api_patch_op

-

  • add
  • replace
  • delete

Patch operation to use when using avi_api_update_method as patch.

avi_api_update_method

-

  • put

  • patch

Default method for object update is HTTP PUT.

Setting to patch will override that behavior to use HTTP PATCH.

avi_credentials

-

added in 2.5

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

controller

-

Default:

""

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

description

-

User defined description for the object.

image_id

-

Unique id of the amazon machine image (ami) or openstack vm id.

mesos

-

Autoscalemesossettings settings for autoscalelaunchconfig.

name

- / required

Name of the object.

openstack

-

Autoscaleopenstacksettings settings for autoscalelaunchconfig.

password

-

Default:

""

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

state

-

  • absent
  • present

The state that should be applied on the entity.

tenant

-

Default:

"admin"

Name of tenant used for all Avi API calls and context of object.

tenant_ref

-

It is a reference to an object of type tenant.

tenant_uuid

-

Default:

""

UUID of tenant used for all Avi API calls and context of object.

url

-

Avi controller URL of the object.

use_external_asg

boolean

  • no
  • yes

If set to true, serverautoscalepolicy will use the autoscaling group (external_autoscaling_groups) from pool to perform scale up and scale down.

Pool should have single autoscaling group configured.

Field introduced in 17.2.3.

Default value when not specified in API or module is interpreted by Avi Controller as True.

username

-

Default:

""

Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.

uuid

-

Unique object identifier of the object.



Notes

Note


Examples

- name: Create an Autoscale Launch configuration.
  avi_autoscalelaunchconfig:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    image_id: default
    name: default-autoscalelaunchconfig
    tenant_ref: admin

Return Values

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

Key Returned Description

obj

dictionary

success, changed

AutoScaleLaunchConfig (api/autoscalelaunchconfig) object





Status

Authors

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