Retrieve Network operation

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>

Adapter request elements for the Retrieve Network operation

Element	Description	Required
<operation-name>	Specifies the name of the operation: retrieve-network	Yes
<target>	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
<host>	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
<user-name>	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
<password>	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
<timeout-secs>	Specifies the time, in seconds, after which the request times out Valid values: Any integer Default value: 60 seconds	No
<parameters>	Contains the elements required to execute the operation	Yes
<network>	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.	No
<mask>	Specify the mask for the network Use the <mask> element with the <network> element.	No
<comment>	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	No
<network-container>	Specifies the network container, in CIDR format, to which this network belongs for example, 10.0.0.0/24	No
<network-type>	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
<network-view>	Specifies the network view in which the network is located By default, all network views are searched, except when <contains-address> is specified.	No
<contains-address>	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.	No
<extensible-attributes>	Contains the <attribute> element	No
<attribute>	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>	No

The [expand] macro is a standalone macro and it cannot be used inline.

Sample adapter response for the Retrieve Network operation

<infoblox-vnios-response>
<metadata>
   <response-count>1</response-count>
   <status>success</status>
</metadata>
<responses>
   <retrieve-network-response>
     <metadata>
       <os-id>Linux</os-id>
       <os-version>2.6.18-1.2747.el5</os-version>
       <os-arch>i386</os-arch>
       <status>success</status>
       <target>10.128.249.111</target>
     </metadata>
     <commands-output>
       <command-output>
         <metadata>
           <command>perl "/home/user/LAPfor118/server/grids/GRID1/library/adapters/implementations/bmc-adapter-infoblox-vnios-actor_20.12.03.00_5/retrieve_network.pl" "10.128.249.111" "ad***" "i@cbol" "comment:adapter"</command>
           <line-count>50</line-count>
           <execution-milliseconds>4968</execution-milliseconds>
           <exit-code>0</exit-code>
           <status>success</status>
         </metadata>
         <output>
           <line index="1">Response Code:0</line>
           <line index="2">Response Description:Operation succeeded</line>
           <items>
             <item>
               <network>55.0.0.0/24</network>
               <authority>true</authority>
               <comment>this is the sample comment using the adapter xml.</comment>
               <disable>true</disable>
               <auto-create-reversezone></auto-create-reversezone>
               <network-container>/</network-container>
               <network-view>default</network-view>
               <next-available-ip>55.0.0.1</next-available-ip>
             </item>
             <item>
               <network>10.5.0.0/24</network>
               <authority>true</authority>
               <comment>sample comment added by adapter</comment>
               <disable>true</disable>
               <auto-create-reversezone></auto-create-reversezone>
               <network-container>/</network-container>
               <network-view>default</network-view>
               <next-available-ip>10.5.0.1</next-available-ip>
             </item>
           </items>
         </output>
       </command-output>
     </commands-output>
   </retrieve-network-response>
</responses>
</infoblox-vnios-response>

Retrieve Network operation

TrueSight Orchestration Content 20.19.01

On this page