LogicalHostingEnvironment releaseNATAddress request
Description
This API releases a NAT address for a device.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/LogicalHostingEnvironment/guid/releaseNATAddress | 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 |
|---|---|---|---|
deviceName | String | 1 | Name of the device, server or virtual machine for which one or more NAT IP addresses are to be released |
natIPList | 1..* | List of NAT IP addresses to be released | |
releaseOnFailure | Boolean | 1 | Indicates whether to force the NAT IP(s) to be released in case a failure occurs. |
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 releases a NAT address from the Logical Hosting Environment (LHE):
"timeout":1000,
"preCallout":"",
"postCallout":"",
"callbackURL":"",
"operationParams":
[
{
"name": "deviceName",
"value": "testroute-4",
"type": "java.lang.String",
"multiplicity" : "1"
},
{
"name": "natIPList",
"value":
[
{
"nic": "/servernetworkinterface/203b6a99-988d-437d-afb7-df0b9bf62748",
"cloudClass": "com.bmc.cloud.model.beans.IPAddress",
"provider": "/provider/520f3309-01de-47ee-a8b0-7eefd24fa701",
"ipAddress": "156.54.142.10",
"isPublic": true,
"subnet": "255.255.255.128",
"reconciliationID": "OI-685e05c2f25f4f738c567fa056794abe",
"guid":"dbb98b59-c02d-44eb-b509-1d88dcb401f1"
}
],
"type": "com.bmc.cloud.model.beans.IPAddress",
"multiplicity" : "1..*"
},
{
"name": "releaseOnFailure",
"value": true,
"type": "java.lang.Boolean",
"multiplicity" : "1"
}
]
}