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 method	URI	Description
create	`POST`	`csm/LogicalHostingEnvironment`	Creates a `LogicalHostingEnvironment` object.
delete	`DELETE`	`csm/LogicalHostingEnvironment/guid`	Deletes a `LogicalHostingEnvironment` object.
get	`GET`	`csm/LogicalHostingEnvironment/guid`	Retrieves a `LogicalHostingEnvironment` object.
update	`POST`	`csm/LogicalHostingEnvironment/guid/update`	Updates a `LogicalHostingEnvironment` object.
search	`POST`	`csm/LogicalHostingEnvironment/search`	Searches for `LogicalHostingEnvironment` objects.

Operation APIs

Name	HTTP method	URI	Description
acquireLock	`POST`	`csm/LogicalHostingEnvironment/guid/acquireLock`	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`	`csm/LogicalHostingEnvironment/guid/acquireNATAddress`	Acquires a NAT address for a device.
releaseLock	`POST`	`csm/LogicalHostingEnvironment/guid/releaseLock`	Releases a previously acquired lock on the `LogicalHostingEnvironment` object.
releaseNATAddress	`POST`	`csm/LogicalHostingEnvironment/guid/releaseNATAddress`	Releases a NAT address from a device
reprovision	`POST`	`csm/LogicalHostingEnvironment/guid/reprovision`	Re-provisions the `LogicalHostingEnvironment` to adhere to a newer version of a `LogicalHostingEnvironmentBlueprint`.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/LogicalHostingEnvironment/guid/cloudParameter`	Retrieves the `cloudParameter` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalAddressPool`	Retrieves the `logicalAddressPool` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalAddressSpace`	Retrieves the `logicalAddressSpace` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalCommunicationPath`	Retrieves the `logicalCommunicationPath` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalDomainNameSystem`	Retrieves the `logicalDomainNameSystem` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalFirewall`	Retrieves the `logicalFirewall` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalHostingEnvironmentBlueprint`	Retrieves the `logicalHostingEnvironmentBlueprint` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalLoadBalancer`	Retrieves the `logicalLoadBalancer` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalNetwork`	Retrieves the `logicalNetwork` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/logicalZone`	Retrieves the `logicalZone` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/organization`	Retrieves the `organization` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/resourceHostingEnvironment`	Retrieves the `resourceHostingEnvironment` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/resourceSet`	Retrieves the `resourceSet` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/templateLogicalHostingEnvironmentBlueprint`	Retrieves the `templateLogicalHostingEnvironmentBlueprint` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/LogicalHostingEnvironment/guid/tags`	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- plicity	Description
`cloudParameter`	`CloudParameter`	0..*
`logicalAddressPool`	`LogicalAddressPool`	0..*
`logicalAddressSpace`	`LogicalAddressSpace`	0..*
`logicalCommunicationPath`	`LogicalCommunicationPath`	0..*	Associated logical communication paths
`logicalDomainNameSystem`	`LogicalDomainNameSystem`	0..*
`logicalFirewall`	`LogicalFirewall`	0..*
`logicalHostingEnvironmentBlueprint`	`LogicalHostingEnvironmentBlueprint`	1
`logicalLoadBalancer`	`LogicalLoadBalancer`	0..*
`logicalNetwork`	`LogicalNetwork`	0..*	Associated logical networks
`logicalZone`	`LogicalZone`	0..*
`organization`	`Organization`	0..*	Associated organizations
`resourceHostingEnvironment`	`ResourceHostingEnvironment`	1	Associated resource hosting environment
`resourceSet`	`ResourceSet`	0..*	Associated resource sets
`templateLogicalHostingEnvironmentBlueprint`	`LogicalHostingEnvironmentBlueprint`	0..1
`tickets`	`Ticket`	0..*
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`isNATSupported`	`Boolean`	0..1
`isTemplate`	`Boolean`	0..1
`state`	`ResourceHostingEnvironmentState`	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`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object