Description
Returns an array of IPv6 objects found under a given container object. The networks can be filtered by using ObjectProperties.hint and ObjectProperties.accessRight options. Currently, it only supports IPv6 networks.
Parameters
| Name | Description |
|---|---|
| containerId |
Location: query Type: integer (int64) The object ID for the container object. It can be the object ID of any object in the parent object hierarchy. The highest parent object is the configuration level. |
| count |
Location: query Type: integer (int32) Indicates the maximum number of child objects that this method will return. |
| objectType |
Location: query Type: string The type of object containing the IPv6 network. Currently, it only supports ObjectTypes.IP6Network. |
| options |
Location: query Type: string A string containing options. The Option names available in ObjectProperties are ObjectProperties.hint and ObjectProperties.accessRight.
Multiple options can be separated by a
pipe | character. For example:
hint=ab| accessRight=ADDThe values for the ObjectProperties.hint option can be the prefix of the IP address for a network or the name of a network.
Note: Matching networks to a network ID Example 1 will take precedence
over matching networks to a name Example 2.
The values for the ObjectProperties.accessRight option must be one
of the constants listed in
Access right values
and Object types.
For example:
String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess; |
| start |
Location: query Type: integer (int32) Indicates where in the list of objects to start returning objects. The list begins at an index of 0. |
Responses
| Code | Description |
|---|---|
| 200 |
Type: Array of APIEntity Returns an array of IPv6 objects based on the input argument without their properties fields populated, or returns an empty array if containerId is invalid. If no access right option is specified, the View access level will be used by default. |