community.general.rax_scaling_group module – Manipulate Rackspace Cloud Autoscale Groups
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.rax_scaling_group
.
DEPRECATED
- Removed in:
version 9.0.0
- Why:
This module relies on the deprecated package pyrax.
- Alternative:
Use the Openstack modules instead.
Synopsis
Manipulate Rackspace Cloud Autoscale Groups
Aliases: cloud.rackspace.rax_scaling_group
Requirements
The below requirements are needed on the host that executes this module.
pyrax
Parameters
Parameter |
Comments |
---|---|
Rackspace API key, overrides |
|
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/. |
|
Attach read-only configuration drive to server as label config-2 Choices:
|
|
The period of time, in seconds, that must pass before any scaling can occur after the previous scaling. Must be an integer between 0 and 86400 (24 hrs). Default: |
|
Disk partitioning strategy If not specified, it will fallback to Choices:
|
|
Environment as configured in |
|
Files to insert into the instance. Hash of Default: |
|
flavor to use for the instance |
|
Authentication mechanism to use, such as rackspace or keystone. Default: |
|
image to use for the instance. Can be an |
|
key pair to use on the instance |
|
List of load balancer |
|
The maximum number of entities that are allowed in the scaling group. Must be an integer between 0 and 1000. |
|
A hash of metadata to associate with the instance Default: |
|
The minimum number of entities that are allowed in the scaling group. Must be an integer between 0 and 1000. |
|
Name to give the scaling group |
|
The network to attach to the instances. If specified, you must include ALL networks including the public and private interfaces. Can be Default: |
|
Region to create an instance in. |
|
The base name for servers created by Autoscale |
|
Indicate desired state of the resource Choices:
|
|
The tenant ID used for authentication. |
|
The tenant name used for authentication. |
|
Data to be uploaded to the servers config drive. This option implies |
|
Rackspace username, overrides |
|
Whether or not to require SSL validation of API endpoints. Choices:
|
|
wait for the scaling group to finish provisioning the minimum amount of servers Choices:
|
|
how long before wait gives up, in seconds Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
.RAX_CREDENTIALS
andRAX_CREDS_FILE
point to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating.RAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials file.RAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, …).The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
.RAX_CREDENTIALS
andRAX_CREDS_FILE
points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating.RAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials file.RAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, …).
Examples
---
- hosts: localhost
gather_facts: false
connection: local
tasks:
- community.general.rax_scaling_group:
credentials: ~/.raxpub
region: ORD
cooldown: 300
flavor: performance1-1
image: bb02b1a3-bc77-4d17-ab5b-421d89850fca
min_entities: 5
max_entities: 10
name: ASG Test
server_name: asgtest
loadbalancers:
- id: 228385
port: 80
register: asg
Status
This module will be removed in version 9.0.0. [deprecated]
For more information see DEPRECATED.