VM Autoscaling Group

vm_autoscaling_group

This is a module that supports creating, updating or destroying VM Autoscaling Groups

Example Syntax

name: Create VM Autoscaling Group
ionoscloudsdk.ionoscloud.vm_autoscaling_group:
  datacenter: 'AnsibleVMAutoscaling'
  name: 'AnsibleVMAutoscalingGroup'
  max_replica_count: '5'
  min_replica_count: '1'
  metric: 'INSTANCE_CPU_UTILIZATION_AVERAGE'
  range: 'PT24H'
  unit: 'PER_HOUR'
  scale_in_threshold: '33'
  scale_out_threshold: '77'
  scale_in_action: '{'amount': 1, 'amount_type': 'ABSOLUTE', 'cooldown_period': 'PT5M', 'termination_policy': 'RANDOM', 'delete_volumes': True}'
  scale_out_action: '{'amount': 1, 'amount_type': 'ABSOLUTE', 'cooldown_period': 'PT5M'}'
  availability_zone: 'AUTO'
  cores: '2'
  cpu_family: 'INTEL_XEON'
  ram: '1024'
  nics: '[{'lan': 1, 'name': 'SDK_TEST_NIC1', 'dhcp': True}, {'lan': 1, 'name': 'SDK_TEST_NIC2', 'dhcp': False}]'
  volumes: '[{'image': '0ede69ec-eeab-11ef-8fa7-aee9942a25aa', 'image_password': 'test12345', 'name': 'SDK_TEST_VOLUME', 'size': 50, 'type': 'HDD', 'bus': 'IDE', 'boot_order': 'AUTO'}]'
register: vm_autoscaling_group_response


name: Update VM Ausocaling Group
ionoscloudsdk.ionoscloud.vm_autoscaling_group:
  vm_autoscaling_group: ''
  datacenter: 'AnsibleVMAutoscalingUpdate'
  name: 'AnsibleVMAutoscalingGroupUPDATED'
  max_replica_count: '1'
  min_replica_count: '0'
  metric: 'INSTANCE_NETWORK_IN_BYTES'
  range: 'PT12H'
  unit: 'PER_MINUTE'
  scale_in_threshold: '30'
  scale_out_threshold: '86'
  scale_in_action: '{'amount': 50, 'amount_type': 'PERCENTAGE', 'cooldown_period': 'PT10M', 'termination_policy': 'RANDOM', 'delete_volumes': False}'
  scale_out_action: '{'amount': 2, 'amount_type': 'ABSOLUTE', 'cooldown_period': 'PT15M'}'
  availability_zone: 'AUTO'
  cores: '1'
  cpu_family: 'INTEL_SKYLAKE'
  ram: '2048'
  nics: '[{'lan': 1, 'name': 'SDK_TEST_NIC1', 'dhcp': True, 'firewall_active': True, 'firewall_rules': [{'name': 'test2', 'protocol': 'TCP', 'port_range_end': 12}]}]'
  volumes: '[{'image': 'b5548883-108b-11f0-8ffe-266d89ffd7f8', 'image_password': 'test12345', 'name': 'SDK_TEST_VOLUME_UPDATE', 'size': 75, 'type': 'SSD', 'bus': 'IDE', 'boot_order': 'AUTO'}]'
  do_not_replace: false
  state: update
register: vm_autoscaling_group_response


name: Remove VM Ausocaling Group
ionoscloudsdk.ionoscloud.vm_autoscaling_group:
  vm_autoscaling_group: 'AnsibleVMAutoscalingGroup'
  state: absent
register: vm_autoscaling_group_response

Returned object

