IP Address Management module root-level workflows

This topic describes the following root-level workflows and their input and output parameters for the IP Address Management module:

Acquire IP Range workflow

The Acquire IP Range workflow creates and reserves a new IP range within an existing network. For an IPv4 or an IPv6 network, use the start address and end address parameters. However, for an IPv6 network, you can also specify ipv6 start prefix, ipv6 end prefix and ipv6 prefix bits parameters.

Acquire IP Range workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the network in Classless Inter-Domain Routing (CIDR) format You can specify an IPv4 or an IPv6 network address. Examples: 10.128.37.0/24 (IPv4), fe80::/64 (IPv6)	Yes
start address	Specifies the starting IP address of the range of IP addresses that you want to acquire	Conditional; required if you specify an IPv4 network
end address	Specifies the ending IP address of the range of IP addresses that you want to acquire	Conditional; required if you specify an IPv4 network
ipv6 start prefix	Specifies the start prefix of the IPv6 range that is used to reserve the network	No
ipv6 end prefix	Specifies the end prefix of the IPv6 range that is used to reserve the network	No
ipv6 bits	Specifies the prefix bits of the IPv6 range that are used to specify the network	No
comment	Contains any additional information Note: You cannot specify the following special characters in the comment parameter: & < > " '	No
network template	Specifies the name of the template to use to create the IP range When you use a template to create a range, the configuration settings of the template are applied to the new range.	No
name	Specifies a name for the IP range	No
disable	Specifies whether to disable the IP range after is created Valid values: true, false (default)	No
failover association	Specifies the failover association for the created range The failover association is only for IPv4 network. Note: Specify either the failover association or grid member address parameter. If you provide both the parameters, then the failover association parameter is used.	No
grid member address	Specifies the IP address of the grid member Note: Specify either the failover association or grid member address parameter. If you provide both the parameters, then the failover association parameter is used.	No
recycle leases	Specifies the retention duration for leases If recycle leases is true, the leases are saved in the Recycle Bin for one week after they expire. Otherwise, the leases are permanently deleted. Note: The recycle leases parameter is applicable when the grid member address is specified for a particular IPv6 address range. Valid values: true (default), false	No
lease settings	Specifies the lease settings for a network The lease settings are available under IPv4 DHCP Options in the Infoblox application. Note: This parameter is valid only if either failover association or grid member address is provided. This option is only valid for an IPv4 range. The following sample XML shows the lease settings parameter: `<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>`	No
`<lease time>`	Specifies the lease time of an IP address to a DHCP client, in seconds Default value: null	No
`<routers>`	Specifies the comma-separated IP addresses of routers Example 10.0.0.1,10.0.0.2	No
`<domain-name>`	Specifies the domain name for the network	No
`<broadcast-address>`	Specifies the broadcast address of the network to which the DHCP server is attached	No
`<dns-servers>`	Specifies the comma-separated list of DNS servers to which this network is to be connected	No
extensible attributes	Specifies additional custom attributes for the network in a key-value pair The following XML sample defines an extensible attribute: `<extensible-attributes> <attribute> <key>Building</key> <value>Building 101</value> </attribute> </extensible-attributes>`	No
hostname	Specifies the host name or IP address of the Infoblox application	No
user name	Specifies the user name required to log on to the Infoblox application	No
password	Specifies the password that corresponds to the user name The password parameter can contain an encryption-type attribute that specifies whether the password is encrypted. Valid value for password: Any string	No
encryption-type	Specifies whether the password is encrypted Valid values: Base64, Plain (default)	No
timeout-secs	Specifies the time, in seconds, after which the attempt to connect to the Infoblox application expires Default value: 60	No

Acquire IP Range workflow output parameters

Output	Description
status message	Contains a process-specific explanation for the value of success status Contains the error message in case of failure.
success status	Provides a process-specific explanation for the value of the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow

Create Host workflow

The Create Host workflow creates a host within a network. A host resides within a zone.

