The Retrieve Network operation finds one or more networks in the Infoblox Grid Manager.
Note
Do not combine multiple elements when defining the search criteria.
When <network-type> is set to ipv4, you can only combine the <network> and <mask> elements or the <contains-address> and <network-view> elements to define the search criteria.
When <network-type> is set to ipv6, you can search by specifying any one of the following elements. However, you can only combine <network> and <network-view> to define the search criteria.
- <network>
- <comment>
- <extensible-attributes>
- <network-view>
| | |
|---|
| Specifies the name of the operation: retrieve-network | |
| Contains the following elements: - <host>
- <user-name>
- <password>
- <timeout-secs>
| Conditional:
- Required if not specified in the configuration
- If specified in the configuration and request, the value in the request overrides the value in the configuration
|
| Specifies the host name (fully qualified domain name) or IP address of the Infoblox Grid Manager
Valid value: Any string | Conditional: - Required if not specified in the configuration
- If specified in the configuration and request, the value in the request overrides the value in the configuration
|
| Specifies the user name required to connect to the Infoblox Grid Manager
Valid value: Any string | Conditional: - Required if not specified in the configuration
- If specified in the configuration and request, the value in the request overrides the value in the configuration
|
| Specifies the password that corresponds to <user-name>
The <password> element can contain an encryption-type attribute (the Encryption Type field on the form in the form view) that specifies whether the password is encrypted.
Valid value for <password>: Any string
Valid values for encryption-type: base64, plain (default) | Conditional: - Required if not specified in the request
- If specified in the configuration and request, the value in the request overrides the value in the configuration
|
| Specifies the time, in seconds, after which the request times out
Valid values: Any integer
Default value: 60 seconds | |
| Contains the elements required to execute the operation | |
| Specifies the network or subnetwork in Classless Inter-Domain Routing (CIDR) format whose in which the IP range is to be created and reserved
Note: When searching an IPv6 network using the <network> element, the response might include more records than expected because the API considers the value of the <network> element as a regular expression and returns all the matching records for the given expression. | |
| Specify the mask for the network
Use the <mask> element with the <network> element. | |
| Specifies a user comment for the network
Note: All the networks in which the comment element contains any of the matching string are searched.
Valid value: Any string | |
| Specifies the network container, in CIDR format, to which this network belongs
for example, 10.0.0.0/24 | |
| Specifies the network type for which you want to retrieve information
Valid values: ipv4 (default), ipv6 | Conditional; required if you want to search an IPv6 network |
| Specifies the network view in which the network is located
By default, all network views are searched, except when <contains-address> is specified. | |
| Specifies an IPv4 address in string format
If you specify <contains-address>, all other search criteria except <network-view> are ignored and <network-view> defaults to the system-defined default network view, unless specified. The returned network is the smallest network enclosing the specified IPv4 address. | |
| Contains the <attribute> element | |
| Contains a key-value pair designated by the <key> and <value> elements that contain location-specific information for the network, such as building, site, and so on
Multiple instances of <attribute> are permitted.
Example: <extensible-attributes>
<attribute>
<key>Building</key>
<value>test</value>
</attribute>
<attribute>
<key>Floor</key>
<value>4</value>
</attribute>
</extensible-attributes> | |