LogicalHostingEnvironment acquireNATAddress request

Description

This API acquires a NAT address for a device within the LogicalHostingEnvironment

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/LogicalHostingEnvironment/guid/acquireNATAddress	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.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Name	Type	Multi- plicity	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: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
operationParams	OperationParameter	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.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
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.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Name	Type	Multi- plicity	Description
deploymentParameterValue	DeploymentParameterValue	0..*	Deployment parameter values
deviceName	String	1	Name of the device, server or virtual machine for which a NAT address is to be acquired.
privateIPList	IPAddress	1..*	List of private IP addresses for which NAT IP address are to be acquired.

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 acquires a NAT address for the Logical Hosting Environment (LHE):

{
    "timeout": 1000,
    "preCallout": "",
    "postCallout": "",
    "callbackURL": "",
    "operationParams": [
        {
            "name": "deploymentParameterValue",
            "value": [],
            "type": "com.bmc.cloud.model.beans.DeploymentParameterValue",
            "multiplicity": "0..*"
        },
        {
            "name": "deviceName",
            "value": "testroute-4",
            "type": "java.lang.String",
            "multiplicity": "1"
        },
        {
            "name": "privateIPList",
            "value": [
                {
                    "nic": "/servernetworkinterface/203b6a99-988d-437d-afb7-
df0b9bf62748/servernetworkinterface/118eafa7-5985-46a2-
99c0-1a1633a5a675",
                    "cloudClass": "com.bmc.cloud.model.beans.IPAddress",
                    "provider": "/provider/520f3309-01de-47ee-a8b0-7eefd24fa701",
                    "ipAddress": "192.168.20.5",
                    "isPublic": false,
                    "subnet": "255.255.255.224255.255.255.0",
                    "reconciliationID": "OI-9666b8b1e7d843c79cffb248d37998bdOI-
696800fdda3549889058f8946126366d",
                    "guid": "d211b0d1-e7a5-413d-8d12-cf86ac152027fdb16585-fc86-457b
-b452-7d8327c5a35d"
                }
            ],
            "type": "com.bmc.cloud.model.beans.IPAddress",
            "multiplicity": "1..*"
        }
    ]
}

The following example shows the response for the preceding request:

[
{
"cloudClass" : "com.bmc.cloud.model.beans.IPAddress",
"guid" : "dbb98b59-c02d-44eb-b509-1d88dcb401f1",
"ipAddress" : "156.54.142.10",
"isPublic" : true,
"nic" : "/servernetworkinterface/203b6a99-988d-437d-afb7-df0b9bf62748/
servernetworkinterface/118eafa7-5985-46a2-99c0-1a1633a5a675",
"reconciliationID" : "OI-685e05c2f25f4f738c567fa056794abe",
"subnet" : "255.255.255.128"
}
]