{
    "changed": true,
    "failed": false,
    "action": "create",
    "vm_autoscaling_group": {
        "id": "cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66",
        "type": "autoscaling-group",
        "href": "https://api.ionos.com/autoscaling/groups/cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66",
        "metadata": {
            "created_by": "<USER_EMAIL>",
            "created_by_user_id": "<USER_ID>",
            "created_date": "2023-10-30T13:53:50.863223+00:00",
            "etag": "UqNMEcSKAhvN4GK+OeBxlYlLs0TS6SBCGvk5HgWgdJk=",
            "last_modified_by": "<USER_EMAIL>",
            "last_modified_by_user_id": "<USER_ID>",
            "last_modified_date": "2023-10-30T13:53:54.378143+00:00",
            "state": "AVAILABLE"
        },
        "properties": {
            "datacenter": {
                "id": "8b8b9122-b8ef-4966-a36a-2e9cf8609121",
                "type": "datacenter",
                "href": "https://api.public.production.k8s.fra2.profitbricks.net/cloudapi/v6/datacenters/8b8b9122-b8ef-4966-a36a-2e9cf8609121"
            },
            "location": "us/las",
            "max_replica_count": 5,
            "min_replica_count": 1,
            "name": "AnsibleVMAutoscalingGroup",
            "policy": {
                "metric": "INSTANCE_CPU_UTILIZATION_AVERAGE",
                "range": "PT24H",
                "scale_in_action": {
                    "amount": 1.0,
                    "amount_type": "ABSOLUTE",
                    "cooldown_period": "PT5M",
                    "termination_policy": "RANDOM",
                    "delete_volumes": true
                },
                "scale_in_threshold": 33.0,
                "scale_out_action": {
                    "amount": 1.0,
                    "amount_type": "ABSOLUTE",
                    "cooldown_period": "PT5M"
                },
                "scale_out_threshold": 77.0,
                "unit": "PER_HOUR"
            },
            "replica_configuration": {
                "availability_zone": "AUTO",
                "cores": 2,
                "cpu_family": "INTEL_XEON",
                "nics": [
                    {
                        "lan": 1,
                        "name": "SDK_TEST_NIC1",
                        "dhcp": true,
                        "firewall_active": null,
                        "firewall_type": null,
                        "flow_logs": [],
                        "firewall_rules": [],
                        "target_group": null
                    },
                    {
                        "lan": 1,
                        "name": "SDK_TEST_NIC2",
                        "dhcp": false,
                        "firewall_active": null,
                        "firewall_type": null,
                        "flow_logs": [],
                        "firewall_rules": [],
                        "target_group": null
                    }
                ],
                "ram": 1024,
                "volumes": [
                    {
                        "image": "b6d8c6f2-febc-11ed-86e8-2e7f0689c849",
                        "image_alias": null,
                        "name": "SDK_TEST_VOLUME",
                        "size": 50,
                        "ssh_keys": [],
                        "type": "HDD",
                        "user_data": null,
                        "bus": "IDE",
                        "backupunit_id": null,
                        "boot_order": "AUTO",
                        "image_password": null
                    }
                ]
            }
        },
        "entities": {
            "actions": {
                "id": "cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66/actions",
                "type": "collection",
                "href": "https://api.ionos.com/autoscaling/groups/cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66/actions"
            },
            "servers": {
                "id": "cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66/servers",
                "type": "collection",
                "href": "https://api.ionos.com/autoscaling/groups/cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66/servers"
            }
        },
        "started_actions": [
            {
                "id": "4293fe77-1fc5-42e9-aff4-2ed8341c1b0e",
                "type": "autoscaling-action",
                "href": "https://api.ionos.com/autoscaling/groups/cd7407bc-54ff-4dcb-bf0e-6c2f7fa45c66/actions/4293fe77-1fc5-42e9-aff4-2ed8341c1b0e"
            }
        ]
    }
}

For more examples please check out the tests here.

NOTE: If you are using a versions 7.0.0 and up: modules can replace resources if certain set parameters differ from the results found in the API!

Parameters that can trigger a resource replacement:

• datacenter

state: present

  
name: Create VM Autoscaling Group
ionoscloudsdk.ionoscloud.vm_autoscaling_group:
  datacenter: 'AnsibleVMAutoscaling'
  name: 'AnsibleVMAutoscalingGroup'
  max_replica_count: '5'
  min_replica_count: '1'
  metric: 'INSTANCE_CPU_UTILIZATION_AVERAGE'
  range: 'PT24H'
  unit: 'PER_HOUR'
  scale_in_threshold: '33'
  scale_out_threshold: '77'
  scale_in_action: '{'amount': 1, 'amount_type': 'ABSOLUTE', 'cooldown_period': 'PT5M', 'termination_policy': 'RANDOM', 'delete_volumes': True}'
  scale_out_action: '{'amount': 1, 'amount_type': 'ABSOLUTE', 'cooldown_period': 'PT5M'}'
  availability_zone: 'AUTO'
  cores: '2'
  cpu_family: 'INTEL_XEON'
  ram: '1024'
  nics: '[{'lan': 1, 'name': 'SDK_TEST_NIC1', 'dhcp': True}, {'lan': 1, 'name': 'SDK_TEST_NIC2', 'dhcp': False}]'
  volumes: '[{'image': '0ede69ec-eeab-11ef-8fa7-aee9942a25aa', 'image_password': 'test12345', 'name': 'SDK_TEST_VOLUME', 'size': 50, 'type': 'HDD', 'bus': 'IDE', 'boot_order': 'AUTO'}]'
