LTM/ADC Self-Service Task (enable/disable pool member)¶
Overview¶
API used create a self-service task to perform functions such as enable/disable pool member.
REST Endpoint: /mgmt/cm/adc-core/tasks/self-service¶
Requests¶
POST /mgmt/cm/adc-core/tasks/self-service¶
Create an ADC self-service task managed by BIG-IQ.
Request Parameters¶
Name | Type | Description |
---|---|---|
objectId | string(UUID) | Unique id assigned to a self-service task. required |
Json string request body. | object | Input parameter list in json format. post_adc_self_service_body required Ex. {“resourceReference”:{“link”:”https://localhost/mgmt/cm/adc-core/working-config/ltm/pool/3a3361a8-64fa-33d7-bc1a-d6658f31e687/members/a0fd9118-b58c-339f-8085-e92f1f75ec1e”},”operation”:”enable”} |
resourceReference | string | Reference link to the pool member resource for self service. required |
operation | string | Enable, Disable or Force Offline. required |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Add an item in the properties_collection representing a self-service task.
Name | Type | Description |
---|---|---|
generation | integer(int64) | A integer that will track change made to a self-service collection object. generation. optional, read-only |
items | < object > array | Self-serivice task properties associated with the collection. optional |
kind | string | Type information for this self-service task collection object. optional, read-only |
lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an self-service collection object. time. optional, read-only |
selfLink | string | A reference link URI to the self-service task collection object. optional, read-only |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
Name | Schema | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of self-service task errors. optional |
kind | string | Type information for device-trust collections-cm:global:tasks:device-trust:bigiptrusttaskstate. 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 |
---|---|
Local Traffic & Network Editor | Yes |
Local Traffic & Network Manager | Yes |
Local Traffic & Network Viewer | Yes |
GET /mgmt/cm/adc-core/tasks/self-service¶
List all self-service tasks.
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Retrieve the properties_collection representing all self-service tasks.
Name | Type | Description |
---|---|---|
generation | integer(int64) | A integer that will track change made to a self-service collection object. generation. optional, read-only |
items | < object > array | Self-service task properties associated with the collection. optional |
kind | string | Type information for this self-service task collection object. optional, read-only |
lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an self-service collection object. time. optional, read-only |
selfLink | string | A reference link URI to the self-service task collection object. optional, read-only |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
Name | Schema | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of self-service task errors. optional |
kind | string | Type information for device-trust collections-cm:global:tasks:device-trust:bigiptrusttaskstate. 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 |
---|---|
Local Traffic & Network Editor | Yes |
Local Traffic & Network Manager | Yes |
Local Traffic & Network Viewer | Yes |
GET /mgmt/cm/adc-core/tasks/self-service/{objectId}¶
Get a single instance of a self-service task object identified by id for an endpoint URI.
Request Parameters¶
None
Query Parameters¶
Name | Type | Description |
---|---|---|
objectId | string(UUID) | Unique id assigned to a self-service task. required |
Response¶
Retrieve a properties_self_service representing a single self-service task.
Name | Schema | Description |
---|---|---|
deviceReference | object | Reference link to device object in resolver. optional, read-only |
link | string | Reference link to device associated with this self-service task in the device resolver. optional |
endDateTime | string | Date/Time when self-service task end. 2016-10-11T10:30:17.834-0400 optional |
generation | integer(int64) | A integer that will track change made to a self-service task object. generation. optional, read-only |
id | string | Unique id assigned to a self-service task object. optional, read-only |
identityReference | < object > array | Array of reference links to user used to create self-service task. mgmt/shared/authz/users/admin optional |
link | string | Reference link table to authz users. optional |
kind | string | Type information for this self-service task object. optional, read-only |
lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an self-service task object. time. optional, read-only |
name | string | Name of self-service task object. example. ‘Self-Service_10.55.2.20:80’ optional |
operation | string | Description of operation type. example. (enable/disable/force offline). optional |
ownerMachineId | string | A unique id string for the BIGIQ acting as a device owner. optional, read-only |
resourceReference | object | Reference link to resource used. example. pool member enable/disable optional, read-only |
link | string | Reference link to the resource in which the task is managing. optional |
selfLink | string | A reference link URI to the self-service task object. optional |
stateDateTime | string | Date/Time when self-service task began. 2016-10-11T10:30:17.834-0400 optional |
status | string | Status if self-service task based on state. STARTED; FINSIHED etc. optional |
userReference | object | Reference link to user used to create self-service task. mgmt/shared/authz/users/admin optional |
link | string | Reference link table to authz user. optional |
username | string | Username of user whom iniated the task. optional |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
Name | Schema | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of self-service task errors. optional |
kind | string | Type information for device-trust collections-cm:global:tasks:device-trust:bigiptrusttaskstate. 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 |
---|---|
Local Traffic & Network Editor | Yes |
Local Traffic & Network Manager | Yes |
Local Traffic & Network Viewer | Yes |
Examples¶
None