×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
TrueSight Orchestration Content 20.19.01 ... Application adapters Infoblox NIOS adapter Infoblox NIOS adapter requests and responses DHCP operations

Create Fixed Address operation

The Create Fixed Address operation creates a fixed IPv4 or IPv6 address in the Infoblox application. You can create fixed addresses for network devices such as routers and printers that are not frequently moved from network to network.

You can create fixed IP address by using a template or without a template. Do not use the template if you want to create the IPv4 fixed address by using the <agent-circuit-id> or <agent-remote-id> elements. If you use a template, the <lease settings element> is not required as the template contains the lease settings details.

You can change and assign the IPv4 fixed address by any one of the following elements:

  • <mac-address>
  • <dhcp-client-identifier>
  • <agent-circuit-id> or <agent-remote-id>

Note

Ensure that you specify only one of these elements in the request.

Adapter request elements for creating a fixed address for an IPv4 address

Element

Description

Required

<operation-name>

Specifies the name of the operation: create-fixed-address

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 expires

Valid values: Any integer

Default value: 60 seconds

No

<parameters>

Contains the elements required to execute the operation

Yes

<name>

Specifies the name for the fixed address

No

<network>

Specifies the network address for the fixed address

Yes

<mask>

Sets the subnet mask for the network

Yes

<disable>

Specifies whether you want the DHCP server to allocate the IP address immediately

Valid values: true, false (default)

If you use a template, you cannot disable the fixed IP address.

No

<ip-address>

Specifies the IPv4 address for the fixed address

Yes

<comment>

Specifies the user comment when creating an IPv4 fixed address

No

<mac-address>

Specifies the machine access control (MAC) address for the fixed IP address

Conditional; required if you want to assign the IP address to a MAC address

<dhcp-client-identifier>

Specifies a unique client identifier of the host to which you want the DHCP server to assign the IP address

Conditional; required if you want to assign the IP address to a DHCP client identifier

<agent-circuit-id>

Specifies the circuit ID of the host to which you want to assign the fixed IPv4 address

Note: You can use the <agent-circuit-id> or the <agent-remote-id> element.

Conditional

<agent-remote-id>

Specifies the remote ID of the host to which you want to assign the fixed IPv4 address

Note: You can either use the <agent-circuit-id> or the <agent-remote-id> element.

Conditional

<lease-settings>

Contains the following elements:

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

    If you use the <template> element, the values for the <lease-settings> override the values in the request.

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

<scheduled-at>

Specifies the date and time, in ISO 8601 extended format, at which you want to execute the operation

Example: 2008-10-21T10:56:00Z

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>ICC Towers</value>
</attribute>
<attribute>
<key>Floor</key>
<value>4</value>
</attribute>
</extensible-attributes>



The <extensible-attributes> element is ignored if you use the <template> element.

No

<template>

Specifies the name of the template that exists in the application to be used to create an IPv4 fixed address

You can specify the template only when you want to create an IPv4 fixed address. The template name does not appear when you retrieve the IPv4 fixed addresses.

No 


<items>
 <item>
    <parameters>
     <network>55.5.0.0</network>
     <mask>24</mask>
     <disable>true</disable>
     <name>55.5.0.7 Name</name>
     <ip-address>55.5.0.7</ip-address>
     <comment>Comment by adapter for IP 55.5.0.7</comment>
     <mac-address>00:00:00:11:12:16</mac-address>
     <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
     <lease-settings>
     <lease-time>361</lease-time>
     <routers>55.5.0.4,55.5.0.5</routers>
     <domain-name>demo.com</domain-name>
     <dns-servers>55.5.0.5,55.5.0.7</dns-servers>
     <broadcast-address>127.0.0.2</broadcast-address>
     </lease-settings>
     <extensible-attributes>
     <attribute>
     <key>Site</key>
     <value>sample_site</value>
     </attribute>
     </extensible-attributes>
     </parameters>
   </item>
</items>


<items>
 <item>
  <parameters>
   <network>10.10.14.0</network>
   <mask>24</mask>
   <disable>true</disable>
   <name>10.10.14.3 Name</name>
   <ip-address>10.10.14.3</ip-address>
   <mac-address>00:00:00:03:19:13</mac-address>
   <template>IPV4_Template_Testing</template>
   <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
  </parameters>
 </item>
</items>


