{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21819,"path":"integrate-applications/orchestration/c_InfobloxIPAMActivities.md","title":"Infoblox IPAM activities","bundle":null,"doc_type":null,"release":"australia","body":"\n# Infoblox IPAM activities\n\nThe Infoblox IPAM activities manage IP addresses in your network using an Infoblox DDI Grid Server.\n\nUse these activities to register, reserve, list, or delete IP addresses.\n\n**Parent Topic:**[Infoblox DDI activity pack](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/c_InfobloxDDIActivityPack.md)\n\n## IPAM Register IP Address activity\n\nThe IPAM Register IP Address activity registers an IP address in a network using Infoblox IPAM.\n\nThe 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>`.\n\nThe IPAM activities use the [REST web service activity template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/t_CreateARESTWebServiceActivity.md) to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.\n\nTo access this activity in the Workflow Editor, select the **Custom** tab, and then navigate to **Custom Activities** &gt; **Infoblox DDI** &gt; **IPAM**.\n\n### Input variables\n\n<table id=\"table_gfd_dnx_ft\"><thead><tr><th>\n\nVariable\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nInfobloxServer\n\n</td><td>\n\nName of the Infoblox DDI Grid Server.\n\n</td></tr><tr><td>\n\nmacAddress\n\n</td><td>\n\nMac address of the computer for which this IP address is registered.\n\n</td></tr><tr><td>\n\nipAddress\n\n</td><td>\n\nSpecific IP address to register.\n\n</td></tr><tr><td>\n\nnetwork\n\n</td><td>\n\nAddress of the network containing the registered IP address.\n\n</td></tr><tr><td>\n\nrestCredentials\n\n</td><td>\n\nThe sys\\_id of the REST credentials from the ServiceNow instance.\n\n</td></tr><tr><td>\n\napi\\_version\n\n</td><td>\n\nDefines 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.\n\n</td></tr><tr><td>\n\nview\n\n</td><td>\n\nName 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.\n\n</td></tr></tbody>\n</table>### Output variables\n\n|Variable|Description|\n|--------|-----------|\n|error|Displays the message for any REST error encountered.|\n|IPAddressRecord|IPAM record of the registered IP address.|\n\n### Conditions\n\n|Variable|Description|\n|--------|-----------|\n|Success|Activity successfully registered the specified IP address.|\n|Failure|Activity failed to register the specified IP address.|\n\n## IPAM Reserve IP Address activity\n\nThe IPAM Reserve IP Address activity reserves an IP address in a network using Infoblox IPAM.\n\nThe 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>`.\n\nThe IPAM activities use the [REST web service activity template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/t_CreateARESTWebServiceActivity.md) to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.\n\nTo access this activity in the Workflow Editor, select the **Custom** tab, and then navigate to **Custom Activities** &gt; **Infoblox DDI** &gt; **IPAM**.\n\n### Input variables\n\n<table id=\"table_p2w_pjx_ft\"><thead><tr><th>\n\nVariable\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nInfobloxServer\n\n</td><td>\n\nName of the Infoblox DDI Grid Server.\n\n</td></tr><tr><td>\n\nmacAddress\n\n</td><td>\n\nMac address of the computer for which this IP address is reserved.\n\n</td></tr><tr><td>\n\nnetwork\n\n</td><td>\n\nAddress of the network containing the reserved IP address. The Infoblox server reserves the next available IP address from this network.\n\n</td></tr><tr><td>\n\nrestCredentials\n\n</td><td>\n\nThe sys\\_id of the REST credentials from the ServiceNow instance.\n\n</td></tr><tr><td>\n\napi\\_version\n\n</td><td>\n\nDefines 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.\n\n</td></tr><tr><td>\n\nview\n\n</td><td>\n\nName 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.\n\n</td></tr></tbody>\n</table>### Output variables\n\n|Variable|Description|\n|--------|-----------|\n|error|Displays the message for any REST error encountered.|\n|IPAddressRecord|IPAM record of the reserved IP address.|\n|IPAddress|Selected IP address to reserve.|\n\n### Conditions\n\n|Variable|Description|\n|--------|-----------|\n|Success|Activity successfully reserved the specified IP address.|\n|Failure|Activity failed to reserve the specified IP address.|\n\n## IPAM List IP Reservations activity\n\nThe IPAM List IP Reservations activity returns an array of all IP Address within the named InfoBlox Server.\n\nThe IPAM activities use the [REST web service activity template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/t_CreateARESTWebServiceActivity.md) to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.\n\nTo access this activity in the Workflow Editor, select the **Custom** tab, and then navigate to **Custom Activities** &gt; **Infoblox DDI** &gt; **IPAM**.\n\n### Input variables\n\n<table id=\"table_ufd_2bx_ft\"><thead><tr><th>\n\nVariable\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nInfobloxServer\n\n</td><td>\n\nName of the Infoblox DDI Grid Server.\n\n</td></tr><tr><td>\n\nrestCredentials\n\n</td><td>\n\nThe sys\\_id of the REST credentials from the ServiceNow instance.\n\n</td></tr><tr><td>\n\napi\\_version\n\n</td><td>\n\nDefines 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.\n\n</td></tr><tr><td>\n\nview\n\n</td><td>\n\nName 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.\n\n</td></tr></tbody>\n</table>### Output variables\n\nThe output of this activity produces an array of reserved IP addresses in the format `fixedaddress/<encrypted key>:<reserved ip address>/<view>`.\n\n|Variable|Description|\n|--------|-----------|\n|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\"`|\n|ipv4addr|The reserved IPv4 address.|\n|network\\_view|Routing domain associated with the network returned.|\n|error|Displays the message for any REST error encountered.|\n\n### Conditions\n\n|Variable|Description|\n|--------|-----------|\n|Success|Activity successfully retrieved the list of reserved IP addresses from the Infoblox server.|\n|Failure|Activity failed to retrieve the list of reserved IP addresses from the Infoblox server.|\n\n## IPAM Delete activity\n\nThe IPAM Delete activity deletes an IP Address within a named InfoBlox server.\n\nThe IPAM activities use the [REST web service activity template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/orchestration/t_CreateARESTWebServiceActivity.md) to manage IP addresses using an Infoblox DDI Grid Server. These activities are configured to use a MID Server with REST capabilities.\n\nTo access this activity in the Workflow Editor, select the **Custom** tab, and then navigate to **Custom Activities** &gt; **Infoblox DDI** &gt; **IPAM**.\n\n### Input variables\n\n<table id=\"table_onx_3ww_ft\"><thead><tr><th>\n\nVariable\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nInfobloxServer\n\n</td><td>\n\nName of the Infoblox DDI Grid Server.\n\n</td></tr><tr><td>\n\nitemToDelete\n\n</td><td>\n\nThe IP address to delete, in the format `fixedaddress/<encrypted key>:<reserved ip address>/<view>`.\n\n</td></tr><tr><td>\n\nrestCredentials\n\n</td><td>\n\nThe sys\\_id of the REST credentials from the ServiceNow instance.\n\n</td></tr><tr><td>\n\napi\\_version\n\n</td><td>\n\nDefines 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.\n\n</td></tr></tbody>\n</table>### Output variables\n\n|Variable|Description|\n|--------|-----------|\n|DeletedRecord|IPAM record of the deleted IP address.|\n|error|Displays the message for any REST error encountered.|\n\n### Conditions\n\n|Variable|Description|\n|--------|-----------|\n|Success|Activity successfully deleted the specified IP address.|\n|Failure|Activity failed to delete the specified IP address.|\n\n"}}