Retrieve Fixed Address operation

The Retrieve Fixed Address operation retrieves the fixed IPv4 and IPv6 addresses from the Infoblox NIOS application.

For retrieving an IPv4 fixed address, you can use the following elements in the request:

  • <network>, <mask>, and <network-type>
  • <network> and <network-view>
  • <ip-address>
  • <mac-address>
  • <dhcp-client-identifier>
  • <extensible-attributes>

Adapter request elements for the retrieving an IPv4 fixed address

Element

Description

Required

<operation-name>

Specifies the name of the operation: retrieve-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

No

<mask>

Sets the subnet mask for the network

Conditional; required if you specify the <network> element

<network-view>

Specifies the view in which the network is located

If you do not specify the <network view> element, the adapter considers the default network view in the Infoblox NIOS application.

No

<network-type>

Specifies the network type for which you want to retrieve the fixed address

Valid values: ipv4 (default), ipv6

Conditional; required if you want to search an IPv6 fixed address

<ip-address>

Specifies the IPv4 address for the fixed address

No

<dhcp-client-identifier>

Specifies a unique client identifier of the host to which you want the DHCP server to assign the IP 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>ICC Towers</value>
 </attribute>
 <attribute>
   <key>Floor</key>
   <value>4</value>
 </attribute>
</extensible-attributes>

No


Back to top
 

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

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

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

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

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

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

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

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

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

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

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

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


Back to top

For retrieving an IPv6 fixed address, you can use the following elements in the request:

  • <network>, <mask>, and <network-view>
  • <extensible-attributes>
  • <comment>
  • <duid>
  • <ip-address>
  • <network>

Adapter request elements for the retrieving an IPv6 fixed address

Element

Description

Required

<operation-name>

Specifies the name of the operation: retrieve-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

No

<mask>

Sets the subnet mask for the network

No

<network-view>

Specifies the view in which the network is located

No

<ip-address>

Specifies the IPv6 address for the fixed address

No

<comment>

Specifies the user comment when you are creating an IPv6 fixed address

No

<duid>

Specifies the DHCP Unique Identifier (DUID) for the IPv6 fixed 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>ICC Towers</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.

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

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

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

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

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

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

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

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

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

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

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

Back to top

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*