Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

LogicalHostingEnvironment create request

Description

Creates a LogicalHostingEnvironment which adheres to a selected LogicalHostingEnvironmentBlueprint.

API stability classification

Unstable

API overview


 


HTTP
method

URI

Return
type

Return type
multiplicity

POST
csm/LogicalHostingEnvironment
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 objects

 


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

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.


 

Input parameters to include in operationParams

 


Name

Type

Multi-
plicity

Description

contextId
String

0..1

For an on-premise Logical Hosting Environment creation, contextId must be a valid Pod ID. For any other type of Logical Hosting Environment, this parameter is not required.

logicalHostingEnvironment

1

Logical hosting environment to create

runtimeParameters

0..*

An optional list of CloudParameter objects containing any specialized parameters to be applied during LogicalHostingEnvironment creation.
 The set of possible parameters that may be provided is available in the LogicalHostingEnvironmentBlueprint.


 


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 creates a network container:

{
   "timeout": -1,
   "preCallout": "",
   "postCallout": "",
   "callbackURL": "http://172.22.183.149:9090/callback/bc8b4e88-3b63-4b1f-a817-9a3088229bb1",
   "operationParams": [
        {
           "name": "logicalHostingEnvironment",
           "type": "com.bmc.cloud.model.beans.LogicalHostingEnvironment",
           "multiplicity": "1",
           "value": {
               "cloudClass": "com.bmc.cloud.model.beans.LogicalHostingEnvironment",
               "name": "API-LHE-78",
               "logicalHostingEnvironmentBlueprintObject": {
                   "cloudClass": "com.bmc.cloud.model.beans.LogicalHostingEnvironmentBlueprint",
                   "guid": "7c977bef-9abf-430a-9a47-ad886bb65311"
                },
               "logicalNetworkObject": [
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.LogicalNetwork",
                       "guid": "7c5cdc97-6fcc-4438-8c13-e48b0b5136d8",
                       "networkAddress": "10.137.144.0",
                       "networkMask": "255.255.255.0",
                       "isEnabled": true,
                       "isLocked": false
                    },
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.LogicalNetwork",
                       "guid": "b4d8c2b5-31f8-48de-bb3e-7f57960f2708",
                       "networkAddress": "16.0.0.0",
                       "networkMask": "255.255.255.0",
                       "isEnabled": true,
                       "isLocked": false
                    },
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.LogicalNetwork",
                       "guid": "3aa74988-d823-414e-8108-67e022023838",
                       "networkAddress": "10.137.0.0",
                       "networkMask": "255.255.255.0",
                       "isEnabled": true,
                       "isLocked": false
                    }
                ],
               "logicalFirewallObject": [
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.LogicalPerimeterFirewall",
                       "guid": "16488ca6-bfed-4328-b5bb-5efac5fbc0f9",
                       "isEnabled": "true",
                       "isLocked": false,
                       "isManuallyEnableable": true,
                       "isTemplate": false,
                       "name": "VFW"
                    }
                ],
               "logicalLoadBalancerObject": [
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.LogicalLoadBalancer",
                       "guid": "a005506c-a748-4d83-a73b-80fb048ce237",
                       "isEnabled": "true",
                       "isLocked": false
                    }
                ],
               "logicalZoneObject": [
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.LogicalZone",
                       "guid": "67703ae6-6d5d-4e9d-8160-aa9beefe0aa3",
                       "isEnabled": true,
                       "logicalNetworkObject": [
                            {
                               "cloudClass": "com.bmc.cloud.model.beans.LogicalNetwork",
                               "guid": "3aa74988-d823-414e-8108-67e022023838",
                               "networkAddress": "10.137.0.0",
                               "networkMask": "255.255.255.0",
                               "isEnabled": true,
                               "isLocked": false
                            }
                        ]
                    }
                ]
            }
        },
        {
           "name": "contextId",
           "type": "java.lang.String",
           "multiplicity": "1",
           "value": "5710dcec-cfc7-4d19-a43a-4230198d1ef0"
        }
    ]
}

The following example shows the response for the preceding request:

