Catalog.Bandwidth

URI: http://soap.zeus.com/zxtm/1.0/Catalog/Bandwidth/

The Catalog.Bandwidth interface allows management of Bandwidth classes. Using this interface, you can create, delete and rename bandwidth classes, and manage their configuration.

Methods

addBandwidth( class_names ) throws InvalidOperation, ObjectAlreadyExists, InvalidObjectName, LicenseError, DeploymentError

Add new bandwidth classes.

void addBandwidth(
String[] class_names
)

copyBandwidth( class_names, new_names ) throws InvalidOperation, ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, LicenseError

Copy the named bandwidth classes.

void copyBandwidth(
String[] class_names
String[] new_names
)

deleteBandwidth( class_names ) throws ObjectDoesNotExist, ObjectInUse, LicenseError, DeploymentError

Delete the named bandwidth classes.

void deleteBandwidth(
String[] class_names
)

getBandwidthNames() throws LicenseError

Get the names of all the configured bandwidth classes.

String[] getBandwidthNames()

getMaximum( class_names ) throws ObjectDoesNotExist, LicenseError

Get the maximum bandwidth, in kbits/second.

Unsigned Integer[] getMaximum(
String[] class_names
)

getMaximumByLocation( location, class_names ) throws ObjectDoesNotExist, LicenseError

Get the maximum bandwidth, in kbits/second. This is a location specific function, any action will operate on the specified location.

Unsigned Integer[] getMaximumByLocation(
String location
String[] class_names
)

getNote( class_names ) throws ObjectDoesNotExist, LicenseError

Get the note for each of the named Bandwidth classes.

String[] getNote(
String[] class_names
)

getSharing( class_names ) throws ObjectDoesNotExist, LicenseError

Get the bandwidth sharing mode

Catalog.Bandwidth.Sharing[] getSharing(
String[] class_names
)

getSharingByLocation( location, class_names ) throws ObjectDoesNotExist, LicenseError

Get the bandwidth sharing mode This is a location specific function, any action will operate on the specified location.

Catalog.Bandwidth.Sharing[] getSharingByLocation(
String location
String[] class_names
)

renameBandwidth( class_names, new_names ) throws ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidOperation, LicenseError

Rename the named bandwidth classes.

void renameBandwidth(
String[] class_names
String[] new_names
)

setMaximum( class_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the maximum bandwidth, in kbits/second.

void setMaximum(
String[] class_names
Unsigned Integer[] values
)

setMaximumByLocation( location, class_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the maximum bandwidth, in kbits/second. This is a location specific function, any action will operate on the specified location.

void setMaximumByLocation(
String location
String[] class_names
Unsigned Integer[] values
)

setNote( class_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the note for each of the named Bandwidth classes.

void setNote(
String[] class_names
String[] values
)

setSharing( class_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the bandwidth sharing mode

void setSharing(
String[] class_names
Catalog.Bandwidth.Sharing[] values
)

setSharingByLocation( location, class_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the bandwidth sharing mode This is a location specific function, any action will operate on the specified location.

void setSharingByLocation(
String location
String[] class_names
Catalog.Bandwidth.Sharing[] values
)

Enumerations

Catalog.Bandwidth.Sharing

enum Catalog.Bandwidth.Sharing {
# Each connection can use the maximum rate
connection,
# Bandwidth is shared per traffic manager
machine,
# Bandwidth is shared across all traffic managers
cluster
}