<items>
 <item>
  <parameters>
    <network>10.10.14.0</network>
    <mask>24</mask>
    <disable>true</disable>
    <name>10.10.14.6 Name</name>
    <ip-address>10.10.14.18</ip-address>
    <comment>Comment by adapter for IP 10.10.14.18</comment>
    <dhcp-client-identifier>10.10.14.18-DHCP</dhcp-client-identifier>
    <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
    <lease-settings>
       <lease-time>361</lease-time>
       <routers>10.10.14.5</routers>
       <domain-name>demo.com</domain-name>
       <dns-servers>55.5.0.5</dns-servers>
       <broadcast-address>127.0.0.2</broadcast-address>
    </lease-settings>
    <extensible-attributes>
      <attribute>
        <key>Site</key>
        <value>sample_site</value>
      </attribute>
    </extensible-attributes>
 </parameters>
 </item>
</items>


<items>
 <item>
 <parameters>
 <network>10.10.14.0</network>
 <mask>24</mask>
 <disable>true</disable>
 <name>10.10.14.22 Name</name>
 <ip-address>10.10.14.22</ip-address>
 <comment>Comment by adapter for IP 10.10.14.22</comment>
 <agent-circuit-id>10.10.14.22-ACI</agent-circuit-id>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 <lease-settings>
 <lease-time>361</lease-time>
 <routers>10.10.14.1</routers>
 <domain-name>demo.com</domain-name>
 <dns-servers>10.10.14.5</dns-servers>
 <broadcast-address>127.0.0.2</broadcast-address>
  </lease-settings>
 <extensible-attributes>
 <attribute>
 <key>Site</key>
 <value>sample_site</value>
 </attribute>
 </extensible-attributes>
 </parameters>
 </item>
</items>


<items>
 <item>
 <parameters>
 <network>10.10.14.0</network>
 <mask>24</mask>
 <disable>true</disable>
 <name>10.10.14.21 Name</name>
 <ip-address>10.10.14.21</ip-address>
 <comment>Comment by adapter for IP 10.10.14.21</comment>
 <agent-remote-id>10.10.14.21-ARI</agent-remote-id>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 <lease-settings>
 <lease-time>361</lease-time>
 <routers>10.10.14.1</routers>
 <domain-name>demo.com</domain-name>
 <dns-servers>10.10.14.5</dns-servers>
 <broadcast-address>127.0.0.2</broadcast-address>
 </lease-settings>
 <extensible-attributes>
 <attribute>
 <key>Site</key>
 <value>sample_site</value>
 </attribute>
 </extensible-attributes>
 </parameters>
 </item>
</items>


You can change and assign the IPv6 fixed address by any one of the following elements:

  • IP address: <ip-address>
  • Prefix delegation: <ipv6-prefix>
  • IP address and prefix delegation: <ip-address>, <ipv6-prefix>, and <ipv6-prefix-bits>

Adapter request elements for the creating a fixed address for an IPv6 address

Element

Description

Required

<operation-name>

Specifies the name of the operation: create-fixed-address

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 expires

Valid values: Any integer

Default value: 60 seconds

No

<parameters>

Contains the elements required to execute the operation

Yes

<network>

Specifies the network address for the fixed address

Yes

<mask>

Sets the subnet mask for the network

Yes

<disable>

Specifies whether you want the DHCP server to allocate the IP address immediately

Valid values: true, false (default)

No

<duid>

Specifies the DHCP Unique Identifier (DUID) for the IPv6 fixed address

Yes

<name>

Specifies the name of the IPv6 fixed address

No

<ip-address>

Specifies the IPv6 address for the fixed address

Conditional

<ipv6-prefix>

Specifies the prefix delegation for an IPv6 fixed address

Example: "2013::"

Conditional; required when IPv6 is specified by prefix delegation

<ipv6-prefix-bits>

Specifies the IPv6 prefix bits 

Example: "32"

Conditional

<comment>

Specifies a user comment when creating a fixed IPv6 address

Valid value: Any string

No

<scheduled-at>

Specifies the date and time, in ISO 8601 extended format, at which you want to execute the operation

Example: 2008-10-21T10:56:00Z

No

<lease-settings>

Contains the following elements:

  • <valid-lifetime>
  • <preferred-lifetime>
  • <domain-name>
  • <dns-servers>

    If you use the <template> element, the values for the <lease-settings> override the values in the request.

No

<valid-lifetime>

Specifies the length of time the IP address assigned to the DHCP clients remains in a valid state

