LogicalServerFarmEntry bulkDisable request
Description
Disables one or more LogicalServerFarmEntry objects. Once disabled, the server represented by the LoigcalServerFarmEntry will no longer be routed any traffic via the LogicalServerFarm with which this LogicalServerFarmEntry is associated.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/LogicalServerFarmEntry/bulkDisable | void | Not applicable |
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Name | Type | Multi- | Description |
|---|---|---|---|
logicalServerFarmEntries | 1..* | The LogicalServerFarmEntry to be disabled. |
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.
Example
The following example shows an HTTP request that disables a list of logical server farm objects, where each object includes a reference to the LogicalServerFarm to which it is to be disabled:
"cloudClass" : "com.bmc.cloud.model.beans.LogicalServerFarmEntry",
"name" : "Test_LogicalServerFarmEntry",
"ipAddress" : "10.1.7.11",
"isEnabled" : "false",
"computeContainerNetworkInterface" : "/computecontainernetworkinterface/4278fe64-cc80-4782-a157-17c864684626",
"serverPortNumber" : "80",
"logicalServerFarmObject" : {
"cloudClass" : "com.bmc.cloud.model.beans.LogicalServerFarm",
"name" : "Test_LogicaServerFarm",
"guid" : "2cc1af61-80a3-44f3-8cf3-3380b60f671f",
"logicalLoadBalancerObject" : {
"cloudClass" : "com.bmc.cloud.model.beans.LogicalLoadBalancer",
"guid" : "a7adcc34-b4fa-48b7-977c-38299094f5a1"
}
}
}