[
   {
       "cloudClass": "com.bmc.cloud.model.beans.Task",
       "className": "LogicalHostingEnvironment",
       "completionTime": "2015/04/19 21:30:29 GMT-12:00",
       "creationTime": "2015/04/19 21:09:07 GMT-12:00",
       "errors": [],
       "guid": "189b5d2c-312b-4623-ae98-12cdd801fbe7",
       "isCallout": false,
       "isError": false,
       "isSuccess": true,
       "objectName": "API-LHE-78",
       "operationName": "constructor",
       "results": [
           "com.bmc.cloud.model.beans.LogicalHostingEnvironment:{\r\n \"cloudClass\" : \"com.bmc.cloud.model.beans.LogicalHostingEnvironment\",\r\n \"externalID\" : \"3b3c79ae-1ed9-4db6-9a72-f2e6c70ee44c:VIROY-POD:Nat Address Space:NatPool:API-LHE-78\",\r\n \"guid\" : \"851d80bc-714e-475e-9705-61cd60073d53\",\r\n \"isNATSupported\" : true,\r\n \"isTemplate\" : false,\r\n \"logicalAddressPool\" : [ \"/logicaladdresspool/c78d1a4b-25e6-4f84-a9e3-1931291948cd\" ],\r\n \"logicalFirewall\" : [ \"/logicalperimeterfirewall/4038b6c3-b945-48dc-923c-fef7bc8346ad\" ],\r\n \"logicalHostingEnvironmentBlueprint\" : \"/logicalhostingenvironmentblueprint/7c977bef-9abf-430a-9a47-ad886bb65311\",\r\n \"logicalLoadBalancer\" : [ \"/logicalloadbalancer/cb142ba0-b526-428c-89c6-ed5801890159\" ],\r\n \"logicalNetwork\" : [ \"/logicalnetwork/82692d3e-6679-4007-8341-0ac836f6a80c\", \"/logicalnetwork/13036d5c-96e7-4abf-9ace-134532a5c4df\", \"/logicalnetwork/4eeba21b-6b74-4d77-8f5c-3eae94291bf6\", \"/logicalnetwork/001cfc83-f8b2-4d2e-bb43-3ae0feaca11a\" ],\r\n \"logicalZone\" : [ \"/logicalzone/5c51a756-6d65-4ffe-951f-81173d7012b4\" ],\r\n \"modifiedDate\" : 1429522221000,\r\n \"name\" : \"API-LHE-78\",\r\n \"owner\" : \"AltoCloudAdmin\",\r\n \"provider\" : \"/provider/f8d5bdb5-9202-48b5-a301-90aa5822edfd\",\r\n \"reconciliationID\" : \"OI-1824dfac3d5a42c1afe98f6a58d721a4\",\r\n \"resourceHostingEnvironment\" : \"/networkcontainer/bbe2af46-d69d-43b6-bf45-31a1a9ded9b8\",\r\n \"resourceHostingEnvironmentObject\" : {\r\n \"cloudClass\" : \"com.bmc.cloud.model.beans.NetworkContainer\",\r\n \"allowsPublicIP\" : true,\r\n \"containerBlueprint\" : \"/containerblueprint/4ac20040-9091-4ffc-b2db-d19a70c9dc11\",\r\n \"externalID\" : \"3b3c79ae-1ed9-4db6-9a72-f2e6c70ee44c:VIROY-POD:Nat Address Space:NatPool:API-LHE-78\",\r\n \"firewall\" : [ \"/firewall/e04ff1d5-16d8-48be-881e-ade17727470c\" ],\r\n \"guid\" : \"bbe2af46-d69d-43b6-bf45-31a1a9ded9b8\",\r\n \"hostingEnvironmentType\" : \"OnPremise\",\r\n \"ipAddressPools\" : [ \"/ipaddresspool/68b7848d-01b7-443a-8c11-8178bb7060e2\" ],\r\n \"isOnboarded\" : true,\r\n \"isTemplate\" : false,\r\n \"loadBalancer\" : [ \"/loadbalancer/07314696-d4de-4b2d-908b-d4c850b00078\" ],\r\n \"logicalHostingEnvironment\" : [ \"/logicalhostingenvironment/851d80bc-714e-475e-9705-61cd60073d53\" ],\r\n \"modifiedDate\" : 1429522210000,\r\n \"name\" : \"API-LHE-78\",\r\n \"network\" : [ \"/network/b92b066b-d186-45bb-844f-fb6df8103dbe\", \"/network/3645875e-e746-4f8e-be21-80cb464c4e06\" ],\r\n \"owner\" : \"AltoCloudAdmin\",\r\n \"pod\" : \"/pod/5710dcec-cfc7-4d19-a43a-4230198d1ef0\",\r\n \"provider\" : \"/provider/3b3c79ae-1ed9-4db6-9a72-f2e6c70ee44c\",\r\n \"reconciliationID\" : \"OI-b1a3f033a5234ca79e2cec7367b63104\",\r\n \"state\" : \"Active\",\r\n \"switchPort\" : [ \"/switchport/70d1c882-d5f2-45bb-b4ef-ba9234356886\", \"/switchport/81a3e04c-dbc7-4d62-8aca-bcde27f44521\", \"/switchport/c04f95f2-2966-4948-81c1-5c0aaa2ff031\", \"/switchport/971b3d35-d30e-41a8-bbc1-b8aa20b17c35\", \"/switchport/1453f644-386d-4fac-982d-146fad606a9f\", \"/switchport/d3960414-ff8a-4f2d-94b5-6845d00e5a0a\" ],\r\n \"tokenID\" : \"5710dcec-cfc7-4d19-a43a-4230198d1ef0:bbe2af46-d69d-43b6-bf45-31a1a9ded9b8\",\r\n \"zones\" : [ \"/zone/09ebf631-3d51-45ae-af0c-bad5da1c718e\" ]\r\n },\r\n \"state\" : \"Active\",\r\n \"tokenID\" : \"851d80bc-714e-475e-9705-61cd60073d53\",\r\n \"useExternalDNS\" : false,\r\n \"useExternalIPAM\" : false\r\n}"
        ],
       "taskInternalUUID": "4033b260-9309-42ba-88b6-3add103ff8c3",
       "taskProgress": 100,
       "taskResultURI": "http://10.1.48.7:9090/csm/task/4033b260-9309-42ba-88b6-3add103ff8c3/result",
       "taskState": "COMPLETED",
       "taskStatusURI": "http://10.1.48.7:9090/csm/task/4033b260-9309-42ba-88b6-3add103ff8c3/status",
       "taskSubState": "lheCreate_task_success",
       "transactionID": "4ea1e496-45e6-45f3-8b10-20df2bfd93e8"
   }
]

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*