Returns an array of IPv4 networks found under a given container object. The networks can be filtered by using ObjectProperties.hint, ObjectProperties.accessRight, and ObjectProperties.overrideType options.
Output / Response
Returns an array of IPv4 networks 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.
API call:
APIEntity[] getIP4NetworksByHint ( long containerId,
int start, int count, String options
)
| Parameter | Description |
|---|---|
| containerId | 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 |
| start | Indicates where in the list of objects to start returning objects. The list begins at an index of 0. |
| count | Indicates the maximum number of child objects that this method will return. The maximum number of child objects that can be returned is 10. |
| options | A string containing options. The Option names available in the
ObjectProperties are ObjectProperties.hint,
ObjectProperties.accessRight, and
ObjectProperties.overrideType. Multiple options can
be separated by a | (pipe) character. For
example:hint=ab|overrideType=HostRecord|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 and
ObjectProperties.overrideType options must be one
of the constants listed in Access Right Values and Object Types. For
example:String options = ObjectProperties.accessRight + "=" + AccessRightValues.AddAccess + "|"+ ObjectProperties.overrideType + "=" + ObjectTypes.HostRecord; |