Fortinet Document Library

Version:


Table of Contents

2.0.0
Copy Link

About the connector

Infoblox DDI is an integrated, and centrally managed approach to delivering enterprise-grade DDI. Infoblox DDI makes it easier for you to support your current and evolving needs while achieving the highest standards for security, service uptime, and operational efficiencies. Infoblox DDI Connector which consolidates network services such as domain and IP address management from a single platform.

This document provides information about the Infoblox DDI connector, which facilitates automated interactions with Infoblox DDI using FortiSOAR™ playbooks. Add the Infoblox DDI connector as a step in FortiSOAR™ playbooks and perform automated operations, such as creating and updating Response Policy Zones, and managing hosts, IPs, and domains, on Infoblox DDI. 

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 5.1.1-58

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

Following enhancements have been made to the Infoblox DDI Connector in version 2.0.0:

  • Added "API version" as a configuration parameter to enable you to select the Infoblox DDI RESTful Web API that you will use to perform automated operations. Versions supported are 2.5 and 2.7.

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-infoblox-ddi

Prerequisites to configuring the connector

  • You must have the URL of Infoblox DDI server to which you will connect and perform automated operations, and the credentials to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Infoblox DDI connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL Server URL of the Infoblox DDI server to which you will connect and perform automated operations.
Username Username to access the Infoblox DDI server to which you will connect and perform automated operations.
Password Password to access the Infoblox DDI server to which you will connect and perform automated operations.
API Version Version of the Infoblox DDI RESTful Web API to be used for performing automated operations.
Note: Versions supported are 2.5 and 2.7.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Add Host with Aliases Adds a host name record to the Infoblox DDI server based on the Hostname and IP Address you have specified, and assigns Aliases to the host name. You can specify multiple (comma separated) aliases. add_host_with_aliases
Containment
Create RPZ Creates a Response Policy Zone on the Infoblox DDI server based on the FQDN you have specified. DNS RPZs allow reputable sources to dynamically communicate domain name reputation, so that you can implement policy controls for DNS lookups. create_rpz
Containment
Update RPZ Updates a Response Policy Zone on the Infoblox DDI server based on the Referenced Zone ID you have specified. update_rpz
Containment
Delete RPZ Deletes a Response Policy Zone from the Infoblox DDI server based on the Referenced Zone ID you have specified. delete_rpz
Containment
Retrieve RPZ Details Retrieves details for a Response Policy Zone from the Infoblox DDI server based on the Zone Name you have specified. retrieve_rpz_details
Containment
Add Block Client IP (No Data) Rule Adds a Block Client IP (with No Data rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_client_ip_no_data
Containment
Add Block Client IP (No Domain) Rule Adds a Block Client IP (with No Domain rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_client_ip_no_domain
Containment
Add Block Domain Name (No Data) Rule Adds a Block Domain Name (with No Data rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_domain_name_no_data
Containment
Add Block Domain Name (No Domain) Rule Adds a Block Domain Name (with No Domain rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_domain_name_no_domain
Containment
Add Block IP Address (No Data) Rule Adds a Block IP Address (with No Data rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_ip_address_no_data
Containment
Add Block IP Address (No Domain) Rule Adds a Block IP Address (with No Domain rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_ip_address_no_domain
Containment
Add Passthru Domain Name Adds a Passthru rule on the Infoblox DDI server based on the Domain Name you have specified. add_passthru_domain_name
Containment
Add Passthru IP Address Adds a Passthru rule on the Infoblox DDI server based on the IP Address you have specified. add_passthru_ip_address
Containment
Search Network Searches for a network on the Infoblox DDI server based on Network Address you have specified. search_network
Investigation
Search Network by EA Searches for a network on the Infoblox DDI server based on its extensible attributes that you have specified. search_network_by_ea
Investigation
Search IP Address Searches for the specified IP address on the Infoblox DDI server. search_ip_address
Investigation
Search Objects with IP Searches for the objects on the Infoblox DDI server related to the IP Address you have specified. search_objects_with_ip
Investigation
Get Host Aliases Retrieves aliases from the Infoblox DDI server based on the Hostname you have specified. get_host_aliases
Investigation
Get Subnet Addresses Retrieves all the subnet addresses from the Infoblox DDI server related to the IP Address you have specified. get_subnet_addresses
Investigation
Fetch RPZs Fetches all the Response Policy Zones from the Infoblox DDI server. fetch_rpzs
Investigation
Modify or Remove Host Aliases Modify or remove aliases from the Infoblox DDI server based on the input parameters you have specified. modify_or_remove_host_aliases
Miscellaneous
Change Host IP Change the IP address on the Infoblox DDI server based on the input parameters you have specified. change_host_ip
Miscellaneous
Delete IP Address Delete an IP address from the Infoblox DDI server based on the input parameters you have specified. delete_ip_address
Miscellaneous
Remove Host IP Removes an IP address from the host record on the Infoblox DDI server without altering the original list, based on the input parameters you have specified. remove_host_ip
Miscellaneous
Add IP Address to Host Adds an IP address to the host record on the Infoblox DDI server without altering the original list, based on the input parameters you have specified. add_host_ip
Miscellaneous
Get Information About IP Address Retrieve details of an IP address from the Infoblox DDI server based on IP address you have specified. get_ip_address_info
Investigation

operation: Add Host with Aliases

Input parameters

Parameter Description
Hostname Hostname for the host that you want to add to the Infoblox DDI server.
IP Address IP Address of the host that you want to add to the Infoblox DDI server.
Aliases Aliases are alternative host names used to refer to the same host that you want to add to the Infoblox DDI server. You can enter multiple aliases separated by comma.
Configure for DNS Enable this option if you want to configure for DNS, the Hostname that you want add to the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": {
         "name": "",
         "aliases": [],
         "_ref": "",
         "view": "",
         "ipv4addrs": []
     }
}

operation: Create RPZ

Input parameters

Parameter Description
FQDN A fully qualified domain name (FQDN) of the Response Policy Zone (RPZ) that you want to create on the Infoblox DDI server.
Policy Select the type of policy that will be applicable for the Response Policy Zone that you want to create on the Infoblox DDI server. Policy options are: Passthru, Given, Disabled, Nxdomain, Nodata, and Substitute.
Substitute Name An alternative name for the Response Policy Zone that you want to create on the Infoblox DDI server.
Note: It is mandatory only when the 'Policy' is selected as 'Substitute'.
Severity Select the severity of the Response Policy Zone that you want to create on the Infoblox DDI server. Valid values are: Critical, Informational, Major and Warning.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Update RPZ

Input parameters

Parameter Description
Referenced Zone ID Unique reference ID pointing to the Response Policy Zone that you want to update on the Infoblox DDI server.
Policy Select the type of policy that will be applicable for the Response Policy Zone that you want to update on the Infoblox DDI server. Policy options are: Passthru, Given, Disabled, Nxdomain, Nodata, and Substitute.
Substitute Name An alternative name for the Response Policy Zone that you want to update on the Infoblox DDI server.
Note: It is mandatory only when the 'Policy' is selected as 'Substitute'.
Severity Select the severity of the Response Policy Zone that you want to update on the Infoblox DDI server. Valid values are: Critical, Informational, Major and Warning.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Delete RPZ

Input parameters

Parameter Description
Referenced Zone ID Unique reference ID pointing to the Response Policy Zone that you want to delete from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Retrieve RPZ Details

Input parameters

Parameter Description
Zone Name A fully qualified domain name (FQDN) of the Response Policy Zone (RPZ) for which you want to retrieve the details from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "name": "",
     "comment": "",
     "view": "",
     "zone": "",
     "type": "",
     "_ref": ""
}

operation: Add Block Client IP (No Data) Rule

Input parameters

Parameter Description
Name The name of the Block Client IP (with No Data rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Client IP (with No Data rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block Client IP (No Domain) Rule

Input parameters

Parameter Description
Name The name of the Block Client IP (with No Domain rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Client IP (with No Domain rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block Domain Name (No Data) Rule

Input parameters

Parameter Description
Name The name of the Block Domain Name (with No Data rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Domain Name (with No Data rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block Domain Name (No Domain) Rule

Input parameters

Parameter Description
Name The name of the Block Domain Name (with No Domain rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Domain Name (with No Domain rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block IP Address (No Data) Rule

Input parameters

Parameter Description
Name The name of the Block IP Address (with No Data rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block IP Address (with No Data rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block IP Address (No Domain) Rule

Input parameters

Parameter Description
Name The name of the Block IP Address (with No Domain rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block IP Address (with No Domain rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Passthru Domain Name

Input parameters

Parameter Description
Name The domain name in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value cannot be in the Unicode format.
Canonical The canonical name of the domain in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value can be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Passthru Domain Name record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Passthru IP Address

Input parameters

Parameter Description
IP Address The IP address in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value cannot be in the Unicode format.
Canonical The canonical name of the IP address in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value can be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Passthru IP Address record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Search Network

Input parameters

Parameter Description
Network Address Address of the network in IPv4/CIDR format that you want to search for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Search Network by EA

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned. 

Parameter Description
Country Name of the country in which you want to search the network for on the Infoblox DDI server.
State Name of the state in which you want to search the network for on the Infoblox DDI server.
Region Name of the region in which you want to search the network for on the Infoblox DDI server.
Site Name of the site in which you want to search the network for on the Infoblox DDI server.
Building Name of the building in which you want to search the network for on the Infoblox DDI server.
VLAN Name of the VLAN in which you want to search the network for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Search IP Address

Input parameters

Parameter Description
IP Address IP address that you want to search for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "comment": "",
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Search Objects with IP

Input parameters

Parameter Description
IP Address IP address whose related objects you want to search for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Get Host Aliases

Input parameters

Parameter Description
Hostname Hostname for which you want to retrieve aliases from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "name": "",
     "_ref": "",
     "view": "",
     "ipv4addrs": []
}

operation: Get Subnet Addresses

Input parameters

Parameter Description
Netw Address IP address whose subnet addresses you want to retrieve from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "objects": [],
             "network": "",
             "status": "",
             "is_conflict": "",
             "usage": [],
             "mac_address": "",
             "names": [],
             "network_view": "",
             "types": [],
             "ip_address": "",
             "_ref": ""
         }
     ]
}

operation: Fetch RPZs

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "fqdn": "",
             "view": "",
             "_ref": ""
         }
     ]
}

operation: Modify or Remove Host Aliases

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to modify or remove aliases for on the Infoblox DDI server.
Aliases (Optional) Aliases that you want to modify or remove for the host on the Infoblox DDI server. Leave this field blank to remove all aliases

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Change Host IP

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to change the IP Address for on the Infoblox DDI server.
IP Address New IP address for the host that you want to update on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Delete IP Address

Input parameters

Parameter Description
Referenced IP ID Unique reference ID pointing to the IP address that you want to delete from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Remove Host IP

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to remove the IP address for on the Infoblox DDI server, without altering the original list.
IP Address IP address for the host that you want to remove from the host record on the Infoblox DDI server, without altering the original list.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add IP Address to Host

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to add the IP address for on the Infoblox DDI server, without altering the original list.
IP Address New IP address that you want to add to the host record on the Infoblox DDI server, without altering the original list.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Get Information About IP Address

Input parameters

Parameter Description
IP Address IP address whose information you want to retrieve from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "is_conflict": "",
             "types": [],
             "_ref": "",
             "network_view": "",
             "names": [],
             "mac_address": "",
             "usage": [],
             "ip_address": "",
             "objects": [],
             "status": ""
         }
     ]
}

Included playbooks

The Sample - Infoblox DDI - 2.0.0 playbook collection comes bundled with the Infoblox DDI connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Infoblox DDI connector.

  • Add Block Client IP (No Data) Rule
  • Add Block Client IP (No Domain) Rule
  • Add Block Domain Name (No Data) Rule
  • Add Block Domain Name (No Domain) Rule
  • Add Block IP Address (No Data) Rule
  • Add Block IP Address (No Domain) Rule
  • Add Host with Aliases
  • Add IP Address to Host
  • Add Passthru Domain Name
  • Add Passthru IP Address
  • Change Host IP
  • Create RPZ
  • Delete IP Address
  • Delete RPZ
  • Fetch RPZs
  • Get Host Aliases
  • Get Information About IP Address
  • Get Subnet Addresses
  • Modify or Remove Host Aliases
  • Remove Host IP
  • Retrieve RPZ Details
  • Search IP Address
  • Search Network
  • Search Network by EA
  • Search Objects with IP
  • Update RPZ

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

About the connector

Infoblox DDI is an integrated, and centrally managed approach to delivering enterprise-grade DDI. Infoblox DDI makes it easier for you to support your current and evolving needs while achieving the highest standards for security, service uptime, and operational efficiencies. Infoblox DDI Connector which consolidates network services such as domain and IP address management from a single platform.

This document provides information about the Infoblox DDI connector, which facilitates automated interactions with Infoblox DDI using FortiSOAR™ playbooks. Add the Infoblox DDI connector as a step in FortiSOAR™ playbooks and perform automated operations, such as creating and updating Response Policy Zones, and managing hosts, IPs, and domains, on Infoblox DDI. 

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 5.1.1-58

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

Following enhancements have been made to the Infoblox DDI Connector in version 2.0.0:

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-infoblox-ddi

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Infoblox DDI connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL Server URL of the Infoblox DDI server to which you will connect and perform automated operations.
Username Username to access the Infoblox DDI server to which you will connect and perform automated operations.
Password Password to access the Infoblox DDI server to which you will connect and perform automated operations.
API Version Version of the Infoblox DDI RESTful Web API to be used for performing automated operations.
Note: Versions supported are 2.5 and 2.7.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Add Host with Aliases Adds a host name record to the Infoblox DDI server based on the Hostname and IP Address you have specified, and assigns Aliases to the host name. You can specify multiple (comma separated) aliases. add_host_with_aliases
Containment
Create RPZ Creates a Response Policy Zone on the Infoblox DDI server based on the FQDN you have specified. DNS RPZs allow reputable sources to dynamically communicate domain name reputation, so that you can implement policy controls for DNS lookups. create_rpz
Containment
Update RPZ Updates a Response Policy Zone on the Infoblox DDI server based on the Referenced Zone ID you have specified. update_rpz
Containment
Delete RPZ Deletes a Response Policy Zone from the Infoblox DDI server based on the Referenced Zone ID you have specified. delete_rpz
Containment
Retrieve RPZ Details Retrieves details for a Response Policy Zone from the Infoblox DDI server based on the Zone Name you have specified. retrieve_rpz_details
Containment
Add Block Client IP (No Data) Rule Adds a Block Client IP (with No Data rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_client_ip_no_data
Containment
Add Block Client IP (No Domain) Rule Adds a Block Client IP (with No Domain rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_client_ip_no_domain
Containment
Add Block Domain Name (No Data) Rule Adds a Block Domain Name (with No Data rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_domain_name_no_data
Containment
Add Block Domain Name (No Domain) Rule Adds a Block Domain Name (with No Domain rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_domain_name_no_domain
Containment
Add Block IP Address (No Data) Rule Adds a Block IP Address (with No Data rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_ip_address_no_data
Containment
Add Block IP Address (No Domain) Rule Adds a Block IP Address (with No Domain rule) on the Infoblox DDI server based on the input parameters you have specified. add_block_ip_address_no_domain
Containment
Add Passthru Domain Name Adds a Passthru rule on the Infoblox DDI server based on the Domain Name you have specified. add_passthru_domain_name
Containment
Add Passthru IP Address Adds a Passthru rule on the Infoblox DDI server based on the IP Address you have specified. add_passthru_ip_address
Containment
Search Network Searches for a network on the Infoblox DDI server based on Network Address you have specified. search_network
Investigation
Search Network by EA Searches for a network on the Infoblox DDI server based on its extensible attributes that you have specified. search_network_by_ea
Investigation
Search IP Address Searches for the specified IP address on the Infoblox DDI server. search_ip_address
Investigation
Search Objects with IP Searches for the objects on the Infoblox DDI server related to the IP Address you have specified. search_objects_with_ip
Investigation
Get Host Aliases Retrieves aliases from the Infoblox DDI server based on the Hostname you have specified. get_host_aliases
Investigation
Get Subnet Addresses Retrieves all the subnet addresses from the Infoblox DDI server related to the IP Address you have specified. get_subnet_addresses
Investigation
Fetch RPZs Fetches all the Response Policy Zones from the Infoblox DDI server. fetch_rpzs
Investigation
Modify or Remove Host Aliases Modify or remove aliases from the Infoblox DDI server based on the input parameters you have specified. modify_or_remove_host_aliases
Miscellaneous
Change Host IP Change the IP address on the Infoblox DDI server based on the input parameters you have specified. change_host_ip
Miscellaneous
Delete IP Address Delete an IP address from the Infoblox DDI server based on the input parameters you have specified. delete_ip_address
Miscellaneous
Remove Host IP Removes an IP address from the host record on the Infoblox DDI server without altering the original list, based on the input parameters you have specified. remove_host_ip
Miscellaneous
Add IP Address to Host Adds an IP address to the host record on the Infoblox DDI server without altering the original list, based on the input parameters you have specified. add_host_ip
Miscellaneous
Get Information About IP Address Retrieve details of an IP address from the Infoblox DDI server based on IP address you have specified. get_ip_address_info
Investigation

operation: Add Host with Aliases

Input parameters

Parameter Description
Hostname Hostname for the host that you want to add to the Infoblox DDI server.
IP Address IP Address of the host that you want to add to the Infoblox DDI server.
Aliases Aliases are alternative host names used to refer to the same host that you want to add to the Infoblox DDI server. You can enter multiple aliases separated by comma.
Configure for DNS Enable this option if you want to configure for DNS, the Hostname that you want add to the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": {
         "name": "",
         "aliases": [],
         "_ref": "",
         "view": "",
         "ipv4addrs": []
     }
}

operation: Create RPZ

Input parameters

Parameter Description
FQDN A fully qualified domain name (FQDN) of the Response Policy Zone (RPZ) that you want to create on the Infoblox DDI server.
Policy Select the type of policy that will be applicable for the Response Policy Zone that you want to create on the Infoblox DDI server. Policy options are: Passthru, Given, Disabled, Nxdomain, Nodata, and Substitute.
Substitute Name An alternative name for the Response Policy Zone that you want to create on the Infoblox DDI server.
Note: It is mandatory only when the 'Policy' is selected as 'Substitute'.
Severity Select the severity of the Response Policy Zone that you want to create on the Infoblox DDI server. Valid values are: Critical, Informational, Major and Warning.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Update RPZ

Input parameters

Parameter Description
Referenced Zone ID Unique reference ID pointing to the Response Policy Zone that you want to update on the Infoblox DDI server.
Policy Select the type of policy that will be applicable for the Response Policy Zone that you want to update on the Infoblox DDI server. Policy options are: Passthru, Given, Disabled, Nxdomain, Nodata, and Substitute.
Substitute Name An alternative name for the Response Policy Zone that you want to update on the Infoblox DDI server.
Note: It is mandatory only when the 'Policy' is selected as 'Substitute'.
Severity Select the severity of the Response Policy Zone that you want to update on the Infoblox DDI server. Valid values are: Critical, Informational, Major and Warning.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Delete RPZ

Input parameters

Parameter Description
Referenced Zone ID Unique reference ID pointing to the Response Policy Zone that you want to delete from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Retrieve RPZ Details

Input parameters

Parameter Description
Zone Name A fully qualified domain name (FQDN) of the Response Policy Zone (RPZ) for which you want to retrieve the details from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "name": "",
     "comment": "",
     "view": "",
     "zone": "",
     "type": "",
     "_ref": ""
}

operation: Add Block Client IP (No Data) Rule

Input parameters

Parameter Description
Name The name of the Block Client IP (with No Data rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Client IP (with No Data rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block Client IP (No Domain) Rule

Input parameters

Parameter Description
Name The name of the Block Client IP (with No Domain rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Client IP (with No Domain rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block Domain Name (No Data) Rule

Input parameters

Parameter Description
Name The name of the Block Domain Name (with No Data rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Domain Name (with No Data rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block Domain Name (No Domain) Rule

Input parameters

Parameter Description
Name The name of the Block Domain Name (with No Domain rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block Domain Name (with No Domain rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block IP Address (No Data) Rule

Input parameters

Parameter Description
Name The name of the Block IP Address (with No Data rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block IP Address (with No Data rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Block IP Address (No Domain) Rule

Input parameters

Parameter Description
Name The name of the Block IP Address (with No Domain rule) record in FQDN format that you want to add on the Infoblox DDI server. This value cannot be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Block IP Address (with No Domain rule) record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Passthru Domain Name

Input parameters

Parameter Description
Name The domain name in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value cannot be in the Unicode format.
Canonical The canonical name of the domain in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value can be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Passthru Domain Name record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add Passthru IP Address

Input parameters

Parameter Description
IP Address The IP address in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value cannot be in the Unicode format.
Canonical The canonical name of the IP address in FQDN format for which you want to add a Passthru rule on the Infoblox DDI server. This value can be in the Unicode format.
Response Policy Zone The name of the Response Policy Zone in which the Passthru IP Address record that you want to add on the Infoblox DDI server resides.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Search Network

Input parameters

Parameter Description
Network Address Address of the network in IPv4/CIDR format that you want to search for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Search Network by EA

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned. 

Parameter Description
Country Name of the country in which you want to search the network for on the Infoblox DDI server.
State Name of the state in which you want to search the network for on the Infoblox DDI server.
Region Name of the region in which you want to search the network for on the Infoblox DDI server.
Site Name of the site in which you want to search the network for on the Infoblox DDI server.
Building Name of the building in which you want to search the network for on the Infoblox DDI server.
VLAN Name of the VLAN in which you want to search the network for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Search IP Address

Input parameters

Parameter Description
IP Address IP address that you want to search for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "comment": "",
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Search Objects with IP

Input parameters

Parameter Description
IP Address IP address whose related objects you want to search for on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "network_view": "",
             "_ref": ""
         }
     ]
}

operation: Get Host Aliases

Input parameters

Parameter Description
Hostname Hostname for which you want to retrieve aliases from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "name": "",
     "_ref": "",
     "view": "",
     "ipv4addrs": []
}

operation: Get Subnet Addresses

Input parameters

Parameter Description
Netw Address IP address whose subnet addresses you want to retrieve from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "objects": [],
             "network": "",
             "status": "",
             "is_conflict": "",
             "usage": [],
             "mac_address": "",
             "names": [],
             "network_view": "",
             "types": [],
             "ip_address": "",
             "_ref": ""
         }
     ]
}

operation: Fetch RPZs

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "fqdn": "",
             "view": "",
             "_ref": ""
         }
     ]
}

operation: Modify or Remove Host Aliases

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to modify or remove aliases for on the Infoblox DDI server.
Aliases (Optional) Aliases that you want to modify or remove for the host on the Infoblox DDI server. Leave this field blank to remove all aliases

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Change Host IP

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to change the IP Address for on the Infoblox DDI server.
IP Address New IP address for the host that you want to update on the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Delete IP Address

Input parameters

Parameter Description
Referenced IP ID Unique reference ID pointing to the IP address that you want to delete from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Remove Host IP

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to remove the IP address for on the Infoblox DDI server, without altering the original list.
IP Address IP address for the host that you want to remove from the host record on the Infoblox DDI server, without altering the original list.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Add IP Address to Host

Input parameters

Parameter Description
Referenced Host ID Unique reference ID pointing to the host that you want to add the IP address for on the Infoblox DDI server, without altering the original list.
IP Address New IP address that you want to add to the host record on the Infoblox DDI server, without altering the original list.

Output

The output contains the following populated JSON schema:
{
     "result": ""
}

operation: Get Information About IP Address

Input parameters

Parameter Description
IP Address IP address whose information you want to retrieve from the Infoblox DDI server.

Output

The output contains the following populated JSON schema:
{
     "result": [
         {
             "network": "",
             "is_conflict": "",
             "types": [],
             "_ref": "",
             "network_view": "",
             "names": [],
             "mac_address": "",
             "usage": [],
             "ip_address": "",
             "objects": [],
             "status": ""
         }
     ]
}

Included playbooks

The Sample - Infoblox DDI - 2.0.0 playbook collection comes bundled with the Infoblox DDI connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Infoblox DDI connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.