Pool
URI: http://soap.zeus.com/zxtm/1.0/Pool/
The Pool interface allows management of Pool objects. Using this interface, you can create, delete and rename pool objects, and manage their configuration.
Methods
addAutoScaledPool( names, nodes ) throws ObjectAlreadyExists, InvalidObjectName, InvalidInput, DeploymentError
Add each of the named autoscaled pools, using the node lists for each. The node lists can be empty
void addAutoScaledPool(
String[] names
String[][] nodes
)addAutoscaleSecuritygroupids( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the security group IDs to associate to the new EC2 instances.
void addAutoscaleSecuritygroupids(
String[] names
String[][] values
)addAutoscaleSecuritygroupidsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the security group IDs to associate to the new EC2 instances. This is a location specific function, any action will operate on the specified location.
void addAutoscaleSecuritygroupidsByLocation(
String location
String[] names
String[][] values
)addAutoscaleSubnetids( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic.
void addAutoscaleSubnetids(
String[] names
String[][] values
)addAutoscaleSubnetidsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic. This is a location specific function, any action will operate on the specified location.
void addAutoscaleSubnetidsByLocation(
String location
String[] names
String[][] values
)addDNSAutoscaleHostnames( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the hostnames to be used for DNS-derived autoscaling
void addDNSAutoscaleHostnames(
String[] names
String[][] values
)addDNSAutoscaleHostnamesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the hostnames to be used for DNS-derived autoscaling This is a location specific function, any action will operate on the specified location.
void addDNSAutoscaleHostnamesByLocation(
String location
String[] names
String[][] values
)addDrainingNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add nodes to the lists of draining nodes, for each of the named pools.
void addDrainingNodes(
String[] names
String[][] values
)addDrainingNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add nodes to the lists of draining nodes, for each of the named pools. This is a location specific function, any action will operate on the specified location.
void addDrainingNodesByLocation(
String location
String[] names
String[][] values
)addMonitors( names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
Add monitors to each of the named pools.
void addMonitors(
String[] names
String[][] values
)addMonitorsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
Add monitors to each of the named pools. This is a location specific function, any action will operate on the specified location.
void addMonitorsByLocation(
String location
String[] names
String[][] values
)addNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add nodes to each of the named pools.
void addNodes(
String[] names
String[][] values
)addNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add nodes to each of the named pools. This is a location specific function, any action will operate on the specified location.
void addNodesByLocation(
String location
String[] names
String[][] values
)addPool( names, nodes ) throws ObjectAlreadyExists, InvalidObjectName, InvalidInput, DeploymentError
Add each of the named pools, using the node lists for each.
void addPool(
String[] names
String[][] nodes
)addSSLCommonNameMatch( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the list of names against which the 'common name' of the certificate is matched.
void addSSLCommonNameMatch(
String[] names
String[][] values
)addSSLCommonNameMatchByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Add the list of names against which the 'common name' of the certificate is matched. This is a location specific function, any action will operate on the specified location.
void addSSLCommonNameMatchByLocation(
String location
String[] names
String[][] values
)addServiceDiscoveryPool( names ) throws ObjectAlreadyExists, InvalidObjectName, InvalidInput, DeploymentError
Add each of the named Service Discovery based pools.
void addServiceDiscoveryPool(
String[] names
)copyPool( names, new_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, DeploymentError
Copy each of the named pools.
void copyPool(
String[] names
String[] new_names
)deletePool( names ) throws ObjectInUse, ObjectDoesNotExist, DeploymentError
Delete each of the named pools.
void deletePool(
String[] names
)disableNodes( names, nodes ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
For each of the named pools, disable the specified nodes in the pool.
void disableNodes(
String[] names
String[][] nodes
)disableNodesByLocation( location, names, nodes ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
For each of the named pools, disable the specified nodes in the pool. This is a location specific function, any action will operate on the specified location.
void disableNodesByLocation(
String location
String[] names
String[][] nodes
)enableNodes( names, nodes ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
For each of the named pools, enable the specified nodes that are disabled in the pool.
void enableNodes(
String[] names
String[][] nodes
)enableNodesByLocation( location, names, nodes ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
For each of the named pools, enable the specified nodes that are disabled in the pool. This is a location specific function, any action will operate on the specified location.
void enableNodesByLocation(
String location
String[] names
String[][] nodes
)getAutoscaleAddnodeDelaytime( names ) throws ObjectDoesNotExist
Get Delay in seconds before the node should be added to the autoscaled pool
Unsigned Integer[] getAutoscaleAddnodeDelaytime(
String[] names
)getAutoscaleAddnodeDelaytimeByLocation( location, names ) throws ObjectDoesNotExist
Get Delay in seconds before the node should be added to the autoscaled pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleAddnodeDelaytimeByLocation(
String location
String[] names
)getAutoscaleCloudcredentials( names ) throws ObjectDoesNotExist
Get the cloud credentials for this autoscaled pool
String[] getAutoscaleCloudcredentials(
String[] names
)getAutoscaleCloudcredentialsByLocation( location, names ) throws ObjectDoesNotExist
Get the cloud credentials for this autoscaled pool This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleCloudcredentialsByLocation(
String location
String[] names
)getAutoscaleCluster( names ) throws ObjectDoesNotExist
Get The ESX host or ESX cluster name to put the new virtual machine instances on.
String[] getAutoscaleCluster(
String[] names
)getAutoscaleClusterByLocation( location, names ) throws ObjectDoesNotExist
Get The ESX host or ESX cluster name to put the new virtual machine instances on. This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleClusterByLocation(
String location
String[] names
)getAutoscaleDatacenter( names ) throws ObjectDoesNotExist
Get The name of the logical datacenter on the vCenter server
String[] getAutoscaleDatacenter(
String[] names
)getAutoscaleDatacenterByLocation( location, names ) throws ObjectDoesNotExist
Get The name of the logical datacenter on the vCenter server This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleDatacenterByLocation(
String location
String[] names
)getAutoscaleDatastore( names ) throws ObjectDoesNotExist
Get The name of the datastore to be used by the newly created virtual machine.
String[] getAutoscaleDatastore(
String[] names
)getAutoscaleDatastoreByLocation( location, names ) throws ObjectDoesNotExist
Get The name of the datastore to be used by the newly created virtual machine. This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleDatastoreByLocation(
String location
String[] names
)getAutoscaleEnabled( names ) throws ObjectDoesNotExist
Get whether this pool uses autoscaling.
Boolean[] getAutoscaleEnabled(
String[] names
)getAutoscaleEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether this pool uses autoscaling. This is a location specific function, any action will operate on the specified location.
Boolean[] getAutoscaleEnabledByLocation(
String location
String[] names
)getAutoscaleExternal( names ) throws ObjectDoesNotExist
Get whether autoscaling is handled externally or internally
Boolean[] getAutoscaleExternal(
String[] names
)getAutoscaleExternalByLocation( location, names ) throws ObjectDoesNotExist
Get whether autoscaling is handled externally or internally This is a location specific function, any action will operate on the specified location.
Boolean[] getAutoscaleExternalByLocation(
String location
String[] names
)getAutoscaleExtraargs( names ) throws ObjectDoesNotExist
Get Any extra arguments to the autoscaling API. Each argument can be separated by comma. E.g in case of EC2, it can take extra parameters to the Amazon's RunInstance API say DisableApiTermination=false,Placement.Tenancy=default.
String[] getAutoscaleExtraargs(
String[] names
)getAutoscaleExtraargsByLocation( location, names ) throws ObjectDoesNotExist
Get Any extra arguments to the autoscaling API. Each argument can be separated by comma. E.g in case of EC2, it can take extra parameters to the Amazon's RunInstance API say DisableApiTermination=false,Placement.Tenancy=default. This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleExtraargsByLocation(
String location
String[] names
)getAutoscaleHysteresis( names ) throws ObjectDoesNotExist
Get the hysteresis period for an autoscaled pool
Unsigned Integer[] getAutoscaleHysteresis(
String[] names
)getAutoscaleHysteresisByLocation( location, names ) throws ObjectDoesNotExist
Get the hysteresis period for an autoscaled pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleHysteresisByLocation(
String location
String[] names
)getAutoscaleImageid( names ) throws ObjectDoesNotExist
Get the image identifier
String[] getAutoscaleImageid(
String[] names
)getAutoscaleImageidByLocation( location, names ) throws ObjectDoesNotExist
Get the image identifier This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleImageidByLocation(
String location
String[] names
)getAutoscaleIpstouse( names ) throws ObjectDoesNotExist
Get whether to use the public or private IPs
Pool.AutoscaleIpstouse[] getAutoscaleIpstouse(
String[] names
)getAutoscaleIpstouseByLocation( location, names ) throws ObjectDoesNotExist
Get whether to use the public or private IPs This is a location specific function, any action will operate on the specified location.
Pool.AutoscaleIpstouse[] getAutoscaleIpstouseByLocation(
String location
String[] names
)getAutoscaleLastnodeIdletime( names ) throws ObjectDoesNotExist
Get the idle time of the last node in an autoscaled pool before it can be destroyed
Unsigned Integer[] getAutoscaleLastnodeIdletime(
String[] names
)getAutoscaleLastnodeIdletimeByLocation( location, names ) throws ObjectDoesNotExist
Get the idle time of the last node in an autoscaled pool before it can be destroyed This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleLastnodeIdletimeByLocation(
String location
String[] names
)getAutoscaleMaxNodes( names ) throws ObjectDoesNotExist
Get the maximum number of nodes in an autoscaled pool
Unsigned Integer[] getAutoscaleMaxNodes(
String[] names
)getAutoscaleMaxNodesByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum number of nodes in an autoscaled pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleMaxNodesByLocation(
String location
String[] names
)getAutoscaleMinNodes( names ) throws ObjectDoesNotExist
Get the minimum number of nodes in an autoscaled pool
Unsigned Integer[] getAutoscaleMinNodes(
String[] names
)getAutoscaleMinNodesByLocation( location, names ) throws ObjectDoesNotExist
Get the minimum number of nodes in an autoscaled pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleMinNodesByLocation(
String location
String[] names
)getAutoscaleName( names ) throws ObjectDoesNotExist
Get the node name prefix for this autoscaled pool
String[] getAutoscaleName(
String[] names
)getAutoscaleNameByLocation( location, names ) throws ObjectDoesNotExist
Get the node name prefix for this autoscaled pool This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleNameByLocation(
String location
String[] names
)getAutoscalePort( names ) throws ObjectDoesNotExist
Get the port number for this autoscaled pool
Unsigned Integer[] getAutoscalePort(
String[] names
)getAutoscalePortByLocation( location, names ) throws ObjectDoesNotExist
Get the port number for this autoscaled pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscalePortByLocation(
String location
String[] names
)getAutoscaleRefractory( names ) throws ObjectDoesNotExist
Get the refractory period for an autoscaled pool
Unsigned Integer[] getAutoscaleRefractory(
String[] names
)getAutoscaleRefractoryByLocation( location, names ) throws ObjectDoesNotExist
Get the refractory period for an autoscaled pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleRefractoryByLocation(
String location
String[] names
)getAutoscaleResponseTime( names ) throws ObjectDoesNotExist
Get the expected node response time in milliseconds
Unsigned Integer[] getAutoscaleResponseTime(
String[] names
)getAutoscaleResponseTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the expected node response time in milliseconds This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleResponseTimeByLocation(
String location
String[] names
)getAutoscaleScaledownLevel( names ) throws ObjectDoesNotExist
Get the threshold of conforming requests for scaling down
Unsigned Integer[] getAutoscaleScaledownLevel(
String[] names
)getAutoscaleScaledownLevelByLocation( location, names ) throws ObjectDoesNotExist
Get the threshold of conforming requests for scaling down This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleScaledownLevelByLocation(
String location
String[] names
)getAutoscaleScaleupLevel( names ) throws ObjectDoesNotExist
Get the acceptable lower percentage of conforming requests
Unsigned Integer[] getAutoscaleScaleupLevel(
String[] names
)getAutoscaleScaleupLevelByLocation( location, names ) throws ObjectDoesNotExist
Get the acceptable lower percentage of conforming requests This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAutoscaleScaleupLevelByLocation(
String location
String[] names
)getAutoscaleSecuritygroupids( names ) throws ObjectDoesNotExist
Get the security group IDs to associate to the new EC2 instances.
String[][] getAutoscaleSecuritygroupids(
String[] names
)getAutoscaleSecuritygroupidsByLocation( location, names ) throws ObjectDoesNotExist
Get the security group IDs to associate to the new EC2 instances. This is a location specific function, any action will operate on the specified location.
String[][] getAutoscaleSecuritygroupidsByLocation(
String location
String[] names
)getAutoscaleSizeid( names ) throws ObjectDoesNotExist
Get the size identifier
String[] getAutoscaleSizeid(
String[] names
)getAutoscaleSizeidByLocation( location, names ) throws ObjectDoesNotExist
Get the size identifier This is a location specific function, any action will operate on the specified location.
String[] getAutoscaleSizeidByLocation(
String location
String[] names
)getAutoscaleSubnetids( names ) throws ObjectDoesNotExist
Get the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic.
String[][] getAutoscaleSubnetids(
String[] names
)getAutoscaleSubnetidsByLocation( location, names ) throws ObjectDoesNotExist
Get the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic. This is a location specific function, any action will operate on the specified location.
String[][] getAutoscaleSubnetidsByLocation(
String location
String[] names
)getBandwidthClass( names ) throws ObjectDoesNotExist
Get the Bandwidth Classes that each of the named pools uses.
String[] getBandwidthClass(
String[] names
)getBandwidthClassByLocation( location, names ) throws ObjectDoesNotExist
Get the Bandwidth Classes that each of the named pools uses. This is a location specific function, any action will operate on the specified location.
String[] getBandwidthClassByLocation(
String location
String[] names
)getDNSAutoscaleEnabled( names ) throws ObjectDoesNotExist
Get whether this pool uses DNS-derived autoscaling
Boolean[] getDNSAutoscaleEnabled(
String[] names
)getDNSAutoscaleEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether this pool uses DNS-derived autoscaling This is a location specific function, any action will operate on the specified location.
Boolean[] getDNSAutoscaleEnabledByLocation(
String location
String[] names
)getDNSAutoscaleHostnames( names ) throws ObjectDoesNotExist
Get the hostnames to be used for DNS-derived autoscaling
String[][] getDNSAutoscaleHostnames(
String[] names
)getDNSAutoscaleHostnamesByLocation( location, names ) throws ObjectDoesNotExist
Get the hostnames to be used for DNS-derived autoscaling This is a location specific function, any action will operate on the specified location.
String[][] getDNSAutoscaleHostnamesByLocation(
String location
String[] names
)getDNSAutoscalePort( names ) throws ObjectDoesNotExist
Get the port number for DNS-derived autoscaling in this pool
Unsigned Integer[] getDNSAutoscalePort(
String[] names
)getDNSAutoscalePortByLocation( location, names ) throws ObjectDoesNotExist
Get the port number for DNS-derived autoscaling in this pool This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getDNSAutoscalePortByLocation(
String location
String[] names
)getDisabledNodes( names ) throws ObjectDoesNotExist
For each of the named pools, get the disabled nodes in the pool.
String[][] getDisabledNodes(
String[] names
)getDisabledNodesByLocation( location, names ) throws ObjectDoesNotExist
For each of the named pools, get the disabled nodes in the pool. This is a location specific function, any action will operate on the specified location.
String[][] getDisabledNodesByLocation(
String location
String[] names
)getDrainingNodes( names ) throws ObjectDoesNotExist
Get the lists of draining nodes for each of the named pools.
String[][] getDrainingNodes(
String[] names
)getDrainingNodesByLocation( location, names ) throws ObjectDoesNotExist
Get the lists of draining nodes for each of the named pools. This is a location specific function, any action will operate on the specified location.
String[][] getDrainingNodesByLocation(
String location
String[] names
)getErrorFile( names ) throws ObjectDoesNotExist
This method is now obsolete and is replaced by VirtualServer.getErrorFile.
String[] getErrorFile(
String[] names
)getFTPSupportRfc2428( names ) throws ObjectDoesNotExist
Get whether backend IPv4 nodes understand the FTP EPRT and EPSV commands.
Boolean[] getFTPSupportRfc2428(
String[] names
)getFTPSupportRfc2428ByLocation( location, names ) throws ObjectDoesNotExist
Get whether backend IPv4 nodes understand the FTP EPRT and EPSV commands. This is a location specific function, any action will operate on the specified location.
Boolean[] getFTPSupportRfc2428ByLocation(
String location
String[] names
)getFailpool( names ) throws ObjectDoesNotExist
Get the pool to use when all nodes in a pool fail, for each of the named pools.
String[] getFailpool(
String[] names
)getFailpoolByLocation( location, names ) throws ObjectDoesNotExist
Get the pool to use when all nodes in a pool fail, for each of the named pools. This is a location specific function, any action will operate on the specified location.
String[] getFailpoolByLocation(
String location
String[] names
)getKeepalive( names ) throws ObjectDoesNotExist
Get whether each of the named pools should maintain HTTP keepalive connections to the nodes.
Boolean[] getKeepalive(
String[] names
)getKeepaliveByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should maintain HTTP keepalive connections to the nodes. This is a location specific function, any action will operate on the specified location.
Boolean[] getKeepaliveByLocation(
String location
String[] names
)getKeepaliveNonIdempotent( names ) throws ObjectDoesNotExist
Get whether each of the named pools should maintain HTTP keepalive connections to the nodes for non-idempotent requests.
Boolean[] getKeepaliveNonIdempotent(
String[] names
)getKeepaliveNonIdempotentByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should maintain HTTP keepalive connections to the nodes for non-idempotent requests. This is a location specific function, any action will operate on the specified location.
Boolean[] getKeepaliveNonIdempotentByLocation(
String location
String[] names
)getKerberosProtocolTransitionPrincipal( names ) throws ObjectDoesNotExist
Get the Kerberos principal that each of the named pools uses to perform Kerberos Protocol Transition
String[] getKerberosProtocolTransitionPrincipal(
String[] names
)getKerberosProtocolTransitionPrincipalByLocation( location, names ) throws ObjectDoesNotExist
Get the Kerberos principal that each of the named pools uses to perform Kerberos Protocol Transition This is a location specific function, any action will operate on the specified location.
String[] getKerberosProtocolTransitionPrincipalByLocation(
String location
String[] names
)getKerberosProtocolTransitionTarget( names ) throws ObjectDoesNotExist
Get the Kerberos principal name of the service that each of the named pools target
String[] getKerberosProtocolTransitionTarget(
String[] names
)getKerberosProtocolTransitionTargetByLocation( location, names ) throws ObjectDoesNotExist
Get the Kerberos principal name of the service that each of the named pools target This is a location specific function, any action will operate on the specified location.
String[] getKerberosProtocolTransitionTargetByLocation(
String location
String[] names
)getL4AccelSNAT( names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelSNAT(
String[] names
)getL4AccelSNATByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelSNATByLocation(
String location
String[] names
)getLoadBalancingAlgorithm( names ) throws ObjectDoesNotExist
Get the load balancing algorithms that each of the named pools uses.
Pool.LoadBalancingAlgorithm[] getLoadBalancingAlgorithm(
String[] names
)getLoadBalancingAlgorithmByLocation( location, names ) throws ObjectDoesNotExist
Get the load balancing algorithms that each of the named pools uses. This is a location specific function, any action will operate on the specified location.
Pool.LoadBalancingAlgorithm[] getLoadBalancingAlgorithmByLocation(
String location
String[] names
)getMaxConnectTime( names ) throws ObjectDoesNotExist
Get the time that each of the named pools should wait for a connection to establish to a node before trying another node, in seconds.
Unsigned Integer[] getMaxConnectTime(
String[] names
)getMaxConnectTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the time that each of the named pools should wait for a connection to establish to a node before trying another node, in seconds. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxConnectTimeByLocation(
String location
String[] names
)getMaxConnectionAttempts( names ) throws ObjectDoesNotExist
Get the number of times that each of the named pools can try to connect to any of its nodes before sending an error response.
Unsigned Integer[] getMaxConnectionAttempts(
String[] names
)getMaxConnectionAttemptsByLocation( location, names ) throws ObjectDoesNotExist
Get the number of times that each of the named pools can try to connect to any of its nodes before sending an error response. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxConnectionAttemptsByLocation(
String location
String[] names
)getMaxConnectionsPernode( names ) throws ObjectDoesNotExist
Get is the maximum number of conncurrent connections allowed to each node in the pool per machine.
Unsigned Integer[] getMaxConnectionsPernode(
String[] names
)getMaxConnectionsPernodeByLocation( location, names ) throws ObjectDoesNotExist
Get is the maximum number of conncurrent connections allowed to each node in the pool per machine. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxConnectionsPernodeByLocation(
String location
String[] names
)getMaxIdleConnectionsPerNode( names ) throws ObjectDoesNotExist
Get the maximum numbers of unused HTTP keepalive connections that each of the named pools should maintain to an individual node.
Unsigned Integer[] getMaxIdleConnectionsPerNode(
String[] names
)getMaxIdleConnectionsPerNodeByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum numbers of unused HTTP keepalive connections that each of the named pools should maintain to an individual node. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxIdleConnectionsPerNodeByLocation(
String location
String[] names
)getMaxKeepalivesPerNode( names ) throws ObjectDoesNotExist
getMaxKeepalivesPerNode is deprecated, please use getMaxIdleConnectionsPerNode instead.
Unsigned Integer[] getMaxKeepalivesPerNode(
String[] names
)getMaxKeepalivesPerNodeByLocation( location, names ) throws ObjectDoesNotExist
getMaxKeepalivesPerNode is deprecated, please use getMaxIdleConnectionsPerNode instead. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxKeepalivesPerNodeByLocation(
String location
String[] names
)getMaxQueueSize( names ) throws ObjectDoesNotExist
Get is the maximum number of connections that can be queued due to connection limits.
Unsigned Integer[] getMaxQueueSize(
String[] names
)getMaxQueueSizeByLocation( location, names ) throws ObjectDoesNotExist
Get is the maximum number of connections that can be queued due to connection limits. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxQueueSizeByLocation(
String location
String[] names
)getMaxReplyTime( names ) throws ObjectDoesNotExist
Get the time that each of the named pools should wait for a response from a node before either discarding the request or trying another node, in seconds (retryable requests only).
Unsigned Integer[] getMaxReplyTime(
String[] names
)getMaxReplyTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the time that each of the named pools should wait for a response from a node before either discarding the request or trying another node, in seconds (retryable requests only). This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxReplyTimeByLocation(
String location
String[] names
)getMaxTimedOutConnectionAttempts( names ) throws ObjectDoesNotExist
Get the number of times that each of the named pools can try to connect and time out waiting for a response, by exceeding max_reply_time, to any of its nodes before sending an error response.
Unsigned Integer[] getMaxTimedOutConnectionAttempts(
String[] names
)getMaxTimedOutConnectionAttemptsByLocation( location, names ) throws ObjectDoesNotExist
Get the number of times that each of the named pools can try to connect and time out waiting for a response, by exceeding max_reply_time, to any of its nodes before sending an error response. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxTimedOutConnectionAttemptsByLocation(
String location
String[] names
)getMaxTransactionsPerNode( names ) throws ObjectDoesNotExist
Get the maximum number of concurrent transactions allowed to each node in the pool per machine.
Unsigned Integer[] getMaxTransactionsPerNode(
String[] names
)getMaxTransactionsPerNodeByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum number of concurrent transactions allowed to each node in the pool per machine. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxTransactionsPerNodeByLocation(
String location
String[] names
)getMonitors( names ) throws ObjectDoesNotExist
Get the list of all monitors.
String[][] getMonitors(
String[] names
)getMonitorsByLocation( location, names ) throws ObjectDoesNotExist
Get the list of all monitors. This is a location specific function, any action will operate on the specified location.
String[][] getMonitorsByLocation(
String location
String[] names
)getNodeCloseWithRst( names ) throws ObjectDoesNotExist
Get whether connections to the back-end nodes should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state.
Boolean[] getNodeCloseWithRst(
String[] names
)getNodeCloseWithRstByLocation( location, names ) throws ObjectDoesNotExist
Get whether connections to the back-end nodes should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state. This is a location specific function, any action will operate on the specified location.
Boolean[] getNodeCloseWithRstByLocation(
String location
String[] names
)getNodeConnClose( names ) throws ObjectDoesNotExist
Get whether all connections that have been sent to a node are closed when that node is marked as dead.
Boolean[] getNodeConnClose(
String[] names
)getNodeConnCloseByLocation( location, names ) throws ObjectDoesNotExist
Get whether all connections that have been sent to a node are closed when that node is marked as dead. This is a location specific function, any action will operate on the specified location.
Boolean[] getNodeConnCloseByLocation(
String location
String[] names
)getNodeConnectionAttempts( names ) throws ObjectDoesNotExist
Get the number of times your traffic manager should try and connect to a node before registering it as failed when passive monitoring is enabled.
Unsigned Integer[] getNodeConnectionAttempts(
String[] names
)getNodeConnectionAttemptsByLocation( location, names ) throws ObjectDoesNotExist
Get the number of times your traffic manager should try and connect to a node before registering it as failed when passive monitoring is enabled. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getNodeConnectionAttemptsByLocation(
String location
String[] names
)getNodeDeleteBehavior( names ) throws ObjectDoesNotExist
Get the deletion behavior for nodes in a pool.
Pool.NodeDeleteBehavior[] getNodeDeleteBehavior(
String[] names
)getNodeDeleteBehaviorByLocation( location, names ) throws ObjectDoesNotExist
Get the deletion behavior for nodes in a pool. This is a location specific function, any action will operate on the specified location.
Pool.NodeDeleteBehavior[] getNodeDeleteBehaviorByLocation(
String location
String[] names
)getNodeDrainToDeleteTimeout( names ) throws ObjectDoesNotExist
Get the maximum time that a node will be allowed to remain in a draining state after it has been deleted. A value of 0 means no maximum time.
Unsigned Integer[] getNodeDrainToDeleteTimeout(
String[] names
)getNodeDrainToDeleteTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum time that a node will be allowed to remain in a draining state after it has been deleted. A value of 0 means no maximum time. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getNodeDrainToDeleteTimeoutByLocation(
String location
String[] names
)getNodeFailTime( names ) throws ObjectDoesNotExist
Get the length of time a failed node should be isolated for before testing it with new traffic, in seconds
Unsigned Integer[] getNodeFailTime(
String[] names
)getNodeFailTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the length of time a failed node should be isolated for before testing it with new traffic, in seconds This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getNodeFailTimeByLocation(
String location
String[] names
)getNodeUseNagle( names ) throws ObjectDoesNotExist
Get whether Nagle's algorithm should be used for TCP connections to the back-end nodes.
Boolean[] getNodeUseNagle(
String[] names
)getNodeUseNagleByLocation( location, names ) throws ObjectDoesNotExist
Get whether Nagle's algorithm should be used for TCP connections to the back-end nodes. This is a location specific function, any action will operate on the specified location.
Boolean[] getNodeUseNagleByLocation(
String location
String[] names
)getNodes( names ) throws ObjectDoesNotExist
Get the lists of nodes for each of the named pools.
String[][] getNodes(
String[] names
)getNodesByLocation( location, names ) throws ObjectDoesNotExist
Get the lists of nodes for each of the named pools. This is a location specific function, any action will operate on the specified location.
String[][] getNodesByLocation(
String location
String[] names
)getNodesConnectionCounts( nodes )
Get the number of active connections to each of the specified nodes.
Integer[] getNodesConnectionCounts(
String[] nodes
)getNodesLastUsed( nodes )
Get the number of seconds since each of the specified nodes was last used.
Integer[] getNodesLastUsed(
String[] nodes
)getNodesPriorityValue( names, nodes ) throws ObjectDoesNotExist
For each of the named pools, get the priority values for the named nodes in each pool.
Pool.PriorityValueDefinition[][] getNodesPriorityValue(
String[] names
String[][] nodes
)getNodesPriorityValueByLocation( location, names, nodes ) throws ObjectDoesNotExist
For each of the named pools, get the priority values for the named nodes in each pool. This is a location specific function, any action will operate on the specified location.
Pool.PriorityValueDefinition[][] getNodesPriorityValueByLocation(
String location
String[] names
String[][] nodes
)getNodesWeightings( names, nodes ) throws ObjectDoesNotExist
For each of the named pools, get the weighting values for the specified nodes in this pool.
Pool.WeightingsDefinition[][] getNodesWeightings(
String[] names
String[][] nodes
)getNodesWeightingsByLocation( location, names, nodes ) throws ObjectDoesNotExist
For each of the named pools, get the weighting values for the specified nodes in this pool. This is a location specific function, any action will operate on the specified location.
Pool.WeightingsDefinition[][] getNodesWeightingsByLocation(
String location
String[] names
String[][] nodes
)getNote( names ) throws ObjectDoesNotExist
Get the note for each of the named pools.
String[] getNote(
String[] names
)getPassiveMonitoring( names ) throws ObjectDoesNotExist
Get whether this pool uses passive monitoring.
Boolean[] getPassiveMonitoring(
String[] names
)getPassiveMonitoringByLocation( location, names ) throws ObjectDoesNotExist
Get whether this pool uses passive monitoring. This is a location specific function, any action will operate on the specified location.
Boolean[] getPassiveMonitoringByLocation(
String location
String[] names
)getPersistence( names ) throws ObjectDoesNotExist
Get the default Session Persistence classes that each of the named pools uses.
String[] getPersistence(
String[] names
)getPersistenceByLocation( location, names ) throws ObjectDoesNotExist
Get the default Session Persistence classes that each of the named pools uses. This is a location specific function, any action will operate on the specified location.
String[] getPersistenceByLocation(
String location
String[] names
)getPoolNames()
Get the names of all of the configured pools.
String[] getPoolNames()getPriorityEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named pools uses priority lists.
Boolean[] getPriorityEnabled(
String[] names
)getPriorityEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools uses priority lists. This is a location specific function, any action will operate on the specified location.
Boolean[] getPriorityEnabledByLocation(
String location
String[] names
)getPriorityNodes( names ) throws ObjectDoesNotExist
Get the minimum number of highest-priority active nodes, for each of the named pools.
Unsigned Integer[] getPriorityNodes(
String[] names
)getPriorityNodesByLocation( location, names ) throws ObjectDoesNotExist
Get the minimum number of highest-priority active nodes, for each of the named pools. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getPriorityNodesByLocation(
String location
String[] names
)getPriorityValues( names ) throws ObjectDoesNotExist
For each of the named pools, get the priority values for each of the nodes in each pool.
Pool.PriorityValueDefinition[][] getPriorityValues(
String[] names
)getPriorityValuesByLocation( location, names ) throws ObjectDoesNotExist
For each of the named pools, get the priority values for each of the nodes in each pool. This is a location specific function, any action will operate on the specified location.
Pool.PriorityValueDefinition[][] getPriorityValuesByLocation(
String location
String[] names
)getQueueTimeout( names ) throws ObjectDoesNotExist
Get is the maximum time to keep a connections queued in seconds. A value of 0 will not timeout queued connections.
Unsigned Integer[] getQueueTimeout(
String[] names
)getQueueTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get is the maximum time to keep a connections queued in seconds. A value of 0 will not timeout queued connections. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getQueueTimeoutByLocation(
String location
String[] names
)getSMTPSendStartTLS( names ) throws ObjectDoesNotExist
Get whether each of the named pools should upgrade SMTP connections to SSL using STARTTLS (the alternative is to encrypt the entire connection).
Boolean[] getSMTPSendStartTLS(
String[] names
)getSMTPSendStartTLSByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should upgrade SMTP connections to SSL using STARTTLS (the alternative is to encrypt the entire connection). This is a location specific function, any action will operate on the specified location.
Boolean[] getSMTPSendStartTLSByLocation(
String location
String[] names
)getSSLCipherSuites( names ) throws ObjectDoesNotExist
Get the SSL/TLS cipher suites allowed for connections to a back-end node
String[] getSSLCipherSuites(
String[] names
)getSSLCipherSuitesByLocation( location, names ) throws ObjectDoesNotExist
Get the SSL/TLS cipher suites allowed for connections to a back-end node This is a location specific function, any action will operate on the specified location.
String[] getSSLCipherSuitesByLocation(
String location
String[] names
)getSSLCiphers( names ) throws ObjectDoesNotExist
This method is deprecated, and has been replaced with Pool.getSSLCipherSuites.
String[] getSSLCiphers(
String[] names
)getSSLCiphersByLocation( location, names ) throws ObjectDoesNotExist
This method is deprecated, and has been replaced with Pool.getSSLCipherSuites. This is a location specific function, any action will operate on the specified location.
String[] getSSLCiphersByLocation(
String location
String[] names
)getSSLClientAuth( names ) throws ObjectDoesNotExist
Get whether each of the named pools should use client authentication. If client authentication is enabled and a back-end node asks for a client authentication, a suitable certificate and private key will be used from the SSL Client Certificates catalog.
Boolean[] getSSLClientAuth(
String[] names
)getSSLClientAuthByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should use client authentication. If client authentication is enabled and a back-end node asks for a client authentication, a suitable certificate and private key will be used from the SSL Client Certificates catalog. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLClientAuthByLocation(
String location
String[] names
)getSSLCommonNameMatch( names ) throws ObjectDoesNotExist
Get the list of names against which the 'common name' of the certificate is matched.
String[][] getSSLCommonNameMatch(
String[] names
)getSSLCommonNameMatchByLocation( location, names ) throws ObjectDoesNotExist
Get the list of names against which the 'common name' of the certificate is matched. This is a location specific function, any action will operate on the specified location.
String[][] getSSLCommonNameMatchByLocation(
String location
String[] names
)getSSLEllipticCurves( names ) throws ObjectDoesNotExist
Get the elliptic curve preference list for SSL connections from this pool
String[] getSSLEllipticCurves(
String[] names
)getSSLEllipticCurvesByLocation( location, names ) throws ObjectDoesNotExist
Get the elliptic curve preference list for SSL connections from this pool This is a location specific function, any action will operate on the specified location.
String[] getSSLEllipticCurvesByLocation(
String location
String[] names
)getSSLEncrypt( names ) throws ObjectDoesNotExist
Get whether each of the named pools should encrypt data to the back-end nodes using SSL.
Boolean[] getSSLEncrypt(
String[] names
)getSSLEncryptByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should encrypt data to the back-end nodes using SSL. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLEncryptByLocation(
String location
String[] names
)getSSLEnhance( names ) throws ObjectDoesNotExist
Get whether each of the named pools should use SSL protocol enhancements. These enhancements allow Virtual Traffic Manager virtual servers to discover the original client's IP address. Only use enable this if, for this pool, you are using vTMs whose virtual servers have the 'ssl_trust_magic' setting enabled.
Boolean[] getSSLEnhance(
String[] names
)getSSLEnhanceByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should use SSL protocol enhancements. These enhancements allow Virtual Traffic Manager virtual servers to discover the original client's IP address. Only use enable this if, for this pool, you are using vTMs whose virtual servers have the 'ssl_trust_magic' setting enabled. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLEnhanceByLocation(
String location
String[] names
)getSSLFixedClientCert( names ) throws ObjectDoesNotExist
Get the fixed client certificate to be used whenever client certificate authentication is requested.
String[] getSSLFixedClientCert(
String[] names
)getSSLFixedClientCertByLocation( location, names ) throws ObjectDoesNotExist
Get the fixed client certificate to be used whenever client certificate authentication is requested. This is a location specific function, any action will operate on the specified location.
String[] getSSLFixedClientCertByLocation(
String location
String[] names
)getSSLMiddleboxCompatibility( names ) throws ObjectDoesNotExist
Get whether use of TLS 1.3 middlebox compatibility mode is enabled for this pool
Pool.SSLMiddleboxCompatibility[] getSSLMiddleboxCompatibility(
String[] names
)getSSLMiddleboxCompatibilityByLocation( location, names ) throws ObjectDoesNotExist
Get whether use of TLS 1.3 middlebox compatibility mode is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLMiddleboxCompatibility[] getSSLMiddleboxCompatibilityByLocation(
String location
String[] names
)getSSLSendCloseAlerts( names ) throws ObjectDoesNotExist
Get whether each of the named pools should send a close alert when they initiate socket disconnections.
Boolean[] getSSLSendCloseAlerts(
String[] names
)getSSLSendCloseAlertsByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should send a close alert when they initiate socket disconnections. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLSendCloseAlertsByLocation(
String location
String[] names
)getSSLServerNameExtension( names ) throws ObjectDoesNotExist
Get if we should send the server_name extension to the back-end node. This setting forces the use of at least TLS 1.0.
Boolean[] getSSLServerNameExtension(
String[] names
)getSSLServerNameExtensionByLocation( location, names ) throws ObjectDoesNotExist
Get if we should send the server_name extension to the back-end node. This setting forces the use of at least TLS 1.0. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLServerNameExtensionByLocation(
String location
String[] names
)getSSLSessionCacheEnabled( names ) throws ObjectDoesNotExist
Get whether use of the session cache is enabled for this pool
Pool.SSLSessionCacheEnabled[] getSSLSessionCacheEnabled(
String[] names
)getSSLSessionCacheEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether use of the session cache is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLSessionCacheEnabled[] getSSLSessionCacheEnabledByLocation(
String location
String[] names
)getSSLSessionTicketsEnabled( names ) throws ObjectDoesNotExist
Get whether connections to the back-end nodes should use SSL session tickets
Pool.SSLSessionTicketsEnabled[] getSSLSessionTicketsEnabled(
String[] names
)getSSLSessionTicketsEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether connections to the back-end nodes should use SSL session tickets This is a location specific function, any action will operate on the specified location.
Pool.SSLSessionTicketsEnabled[] getSSLSessionTicketsEnabledByLocation(
String location
String[] names
)getSSLSignatureAlgorithms( names ) throws ObjectDoesNotExist
Get the SSL signature algorithms preference list for SSL connections from this pool
String[] getSSLSignatureAlgorithms(
String[] names
)getSSLSignatureAlgorithmsByLocation( location, names ) throws ObjectDoesNotExist
Get the SSL signature algorithms preference list for SSL connections from this pool This is a location specific function, any action will operate on the specified location.
String[] getSSLSignatureAlgorithmsByLocation(
String location
String[] names
)getSSLStrictVerify( names ) throws ObjectDoesNotExist
Get whether each of the named pools should perform strict certificate validation on SSL certificates from the back-end nodes.
Boolean[] getSSLStrictVerify(
String[] names
)getSSLStrictVerifyByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should perform strict certificate validation on SSL certificates from the back-end nodes. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLStrictVerifyByLocation(
String location
String[] names
)getSSLSupportSSL2( names ) throws ObjectDoesNotExist
This method is now deprecated.
Pool.SSLSupportSSL2[] getSSLSupportSSL2(
String[] names
)getSSLSupportSSL2ByLocation( location, names ) throws ObjectDoesNotExist
This method is now deprecated. This is a location specific function, any action will operate on the specified location.
Pool.SSLSupportSSL2[] getSSLSupportSSL2ByLocation(
String location
String[] names
)getSSLSupportSSL3( names ) throws ObjectDoesNotExist
Get whether SSLv3 is enabled for this pool
Pool.SSLSupportSSL3[] getSSLSupportSSL3(
String[] names
)getSSLSupportSSL3ByLocation( location, names ) throws ObjectDoesNotExist
Get whether SSLv3 is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLSupportSSL3[] getSSLSupportSSL3ByLocation(
String location
String[] names
)getSSLSupportTLS1( names ) throws ObjectDoesNotExist
Get whether TLSv1.0 is enabled for this pool
Pool.SSLSupportTLS1[] getSSLSupportTLS1(
String[] names
)getSSLSupportTLS11( names ) throws ObjectDoesNotExist
Get whether TLSv1.1 is enabled for this pool
Pool.SSLSupportTLS11[] getSSLSupportTLS11(
String[] names
)getSSLSupportTLS11ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.1 is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLSupportTLS11[] getSSLSupportTLS11ByLocation(
String location
String[] names
)getSSLSupportTLS12( names ) throws ObjectDoesNotExist
Get whether TLSv1.2 is enabled for this pool
Pool.SSLSupportTLS12[] getSSLSupportTLS12(
String[] names
)getSSLSupportTLS12ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.2 is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLSupportTLS12[] getSSLSupportTLS12ByLocation(
String location
String[] names
)getSSLSupportTLS13( names ) throws ObjectDoesNotExist
Get whether TLSv1.3 is enabled for this pool
Pool.SSLSupportTLS13[] getSSLSupportTLS13(
String[] names
)getSSLSupportTLS13ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.3 is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLSupportTLS13[] getSSLSupportTLS13ByLocation(
String location
String[] names
)getSSLSupportTLS1ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.0 is enabled for this pool This is a location specific function, any action will operate on the specified location.
Pool.SSLSupportTLS1[] getSSLSupportTLS1ByLocation(
String location
String[] names
)getServiceDiscoveryEnabled( names ) throws ObjectDoesNotExist
Get whether this pool uses Service Discovery.
Boolean[] getServiceDiscoveryEnabled(
String[] names
)getServiceDiscoveryInterval( names ) throws ObjectDoesNotExist
Get the poll interval of the Service Discovery plugin for this pool
Unsigned Integer[] getServiceDiscoveryInterval(
String[] names
)getServiceDiscoveryPlugin( names ) throws ObjectDoesNotExist
Get the plugin used by this pool for Service Discovery.
String[] getServiceDiscoveryPlugin(
String[] names
)getServiceDiscoveryPluginArgs( names ) throws ObjectDoesNotExist
Get the arguments used by the pool's Service Discovery plugin
String[] getServiceDiscoveryPluginArgs(
String[] names
)getServiceDiscoveryTimeout( names ) throws ObjectDoesNotExist
Get the timeout of the Service Discovery plugin for this pool
Unsigned Integer[] getServiceDiscoveryTimeout(
String[] names
)getTransparent( names ) throws ObjectDoesNotExist
Get whether each of the named pools should make connections to the back-ends appear to originate from the source client IP address.
Boolean[] getTransparent(
String[] names
)getTransparentByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named pools should make connections to the back-ends appear to originate from the source client IP address. This is a location specific function, any action will operate on the specified location.
Boolean[] getTransparentByLocation(
String location
String[] names
)getUDPAcceptFrom( names ) throws ObjectDoesNotExist
Get what sets of IP addresses and ports from which we should accept UDP responses.
Pool.UDPAcceptFrom[] getUDPAcceptFrom(
String[] names
)getUDPAcceptFromByLocation( location, names ) throws ObjectDoesNotExist
Get what sets of IP addresses and ports from which we should accept UDP responses. This is a location specific function, any action will operate on the specified location.
Pool.UDPAcceptFrom[] getUDPAcceptFromByLocation(
String location
String[] names
)getUDPAcceptFromIPMask( names ) throws ObjectDoesNotExist
Get the mask to validate the IP of UDP responses with. Only used if UDPAcceptFromIP is set to 'ip_mask'.
String[] getUDPAcceptFromIPMask(
String[] names
)getUDPAcceptFromIPMaskByLocation( location, names ) throws ObjectDoesNotExist
Get the mask to validate the IP of UDP responses with. Only used if UDPAcceptFromIP is set to 'ip_mask'. This is a location specific function, any action will operate on the specified location.
String[] getUDPAcceptFromIPMaskByLocation(
String location
String[] names
)getUDPResponseTimeout( names ) throws ObjectDoesNotExist
Get the maximum delay in replying before a node receiving UDP packets is assumed to have failed.
Unsigned Integer[] getUDPResponseTimeout(
String[] names
)getUDPResponseTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum delay in replying before a node receiving UDP packets is assumed to have failed. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getUDPResponseTimeoutByLocation(
String location
String[] names
)getWeightings( names ) throws ObjectDoesNotExist
For each of the named pools, get the weightings for each of the nodes in each pool.
Pool.WeightingsDefinition[][] getWeightings(
String[] names
)getWeightingsByLocation( location, names ) throws ObjectDoesNotExist
For each of the named pools, get the weightings for each of the nodes in each pool. This is a location specific function, any action will operate on the specified location.
Pool.WeightingsDefinition[][] getWeightingsByLocation(
String location
String[] names
)removeAutoscaleSecuritygroupids( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the security group IDs to associate to the new EC2 instances.
void removeAutoscaleSecuritygroupids(
String[] names
String[][] values
)removeAutoscaleSecuritygroupidsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the security group IDs to associate to the new EC2 instances. This is a location specific function, any action will operate on the specified location.
void removeAutoscaleSecuritygroupidsByLocation(
String location
String[] names
String[][] values
)removeAutoscaleSubnetids( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic.
void removeAutoscaleSubnetids(
String[] names
String[][] values
)removeAutoscaleSubnetidsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic. This is a location specific function, any action will operate on the specified location.
void removeAutoscaleSubnetidsByLocation(
String location
String[] names
String[][] values
)removeDNSAutoscaleHostnames( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the hostnames to be used for DNS-derived autoscaling
void removeDNSAutoscaleHostnames(
String[] names
String[][] values
)removeDNSAutoscaleHostnamesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the hostnames to be used for DNS-derived autoscaling This is a location specific function, any action will operate on the specified location.
void removeDNSAutoscaleHostnamesByLocation(
String location
String[] names
String[][] values
)removeDrainingNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove nodes from the lists of draining nodes, for each of the named pools.
void removeDrainingNodes(
String[] names
String[][] values
)removeDrainingNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove nodes from the lists of draining nodes, for each of the named pools. This is a location specific function, any action will operate on the specified location.
void removeDrainingNodesByLocation(
String location
String[] names
String[][] values
)removeMonitors( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove monitors from each of the named pools.
void removeMonitors(
String[] names
String[][] values
)removeMonitorsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove monitors from each of the named pools. This is a location specific function, any action will operate on the specified location.
void removeMonitorsByLocation(
String location
String[] names
String[][] values
)removeNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove nodes from each of the named pools.
void removeNodes(
String[] names
String[][] values
)removeNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove nodes from each of the named pools. This is a location specific function, any action will operate on the specified location.
void removeNodesByLocation(
String location
String[] names
String[][] values
)removeSSLCommonNameMatch( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the list of names against which the 'common name' of the certificate is matched.
void removeSSLCommonNameMatch(
String[] names
String[][] values
)removeSSLCommonNameMatchByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Remove the list of names against which the 'common name' of the certificate is matched. This is a location specific function, any action will operate on the specified location.
void removeSSLCommonNameMatchByLocation(
String location
String[] names
String[][] values
)renamePool( names, new_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation
Rename each of the named pools.
void renamePool(
String[] names
String[] new_names
)setAutoscaleAddnodeDelaytime( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set Delay in seconds before the node should be added to the autoscaled pool
void setAutoscaleAddnodeDelaytime(
String[] names
Unsigned Integer[] values
)setAutoscaleAddnodeDelaytimeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set Delay in seconds before the node should be added to the autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleAddnodeDelaytimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleCloudcredentials( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the cloud credentials for this autoscaled pool
void setAutoscaleCloudcredentials(
String[] names
String[] values
)setAutoscaleCloudcredentialsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the cloud credentials for this autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleCloudcredentialsByLocation(
String location
String[] names
String[] values
)setAutoscaleCluster( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set The ESX host or ESX cluster name to put the new virtual machine instances on.
void setAutoscaleCluster(
String[] names
String[] values
)setAutoscaleClusterByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set The ESX host or ESX cluster name to put the new virtual machine instances on. This is a location specific function, any action will operate on the specified location.
void setAutoscaleClusterByLocation(
String location
String[] names
String[] values
)setAutoscaleDatacenter( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set The name of the logical datacenter on the vCenter server
void setAutoscaleDatacenter(
String[] names
String[] values
)setAutoscaleDatacenterByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set The name of the logical datacenter on the vCenter server This is a location specific function, any action will operate on the specified location.
void setAutoscaleDatacenterByLocation(
String location
String[] names
String[] values
)setAutoscaleDatastore( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set The name of the datastore to be used by the newly created virtual machine.
void setAutoscaleDatastore(
String[] names
String[] values
)setAutoscaleDatastoreByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set The name of the datastore to be used by the newly created virtual machine. This is a location specific function, any action will operate on the specified location.
void setAutoscaleDatastoreByLocation(
String location
String[] names
String[] values
)setAutoscaleEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses autoscaling.
void setAutoscaleEnabled(
String[] names
Boolean[] values
)setAutoscaleEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses autoscaling. This is a location specific function, any action will operate on the specified location.
void setAutoscaleEnabledByLocation(
String location
String[] names
Boolean[] values
)setAutoscaleExternal( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether autoscaling is handled externally or internally
void setAutoscaleExternal(
String[] names
Boolean[] values
)setAutoscaleExternalByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether autoscaling is handled externally or internally This is a location specific function, any action will operate on the specified location.
void setAutoscaleExternalByLocation(
String location
String[] names
Boolean[] values
)setAutoscaleExtraargs( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set Any extra arguments to the autoscaling API. Each argument can be separated by comma. E.g in case of EC2, it can take extra parameters to the Amazon's RunInstance API say DisableApiTermination=false,Placement.Tenancy=default.
void setAutoscaleExtraargs(
String[] names
String[] values
)setAutoscaleExtraargsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set Any extra arguments to the autoscaling API. Each argument can be separated by comma. E.g in case of EC2, it can take extra parameters to the Amazon's RunInstance API say DisableApiTermination=false,Placement.Tenancy=default. This is a location specific function, any action will operate on the specified location.
void setAutoscaleExtraargsByLocation(
String location
String[] names
String[] values
)setAutoscaleHysteresis( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the hysteresis period for an autoscaled pool
void setAutoscaleHysteresis(
String[] names
Unsigned Integer[] values
)setAutoscaleHysteresisByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the hysteresis period for an autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleHysteresisByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleImageid( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the image identifier
void setAutoscaleImageid(
String[] names
String[] values
)setAutoscaleImageidByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the image identifier This is a location specific function, any action will operate on the specified location.
void setAutoscaleImageidByLocation(
String location
String[] names
String[] values
)setAutoscaleIpstouse( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether to use the public or private IPs
void setAutoscaleIpstouse(
String[] names
Pool.AutoscaleIpstouse[] values
)setAutoscaleIpstouseByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether to use the public or private IPs This is a location specific function, any action will operate on the specified location.
void setAutoscaleIpstouseByLocation(
String location
String[] names
Pool.AutoscaleIpstouse[] values
)setAutoscaleLastnodeIdletime( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the idle time of the last node in an autoscaled pool before it can be destroyed
void setAutoscaleLastnodeIdletime(
String[] names
Unsigned Integer[] values
)setAutoscaleLastnodeIdletimeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the idle time of the last node in an autoscaled pool before it can be destroyed This is a location specific function, any action will operate on the specified location.
void setAutoscaleLastnodeIdletimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleMaxNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum number of nodes in an autoscaled pool
void setAutoscaleMaxNodes(
String[] names
Unsigned Integer[] values
)setAutoscaleMaxNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum number of nodes in an autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleMaxNodesByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleMinNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the minimum number of nodes in an autoscaled pool
void setAutoscaleMinNodes(
String[] names
Unsigned Integer[] values
)setAutoscaleMinNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the minimum number of nodes in an autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleMinNodesByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleName( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the node name prefix for this autoscaled pool
void setAutoscaleName(
String[] names
String[] values
)setAutoscaleNameByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the node name prefix for this autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleNameByLocation(
String location
String[] names
String[] values
)setAutoscalePort( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the port number for this autoscaled pool
void setAutoscalePort(
String[] names
Unsigned Integer[] values
)setAutoscalePortByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the port number for this autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscalePortByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleRefractory( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the refractory period for an autoscaled pool
void setAutoscaleRefractory(
String[] names
Unsigned Integer[] values
)setAutoscaleRefractoryByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the refractory period for an autoscaled pool This is a location specific function, any action will operate on the specified location.
void setAutoscaleRefractoryByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleResponseTime( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the expected node response time in milliseconds
void setAutoscaleResponseTime(
String[] names
Unsigned Integer[] values
)setAutoscaleResponseTimeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the expected node response time in milliseconds This is a location specific function, any action will operate on the specified location.
void setAutoscaleResponseTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleScaledownLevel( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the threshold of conforming requests for scaling down
void setAutoscaleScaledownLevel(
String[] names
Unsigned Integer[] values
)setAutoscaleScaledownLevelByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the threshold of conforming requests for scaling down This is a location specific function, any action will operate on the specified location.
void setAutoscaleScaledownLevelByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleScaleupLevel( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the acceptable lower percentage of conforming requests
void setAutoscaleScaleupLevel(
String[] names
Unsigned Integer[] values
)setAutoscaleScaleupLevelByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the acceptable lower percentage of conforming requests This is a location specific function, any action will operate on the specified location.
void setAutoscaleScaleupLevelByLocation(
String location
String[] names
Unsigned Integer[] values
)setAutoscaleSecuritygroupids( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the security group IDs to associate to the new EC2 instances.
void setAutoscaleSecuritygroupids(
String[] names
String[][] values
)setAutoscaleSecuritygroupidsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the security group IDs to associate to the new EC2 instances. This is a location specific function, any action will operate on the specified location.
void setAutoscaleSecuritygroupidsByLocation(
String location
String[] names
String[][] values
)setAutoscaleSizeid( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the size identifier
void setAutoscaleSizeid(
String[] names
String[] values
)setAutoscaleSizeidByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the size identifier This is a location specific function, any action will operate on the specified location.
void setAutoscaleSizeidByLocation(
String location
String[] names
String[] values
)setAutoscaleSubnetids( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic.
void setAutoscaleSubnetids(
String[] names
String[][] values
)setAutoscaleSubnetidsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the list of subnet IDs where the new EC2-VPC instances will be launched. Instances will be evenly distributed among the subnets. If the list is empty, instances will be launched inside EC2-Classic. This is a location specific function, any action will operate on the specified location.
void setAutoscaleSubnetidsByLocation(
String location
String[] names
String[][] values
)setBandwidthClass( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the Bandwidth Classes that each of the named pools uses.
void setBandwidthClass(
String[] names
String[] values
)setBandwidthClassByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the Bandwidth Classes that each of the named pools uses. This is a location specific function, any action will operate on the specified location.
void setBandwidthClassByLocation(
String location
String[] names
String[] values
)setDNSAutoscaleEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses DNS-derived autoscaling
void setDNSAutoscaleEnabled(
String[] names
Boolean[] values
)setDNSAutoscaleEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses DNS-derived autoscaling This is a location specific function, any action will operate on the specified location.
void setDNSAutoscaleEnabledByLocation(
String location
String[] names
Boolean[] values
)setDNSAutoscaleHostnames( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the hostnames to be used for DNS-derived autoscaling
void setDNSAutoscaleHostnames(
String[] names
String[][] values
)setDNSAutoscaleHostnamesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the hostnames to be used for DNS-derived autoscaling This is a location specific function, any action will operate on the specified location.
void setDNSAutoscaleHostnamesByLocation(
String location
String[] names
String[][] values
)setDNSAutoscalePort( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the port number for DNS-derived autoscaling in this pool
void setDNSAutoscalePort(
String[] names
Unsigned Integer[] values
)setDNSAutoscalePortByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the port number for DNS-derived autoscaling in this pool This is a location specific function, any action will operate on the specified location.
void setDNSAutoscalePortByLocation(
String location
String[] names
Unsigned Integer[] values
)setDisabledNodes( names, nodes ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
For each of the named pools, set the specified nodes to be disabled in the pool (all other nodes will remain in their existing state).
void setDisabledNodes(
String[] names
String[][] nodes
)setDisabledNodesByLocation( location, names, nodes ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
For each of the named pools, set the specified nodes to be disabled in the pool (all other nodes will remain in their existing state). This is a location specific function, any action will operate on the specified location.
void setDisabledNodesByLocation(
String location
String[] names
String[][] nodes
)setDrainingNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the lists of draining nodes for each of the named pools.
void setDrainingNodes(
String[] names
String[][] values
)setDrainingNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the lists of draining nodes for each of the named pools. This is a location specific function, any action will operate on the specified location.
void setDrainingNodesByLocation(
String location
String[] names
String[][] values
)setErrorFile( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is now obsolete and is replaced by VirtualServer.setErrorFile.
void setErrorFile(
String[] names
String[] values
)setFTPSupportRfc2428( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether backend IPv4 nodes understand the FTP EPRT and EPSV commands.
void setFTPSupportRfc2428(
String[] names
Boolean[] values
)setFTPSupportRfc2428ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether backend IPv4 nodes understand the FTP EPRT and EPSV commands. This is a location specific function, any action will operate on the specified location.
void setFTPSupportRfc2428ByLocation(
String location
String[] names
Boolean[] values
)setFailpool( names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
Set the pool to use when all nodes in a pool fail, for each of the named pools.
void setFailpool(
String[] names
String[] values
)setFailpoolByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
Set the pool to use when all nodes in a pool fail, for each of the named pools. This is a location specific function, any action will operate on the specified location.
void setFailpoolByLocation(
String location
String[] names
String[] values
)setKeepalive( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should maintain HTTP keepalive connections to the nodes.
void setKeepalive(
String[] names
Boolean[] values
)setKeepaliveByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should maintain HTTP keepalive connections to the nodes. This is a location specific function, any action will operate on the specified location.
void setKeepaliveByLocation(
String location
String[] names
Boolean[] values
)setKeepaliveNonIdempotent( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should maintain HTTP keepalive connections to the nodes for non-idempotent requests.
void setKeepaliveNonIdempotent(
String[] names
Boolean[] values
)setKeepaliveNonIdempotentByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should maintain HTTP keepalive connections to the nodes for non-idempotent requests. This is a location specific function, any action will operate on the specified location.
void setKeepaliveNonIdempotentByLocation(
String location
String[] names
Boolean[] values
)setKerberosProtocolTransitionPrincipal( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the Kerberos principal that each of the named pools uses to perform Kerberos Protocol Transition
void setKerberosProtocolTransitionPrincipal(
String[] names
String[] values
)setKerberosProtocolTransitionPrincipalByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the Kerberos principal that each of the named pools uses to perform Kerberos Protocol Transition This is a location specific function, any action will operate on the specified location.
void setKerberosProtocolTransitionPrincipalByLocation(
String location
String[] names
String[] values
)setKerberosProtocolTransitionTarget( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the Kerberos principal name of the service that each of the named pools target
void setKerberosProtocolTransitionTarget(
String[] names
String[] values
)setKerberosProtocolTransitionTargetByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the Kerberos principal name of the service that each of the named pools target This is a location specific function, any action will operate on the specified location.
void setKerberosProtocolTransitionTargetByLocation(
String location
String[] names
String[] values
)setL4AccelSNAT( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is now obsolete.
void setL4AccelSNAT(
String[] names
Boolean[] values
)setL4AccelSNATByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is now obsolete.
void setL4AccelSNATByLocation(
String location
String[] names
Boolean[] values
)setLoadBalancingAlgorithm( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the load balancing algorithms that each of the named pools uses.
void setLoadBalancingAlgorithm(
String[] names
Pool.LoadBalancingAlgorithm[] values
)setLoadBalancingAlgorithmByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the load balancing algorithms that each of the named pools uses. This is a location specific function, any action will operate on the specified location.
void setLoadBalancingAlgorithmByLocation(
String location
String[] names
Pool.LoadBalancingAlgorithm[] values
)setMaxConnectTime( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the time that each of the named pools should wait for a connection to establish to a node before trying another node, in seconds.
void setMaxConnectTime(
String[] names
Unsigned Integer[] values
)setMaxConnectTimeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the time that each of the named pools should wait for a connection to establish to a node before trying another node, in seconds. This is a location specific function, any action will operate on the specified location.
void setMaxConnectTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxConnectionAttempts( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the number of times that each of the named pools can try to connect to any of its nodes before sending an error response.
void setMaxConnectionAttempts(
String[] names
Unsigned Integer[] values
)setMaxConnectionAttemptsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the number of times that each of the named pools can try to connect to any of its nodes before sending an error response. This is a location specific function, any action will operate on the specified location.
void setMaxConnectionAttemptsByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxConnectionsPernode( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set is the maximum number of conncurrent connections allowed to each node in the pool per machine.
void setMaxConnectionsPernode(
String[] names
Unsigned Integer[] values
)setMaxConnectionsPernodeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set is the maximum number of conncurrent connections allowed to each node in the pool per machine. This is a location specific function, any action will operate on the specified location.
void setMaxConnectionsPernodeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxIdleConnectionsPerNode( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum numbers of unused HTTP keepalive connections that each of the named pools should maintain to an individual node.
void setMaxIdleConnectionsPerNode(
String[] names
Unsigned Integer[] values
)setMaxIdleConnectionsPerNodeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum numbers of unused HTTP keepalive connections that each of the named pools should maintain to an individual node. This is a location specific function, any action will operate on the specified location.
void setMaxIdleConnectionsPerNodeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxKeepalivesPerNode( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
setMaxKeepalivesPerNode is deprecated, please use setMaxIdleConnectionsPerNode instead.
void setMaxKeepalivesPerNode(
String[] names
Unsigned Integer[] values
)setMaxKeepalivesPerNodeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
setMaxKeepalivesPerNode is deprecated, please use setMaxIdleConnectionsPerNode instead. This is a location specific function, any action will operate on the specified location.
void setMaxKeepalivesPerNodeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxQueueSize( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set is the maximum number of connections that can be queued due to connection limits.
void setMaxQueueSize(
String[] names
Unsigned Integer[] values
)setMaxQueueSizeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set is the maximum number of connections that can be queued due to connection limits. This is a location specific function, any action will operate on the specified location.
void setMaxQueueSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxReplyTime( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the time that each of the named pools should wait for a response from a node before either discarding the request or trying another node, in seconds (retryable requests only).
void setMaxReplyTime(
String[] names
Unsigned Integer[] values
)setMaxReplyTimeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the time that each of the named pools should wait for a response from a node before either discarding the request or trying another node, in seconds (retryable requests only). This is a location specific function, any action will operate on the specified location.
void setMaxReplyTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxTimedOutConnectionAttempts( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the number of times that each of the named pools can try to connect and time out waiting for a response, by exceeding max_reply_time, to any of its nodes before sending an error response.
void setMaxTimedOutConnectionAttempts(
String[] names
Unsigned Integer[] values
)setMaxTimedOutConnectionAttemptsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the number of times that each of the named pools can try to connect and time out waiting for a response, by exceeding max_reply_time, to any of its nodes before sending an error response. This is a location specific function, any action will operate on the specified location.
void setMaxTimedOutConnectionAttemptsByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxTransactionsPerNode( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum number of concurrent transactions allowed to each node in the pool per machine.
void setMaxTransactionsPerNode(
String[] names
Unsigned Integer[] values
)setMaxTransactionsPerNodeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum number of concurrent transactions allowed to each node in the pool per machine. This is a location specific function, any action will operate on the specified location.
void setMaxTransactionsPerNodeByLocation(
String location
String[] names
Unsigned Integer[] values
)setMonitors( names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
Set the list of all monitors.
void setMonitors(
String[] names
String[][] values
)setMonitorsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, InvalidOperation, DeploymentError
Set the list of all monitors. This is a location specific function, any action will operate on the specified location.
void setMonitorsByLocation(
String location
String[] names
String[][] values
)setNodeCloseWithRst( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether connections to the back-end nodes should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state.
void setNodeCloseWithRst(
String[] names
Boolean[] values
)setNodeCloseWithRstByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether connections to the back-end nodes should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state. This is a location specific function, any action will operate on the specified location.
void setNodeCloseWithRstByLocation(
String location
String[] names
Boolean[] values
)setNodeConnClose( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether all connections that have been sent to a node are closed when that node is marked as dead.
void setNodeConnClose(
String[] names
Boolean[] values
)setNodeConnCloseByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether all connections that have been sent to a node are closed when that node is marked as dead. This is a location specific function, any action will operate on the specified location.
void setNodeConnCloseByLocation(
String location
String[] names
Boolean[] values
)setNodeConnectionAttempts( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the number of times your traffic manager should try and connect to a node before registering it as failed when passive monitoring is enabled.
void setNodeConnectionAttempts(
String[] names
Unsigned Integer[] values
)setNodeConnectionAttemptsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the number of times your traffic manager should try and connect to a node before registering it as failed when passive monitoring is enabled. This is a location specific function, any action will operate on the specified location.
void setNodeConnectionAttemptsByLocation(
String location
String[] names
Unsigned Integer[] values
)setNodeDeleteBehavior( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the deletion behavior for nodes in a pool.
void setNodeDeleteBehavior(
String[] names
Pool.NodeDeleteBehavior[] values
)setNodeDeleteBehaviorByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the deletion behavior for nodes in a pool. This is a location specific function, any action will operate on the specified location.
void setNodeDeleteBehaviorByLocation(
String location
String[] names
Pool.NodeDeleteBehavior[] values
)setNodeDrainToDeleteTimeout( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum time that a node will be allowed to remain in a draining state after it has been deleted. A value of 0 means no maximum time.
void setNodeDrainToDeleteTimeout(
String[] names
Unsigned Integer[] values
)setNodeDrainToDeleteTimeoutByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum time that a node will be allowed to remain in a draining state after it has been deleted. A value of 0 means no maximum time. This is a location specific function, any action will operate on the specified location.
void setNodeDrainToDeleteTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setNodeFailTime( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the length of time a failed node should be isolated for before testing it with new traffic, in seconds
void setNodeFailTime(
String[] names
Unsigned Integer[] values
)setNodeFailTimeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the length of time a failed node should be isolated for before testing it with new traffic, in seconds This is a location specific function, any action will operate on the specified location.
void setNodeFailTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setNodeUseNagle( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether Nagle's algorithm should be used for TCP connections to the back-end nodes.
void setNodeUseNagle(
String[] names
Boolean[] values
)setNodeUseNagleByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether Nagle's algorithm should be used for TCP connections to the back-end nodes. This is a location specific function, any action will operate on the specified location.
void setNodeUseNagleByLocation(
String location
String[] names
Boolean[] values
)setNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the lists of nodes for each of the named pools.
void setNodes(
String[] names
String[][] values
)setNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the lists of nodes for each of the named pools. This is a location specific function, any action will operate on the specified location.
void setNodesByLocation(
String location
String[] names
String[][] values
)setNodesPriorityValue( names, node_values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
For each of the named pools, set the priority values for the named nodes in each pool.
void setNodesPriorityValue(
String[] names
Pool.PriorityValueDefinition[][] node_values
)setNodesPriorityValueByLocation( location, names, node_values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
For each of the named pools, set the priority values for the named nodes in each pool. This is a location specific function, any action will operate on the specified location.
void setNodesPriorityValueByLocation(
String location
String[] names
Pool.PriorityValueDefinition[][] node_values
)setNodesWeightings( names, nodes_values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
For each of the named pools, set the weighting (for the Weighted Round Robin algorithm) for each node in that pool.
void setNodesWeightings(
String[] names
Pool.WeightingsDefinition[][] nodes_values
)setNodesWeightingsByLocation( location, names, nodes_values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
For each of the named pools, set the weighting (for the Weighted Round Robin algorithm) for each node in that pool. This is a location specific function, any action will operate on the specified location.
void setNodesWeightingsByLocation(
String location
String[] names
Pool.WeightingsDefinition[][] nodes_values
)setNote( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the note for each of the named pools.
void setNote(
String[] names
String[] values
)setPassiveMonitoring( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses passive monitoring.
void setPassiveMonitoring(
String[] names
Boolean[] values
)setPassiveMonitoringByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses passive monitoring. This is a location specific function, any action will operate on the specified location.
void setPassiveMonitoringByLocation(
String location
String[] names
Boolean[] values
)setPersistence( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the default Session Persistence classes that each of the named pools uses.
void setPersistence(
String[] names
String[] values
)setPersistenceByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the default Session Persistence classes that each of the named pools uses. This is a location specific function, any action will operate on the specified location.
void setPersistenceByLocation(
String location
String[] names
String[] values
)setPriorityEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools uses priority lists.
void setPriorityEnabled(
String[] names
Boolean[] values
)setPriorityEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools uses priority lists. This is a location specific function, any action will operate on the specified location.
void setPriorityEnabledByLocation(
String location
String[] names
Boolean[] values
)setPriorityNodes( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the minimum number of highest-priority active nodes, for each of the named pools.
void setPriorityNodes(
String[] names
Unsigned Integer[] values
)setPriorityNodesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the minimum number of highest-priority active nodes, for each of the named pools. This is a location specific function, any action will operate on the specified location.
void setPriorityNodesByLocation(
String location
String[] names
Unsigned Integer[] values
)setQueueTimeout( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set is the maximum time to keep a connections queued in seconds. A value of 0 will not timeout queued connections.
void setQueueTimeout(
String[] names
Unsigned Integer[] values
)setQueueTimeoutByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set is the maximum time to keep a connections queued in seconds. A value of 0 will not timeout queued connections. This is a location specific function, any action will operate on the specified location.
void setQueueTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setSMTPSendStartTLS( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should upgrade SMTP connections to SSL using STARTTLS (the alternative is to encrypt the entire connection).
void setSMTPSendStartTLS(
String[] names
Boolean[] values
)setSMTPSendStartTLSByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should upgrade SMTP connections to SSL using STARTTLS (the alternative is to encrypt the entire connection). This is a location specific function, any action will operate on the specified location.
void setSMTPSendStartTLSByLocation(
String location
String[] names
Boolean[] values
)setSSLCipherSuites( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the SSL/TLS cipher suites allowed for connections to a back-end node
void setSSLCipherSuites(
String[] names
String[] values
)setSSLCipherSuitesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the SSL/TLS cipher suites allowed for connections to a back-end node This is a location specific function, any action will operate on the specified location.
void setSSLCipherSuitesByLocation(
String location
String[] names
String[] values
)setSSLCiphers( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is deprecated, and has been replaced with Pool.setSSLCipherSuites
void setSSLCiphers(
String[] names
String[] values
)setSSLCiphersByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is deprecated, and has been replaced with Pool.setSSLCipherSuites This is a location specific function, any action will operate on the specified location.
void setSSLCiphersByLocation(
String location
String[] names
String[] values
)setSSLClientAuth( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should use client authentication. If client authentication is enabled and a back-end node asks for a client authentication, a suitable certificate and private key will be used from the SSL Client Certificates catalog.
void setSSLClientAuth(
String[] names
Boolean[] values
)setSSLClientAuthByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should use client authentication. If client authentication is enabled and a back-end node asks for a client authentication, a suitable certificate and private key will be used from the SSL Client Certificates catalog. This is a location specific function, any action will operate on the specified location.
void setSSLClientAuthByLocation(
String location
String[] names
Boolean[] values
)setSSLCommonNameMatch( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the list of names against which the 'common name' of the certificate is matched.
void setSSLCommonNameMatch(
String[] names
String[][] values
)setSSLCommonNameMatchByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the list of names against which the 'common name' of the certificate is matched. This is a location specific function, any action will operate on the specified location.
void setSSLCommonNameMatchByLocation(
String location
String[] names
String[][] values
)setSSLEllipticCurves( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the elliptic curve preference list for SSL connections from this pool
void setSSLEllipticCurves(
String[] names
String[] values
)setSSLEllipticCurvesByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the elliptic curve preference list for SSL connections from this pool This is a location specific function, any action will operate on the specified location.
void setSSLEllipticCurvesByLocation(
String location
String[] names
String[] values
)setSSLEncrypt( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should encrypt data to the back-end nodes using SSL.
void setSSLEncrypt(
String[] names
Boolean[] values
)setSSLEncryptByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should encrypt data to the back-end nodes using SSL. This is a location specific function, any action will operate on the specified location.
void setSSLEncryptByLocation(
String location
String[] names
Boolean[] values
)setSSLEnhance( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should use SSL protocol enhancements. These enhancements allow Virtual Traffic Manager virtual servers to discover the original client's IP address. Only use enable this if, for this pool, you are using vTMs whose virtual servers have the 'ssl_trust_magic' setting enabled.
void setSSLEnhance(
String[] names
Boolean[] values
)setSSLEnhanceByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should use SSL protocol enhancements. These enhancements allow Virtual Traffic Manager virtual servers to discover the original client's IP address. Only use enable this if, for this pool, you are using vTMs whose virtual servers have the 'ssl_trust_magic' setting enabled. This is a location specific function, any action will operate on the specified location.
void setSSLEnhanceByLocation(
String location
String[] names
Boolean[] values
)setSSLFixedClientCert( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the fixed client certificate to be used whenever client certificate authentication is requested.
void setSSLFixedClientCert(
String[] names
String[] values
)setSSLFixedClientCertByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the fixed client certificate to be used whenever client certificate authentication is requested. This is a location specific function, any action will operate on the specified location.
void setSSLFixedClientCertByLocation(
String location
String[] names
String[] values
)setSSLMiddleboxCompatibility( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether use of TLS 1.3 middlebox compatibility mode is enabled for this pool
void setSSLMiddleboxCompatibility(
String[] names
Pool.SSLMiddleboxCompatibility[] values
)setSSLMiddleboxCompatibilityByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether use of TLS 1.3 middlebox compatibility mode is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLMiddleboxCompatibilityByLocation(
String location
String[] names
Pool.SSLMiddleboxCompatibility[] values
)setSSLSendCloseAlerts( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should send a close alert when they initiate socket disconnections.
void setSSLSendCloseAlerts(
String[] names
Boolean[] values
)setSSLSendCloseAlertsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should send a close alert when they initiate socket disconnections. This is a location specific function, any action will operate on the specified location.
void setSSLSendCloseAlertsByLocation(
String location
String[] names
Boolean[] values
)setSSLServerNameExtension( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set if we should send the server_name extension to the back-end node. This setting forces the use of at least TLS 1.0.
void setSSLServerNameExtension(
String[] names
Boolean[] values
)setSSLServerNameExtensionByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set if we should send the server_name extension to the back-end node. This setting forces the use of at least TLS 1.0. This is a location specific function, any action will operate on the specified location.
void setSSLServerNameExtensionByLocation(
String location
String[] names
Boolean[] values
)setSSLSessionCacheEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether use of the session cache is enabled for this pool
void setSSLSessionCacheEnabled(
String[] names
Pool.SSLSessionCacheEnabled[] values
)setSSLSessionCacheEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether use of the session cache is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLSessionCacheEnabledByLocation(
String location
String[] names
Pool.SSLSessionCacheEnabled[] values
)setSSLSessionTicketsEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether connections to the back-end nodes should use SSL session tickets
void setSSLSessionTicketsEnabled(
String[] names
Pool.SSLSessionTicketsEnabled[] values
)setSSLSessionTicketsEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether connections to the back-end nodes should use SSL session tickets This is a location specific function, any action will operate on the specified location.
void setSSLSessionTicketsEnabledByLocation(
String location
String[] names
Pool.SSLSessionTicketsEnabled[] values
)setSSLSignatureAlgorithms( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the SSL signature algorithms preference list for SSL connections from this pool
void setSSLSignatureAlgorithms(
String[] names
String[] values
)setSSLSignatureAlgorithmsByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the SSL signature algorithms preference list for SSL connections from this pool This is a location specific function, any action will operate on the specified location.
void setSSLSignatureAlgorithmsByLocation(
String location
String[] names
String[] values
)setSSLStrictVerify( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should perform strict certificate validation on SSL certificates from the back-end nodes.
void setSSLStrictVerify(
String[] names
Boolean[] values
)setSSLStrictVerifyByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should perform strict certificate validation on SSL certificates from the back-end nodes. This is a location specific function, any action will operate on the specified location.
void setSSLStrictVerifyByLocation(
String location
String[] names
Boolean[] values
)setSSLSupportSSL2( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is now deprecated.
void setSSLSupportSSL2(
String[] names
Pool.SSLSupportSSL2[] values
)setSSLSupportSSL2ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
This method is now deprecated. This is a location specific function, any action will operate on the specified location.
void setSSLSupportSSL2ByLocation(
String location
String[] names
Pool.SSLSupportSSL2[] values
)setSSLSupportSSL3( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether SSLv3 is enabled for this pool
void setSSLSupportSSL3(
String[] names
Pool.SSLSupportSSL3[] values
)setSSLSupportSSL3ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether SSLv3 is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLSupportSSL3ByLocation(
String location
String[] names
Pool.SSLSupportSSL3[] values
)setSSLSupportTLS1( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.0 is enabled for this pool
void setSSLSupportTLS1(
String[] names
Pool.SSLSupportTLS1[] values
)setSSLSupportTLS11( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.1 is enabled for this pool
void setSSLSupportTLS11(
String[] names
Pool.SSLSupportTLS11[] values
)setSSLSupportTLS11ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.1 is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS11ByLocation(
String location
String[] names
Pool.SSLSupportTLS11[] values
)setSSLSupportTLS12( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.2 is enabled for this pool
void setSSLSupportTLS12(
String[] names
Pool.SSLSupportTLS12[] values
)setSSLSupportTLS12ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.2 is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS12ByLocation(
String location
String[] names
Pool.SSLSupportTLS12[] values
)setSSLSupportTLS13( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.3 is enabled for this pool
void setSSLSupportTLS13(
String[] names
Pool.SSLSupportTLS13[] values
)setSSLSupportTLS13ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.3 is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS13ByLocation(
String location
String[] names
Pool.SSLSupportTLS13[] values
)setSSLSupportTLS1ByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether TLSv1.0 is enabled for this pool This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS1ByLocation(
String location
String[] names
Pool.SSLSupportTLS1[] values
)setServiceDiscoveryEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether this pool uses Service Discovery.
void setServiceDiscoveryEnabled(
String[] names
Boolean[] values
)setServiceDiscoveryInterval( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the poll interval of the Service Discovery plugin for this pool
void setServiceDiscoveryInterval(
String[] names
Unsigned Integer[] values
)setServiceDiscoveryPlugin( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the plugin used by this pool for Service Discovery.
void setServiceDiscoveryPlugin(
String[] names
String[] values
)setServiceDiscoveryPluginArgs( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the arguments used by the pool's Service Discovery plugin
void setServiceDiscoveryPluginArgs(
String[] names
String[] values
)setServiceDiscoveryTimeout( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the timeout of the Service Discovery plugin for this pool
void setServiceDiscoveryTimeout(
String[] names
Unsigned Integer[] values
)setTransparent( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should make connections to the back-ends appear to originate from the source client IP address.
void setTransparent(
String[] names
Boolean[] values
)setTransparentByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set whether each of the named pools should make connections to the back-ends appear to originate from the source client IP address. This is a location specific function, any action will operate on the specified location.
void setTransparentByLocation(
String location
String[] names
Boolean[] values
)setUDPAcceptFrom( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set what sets of IP addresses and ports from which we should accept UDP responses.
void setUDPAcceptFrom(
String[] names
Pool.UDPAcceptFrom[] values
)setUDPAcceptFromByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set what sets of IP addresses and ports from which we should accept UDP responses. This is a location specific function, any action will operate on the specified location.
void setUDPAcceptFromByLocation(
String location
String[] names
Pool.UDPAcceptFrom[] values
)setUDPAcceptFromIPMask( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the mask to validate the IP of UDP responses with. Only used if UDPAcceptFromIP is set to 'ip_mask'.
void setUDPAcceptFromIPMask(
String[] names
String[] values
)setUDPAcceptFromIPMaskByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the mask to validate the IP of UDP responses with. Only used if UDPAcceptFromIP is set to 'ip_mask'. This is a location specific function, any action will operate on the specified location.
void setUDPAcceptFromIPMaskByLocation(
String location
String[] names
String[] values
)setUDPResponseTimeout( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum delay in replying before a node receiving UDP packets is assumed to have failed.
void setUDPResponseTimeout(
String[] names
Unsigned Integer[] values
)setUDPResponseTimeoutByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError
Set the maximum delay in replying before a node receiving UDP packets is assumed to have failed. This is a location specific function, any action will operate on the specified location.
void setUDPResponseTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)Structures
Pool.PriorityValueDefinition
This structure contains the priority for a particular node. The priority is used when using the priority lists functionality.
struct Pool.PriorityValueDefinition {
# The name of the node.
String node;
# The priority value.
Integer priority;
}Pool.WeightingsDefinition
This structure contains the weighting for a particular node. The weighting is used when using the Weighted Round Robin algorithm functionality.
struct Pool.WeightingsDefinition {
# The name of the node.
String node;
# The weighting value.
Integer weighting;
}Enumerations
Pool.AutoscaleIpstouse
enum Pool.AutoscaleIpstouse {
# Public IP addresses
publicips,
# Private IP addresses
privateips
}Pool.LoadBalancingAlgorithm
enum Pool.LoadBalancingAlgorithm {
# Round Robin
roundrobin,
# Weighted Round Robin
wroundrobin,
# Perceptive
cells,
# Least Connections
connections,
# Weighted Least Connections
wconnections,
# Fastest Response Time
responsetimes,
# Random Node
random
}Pool.NodeDeleteBehavior
enum Pool.NodeDeleteBehavior {
# All connections to the node are closed immediately.
immediate,
# Allow existing connections to the node to finish before deletion.
drain
}Pool.SSLMiddleboxCompatibility
enum Pool.SSLMiddleboxCompatibility {
# Use the global setting for use of middlebox compatibility
use_default,
# Enable use of middlebox compatibility
enabled,
# Disable use of middlebox compatibility
disabled
}Pool.SSLSessionCacheEnabled
enum Pool.SSLSessionCacheEnabled {
# Use the global setting for use of the session cache
use_default,
# Enable use of the session cache
enabled,
# Disable use of the session cache
disabled
}Pool.SSLSessionTicketsEnabled
enum Pool.SSLSessionTicketsEnabled {
# Use the global setting for use of session tickets
use_default,
# Enable use of session tickets
enabled,
# Disable use of session tickets
disabled
}Pool.SSLSupportSSL2
enum Pool.SSLSupportSSL2 {
# Use the global setting for SSLv2
use_default,
# Enable SSLv2 (not recommended)
enabled,
# Disable SSLv2
disabled
}Pool.SSLSupportSSL3
enum Pool.SSLSupportSSL3 {
# Use the global setting for SSLv3
use_default,
# Enable SSLv3
enabled,
# Disable SSLv3
disabled
}Pool.SSLSupportTLS1
enum Pool.SSLSupportTLS1 {
# Use the global setting for TLSv1.0
use_default,
# Enable TLSv1.0
enabled,
# Disable TLSv1.0
disabled
}Pool.SSLSupportTLS11
enum Pool.SSLSupportTLS11 {
# Use the global setting for TLSv1.1
use_default,
# Enable TLSv1.1
enabled,
# Disable TLSv1.1
disabled
}Pool.SSLSupportTLS12
enum Pool.SSLSupportTLS12 {
# Use the global setting for TLSv1.2
use_default,
# Enable TLSv1.2
enabled,
# Disable TLSv1.2
disabled
}Pool.SSLSupportTLS13
enum Pool.SSLSupportTLS13 {
# Use the global setting for TLSv1.3
use_default,
# Enable TLSv1.3
enabled,
# Disable TLSv1.3
disabled
}Pool.UDPAcceptFrom
enum Pool.UDPAcceptFrom {
# Only the IP address and port to which the request was sent.
dest_only,
# Only the IP address to which the request was sent, but from any port.
dest_ip_only,
# Only a specific set of IP addresses, but from any port.
ip_mask,
# Any IP address and any port.
all
}