BIG-IQ Device Trust

Overview

API used to establish a trust relationship between BIG-IQ and BIG-IP.

Version information

Version : 5.2, 5.3, 5.4

URI scheme

BasePath : /mgmt/cm/global/tasks
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Create a new device-trust task.

POST /device-trust

Description

Creates a new device-trust task.

Parameters

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

Responses

HTTP Code Description Schema
200 The newly-created device trust task properties_device_trust_post
400 Error response “Bad Request” error_collection
404 Public URI path not registered. error_collection

List all device-trust task items.

GET /device-trust

Description

Returns the collection of device-trust tasks.

Responses

HTTP Code Description Schema
200 Collection of device-trust tasks. properties_collection
400 Error response “Bad Request” 400_error_collection
404 Public URI path not registered. 404_error_collection

Get a single device-trust task.

GET /device-trust/{objectId}

Description

Returns the device-trust identified by id for an endpoint URI.

Parameters

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

Responses

HTTP Code Description Schema
200 Device-trust task object. properties_device-trust
400 Server error response “Bad Request”. 400_error_collection
404 Public URI path not registered. 404_error_collection

Definitions

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)

properties_collection

Name Description Schema
generation An integer that will track change made to a device trust collection. optional, read-only integer(int64)
items Collection of device-trust task objects. optional < object > array
kind Type information for this device trust collection object. optional, read-only string
lastUpdateMicros Update time (micros) for last change made to a device trust collection object. optional, read-only integer(int64)
selfLink A reference link URI to the device trust collection object. optional, read-only string

properties_device-trust

Name Description Schema
address IP address of device object. optional string
clusterName DSC cluster name of device object to be managed. None if not part of a cluster group. optional string
currentStep State machine current step for device trust task. optional string
endDateTime Date/Time when device trust task end. optional string
generation An integer that will track change made to a device-trust object. optional, read-only integer(int64)
id Unique id assigned to a device trust task object. optional, read-only string
identityReference Array of reference links to user used to estabish trust. mgmt/shared/authz/users/admin optional < identityReference > array
isChassisDevice Is this device virtual or appliance. (True / False) optional boolean
kind Type information for this device trust object. optional, read-only string
lastUpdateMicros Update time (micros) for last change made to a policy object. optional, read-only integer(int64)
machineId A unique id string for the BIG-IP device. optional string
ownerMachineId A unique id string for the BIG-IQ acting as a device owner. optional, read-only string
password Password of device object to be managed. optional string
selfLink A reference link URI to the device trust object. optional, read-only string
stateDateTime Date/Time when device trust task began. optional string
status Status of device trust during state transition. optional string
useBigiqSync To enable DSC configuration sync. True / False. When enabled, the BIG-IQ will manually synchronize configurations changes between members in a DSC group. optional boolean
userName Username of BIG-IQ device object. optional string
userReference Reference link to user used to estabish trust. mgmt/shared/authz/users/admin optional userReference
username User name of device object to be managed. 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

post_device_trust_body

Name Description Schema
address IP address of device object. required string
userName Username of device object. required string
password Password of device object to be managed. required string
clusterName DSC cluster name of device object to be managed. None if not part of a cluster group. required string
useBigiqSync To enable DSC configuration sync. True / False required boolean