Reserve IP Range operation

The Reserve IP Range operation creates and reserves a new IPv4 or IPv6 range within an existing network.

Adapter request elements for the Reserve IP Range operation

Element

Description

Required

<operation-name>

Specifies the name of the operation: reserve-ip-range

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 in which the IP range is to be created and reserved

Yes

<start-address>

Specifies the start address of the range to be reserved

Conditional; required if you specify an IPv4 network

<end-address>

Specifies the end address of the range to be reserved

Conditional; required if you specify an IPv4 network

<ipv6-start-prefix>

Specifies the start prefix of the IPv6 range

Conditional; required if you specify an IPv6 network

<ipv6-end-prefix>

Specifies the end prefix of the IPv6 range

Conditional; required if you specify an IPv6 network

<ipv6-prefix-bits>

Specifies the prefix bits of the IPv6 range that are used to specify the network

Conditional; required if you specify an IPv6 network

<template>

Specifies a template to be used to create the IP range

No

<name>

Specifies a name for the range

No

<disable>

Marks the network as disabled

Valid values: true, false (default)

<comment>

Specifies a user comment for the created range

Valid value: Any string

No

<failover-association>

Specifies the failover association for the created range

Note: Specify either the <failover-association> element or the <grid-member-address> element. If you specify both the elements, <failover-association> takes precedence.

No

<grid-member-address>

Specifies the IP address of the grid member for the created range

Note: Specify either the <failover-association> element or the <grid-member-address> element. If you specify both the elements, <failover-association> takes precedence.

No

<recycle-leases>

Specifies the retention duration for leases

If <recycle-leases> is enabled, the leases are kept in the Recycle Bin until one week after expiration.
If <recycle-leases> is disabled, the leases are irrecoverably deleted.

<recycle-leases> is applicable when <grid-member-address> is specified for a particular IPv6 range.

Valid values: true, false

No

<lease-settings>

Contains the following elements:

  • <lease-time>
  • <routers>
  • <domain-name>
  • <broadcast-address>
  • <dns-servers>

No

<lease-time>

Specifies the lease time of an IP address to a DHCP client

The <lease-time> element is valid only if you specify <failover-association> or <grid-member-address>.

No

<routers>

Specifies the comma-separated IP addresses of routers

Example: 10.0.0.1,10.0.0.2

The <routers> element is valid only if you specify <failover-association> or <grid-member-address>.

No

<domain-name>

Specifies the name of the domain for which the server serves DHCP data

The <domain-name> element is valid only if you specify <failover-association> or <grid-member-address>.

No

<broadcast-address>

Specifies the broadcast IP address of the network to which the DHCP server is attached

The <broadcast-address> element is valid only if you specify <failover-association> or <grid-member-address>.

No

<dns-servers>

Specifies the comma-separated list of DNS servers to which this network is to be connected

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

 Sample adapter request for the Reserve IP Range operation that is used to reserve an IPv4 address


<infoblox-vnios-actor-request>
<operation-name>reserve-ip-range</operation-name>
    <target>
        <host>10.128.249.111</host>
        <user-name>ad***</user-name>
        <password>i@cbol</password>
    </target>
    <parameters>
     <network>10.10.10.0/24</network>
     <start-address>10.10.10.20</start-address>
     <end-address>10.10.10.30</end-address>
     <template>Test template</template>
     <name>Test Range</name>
     <comment>user comment</comment>
     <disable>true</disable>
     <failover-association>Test Association</failover-association>
     <grid-member-address>10.0.0.1</grid-member-address>
     <recycle-leases>true</recycle-leases>
     <lease-settings>
         <lease-time>360</lease-time>
         <routers>10.0.0.1,10.0.0.2</routers>
         <domain-name>domain.com</domain-name>
         <broadcast-address>10.0.0.3</broadcast-address>
         <dns-servers>10.0.0.4,10.0.0.5</dns-servers>
     </lease-settings>
     <extensible-attributes>
         <attribute>
             <key>Building</key>
             <value>value1</value>
         </attribute>
         <attribute>
             <key>Site</key>
             <value>value2</value>
         </attribute>
     </extensible-attributes>
    </parameters>
</infoblox-vnios-actor-request>


 Sample adapter request for the Reserve IP Range operation that is used to reserve an IPv6 address

<infoblox-vnios-actor-request>
<operation-name>reserve-ip-range</operation-name>
    <target>
        <host>10.128.249.111</host>
        <user-name>ad***</user-name>
        <password>i@cbol</password>
    </target>
    <parameters>
      <network>fd65:b3d:c6ff:687c::/64</network>
      <start-address>fd65:b3d:c6ff:687c:687c::</start-address>
      <end-address>fd65:b3d:c6ff:687c:687c::</end-address>
      <ipv6-start-prefix>2001:db8:0:c000:0011::</ipv6-start-prefix>
      <ipv6-end-prefix>2001:db8:0:c000:0021::</ipv6-end-prefix>
      <ipv6-prefix-bits>80</ipv6-prefix-bits>
      <template></template>
      <name>Test Range</name>
      <comment>user comment</comment>
      <disable>false</disable>
      <recycle-leases>true</recycle-leases>
      <extensible-attributes>
        <attribute>
          <key>Building</key>
          <value>value3</value>
        </attribute>
        <attribute>
          <key>Site</key>
          <value>value2</value>
         </attribute>
      </extensible-attributes>
    </parameters>
</infoblox-vnios-actor-request>


 Sample adapter response for the Reserve IP Range operation


<infoblox-vnios-response>
  <metadata>
    <response-count>1</response-count>
    <status>success</status>
  </metadata>
  <responses>
    <reserve-ip-range-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.249.111</target>
      </metadata>
      <commands-output>
        <command-output>
          <metadata>
            <command>perl "C:\user\LAPfor84\server\grids\GRID1\library\
adapters\implementations\bmc-adapter-infoblox-vnios-actor_20.12.03.00_2\
reserve_ip_range.pl"  "10.128.249.111" "ad***" "i@cbol"
 "network:fd65:b3d:c6ff:687c::/64" "start_addr:fd65:b3d:c6ff:687c:687c::" "end_addr:fd65:b3d:c6ff:687c:687c::" "ipv6_start_prefix:2001:db8:0:c000:0011::" "ipv6_end_prefix:2001:db8:0:c000:0021::" "ipv6_prefix_bits:80" "comment:user
 comment" "disable:false" "name:Test Range" "recycle_leases:true"
 "extensible-attributes:{'Building'=>'value3','Site'=>'value2',}," "range_type:ipv6"</command>
            <line-count>2</line-count>
            <execution-milliseconds>4281</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>
          </output>
        </command-output>
      </commands-output>
    </reserve-ip-range-response>
  </responses>
</infoblox-vnios-response>

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

Comments