Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.
Versions
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store
Close

Infoblox IPAM activities

Infoblox IPAM activities

The Infoblox IPAM activities manage IP addresses in your network using an Infoblox DDI Grid Server.

Use these activities to register, reserve, list, or delete IP addresses.

IPAM Register IP Address activity

The IPAM Register IP Address activity registers an IP address in a network using Infoblox IPAM.

The output of this activity produces an InfoBlox IP address record that can be used for other IPAM functions in the format fixedaddress/<encrypted key>:<reserved ip address>/<view>.

The IPAM activities use the REST web service activity template to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.

To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Infoblox DDI > IPAM.

Input variables

Table 1. IPAM Register IP Address input variables
Variable Description
InfobloxServer Name of the Infoblox DDI Grid Server.
macAddress Mac address of the computer for which this IP address is registered.
ipAddress Specific IP address to register.
network Address of the network containing the registered IP address.
restCredentials The sys_id of the REST credentials from the ServiceNow instance.
api_version Defines the version of WAPI to use for the integration endpoints. The default value is 2.0.
Note: This field is mandatory. If the field is empty, the orchestration activity will fail.
view Name of the Infoblox network view. The default value is default.
Note: If the field is empty, the operation is treated as happening in the default view.

Output variables

Table 2. IPAM Register IP Address output variables
Variable Description
error Displays the message for any REST error encountered.
IPAddressRecord IPAM record of the registered IP address.

Conditions

Table 3. IPAM Register IP Address conditions
Variable Description
Success Activity successfully registered the specified IP address.
Failure Activity failed to register the specified IP address.

IPAM Reserve IP Address activity

The IPAM Reserve IP Address activity reserves an IP address in a network using Infoblox IPAM.

The output of this activity produces an InfoBlox IP address record that can be used for other IPAM functions in the format fixedaddress/<encrypted key>:<reserved ip address>/<view>.

The IPAM activities use the REST web service activity template to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.

To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Infoblox DDI > IPAM.

Input variables

Table 4. IPAM Reserve IP Address input variables
Variable Description
InfobloxServer Name of the Infoblox DDI Grid Server.
macAddress Mac address of the computer for which this IP address is reserved.
network Address of the network containing the reserved IP address. The Infoblox server reserves the next available IP address from this network.
restCredentials The sys_id of the REST credentials from the ServiceNow instance.
api_version Defines the version of WAPI to use for the integration endpoints. The default value is 2.0.
Note: This field is mandatory. If the field is empty, the orchestration activity will fail.
view Name of the Infoblox network view. The default value is default.
Note: If the field is empty, the operation is treated as happening in the default view.

Output variables

Table 5. IPAM Reserve IP Address output variables
Variable Description
error Displays the message for any REST error encountered.
IPAddressRecord IPAM record of the reserved IP address.
IPAddress Selected IP address to reserve.

Conditions

Table 6. IPAM Reserve IP Address conditions
Variable Description
Success Activity successfully reserved the specified IP address.
Failure Activity failed to reserve the specified IP address.

IPAM List IP Reservations activity

The IPAM List IP Reservations activity returns an array of all IP Address within the named InfoBlox Server.

The IPAM activities use the REST web service activity template to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.

To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Infoblox DDI > IPAM.

Input variables

Table 7. IPAM List IP Reservations input variables
Variable Description
InfobloxServer Name of the Infoblox DDI Grid Server.
restCredentials The sys_id of the REST credentials from the ServiceNow instance.
api_version Defines the version of WAPI to use for the integration endpoints. The default value is 2.0.
Note: This field is mandatory. If field is empty, the orchestration activity will fail.
view Name of the Infoblox network view. The default value is default.
Note: If the field is empty, the operation is treated as happening with no view and returns the values with data from all views.

Output variables

The output of this activity produces an array of reserved IP addresses in the format fixedaddress/<encrypted key>:<reserved ip address>/<view>.

Table 8. IPAM List IP Reservations output variables
Variable Description
reference Reference value of a reserved IP address contained in an array of addresses, such as fixedaddress/ZG5zLmZpeGVkX2FkZHJlc3MkMTAuMC4xMDMuMTEuMC4u:0.0.0.11/default" ipv4addr: "0.0.0.11"
ipv4addr The reserved IPv4 address.
network_view Routing domain associated with the network returned.
error Displays the message for any REST error encountered.

Conditions

Table 9. IPAM List IP Reservations conditions
Variable Description
Success Activity successfully retrieved the list of reserved IP addresses from the Infoblox server.
Failure Activity failed to retrieve the list of reserved IP addresses from the Infoblox server.

IPAM Delete activity

The IPAM Delete activity deletes an IP Address within a named InfoBlox server.

The IPAM activities use the REST web service activity template to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.

To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Infoblox DDI > IPAM.

Input variables

Table 10. IPAM Delete input variables
Variable Description
InfobloxServer Name of the Infoblox DDI Grid Server.
itemToDelete The IP address to delete, in the format fixedaddress/<encrypted key>:<reserved ip address>/<view>.
restCredentials The sys_id of the REST credentials from the ServiceNow instance.
api_version Defines the version of WAPI to use for the integration endpoints. The default value is 2.0.
Note: This field is mandatory. If the field is empty, the orchestration activity will fail.

Output variables

Table 11. IPAM Delete output variables
Variable Description
DeletedRecord IPAM record of the deleted IP address.
error Displays the message for any REST error encountered.

Conditions

Table 12. IPAM Delete conditions
Variable Description
Success Activity successfully deleted the specified IP address.
Failure Activity failed to delete the specified IP address.