SoftLayer_Scale_Group


SoftLayer_Scale_Group

Description

A scale group can contain a number of guest members which can fluctuate up and down, staying within a defined range, manually or automatically based on policies given. Groups are set of VLANs to be placed behind. Groups can also have static hardware/guests pinned to the group. These static resources can be used to effect things like moving averages for policy triggers but are not counted as group members and are not subject to automatic reclaim.

Methods

createObject
Create a scale group.
deleteObject
Delete this group. This can only be done on an empty, active group.
editObject
Edit this group.
forceDeleteObject
Delete this group and destroy all members of it.
getAccount
Retrieve the account for this scaling group.
getAvailableHourlyInstanceLimit
This returns the number of hourly instances an account can add from this point.
getAvailableRegionalGroups
Get the regional groups available for use by scaling groups. This also includes datacenter children that are available.
getLoadBalancers
Retrieve collection of load balancers for this auto scale group.
getLogs
Retrieve collection of log entries for this group.
getNetworkVlans
Retrieve 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.
getObject
Retrieve a SoftLayer_Scale_Group record.
getPolicies
Retrieve collection of policies for this group. This can be empty.
getRegionalGroup
Retrieve the regional group for this scale group.
getStatus
Retrieve the status for this scale group.
getTerminationPolicy
Retrieve the termination policy for this scaling group.
getVirtualGuestAssets
Retrieve 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.
getVirtualGuestMembers
Retrieve 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.
resume
Resume this group.
scale
Scale this group up or down by the amount given.
scaleTo
Scale this group up or down to the number given.
suspend
Suspend this group.

/reference/services/SoftLayer_Scale_Group/