IP Address Management module Searches workflows

Workflows contained in the Searches folder provide a selection of prebuilt workflows to retrieve data from the Infoblox NIOS application.

Get Address by Status workflow

The Get Address by Status workflow retrieves a list of the IP addresses within a network based on the status that you specify.

Get Address by Status workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration entry that is defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the network address for the IPv4 or IPv6 network or subnetwork that you want to retrieve	Yes
network mask	Specifies the network mask that you must apply to addresses on the network	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 on which to base the search Valid values for IPv6: Used Valid values for IPv4: All (default) Used Unused	No
hostname	Specifies the host name or IP address of the Infoblox application	No
username	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 (the Encryption Type field on the form in the form view) 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

Get Address by Status workflow output parameters

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

Get Network List workflow

The Get Network List workflow retrieves a list of networks as per the parameters that you specify.

Note

Do not combine multiple elements when defining the search criteria.

When the network type is set to ipv4, you can only combine the network and network mask parameters or the contains address and network view parameters to define the search criteria.

When network type is set to ipv6, you can search by specifying any one of the following parameters. However, you can only combine network and network view to define the search criteria.

network
comment
extensible-attributes
network-view

Get Network List workflow input parameters

Input	Description	Required
configuration name	Specifies a configuration entry that is defined in the module configuration Valid value: Infoblox	Yes
network	Specifies the IPv4 or IPv6 network address for a network or a subnetwork that you want to retrieve Note: When searching an IPv6 network using the network parameter, the response might include more records than expected because the API considers the value of the network element as a regular expression and returns all the matching records for the given expression.	No
network mask	Specifies the network mask that you must apply to addresses on the network	Conditional; required if you specify the network value
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
network container	Specifies the network container to which the network belongs, in the Classless Inter-Domain Routing (CIDR) format Example: 10.0.0.0/24	No
contains address	Specifies any IPv4 address If you specify the contains address parameter, all other parameters except network view are ignored and the workflow is executed. The smallest network enclosing the IP address that you specified is retrieved.	No
network type	Specifies the type of the network Valid values: ipv4 (default), ipv6	Conditional; required if you search for an IPv6 network
extensible attributes	Specifies additional custom attributes for the network You can specify multiple attributes in the XML format. Sample format for specifying the additional attributes: <extensible-attributes> <attribute> <key>Building</key> <value>Building 101</value> </attribute> </extensible-attributes>	No
comment	Specifies any additional information	No
target	Specifies the predefined target configurations of the Infoblox application on which the request will be executed Valid values: You must specify the same value for the target element as specified for the name attribute in the adapter configuration.	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 (the Encryption Type field on the form in the form view) 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

Get Network List 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	Contains a process-specific explanation for the success status element Valid values: success, failure
output	Contains the XML output of a successfully executed workflow

IP Address Management module Searches workflows

Get Address by Status workflow

Get Network List workflow

TrueSight Orchestration Content 23.1

On this page