Device Discovery for LTM/ADC Core Management¶
Overview¶
API used for discovery task management of a BIG-IP ADC namespace by BIG-IQ. Re-import uses this task as well.
REST Endpoint: /mgmt/cm/adc-core/tasks/declare-mgmt-authority¶
Requests¶
POST /mgmt/cm/adc-core/tasks/declare-mgmt-authority¶
Create a device discovery declare-mgmt-authority task managed by BIG-IQ module (LTM/ADC) and add to collection.
Request Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to device discovery task object. required |
| Json string request body. | object | Input parameter list in json format. required |
| deviceReference | string | Reference link to device in resolver group. required |
| moduleList | string | List of modules to discover. ex. adc_core, asm, shared_security, firewall required |
| userName | string | Username of device. required |
| password | string | Password of device. required |
| rootUser | string | Root user of device. required |
| rootPassword | string | Root password of device. required |
| automaticallyUpdateFramework | boolean | To update rest framework automatically. It is recommended to do so if using REST API. required |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
A POST of a device discovery declare-mgmt-authority task to the properties_declare_mgmt_authority_collection.
| Name | Type | Description |
|---|---|---|
| generation | integer(int64) | An integer that will track change made to a device discovery declare-mgmt-authority task collection object. generation. optional, read-only |
| items | < object > array | Array of device discovery task object. optional |
| kind | string | Type information for this device discovery declare-mgmt-authority task collection object. cm:adc-core:tasks:declare-mgmt-authority:dmataskcollectionstate optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to a device discovery declare-mgmt-authority task collection object. time. optional, read-only |
| selfLink | string | A reference link URI to the device discovery declare-mgmt-authority task collection object. optional, read-only |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of device discovery declare-mgmt-authority task objects. optional |
| kind | string | Type information for this device discovery declare-mgmt-authority task collection object. cm:adc-core:tasks:declare-mgmt-authority:dmataskcollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| Trust Discovery Import | Yes |
GET /mgmt/cm/adc-core/tasks/declare-mgmt-authority¶
Returns the properties_declare_mgmt_authority_collection of device discover declare-mgmt-authority tasks managed by BIG-IQ module (LTM/ADC).
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Returns a properties_declare_mgmt_authority_collection of device discover declare-mgmt-authority tasks.
| Name | Type | Description |
|---|---|---|
| generation | integer(int64) | An integer that will track change made to a device discovery declare-mgmt-authority task collection object. generation. optional, read-only |
| items | < object > array | Array of device discovery task object. optional |
| kind | string | Type information for this device discovery declare-mgmt-authority task collection object. cm:adc-core:tasks:declare-mgmt-authority:dmataskcollectionstate optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to a device discovery declare-mgmt-authority task collection object. time. optional, read-only |
| selfLink | string | A reference link URI to the device discovery declare-mgmt-authority task collection object. optional, read-only |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of device discovery declare-mgmt-authority task objects. optional |
| kind | string | Type information for this device discovery declare-mgmt-authority task collection object. cm:adc-core:tasks:declare-mgmt-authority:dmataskcollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| Trust Discovery Import | Yes |
GET /mgmt/cm/adc-core/tasks/declare-mgmt-authority/{objectId}¶
Used to get a single device discovery declare-mgmt-authority task identified by a endpoint URI (LTM/ADC).
Request Parameters¶
None
Query Parameters¶
| Name | Type | Description |
|---|---|---|
| objectId | string(UUID) | Unique id assigned to this declare-mgmt-authority task object. required |
Response¶
HTTP/1.1 200 OK
Device discovery properties_declare-mgmt-authority task object (LTM/ADC)
| Name | Type | Description |
|---|---|---|
| copyTaskReference | object | Enable / Disable declare-mgmt-authority copy difference between working-configuration (BIG-IQ) and current-configuration (BIG-IP). optional |
| link | string | Reference link to a declare-mgmt-authority copy task object. optional |
| currentStep | string | The current step of device declare-mgmt-authority task as predicated by state. optional |
| deviceReference | object | Reference link to resolver for device declare-mgmt-authority to be managed by BIG-IQ. (LTM / ADC) optional |
| link | string | Reference link to declare-mgmt-authority adc task device. optional |
| differenceReference | object | Reference link to differences object containing differences between working-configuration (BIG-IQ) and current-configuration (BIG-IP) optional |
| link | string | Reference link to shared security configuration difference report for adc-core. optional |
| differencerTaskReference | object | Reference link to differencer task. Used to manage difference between working-configuration (BIG-IQ) and current-configuration (BIG-IP) optional |
| link | string | Reference link to shared security configuration difference adc-core task object. optional |
| endDateTime | string | Date/Time when device discovery task declare-mgmt-authority ended. optional ex. 2016-10-11T10:30:17.834-0400 |
| generation | integer(int64) | A integer that will track change made to a device discovery declare-mgmt-authority task object. generation. optional, read-only |
| id | string | Unique id assigned to a device discovery declare-mgmt-authority task object. optional, read-only |
| identityReference | < object > array | Array of reference links to user used to discover device declare-mgmt-authority. mgmt/shared/authz/users/admin optional |
| link | string | Reference link to users. /mgmt/shared/authz/users/admin optional |
| kind | string | Type information for this device discovery declare-mgmt-authority task object. cm:adc-core:tasks:declare-mgmt-authority:dmataskitemstate optional, read-only |
| lastUpdateMicros | integer(int64) | Update time (micros) for last change made to a device discovery task object. time (1476742109026835). optional, read-only |
| ownerMachineId | string | A unique id string for the BIG-IQ acting as a device owner for declare-mgmt-authority. (LTM / ADC) optional |
| reImport | boolean | Flag to enable / disable re-import configuration. optional |
| selfLink | string | A reference link URI to the device discovery declare-mgmt-authority task object. optional, read-only |
| startDateTime | string | Date/Time when device discovery declare-mgmt-authority task began. optional ex. 2016-10-11T10:30:17.834-0400 |
| status | string | Status of device discovery declare-mgmt-authority task during state transistion. (LTM / ADC) optional |
| userReference | object | Reference link to user used to discover device declare-mgmt-authority. mgmt/shared/authz/users/admin optional |
| link | string | Reference link to users. /mgmt/shared/authz/users/admin optional |
| username | string | User name of device declare-mgmt-authority object to be managed. (LTM / ADC) optional |
| validationBypassMode | string | Enable / Disable validation check when importing configuration device. BYPASS_NONE - no bypass (default), BYPASS_FINAL - skip final validation phase, BYPASS_ALL - skip all validation phases. optional |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
| Name | Type | Description |
|---|---|---|
| errorStack | string | Error stack trace returned by java. optional, read-only |
| items | < object > array | Collection of device discovery declare-mgmt-authority task objects. optional |
| kind | string | Type information for this device discovery declare-mgmt-authority task collection object. cm:adc-core:tasks:declare-mgmt-authority:dmataskcollectionstate optional, read-only |
| message | string | Error message returned from server. optional, read-only |
| requestBody | string | The data in the request body. GET (None) optional, read-only |
| requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
| Role | Allow |
|---|---|
| Device Manager | Yes |
| Trust Discovery Import | Yes |
Examples¶
None