Create Host workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: Infoblox	Yes
name	Specifies the name for the host	Yes
zone	Specifies the zone in which you want to create a host You must provide the name of a valid zone that exists in the Infoblox application. Note: You must specify the zone if you set the value of configure dns to true.	Conditional
ipv4 hosts	Specifies the comma-separated list of IPv4 addresses for which the host is created Example: 10.0.0.1,10.0.0.2 Note: If you do not specify ipv4 hosts, you must specify ipv6 hosts.	Conditional
ipv6 hosts	Specifies the comma-separated list of IPv6 address for which the host record is created Example: 2001:a000::0000,2001:b000::0000 Note: If you do not specify ipv6 hosts, you must specify ipv4 hosts.	Conditional
aliases	Specifies the comma-separated list of aliases for the host record Example: host1,host2,host3	No
disable	Specifies whether to disable the host after creation Valid values: true, false (default)	No
comment	Contains any additional information that you want to provide Note: You cannot specify the following special characters in the comment parameter: & < > " '	No
configure dns	Indicates if the host is configured for a domain name server (DNS) entry Valid values: false, true (default)	No
extensible attributes	Specifies additional custom attributes for the network in a key-value pair The following XML defines an extensible attribute: `<extensible-attributes> <attribute> <key>Building</key> <value>Building 101</value> <key>Site</key> <value>Housten</value> </attribute> </extensible-attributes>`	No
network-view	Specifies the network view in which the host record is created By default, a host record is created in the default network view. You must specify the name of the network view if it is other than the default network view.	No
dns-view	Specifies the DNS view in which the host record is created By default, a host record is created in the default DNS view. You must specify the name of the dns view if it is other than the default network view.	No
hostname	Specifies the host name or IP address of the Infoblox application	No
user name	Specifies the user name required to log on to the Infoblox application	No
password	Specifies the password that corresponds to the user name The password parameter can contain an encryption-type attribute that specifies whether the password is encrypted. Valid value for password: Any string	No
encryption-type	Specifies whether the password is encrypted Valid values: Base64, Plain (default)	No
timeout-secs	Specifies the time, in seconds, after which the attempt to connect to the Infoblox application expires Default value: 60	No

Create Host workflow output parameters

Output	Description
status message	A process specific explanation for the value of success status Contains the error message in case of a failure scenario.
success status	Provides a process-specific explanation for the value of the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow

Create Network workflow

The Create Network workflow creates a network that contains IP addresses, which you can assign and manage.

Create Network workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the IPv4 or an IPv6 network Examples: 10.128.37.0 (IPv4), fe80:: (IPv6)	Yes
network mask	Specifies the network mask that you must apply to addresses on the network	Yes
disable	Specifies whether to disable the network after it is created Valid values: true, false (default)	No
authority	(IPv4) Sets the authority flag for the network, which specifies whether a Dynamic Host Configuration Protocol (DHCP) server is authoritative for a domain Valid values: true, false (default)	No
network template	Specifies the name of the network template to use to create a new network or a subnetwork When you use a template to create a network, the configuration settings of the template are applied to the new network.	No
auto create reverse zone	Sets the auto create reverse zone flag of the network, which automatically creates reverse-mapping zones for the subnet Valid values: true, false	No
lease settings	Specifies the lease settings for an IPv4 network The lease settings are available under IPv4 DHCP Options in the Infoblox application. Note: Currently, the lease settings are supported only for an IPv4 network. The following sample XML shows the lease settings parameter: `<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>`	No
`<lease time>`	Specifies the lease time of an IP address to a DHCP client, in seconds	No
`<routers>`	Specifies the comma-separated IP addresses of routers For example 10.0.0.1,10.0.0.2	No
`<domain-name>`	Specifies the domain name for the network	No
`<broadcast-address>`	Specifies the broadcast address of the network to which the DHCP server is attached	No
`<dns-servers>`	Specifies the comma-separated list of DNS servers to which this network is to be connected	No
extensible attributes	Specifies additional custom attributes for the network in a key-value pair The following XML sample defines an extensible attribute: `<extensible-attributes> <attribute> <key>Building</key> <value>Building 101</value> <key>Site</key> <value>Housten</value> </attribute> </extensible-attributes>`	No
comment	Contains any additional information Note: You cannot specify the following special characters in the comment parameter: & < > " '	No
hostname	Specifies the host name or IP address of the Infoblox application	No
user name	Specifies the user name required to log on to the Infoblox application	No
password	Specifies the password that corresponds to the user name The password parameter can contain an encryption-type attribute that specifies whether the password is encrypted. Valid value for password: Any string	No
encryption-type	Specifies whether the password is encrypted Valid values: Base64, Plain (default)	No
timeout-secs	Specifies the time, in seconds, after which the attempt to connect to the Infoblox application expires Default value: 60	No

Create Network workflow output parameters

