Action - Graceful Disable Object
Force down active one or more ADC objects for which the action applies to. Applicable only for F5 LTM pool member objects.
Supported on the following object types:
- AVI – Server
URL: /adc-device-object-action-gracefuldisable
Type: PUT
Parameters
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | Gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (for example, web, external) | String |
| Payload | objectIds** | Resource id of the objects. Note: Use the search API to search/get the resource id | String[] |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 202 | Accepted | The action triggered for the following <#> objects … |
| 400 | Bad request | No objects found to perform the action |
| 403 | Forbidden | No given object(s) have Read or Write permission |
Sample Request/Response
Use Case
Trigger graceful disable action on objects with resource id obj_1 and obj_2.
Request URL
http://appviewxapi.com/avxapi/adc-device-object-action-forcedown?gwkey=f000ca01&gwsource=external
Request Payload
{
"payload": {
"objectIds": [
"obj_1",
" obj_2"
]
}
}
Response
{ "response": "Action triggered successfully.", "message": "Action triggered for the following 2 objects : obj_1,obj_2" }