BIG-IQ Device Discovery¶

Overview¶

API used for discovery of BIG-IP by BIG-IQ.

BasePath : /mgmt/cm/global/tasks

Schemes : HTTPS

POST /device-discovery

Create a device discovery task and add to collection.

Type	Name	Description	Schema	Default
Body	JSON request body	Input parameter list in JSON format required	post_device_discovery_body	None

HTTP Code	Description	Schema
200	The newly-created device discovery task	properties_device_discovery
400	Error response “Bad Request”	error_collection

GET /device-discovery

Returns the collection of device discovery tasks.

HTTP Code	Description	Schema
200	Returns a collection of device discovery tasks.	properties_device_discovery_collection
400	Error response “Bad Request”	error_collection

GET /device-discovery/{objectId}

Returns the device discovery task identified by a endpoint URI.

Type	Name	Description	Schema	Default
Path	objectId	Unique id assigned to device discovery task. required	string(UUID)	None

HTTP Code	Description	Schema
200	Device discovery task object	properties_device_discovery
400	Error response “Bad Request”	error_collection

Name	Description	Schema
kind	Type information for error response optional, read-only	string
message	Error message returned from server. optional, read-only	string
requestBody	The data in the request body. optional, read-only	string
requestOperationId	Unique id assigned to REST operation. optional, read-only	integer(int64)

Name	Description	Schema
allModuleStatus	Discovery module status and information. (module type, discovery start time and end time) optional	< allModuleStatus > array
deviceReference	Reference link to resolver for device to be managed by BIG-IQ. optional	deviceReference
endDateTime	Date/Time when device discovery task ended. optional	string
generation	An integer that tracks change made to a device discovery task object. optional, read-only	integer(int64)
id	Unique id assigned to a device discovery task object. optional, read-only	string
identityReference	Array of reference links to user used to discover device. mgmt/shared/authz/users/admin optional	< identityReference > array
kind	Type information for this device discovery task object. optional, read-only	string
lastUpdateMicros	Update time (micros) for last change made to a device discovery task object. optional, read-only	integer(int64)
name	Name of device discovery task. optional	string
ownerMachineId	A unique id string for the BIG-IQ acting as a device owner. optional	string
selfLink	A reference link URI to the device discovery task object. optional, read-only	string
startDateTime	Date/Time when device discovery task began. optional	string
status	Status of device discovery task during state transition. optional	string
userReference	Reference link to user used to discover device. mgmt/shared/authz/users/admin optional	userReference
username	User name of device object to be managed. optional	string

allModuleStatus

Name	Description	Schema
endTime	End time of device discovery task, per module. optional	string
module	Module type of device discovery task, (Module List- access, adc-core, firewall, asm, security_shared, dns) optional	string
startTime	Start time of device discovery task, per module optional	string

deviceReference

Name	Description	Schema
link	Device reference link to device resolver. optional	string

identityReference

Name	Description	Schema
link	Array of user reference links used to discovery devices. optional	string

userReference

Name	Description	Schema
link	Reference link to a user used to discover devices. optional	string

Name	Description	Schema
generation	An integer that tracks changes made to a device discovery task collection. optional, read-only	integer(int64)
items	Array of device discovery task object. optional	< object > array
kind	Type information for this device discovery task collection object. cm:global:tasks:device-discovery:discoverysupertaskcollectionstate optional, read-only	string
lastUpdateMicros	Update time (micros) for last change made to a device discovery task collection object. optional, read-only	integer(int64)
selfLink	A reference link URI to the device discovery task collection object. optional, read-only	string

Name	Description	Schema
moduleList	A list of all modules to discover. ex. access, adc-core, firewall, asm, security_shared, dns required	array
deviceReference	Reference link to device in resolver. required	string

Previous Next