Output	Description
status message	A process specific explanation for the value of success status Contains the error message in case of a failure scenario.
success status	Provides a process-specific explanation for the value of the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow

Delete Network workflow

The Delete Network workflow deletes an entire network and all IP addresses in the network.

Delete Network workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the network address for a network or a subnetwork Valid value: Any IPv4 or IPv6 network address	Yes
hostname	Specifies the host name or IP address of the Infoblox application	No
user name	Specifies the user name required to log on to the Infoblox application	No
password	Specifies the password that corresponds to the user name The password parameter can contain an encryption-type attribute that specifies whether the password is encrypted. Valid value for password: Any string	No
encryption-type	Specifies whether the password is encrypted Valid values: Base64, Plain (default)	No
timeout-secs	Specifies the time, in seconds, after which the attempt to connect to the Infoblox application expires Default value: 60	No

Delete Network workflow output parameters

Output	Description
status message	A process specific explanation for the value of success status Contains the error message in case of a failure scenario.
success status	Provides a process-specific explanation for the value of the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow

Release IP Range workflow

The Release IP Range workflow frees the range of IP addresses that you specify, making them available in the network.

Release IP Range workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the network in a Classless Inter-Domain Routing (CIDR) format You can specify an IPv4 or an IPv6 network address. Example: 10.128.37.0/24 (IPv4), fe80::/64 (IPv6)	Yes
start address	Specifies the starting IP address of the range of IP addresses that you want to release Valid value: 10.128.35.0	No
end address	Specifies the ending IP address of the range of IP addresses that you want to release Valid value: 10.128.39.0	No
ipv6 start prefix	Specifies the start prefix of the IPv6 range that is used to retrieve the network range	No
ipv6 end prefix	Specifies the end prefix of the IPv6 range that is used to retrieve the network range	No
comment	Specifies a comment added for the range Note: You cannot specify the following special characters in the comment parameter: & < > " '	No
failover association	Specifies the failover association for the created range The failover association parameter is applicable only for an IPv4 network range.	No
grid member address	Specify the IP address of the grid member for the created range	No
server association type	Specifies the server association type Valid values for the IPv4 Range: NONE MEMBER FAILOVER MS_SERVER Valid values for IPv6 Range: NONE MEMBER	No
extensible attributes	Specifies additional custom attributes for the network in a key-value pair The following XML sample defines an extensible attribute: `<extensible-attributes> <attribute> <key>Building</key> <value>Building 101</value> <key>Site</key> <value>Housten</value> </attribute> </extensible-attributes>`	No
hostname	Specifies the host name or IP address of the Infoblox application	No
user name	Specifies the user name required to log on to the Infoblox application	No
password	Specifies the password that corresponds to the user name The password parameter can contain an encryption-type attribute that specifies whether the password is encrypted. Valid value for password: Any string	No
encryption-type	Specifies whether the password is encrypted Valid values: Base64, Plain (default)	No
timeout-secs	Specifies the time, in seconds, after which the attempt to connect to the Infoblox application expires Default value: 60	No

Release IP Range workflow output parameters

Output	Description
status message	A process specific explanation for the value of success status Contains the error message in case of a failure scenario.
success status	Provides a process-specific explanation for the value of the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow

Release Network Object workflow

A network object can be a single IP address or an entire network. When you release the network object, its status changes from used to unused. If you do not specify an IP address, the entire network that contains all the IP addresses is released.

Release Network Object workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the network address You can specify an IPv4 or an IPv6 network address. Example: 10.128.37.0 (IPv4), fe80:: (IPv6)	Yes
network mask	Specifies the network mask for the network	Yes
network view	Specifies the network view where the network is located Default value: default	No
ip address	Specifies the IP address to release from the specified network If you do not specify an IP address, all IP addresses within the network are released.	No
hostname	Specifies the host name or IP address of the Infoblox application	No
user name	Specifies the user name required to log on to the Infoblox application	No
password	Specifies the password that corresponds to the user name The password parameter can contain an encryption-type attribute that specifies whether the password is encrypted. Valid value for password: Any string	No
encryption-type	Specifies whether the password is encrypted Valid values: Base64, Plain (default)	No
timeout-secs	Specifies the time, in seconds, after which the attempt to connect to the Infoblox application expires Default value: 60	No

Release Network Object workflow output parameters

Output	Description
status message	A process specific explanation for the value of success status Contains the error message in case of a failure scenario.
success status	Provides a process-specific explanation for the value of the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow