Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

LogicalDataCenter class


The LogicalDataCenter class represents a logical data center.

LogicalDataCenter class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the LogicalDataCenter class.

Basic APIs

Name

HTTP
method

URI

Description

get

GET

Retrieves a LogicalDataCenter object.

search

POST

Searches for LogicalDataCenter objects.

Operation APIs

Name

HTTP
method

URI

Description

offboard

POST

Offboards a logical data center.

onboard

POST

Onboards a logical data center.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

Retrieves the logicalDataCenterAddressSpace relationship.

relation

GET

Retrieves the logicalDataCenterBlueprint relationship.

relation

GET

Retrieves the logicalDataCenterDistributedFirewall relationship.

relation

GET

Retrieves the logicalDataCenterLoadBalancer relationship.

relation

GET

Retrieves the logicalDataCenterNetwork relationship.

relation

GET

Retrieves the logicalDataCenterOrganization relationship.

relation

GET

Retrieves the logicalDataCenterPerimeterFirewall relationship.

relation

GET

Retrieves the logicalDataCenterUserMap relationship.

relation

GET

Retrieves the network relationship.

relation

GET

Retrieves the templateLogicalDataCenterBlueprint relationship.

relation

GET

Retrieves the logicalHostingEnvironment relationship.

relation

GET

Retrieves the resourceDomainNameSystem relationship.

relation

GET

Retrieves the tickets relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

Retrieves the tags relationship.

LogicalDataCenter class relationships and attributes

The following tables list the relationships and attributes of the LogicalDataCenter class.

Relationships

Name

Type

Multi-
plicity

Description

logicalDataCenterAddressSpace

0..*

 

logicalDataCenterBlueprint

1

 

logicalDataCenterDistributedFirewall

0..*

 

logicalDataCenterLoadBalancer

0..*

 

logicalDataCenterNetwork

0..*

 

logicalDataCenterOrganization

0..*

Associated logical data center organizations

logicalDataCenterPerimeterFirewall

0..*

 

logicalDataCenterUserMap

0..*

Associated logical data center user maps

network

0..*

Associated networks

templateLogicalDataCenterBlueprint

1

 

logicalHostingEnvironment

0..*

Associated logical hosting environments

resourceDomainNameSystem

0..*

 

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-
plicity

Description

region
String

0..1

 

useExternalDNS
Boolean

0..1

 

useExternalIPAM
Boolean

0..1

 

hostingEnvironmentType

0..1

 

isTemplate
Boolean

0..1

Indicates whether the network container is a template.

isOnboarded
Boolean

1

Indicates whether the object is onboarded

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

 

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