Function Reference

This chapter contains the full SOAP interface reference for the Traffic Manager Control API.

About the Control API Functions

Control API functions typically operate on lists of configurations. For example, the Virtual Server getEnabled() function takes a list of Virtual Server names as its first argument, and returns a list of boolean values, one for each named Virtual Server.

Some functions depend on compound structures for their arguments, and enumerated types are used to represent some configuration settings.

All of the methods, structures, and enumerated types are specified in the WSDL interface files1 The Traffic Manager WSDL interface specifications are located in $ZEUSHOME/zxtm/etc/wsdl/.

For example, consider the method prototypes for the Virtual Server getRules() and addRules() functions:

VirtualServer.Rule[][] getRules(

   String[] names

)

 

void addRules(

   String[] names

   VirtualServer.Rule[][] rules

)

getRules() takes a list of Virtual Server names and returns a list of VirtualServer.Rule arrays:

struct VirtualServer.Rule {

   # The name of the rule.

   String name;

 

   # Whether the rule is enabled or not.

   Boolean enabled;

 

   # Whether the rule runs on every request response,

# or just the first

   VirtualServer.RuleRunFlag run_frequency;

}

The VirtualServer.Rule structure includes an enumerated type:

enum VirtualServer.RuleRunFlag {

   # Run on every request or response

   run_every,

 

   # Run only on the first request or response

   only_first

}

Your SOAP toolkit represents these WSDL methods, structures, and enumerated types in a form appropriate for the language in use:

•Perl uses methods in the SOAP::Lite object. Structures map straightforwardly onto Perl associative arrays. You need to provide an explicit deserializer to typecast enumerated type values into string values. For details, see Using Perl SOAP::Lite

•The C# and Java toolkits provide a means to convert the WSDL files into C# or Java source files, with fully typed classes, structures, and enumerations to represent the SOAP methods, structures, and enumerated types.

For a worked example that illustrates the use of the methods, structures, and enumerations, see Sample Control API Applications.