Previous Topic: Manage Client Networks with Web Service MethodsNext Topic: Web Service Methods


Parameter Descriptions

The following sections discuss the parameters that are used throughout the described web service methods:

ClientId

Type: Unsigned 4-byte integer

Definition: The network definition identifier (clients table entry). Possibly mapped to more than one network (client_cache table entry), depending on the number of sub regions configured.

In the Administration page, each network definition in the Network List has a unique client ID, but it is not displayed.

ClientSetId

Type: Unsigned 4-byte integer

Definition: The network set to which this definition belongs. This field is not exposed and always defaults to the first active client set identifier.

Description

Type: String of up to 50 characters (latin1)

Definition: User-specified label for the network definition being added.

In the Administration page, the Network column in the Network List lists the description for each network definition.

NetworkType

Type: String of up to 50 characters (latin1)

Definition: Identifies the assigned type of the definition or empty/null/Unassigned if none is required. This parameter is case insensitive on matches. If a match is not found, a new network type will be added.

In the Administration page, the Network Type column in the Network List shows the network type associated with each network definition. If a definition is not assigned a network type, it is marked Unassigned.

Regions

Type: Integer power of 2 between 1 and 256. Regions is constrained by subnet mask selection; for example, /31 can only expand into 2 sub regions.

Definition: The number of sub regions into which this definition should be expanded.

In the Administration page, the Regions column in the Network List shows the number of sub regions into which each network definition will expand. Those displayed are set to the minimum; that is, one region per definition.

Subnet

Type: String in x.x.x.x/m format, where x.x.x.x is a valid IP address and m is an integer subnet mask between 1 and 32.

Definition: The address and mask of the subnet for this network definition.

In the Network List, the Subnet column shows the subnet of the network definition in the expected address/mask input and output format.