SoftLayer_Scale_Group


SoftLayer_Scale_Group

Description

Local


accountId

The identifier of the account assigned to this group.
Type: integer


balancedTerminationFlag

If this is true, this group will scale down members in a way to preserve the balance across VLANs. If there is ambiguity about which member to use to maintain balance, the terminationPolicy is used to resolve it. This is false by default and can only be set to true if there are multiple VLANs that are being balanced across.
Type: boolean


cooldown

The number of seconds this group will wait after lastActionDate before performing another action. Be advised, this can be overridden per policy. While strongly discouraged, a value of 0 effectively disables cooldown.
Type: integer


createDate

When this group was created.
Type: dateTime


desiredMemberCount

This value is only available on the template for creating and editing a group. It will be null when retrieved. When this value is provided on create or edit, guests will be scaled up or down to meet this number. This number must be in the range provided by minimumMemberCount and maximumMemberCount. This value can only be present during create or edit when this group is active. Note, guests that are created as a result of this value can possibly be removed after cooldown by a policy.
Type: integer


id

A group’s internal identifier.
Type: integer


lastActionDate

The date of the last action on this group or its create date
Type: dateTime


maximumMemberCount

The greatest number of virtual guest members that are allowed on this group. Any attempts to add a guest member will fail if it will result in the total guest member count of this group to be above this number. If this number is edited and is less than the current guest member count, guests will be removed to at least be no greater than this number.
Type: integer


minimumMemberCount

The fewest number of virtual guest members that are allowed on this group. Any attempts to remove a guest member will fail if it will result in the total guest member count of this group to be below this number. If this number is edited and is larger than the current guest member count, guests will be added to at least reach this number.
Type: integer


modifyDate

When this group was last modified.
Type: dateTime


name

The name of this scale group. It must be unique on the account.
Type: string


regionalGroupId

The identifier of the regional group this scaling group is assigned to.
Type: integer


suspendedFlag

If true, this group is suspended.
Type: boolean


terminationPolicyId

The termination policy for the group. This determines which member to choose to delete when scaling downwards.
Type: integer


virtualGuestMemberTemplate

This is the template to create guest members with. This is the same template accepted by the createObject call on SoftLayer_Virtual_Guest with some caveats. The hostname provided will have an arbitrary value appended to it for each guest created. Also, hourlyBillingFlag cannot be false, and if the datacenter is provided it must be in the region of this group. Finally, VLANs cannot be provided for the template, it will use VLANs provided to this group instead.

Note, if this template is edited on an existing group the previous template values are not kept and are not considered during termination. This means a group’s guest members could effectively be a hybrid of multiple templates because this value was changed after some guest members were created but before others were created.
Type: SoftLayer_Virtual_Guest

Relational


account

The account for this scaling group.
Type: SoftLayer_Account


loadBalancers

Collection of load balancers for this auto scale group.
Type: SoftLayer_Scale_LoadBalancer[]


logs

Collection of log entries for this group.
Type: SoftLayer_Scale_Group_Log[]


networkVlans

Collection of VLANs for this auto scale group. VLANs are optional. This can contain a public or private VLAN or both. When a single VLAN for a public/private type is given it can be a non-purchased VLAN only if the minimumMemberCount on the group is >= 1. This can also contain any number of public/private purchased VLANs and members are staggered across them when scaled up.
Type: SoftLayer_Scale_Network_Vlan[]


policies

Collection of policies for this group. This can be empty.
Type: SoftLayer_Scale_Policy[]


regionalGroup

The regional group for this scale group.
Type: SoftLayer_Location_Group_Regional


status

The status for this scale group.
Type: SoftLayer_Scale_Group_Status


terminationPolicy

The termination policy for this scaling group.
Type: SoftLayer_Scale_Termination_Policy


virtualGuestAssets

Collection of guests that have been pinned to this group. Guest assets are only used for certain trigger checks such as resource watches. They do not count towards the auto scaling guest counts of this group in anyway and are never automatically added or removed.
Type: SoftLayer_Scale_Asset[]


virtualGuestMembers

Collection of guests that have been scaled with the group. When this group is active, the count of guests here is guaranteed to be between minimumMemberCount and maximumMemberCount inclusively.
Type: SoftLayer_Scale_Member[]

Count


loadBalancerCount

A count of collection of load balancers for this auto scale group.
Type: unsigned long


logCount

A count of collection of log entries for this group.
Type: unsigned long


networkVlanCount

A count of collection of VLANs for this auto scale group. VLANs are optional. This can contain a public or private VLAN or both. When a single VLAN for a public/private type is given it can be a non-purchased VLAN only if the minimumMemberCount on the group is >= 1. This can also contain any number of public/private purchased VLANs and members are staggered across them when scaled up.
Type: unsigned long


policyCount

A count of collection of policies for this group. This can be empty.
Type: unsigned long


virtualGuestAssetCount

A count of collection of guests that have been pinned to this group. Guest assets are only used for certain trigger checks such as resource watches. They do not count towards the auto scaling guest counts of this group in anyway and are never automatically added or removed.
Type: unsigned long


virtualGuestMemberCount

A count of collection of guests that have been scaled with the group. When this group is active, the count of guests here is guaranteed to be between minimumMemberCount and maximumMemberCount inclusively.
Type: unsigned long



© SoftLayer 2020
Built with Hugo