register: vm_autoscaling_group_response

Available parameters for state present:

Name	Required	Description
max_replica_count int	True	The maximum value for the number of replicas for 'targetReplicaCount'. Must be >= 0 and <= 200. Will be enforced for both automatic and manual changes.
min_replica_count int	True	The minimum value for the number of replicas for 'targetReplicaCount'. Must be >= 0 and <= 200. Will be enforced for both automatic and manual changes
name str	True	The name of the VM Auto Scaling Group. This field must not be null or blank.
datacenter str	True	The VMs for this VM Auto Scaling Description are created in this virtual data center.
metric str	True	The metric that triggers the scaling actions. Metric values are checked at fixed intervals. Options: ['INSTANCE_CPU_UTILIZATION_AVERAGE', 'INSTANCE_NETWORK_IN_BYTES', 'INSTANCE_NETWORK_IN_PACKETS', 'INSTANCE_NETWORK_OUT_BYTES', 'INSTANCE_NETWORK_OUT_PACKETS']
range str	False	Specifies the time range for which the samples are to be aggregated. Must be >= 2 minutes.
unit str	False	The units of the applied metric. 'TOTAL' can only be combined with 'INSTANCE_CPU_UTILIZATION_AVERAGE'. Options: ['PER_HOUR', 'PER_MINUTE', 'PER_SECOND', 'TOTAL']
scale_in_threshold int	True	The lower threshold for the value of the 'metric'. Used with the `less than` (<) operator. When this value is exceeded, a scale-in action is triggered, specified by the 'scaleInAction' property. The value must have a higher minimum delta to the 'scaleOutThreshold', depending on the 'metric', to avoid competing for actions at the same time.
scale_out_threshold int	True	The upper threshold for the value of the 'metric'. Used with the 'greater than' (>) operator. A scale-out action is triggered when this value is exceeded, specified by the 'scaleOutAction' property. The value must have a lower minimum delta to the 'scaleInThreshold', depending on the metric, to avoid competing for actions simultaneously. If 'properties.policy.unit=TOTAL', a value >= 40 must be chosen.
scale_in_action dict	True	Defines the action to be taken when the 'scaleInThreshold' is exceeded. Here, scaling is always about removing VMs associated with this VM Auto Scaling Group. By default, the termination policy is 'OLDEST_SERVER_FIRST' is effective.
scale_out_action dict	True	Defines the action to be performed when the 'scaleOutThreshold' is exceeded. Here, scaling is always about adding new VMs to this VM Auto Scaling Group.
nics list	False	The list of NICs associated with this replica.
volumes list	False	List of volumes associated with this Replica.
availability_zone str	False	The zone where the VMs are created. The availability zone is always automatically set to 'AUTO' for performance reasons. Even if you set another value, e.g. 'null', or leave it empty.
cores str	True	The total number of cores for the VMs.
cpu_family str	False	The CPU family for the VMs created with this configuration. If the value is 'null', the VM is created with the default CPU family for the assigned site.
ram int	True	The size of the memory for the VMs in MB. The size must be in multiples of 256 MB, with a minimum of 256 MB; if you set 'ramHotPlug=TRUE', you must use at least 1024 MB. If you set the RAM size to more than 240 GB, 'ramHotPlug=FALSE' is fixed.
do_not_replace bool	False	Boolean indicating if the resource should not be recreated when the state cannot be reached in another way. This may be used to prevent resources from being deleted from specifying a differentvalue to an immutable property. An error will be thrown instead Default: True
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: absent

  
name: Remove VM Ausocaling Group
ionoscloudsdk.ionoscloud.vm_autoscaling_group:
  vm_autoscaling_group: 'AnsibleVMAutoscalingGroup'
  state: absent
register: vm_autoscaling_group_response

Available parameters for state absent:

