---
title: Catalog.Bandwidth
slug: ps/help/en_us/vtm/controlapi/catalogbandwidth
docTags: 
createdAt: 2026-08-02T08:52:21.976Z
---

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.

```bash
void addBandwidth(
String[] class_names
)
```

### copyBandwidth( class\_names, new\_names ) throws InvalidOperation, ObjectDoesNotExist, ObjectAlreadyExists, InvalidObjectName, DeploymentError, LicenseError

Copy the named bandwidth classes.

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

### deleteBandwidth( class\_names ) throws ObjectDoesNotExist, ObjectInUse, LicenseError, DeploymentError

Delete the named bandwidth classes.

```bash
void deleteBandwidth(
String[] class_names
)
```

### getBandwidthNames() throws LicenseError

Get the names of all the configured bandwidth classes.

```bash
String[] getBandwidthNames()
```

### getMaximum( class\_names ) throws ObjectDoesNotExist, LicenseError

Get the maximum bandwidth, in kbits/second.

```bash
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.

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

### getNote( class\_names ) throws ObjectDoesNotExist, LicenseError

Get the note for each of the named Bandwidth classes.

```bash
String[] getNote(
String[] class_names
)
```

### getSharing( class\_names ) throws ObjectDoesNotExist, LicenseError

Get the bandwidth sharing mode

```bash
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.

```bash
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.

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

### setMaximum( class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the maximum bandwidth, in kbits/second.

```bash
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.

```bash
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.

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

### setSharing( class\_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the bandwidth sharing mode

```bash
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.

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

### Enumerations

### Catalog.Bandwidth.Sharing

```bash
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
}
```