Retrieve Addresses operation

The Retrieve Addresses operation retrieves a list of IP addresses in a network. For an IPv4 network, the list contains all used and unused IP addresses. For an IPv6 network, the list contains only used IP addresses.

Note

Infoblox application retrieves only up to 2000 IP addresses within a network.

Adapter request elements for the Retrieve Addresses operation

Element

Description

Required

<operation-name>

Specifies the name of the operation: retrieve-addresses

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 attempt to connect to the Infoblox application expires

Valid values: Any integer

Default value: 60 seconds

No

<parameters>

Contains the following elements:

  • <network>
  • <mask>
  • <network-view>
  • <status>

Yes

<network>

Specifies the network or subnetwork that contains the IP address that you want to retrieve

You must specify the <network> element in a Classless Inter-Domain Routing (CIDR) format.

Yes

<mask>

Sets the subnet mask for the network

The value for <mask> must be compatible with the network range. For example, for network 10.0.0.0, the value of <mask> should be 24.

Yes

<network-view>

Specifies the single routing domain in which the IPv4 or IPv6 network is located 

If not specified, by default, the IP addresses in the default network view are retrieved.

No

<status>

Specifies the status of the IP address

Valid value for an IPv6 network: Used

Valid value for an IPv4 network:

  • all (default)
  • used
  • unused

No



 Sample adapter request for the Retrieve Addresses operation


<infoblox-vnios-actor-request>
 <operation-name>retrieve-addresses</operation-name>
        <target>
            <host>10.128.36.17</host>
            <user-name>ad***</user-name>
            <password encryption-type="Base64">aW5mb2Jsb3g=</password>
            <timeout-secs>120</timeout-secs>
        </target>
           <parameters>
             <network>55.5.0.0</network>
             <mask>24</mask>
                 <network-view>default</network-view>
             <status>used</status>
           </parameters>
</infoblox-vnios-actor-request>


 Sample adapter response for the Retrieve Addresses operation


<infoblox-vnios-response>
  <metadata>
    <response-count>1</response-count>
    <status>success</status>
  </metadata>
  <responses>
    <retrieve-addresses-response>
      <metadata>
        <os-id>Windows 2003</os-id>
        <os-version>5.2</os-version>
        <os-arch>x86</os-arch>
        <status>success</status>
        <target>10.128.36.17</target>
      </metadata>
      <commands-output>
        <command-output>
          <metadata>
            <command>perl "C:\BMC Software\AO\Server\7_6_02_01\CDP\server\grids\GRID1\library\adapters\implementations\bmc-adapter-infoblox-nios-actor_20.13.01.00_3\retrieve_addresses.pl"  "10.128.36.17" "ad***" "i@cbol" "network:10.128.99.0" "mask:24" "status:used"</command>
            <line-count>7</line-count>
            <execution-milliseconds>16000</execution-milliseconds>
            <exit-code>0</exit-code>
            <status>success</status>
          </metadata>
          <output>
            <line index="6">Response Code:0</line>
            <line index="7">Response Description:Operation succeeded</line>
            <used-addresses>
              <ip-address>10.128.99.0</ip-address>
              <ip-address>10.128.99.2</ip-address>
              <ip-address>10.128.99.9</ip-address>
              <ip-address>10.128.99.10</ip-address>
              <ip-address>10.128.99.255</ip-address>
            </used-addresses>
          </output>
        </command-output>
      </commands-output>
    </retrieve-addresses-response>
  </responses>
</infoblox-vnios-response>

Was this page helpful? Yes No Submitting... Thank you

Comments