Name	Required	Description
vm_autoscaling_group str	True	The ID or name of an existing VM Autoscaling Group.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: update

  
name: Update VM Ausocaling Group
ionoscloudsdk.ionoscloud.vm_autoscaling_group:
  vm_autoscaling_group: ''
  datacenter: 'AnsibleVMAutoscalingUpdate'
  name: 'AnsibleVMAutoscalingGroupUPDATED'
  max_replica_count: '1'
  min_replica_count: '0'
  metric: 'INSTANCE_NETWORK_IN_BYTES'
  range: 'PT12H'
  unit: 'PER_MINUTE'
  scale_in_threshold: '30'
  scale_out_threshold: '86'
  scale_in_action: '{'amount': 50, 'amount_type': 'PERCENTAGE', 'cooldown_period': 'PT10M', 'termination_policy': 'RANDOM', 'delete_volumes': False}'
  scale_out_action: '{'amount': 2, 'amount_type': 'ABSOLUTE', 'cooldown_period': 'PT15M'}'
  availability_zone: 'AUTO'
  cores: '1'
  cpu_family: 'INTEL_SKYLAKE'
  ram: '2048'
  nics: '[{'lan': 1, 'name': 'SDK_TEST_NIC1', 'dhcp': True, 'firewall_active': True, 'firewall_rules': [{'name': 'test2', 'protocol': 'TCP', 'port_range_end': 12}]}]'
  volumes: '[{'image': 'b5548883-108b-11f0-8ffe-266d89ffd7f8', 'image_password': 'test12345', 'name': 'SDK_TEST_VOLUME_UPDATE', 'size': 75, 'type': 'SSD', 'bus': 'IDE', 'boot_order': 'AUTO'}]'
  do_not_replace: false
  state: update
register: vm_autoscaling_group_response

Available parameters for state update:

Name	Required	Description
max_replica_count int	False	The maximum value for the number of replicas for 'targetReplicaCount'. Must be >= 0 and <= 200. Will be enforced for both automatic and manual changes.
min_replica_count int	False	The minimum value for the number of replicas for 'targetReplicaCount'. Must be >= 0 and <= 200. Will be enforced for both automatic and manual changes
name str	False	The name of the VM Auto Scaling Group. This field must not be null or blank.
datacenter str	False	The VMs for this VM Auto Scaling Description are created in this virtual data center.
metric str	False	The metric that triggers the scaling actions. Metric values are checked at fixed intervals. Options: ['INSTANCE_CPU_UTILIZATION_AVERAGE', 'INSTANCE_NETWORK_IN_BYTES', 'INSTANCE_NETWORK_IN_PACKETS', 'INSTANCE_NETWORK_OUT_BYTES', 'INSTANCE_NETWORK_OUT_PACKETS']
range str	False	Specifies the time range for which the samples are to be aggregated. Must be >= 2 minutes.
unit str	False	The units of the applied metric. 'TOTAL' can only be combined with 'INSTANCE_CPU_UTILIZATION_AVERAGE'. Options: ['PER_HOUR', 'PER_MINUTE', 'PER_SECOND', 'TOTAL']
scale_in_threshold int	False	The lower threshold for the value of the 'metric'. Used with the `less than` (<) operator. When this value is exceeded, a scale-in action is triggered, specified by the 'scaleInAction' property. The value must have a higher minimum delta to the 'scaleOutThreshold', depending on the 'metric', to avoid competing for actions at the same time.
scale_out_threshold int	False	The upper threshold for the value of the 'metric'. Used with the 'greater than' (>) operator. A scale-out action is triggered when this value is exceeded, specified by the 'scaleOutAction' property. The value must have a lower minimum delta to the 'scaleInThreshold', depending on the metric, to avoid competing for actions simultaneously. If 'properties.policy.unit=TOTAL', a value >= 40 must be chosen.
scale_in_action dict	False	Defines the action to be taken when the 'scaleInThreshold' is exceeded. Here, scaling is always about removing VMs associated with this VM Auto Scaling Group. By default, the termination policy is 'OLDEST_SERVER_FIRST' is effective.
scale_out_action dict	False	Defines the action to be performed when the 'scaleOutThreshold' is exceeded. Here, scaling is always about adding new VMs to this VM Auto Scaling Group.
nics list	False	The list of NICs associated with this replica.
volumes list	False	List of volumes associated with this Replica.
availability_zone str	False	The zone where the VMs are created. The availability zone is always automatically set to 'AUTO' for performance reasons. Even if you set another value, e.g. 'null', or leave it empty.
cores str	False	The total number of cores for the VMs.
cpu_family str	False	The CPU family for the VMs created with this configuration. If the value is 'null', the VM is created with the default CPU family for the assigned site.
ram int	False	The size of the memory for the VMs in MB. The size must be in multiples of 256 MB, with a minimum of 256 MB; if you set 'ramHotPlug=TRUE', you must use at least 1024 MB. If you set the RAM size to more than 240 GB, 'ramHotPlug=FALSE' is fixed.
vm_autoscaling_group str	True	The ID or name of an existing VM Autoscaling Group.
do_not_replace bool	False	Boolean indicating if the resource should not be recreated when the state cannot be reached in another way. This may be used to prevent resources from being deleted from specifying a differentvalue to an immutable property. An error will be thrown instead Default: True
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']