LogicalHostingEnvironment class
The LogicalHostingEnvironment class represents a logical hosting environment.
LogicalHostingEnvironment class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the LogicalHostingEnvironment class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
create | POST | Creates a LogicalHostingEnvironment object. | |
delete | DELETE | Deletes a LogicalHostingEnvironment object. | |
get | GET | Retrieves a LogicalHostingEnvironment object. | |
update | POST | Updates a LogicalHostingEnvironment object. | |
search | POST | Searches for LogicalHostingEnvironment objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
acquireLock | POST | Locks a LogicalHostingEnvironment object to prevent parallel updates. This API should be executed before any updates to LogicalFirewallRule or LogicalNetworkPath within this environment. Once updates are complete, the LogicalHostingEnvironment lock should be released using the releaseLock API. | |
acquireNATAddress | POST | Acquires a NAT address for a device. | |
releaseLock | POST | Releases a previously acquired lock on the LogicalHostingEnvironment object. | |
releaseNATAddress | POST | Releases a NAT address from a device | |
reprovision | POST | Re-provisions the LogicalHostingEnvironment to adhere to a newer version of a LogicalHostingEnvironmentBlueprint. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the cloudParameter relationship. | |
relation | GET | Retrieves the logicalAddressPool relationship. | |
relation | GET | Retrieves the logicalAddressSpace relationship. | |
relation | GET | Retrieves the logicalCommunicationPath relationship. | |
relation | GET | Retrieves the logicalDomainNameSystem relationship. | |
relation | GET | Retrieves the logicalFirewall relationship. | |
relation | GET | Retrieves the logicalHostingEnvironmentBlueprint relationship. | |
relation | GET | Retrieves the logicalLoadBalancer relationship. | |
relation | GET | Retrieves the logicalNetwork relationship. | |
relation | GET | Retrieves the logicalZone relationship. | |
relation | GET | Retrieves the organization relationship. | |
relation | GET | Retrieves the resourceHostingEnvironment relationship. | |
relation | GET | Retrieves the resourceSet relationship. | |
relation | GET | Retrieves the templateLogicalHostingEnvironmentBlueprint relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
LogicalHostingEnvironment class relationships and attributes
The following tables list the relationships and attributes of the LogicalHostingEnvironment class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
cloudParameter | 0..* |
| |
logicalAddressPool | 0..* |
| |
logicalAddressSpace | 0..* |
| |
logicalCommunicationPath | 0..* | Associated logical communication paths | |
logicalDomainNameSystem | 0..* |
| |
logicalFirewall | 0..* |
| |
logicalHostingEnvironmentBlueprint | 1 |
| |
logicalLoadBalancer | 0..* |
| |
logicalNetwork | 0..* | Associated logical networks | |
logicalZone | 0..* |
| |
organization | 0..* | Associated organizations | |
resourceHostingEnvironment | 1 | Associated resource hosting environment | |
resourceSet | 0..* | Associated resource sets | |
templateLogicalHostingEnvironmentBlueprint | 0..1 |
| |
tickets | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
isNATSupported | Boolean | 0..1 |
|
isTemplate | Boolean | 0..1 |
|
state | 1 |
| |
useExternalDNS | Boolean | 0..1 |
|
useExternalIPAM | Boolean | 0..1 |
|
externalID | String | 0..1 | Identifier used for the object by an external provider |
owner | String | 0..1 | Name of the owner of the object |
reconciliationID | String | 0..1 | Reconciliation identity value for the object from the BMC Atrium CMDB |
tokenID | String | 0..1 | Token identifier |
description | String | 0..1 | Text that describes the object |
guid | String | 1 | Globally unique identifier for the object |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |