TrafficIPGroups
URI: http://soap.zeus.com/zxtm/1.0/TrafficIPGroups/
The TrafficIPGroup interface allows management of Traffic IP Group objects. Using this interface, you can create, delete and rename Traffic IP Group objects, and manage their configuration.
Methods
addBackEndTrafficIPAddresses( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
This method is now obsolete.
void addBackEndTrafficIPAddresses(
String[] names
String[][] values
)addIPAddresses( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Add new IP addresses to each of the named traffic IP groups.
void addIPAddresses(
String[] names
String[][] values
)addPassiveMachine( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Add machines to the lists of passive machines, for each of the named traffic IP groups.
void addPassiveMachine(
String[] names
String[][] values
)addTrafficIPGroup( names, details ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidInput, InvalidOperation
Add the new named Traffic IP Groups, using the provided details.
void addTrafficIPGroup(
String[] names
TrafficIPGroups.Details[] details
)addTrafficIPGroupWithMode( names, details ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidInput, InvalidOperation
Add the new named Traffic IP Groups, using the provided details.
void addTrafficIPGroupWithMode(
String[] names
TrafficIPGroups.DetailsV2[] details
)addTrafficManager( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new traffic managers to each of the named traffic IP groups.
void addTrafficManager(
String[] names
String[][] values
)deleteSpecificSubnetMappings( mappings ) throws InvalidInput
Delete specified interface network mappings.
void deleteSpecificSubnetMappings(
TrafficIPGroups.SubnetMappingPerHost[] mappings
)deleteSubnetMappings()
Delete all interface network mappings.
void deleteSubnetMappings()deleteTrafficIPGroup( names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError, InvalidOperation
Delete the named Traffic IP Groups.
void deleteTrafficIPGroup(
String[] names
)getAvailableTrafficManagers()
Get the names of all of the Traffic Managers in the cluster.
String[] getAvailableTrafficManagers()getBackEndTrafficIPAddresses( names ) throws ObjectDoesNotExist
This method is now obsolete.
String[][] getBackEndTrafficIPAddresses(
String[] names
)getEnabled( names ) throws ObjectDoesNotExist
Get whether this traffic IP group is enabled or not.
Boolean[] getEnabled(
String[] names
)getIPAddresses( names ) throws ObjectDoesNotExist
Get the IP addresses that are managed by each of the named traffic IP groups.
String[][] getIPAddresses(
String[] names
)getIPAssignmentMode( names ) throws ObjectDoesNotExist
Get the traffic IP distribution mode.
TrafficIPGroups.IPAssignmentMode[] getIPAssignmentMode(
String[] names
)getIPDistributionMode( names ) throws ObjectDoesNotExist
Get how traffic IPs will be distributed across the machines in the cluster. If "multihosted" mode is used, the multicast IP must be set first.
TrafficIPGroups.IPDistributionMode[] getIPDistributionMode(
String[] names
)getKeepTogether( names ) throws ObjectDoesNotExist
Get the KeepTogether attribute for each of the named traffic IP groups.
Boolean[] getKeepTogether(
String[] names
)getMulticastIP( names ) throws ObjectDoesNotExist
Get the multicast IP group that is used to share data across machines in the cluster. This setting is only used if the traffic IP is using 'multihosted' distribution mode.
String[] getMulticastIP(
String[] names
)getNetworkInterfaces()
Get a list of network interfaces for all machines in the cluster.
TrafficIPGroups.NetworkInterface[] getNetworkInterfaces()getNote( names ) throws ObjectDoesNotExist
Get the note for each of the named traffic IP groups.
String[] getNote(
String[] names
)getPassiveMachine( names ) throws ObjectDoesNotExist
Get the lists of passive machines in each of the named traffic IP groups.
String[][] getPassiveMachine(
String[] names
)getRhiBgpMetricBase( names ) throws ObjectDoesNotExist
Get the base BGP routing metric for this Traffic IP group.
Unsigned Integer[] getRhiBgpMetricBase(
String[] names
)getRhiBgpPassiveMetricOffset( names ) throws ObjectDoesNotExist
Get the BGP routing metric offset between active and passive traffic managers in this Traffic IP group.
Unsigned Integer[] getRhiBgpPassiveMetricOffset(
String[] names
)getRhiOspfv2MetricBase( names ) throws ObjectDoesNotExist
Get the base OSPFv2 routing metric for this Traffic IP group.
Unsigned Integer[] getRhiOspfv2MetricBase(
String[] names
)getRhiOspfv2PassiveMetricOffset( names ) throws ObjectDoesNotExist
Get the OSPFv2 routing metric offset between active and passive traffic managers in this Traffic IP group.
Unsigned Integer[] getRhiOspfv2PassiveMetricOffset(
String[] names
)getRhiProtocols( names ) throws ObjectDoesNotExist
Get the RHI protocols which may be used to advertise the addresses in the Traffic IP group.
String[] getRhiProtocols(
String[] names
)getSubnetMappings( hostnames ) throws InvalidInput
Get interface to CIDR subnet mappings.
TrafficIPGroups.SubnetMappingPerHost[] getSubnetMappings(
String[] hostnames
)getTrafficIPGroupNames()
Get the names of all of the configured Traffic IP Groups.
String[] getTrafficIPGroupNames()getTrafficManager( names ) throws ObjectDoesNotExist
Get the traffic managers that manage the IP addresses in each of the named traffic IP groups.
String[][] getTrafficManager(
String[] names
)getUseClientSourcePort( names ) throws ObjectDoesNotExist
Get whether the source port is taken into account when deciding which traffic manager should handle the request. This setting is only used if the Traffic IP is using 'multihosted' distribution mode.
Boolean[] getUseClientSourcePort(
String[] names
)removeBackEndTrafficIPAddresses( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
This method is now obsolete.
void removeBackEndTrafficIPAddresses(
String[] names
String[][] values
)removeIPAddresses( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Remove the named IP addresses from each of the named traffic IP groups.
void removeIPAddresses(
String[] names
String[][] values
)removePassiveMachine( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Remove the named machines from the list of passive machines, for each of the named traffic IP groups.
void removePassiveMachine(
String[] names
String[][] values
)removeTrafficManager( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidOperation
Remove the named traffic managers from each named traffic IP group.
void removeTrafficManager(
String[] names
String[][] values
)renameTrafficIPGroup( names, new_names ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Rename each of the named Traffic IP Groups.
void renameTrafficIPGroup(
String[] names
String[] new_names
)setBackEndTrafficIPAddresses( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
This method is now obsolete.
void setBackEndTrafficIPAddresses(
String[] names
String[][] values
)setEnabled( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Set whether this traffic IP group is enabled or not.
void setEnabled(
String[] names
Boolean[] values
)setIPAddresses( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the IP addresses that are managed by each of the named traffic IP groups.
void setIPAddresses(
String[] names
String[][] values
)setIPAssignmentMode( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the traffic IP distribution mode.
void setIPAssignmentMode(
String[] names
TrafficIPGroups.IPAssignmentMode[] values
)setIPDistributionMode( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set how traffic IPs will be distributed across the machines in the cluster. If "multihosted" mode is used, the multicast IP must be set first.
void setIPDistributionMode(
String[] names
TrafficIPGroups.IPDistributionMode[] values
)setKeepTogether( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Set the KeepTogether attribute for each of the named traffic IP groups.
void setKeepTogether(
String[] names
Boolean[] values
)setMulticastIP( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the multicast IP group that is used to share data across machines in the cluster. This setting is only used if the traffic IP is using 'multihosted' distribution mode.
void setMulticastIP(
String[] names
String[] values
)setNote( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the note for each of the named traffic IP groups.
void setNote(
String[] names
String[] values
)setPassiveMachine( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the lists of passive machines in each of the named traffic IP groups.
void setPassiveMachine(
String[] names
String[][] values
)setRhiBgpMetricBase( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the base BGP routing metric for this Traffic IP group.
void setRhiBgpMetricBase(
String[] names
Unsigned Integer[] values
)setRhiBgpPassiveMetricOffset( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the BGP routing metric offset between active and passive traffic managers in this Traffic IP group.
void setRhiBgpPassiveMetricOffset(
String[] names
Unsigned Integer[] values
)setRhiOspfv2MetricBase( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the base OSPFv2 routing metric for this Traffic IP group.
void setRhiOspfv2MetricBase(
String[] names
Unsigned Integer[] values
)setRhiOspfv2PassiveMetricOffset( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the OSPFv2 routing metric offset between active and passive traffic managers in this Traffic IP group.
void setRhiOspfv2PassiveMetricOffset(
String[] names
Unsigned Integer[] values
)setRhiProtocols( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the RHI protocols which may be used to advertise the addresses in the Traffic IP group.
void setRhiProtocols(
String[] names
String[] values
)setSubnetMappings( mappings ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Update interface to CIDR subnet mappings. Note: this function replaces your existing TrafficIP network mappings rather than adding to them. To avoid deleting any existing entries, you must include them in the specified update list.
void setSubnetMappings(
TrafficIPGroups.SubnetMappingPerHost[] mappings
)setTrafficManager( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the traffic managers that manage the IP addresses in each of the named traffic IP groups.
void setTrafficManager(
String[] names
String[][] values
)setUseClientSourcePort( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether the source port is taken into account when deciding which traffic manager should handle the request. This setting is only used if the Traffic IP is using 'multihosted' distribution mode.
void setUseClientSourcePort(
String[] names
Boolean[] values
)Structures
TrafficIPGroups.Details
This structure contains the basic details of a Traffic IP Group: the nodes, and the traffic managers that the Traffic IP group spans. It is used when creating a new Traffic IP Group.
struct TrafficIPGroups.Details {
# The IP addresses in the Traffic IP Group.
String[] ipaddresses;
# The names of the traffic managers that will manage the IP Addresses.
String[] machines;
}TrafficIPGroups.DetailsV2
This structure contains the basic details of a Traffic IP Group: the nodes, and the traffic managers that the Traffic IP group spans. It is used when creating a new Traffic IP Group.
struct TrafficIPGroups.DetailsV2 {
# The IP addresses in the Traffic IP Group.
String[] ipaddresses;
# The IP distribution mode of the traffic IP group.
TrafficIPGroups.IPDistributionMode mode;
# The multicast IP address of a multihosted traffic IP group.
String multicast;
# The names of the traffic managers that will manage the IP Addresses.
String[] machines;
# The names of the traffic managers that will be passive / standby members of
# the group.
String[] passive_machines;
}TrafficIPGroups.NetworkInterface
This structure displays the network interfaces of all machines in the cluster.
struct TrafficIPGroups.NetworkInterface {
# The traffic manager in the cluster.
String hostname;
# The network interfaces configured in this traffic manager.
String[] interfaces;
}TrafficIPGroups.SubnetMapping
This structure contains mappings of network interface to CIDR subnets. These mappings are used to raise a TrafficIP on a desired interface.
struct TrafficIPGroups.SubnetMapping {
# The interface on the system.
String interface;
# The subnets mappings for the interface.
String[] subnets;
}TrafficIPGroups.SubnetMappingPerHost
This structure shows the traffic IP subnet mapping per host machine in the cluster.
struct TrafficIPGroups.SubnetMappingPerHost {
# The traffic manager in the cluster.
String hostname;
# The subnets mappings for this traffic manager.
TrafficIPGroups.SubnetMapping[] subnetmappings;
}Enumerations
TrafficIPGroups.IPAssignmentMode
enum TrafficIPGroups.IPAssignmentMode {
# Alphabetical order of traffic manager hostnames
alphabetic,
# Approximately balanced between traffic managers
balanced
}TrafficIPGroups.IPDistributionMode
enum TrafficIPGroups.IPDistributionMode {
# Raise each address on a single machine (Single-Hosted mode)
singlehosted,
# Raise each address on every machine in the group (Multi-Hosted mode) - IPv4
# only
multihosted,
# Use route health injection to route traffic to the active machine - IPv4
# only
rhi,
# Use an EC2-Classic Elastic IP address.
ec2elastic,
# Use an EC2-VPC Elastic IP address.
ec2vpcelastic,
# Use an EC2-VPC Private IP address.
ec2vpcprivate,
# Use GCE External IP addresses.
gceexternal
}