discovery : Discovery object.

This object can be used to control the Network Insight functionality of the appliance.

Object Reference

This object cannot be retrieved from the appliance, hence it does not support references.

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Read (retrieve)
  • Modify (update)
  • Permissions
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

The object does not support any fields.

Function Calls

clear_network_port_assignment

This function is used to clear a network port assignment on a device.

This function must always be executed as a scheduled task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

network_deprovision_info ( A/An Network Deprovision Info struct array. ). This parameter is mandatory. The list of Network Deprovision Info structs, which contains information about interface and network for de-provisioning.

Output fields

None

control_switch_port

This function is used to configure the interface of a given switch device.

This function is used for both the Port Configuration and Device Interface Port Control for the IPAM IP Address object.

This function must always be executed as a scheduled task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

port_configs ( A/An Port Control info struct array. ). This parameter is mandatory. The list of port control configuration information.

Output fields

None

discovery_data_conversion

Use this function to convert multiple unmanaged objects into managed objects.

You can execute this function as a scheduled task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

addresses ( An array of the following objects: ipv4address, ipv6address. ). This parameter is mandatory. The list of IPv4 and IPv6 addresses, referring to the unmanaged Discovery Data.

attributes ( A/An Discovery Data Conversion attributes struct. ) The set of attributes that will override the default values of the target objects. The default value is “{}”.

extensible_attributes ( String. ) The set of extensible attributes that will be associated with the target objects. The default value is “{}”.

type ( String. Valid values are: “HOST_RECORD”, “FIXED_ADDRESS”, “IPV6_FIXED_ADDRESS”, “A_AND_PTR_RECORD”, “AAAA_AND_PTR_RECORD” ). This parameter is mandatory. The record type of the target objects.

Output fields

results ( A/An Discovery Data Conversion result struct array. ) The list of Discovery Data conversion results for each processed object.

get_device_support_info

Use this function to get such information about device as device support statuses and device support info.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

device ( String. ). This parameter is mandatory. A reference of the device for which device support information should be retrieved.

Output fields

device_data_collection_status ( A/An Device Data Collection Status struct struct array. ) Array of device data statuses.

device_support_info ( A/An Device Support Info struct struct array. ) Array of device support info.

get_job_devices

This function is used to get the list of devices on which the Network Insight job is being processed.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

task ( String. ). This parameter is mandatory. The scheduled task reference of the Network Insight job.

Output fields

devices ( A/An discovery:device object array. ) The list of the devices on which jobs are executing.

get_job_process_details

This function is used to get Network Insight job proecssing logs for a given task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

device ( String. ). This parameter is mandatory. A reference to a RESTful API Device object.

start_line ( Unsigned integer. ). This parameter is mandatory. The start line of the stream.

task ( String. ). This parameter is mandatory. The scheduled task reference of the Network Insight job.

Output fields

details ( A/An Discovery Job Process Details struct. ) The job process details.

import_device_support_bundle

Use this function to import the device support file to the Infoblox appliance.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

filename ( String. ). This parameter is mandatory. Name of the file as displayed to the user.

token ( String. ). This parameter is mandatory. The token returned by the uploadinit function call.

Output fields

None

modify_vrf_assignment

Use this function to assign a list of VRFs to the network view.

You can execute this function as a scheduled task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

mode ( String. Valid values are: “ASSIGN”, “UNASSIGN” ). This parameter is mandatory. VRF membership modification mode.

network_view ( String. ). This parameter is mandatory. The name of the network view to which a list of the virtual networks (VRFs) should be assign (unassign).

vrfs ( A/An discovery:vrf object array. ). This parameter is mandatory. The list of VRFs that will be assigned/unassigned to the network view.

Output fields

None

provision_network_dhcp_relay

This function is used to provision the network with an interface and to assign a default router IP address on a device.

This function must always be executed as a scheduled task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

enable_dhcp_relay ( Bool. ). This parameter is mandatory. If set to True, the IP address of the DHCP member that was assigned to this network will be configured on the device. If set to False, the IP address will be removed.

interfaces ( A/An discovery:deviceinterface object array. ). This parameter is mandatory. A list of references to a RESTful API Inteface object of the device to which the DHCP forwarding information is pushed.

parent ( String. ). This parameter is mandatory. A reference to the RESTful API Network object on which the port is provisioned.

Output fields

None

provision_network_port

This function is used to provision the network with an interface and to assign default a router ip address on a device.

This function must always be executed as a scheduled task.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

device ( String. ) A reference to the RESTful API Device object on which the port is configured.

enable_dhcp_relay ( Bool. ) Determines whether DHCP member’s IP address assigned to this network will be configured on device.

interface ( String. ) A reference to the RESTful API Interface object of the given device.

network ( String. ). This parameter is mandatory. The network address, in IPv4 Address/CIDR or IPv6 Address/CIDR format.

network_view ( String. ). This parameter is mandatory. The name of the network view in which this network resides.

router_ip ( String. ). This parameter is mandatory. The IPv4 Address or IPv6 Address of the router to be configured.

vlan_info ( A/An VLAN information struct. ) The VLAN information if the interface object reference is not provided.

Output fields

None