After the the time expires, the IP address can be assigned to any other client.

No

<preferred-lifetime>

Specifies the preferred length of time the IP address assigned to the DHCP clients remains in a valid state

No

<domain-name>

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

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

If you use the <template> element, the values for the <extensible-attributes> override the values in the request.

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>ICC Towers</value>
</attribute>
<attribute>
<key>Floor</key>
<value>4</value>
</attribute>
</extensible-attributes>

No

<template>

Specifies the name of the template to be used to create an IPv6 fixed address in the Infoblox application

You can specify the template only when you want to create an IPv6 fixed address. The template name does not appear when you retrieve the IPv4 fixed addresses.

Valid value: Any string

No 



<items>
 <item>
 <parameters>
 <network>2002::</network>
 <mask>64</mask>
 <disable>true</disable>
 <duid>8037</duid>
 <name>2002::37-NAME by Prefix 2023::</name>
 <ip-address>2002::37</ip-address>
 <ipv6-prefix>2023::</ipv6-prefix>
 <ipv6-prefix-bits>32</ipv6-prefix-bits>
 <comment>COMMENT</comment>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 <lease-settings>
 <valid-lifetime>123456</valid-lifetime>
 <preferred-lifetime>1234</preferred-lifetime>
 <domain-name>foo.com</domain-name>
 <dns-servers>2002::1</dns-servers>
 </lease-settings>
 <extensible-attributes>
 <attribute>
 <key>Site</key>
 <value>sample_site</value>
 </attribute>
 </extensible-attributes>
 </parameters>
 </item>
</items>


<items>
 <item>
 <parameters>
 <network>2002::</network>
 <mask>64</mask>
 <disable>true</disable>
 <duid>9135</duid>
 <name>Name 2002::35 Fixed Address</name>
 <ip-address>2002::35</ip-address>
 <template>IPV6_Template_Testing</template>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 </parameters>
 </item>
</items>


<items>
 <item>
 <parameters>
 <network>2002::</network>
 <mask>64</mask>
 <disable>true</disable>
 <duid>9130</duid>
 <name>Name 2002::30 Fixed Address</name>
 <ip-address>2002::30</ip-address>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 <extensible-attributes>
 <attribute>
 <key>Site</key>
 <value>sample_site</value>
 </attribute>
 </extensible-attributes>
 <template>IPV6_Template_Testing</template>
 </parameters>
 </item>
</items>


<items>
 <item>
 <parameters>
 <network>2002::</network>
 <mask>64</mask>
 <disable>true</disable>
 <duid>9131</duid>
 <name>Name 2002::31 Fixed Address</name>
 <ip-address>2002::31</ip-address>
 <comment>Comment From the Wrapper for fixed address</comment>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 <lease-settings>
 <valid-lifetime>123456</valid-lifetime>
 <preferred-lifetime>1234</preferred-lifetime>
 <domain-name>foo.com</domain-name>
 <dns-servers>2002::1</dns-servers>
 </lease-settings>
 <extensible-attributes>
 <attribute>
 <key>Site</key>
 <value>sample_site</value>
 </attribute>
 </extensible-attributes>
 </parameters>
 </item>
</items>


<item>
 <parameters>
 <network>2002::</network>
 <mask>64</mask>
 <disable>true</disable>
 <duid>8037</duid>
 <name>2002::37-NAME by Prefix 2023::</name>
 <ip-address>2002::37</ip-address>
 <ipv6-prefix>2023::</ipv6-prefix>
 <ipv6-prefix-bits>32</ipv6-prefix-bits>
 <comment>COMMENT</comment>
 <scheduled-at>2012-11-29T18:30:19+05:30</scheduled-at>
 <lease-settings>
 <valid-lifetime>123456</valid-lifetime>
 <preferred-lifetime>1234</preferred-lifetime>
 <domain-name>foo.com</domain-name>
 <dns-servers>2002::1</dns-servers>
 </lease-settings>
 <extensible-attributes>
 <attribute>
 <key>Site</key>
 <value>sample_site</value>
 </attribute>
 </extensible-attributes>
 </parameters>
 </item>
</items>


Was this page helpful? Yes No Submitting... Thank you
Last modified by Shweta Hardikar on May 08, 2018
ipv6 fixed_addresses dhcp ipv4 infoblox

Comments

Log in or register to comment.

DHCP operations
Delete Fixed Address operation
© Copyright 2013 - 2019 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.