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.

Zone class

The Zone class represents a level 3 application execution environment based on some set of rules. For example, zones may be organized based on data sensitivity or security labels, service levels, workload type (such as production or preproduction), application tiers, and so on. Typically, each zone in a network container is separated by a firewall. VMs are typically created in a specific zone.

Zone class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/Zone/guid

Retrieves a Zone object.

search

POST

csm/Zone/search

Searches for Zone objects.

Operation APIs

The Zone class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Zone/guid/container

Retrieves the container relationship.

relation

GET

csm/Zone/guid/firewall

Retrieves the firewall relationship.

relation

GET

csm/Zone/guid/loadBalancer

Retrieves the loadBalancer relationship.

relation

GET

csm/Zone/guid/networkInterfaces

Retrieves the networkInterfaces relationship.

relation

GET

csm/Zone/guid/networks

Retrieves the networks relationship.

relation

GET

csm/Zone/guid/staticPools

Retrieves the staticPools relationship.

relation

GET

csm/Zone/guid/logicalZone

Retrieves the logicalZone relationship.

relation

GET

csm/Zone/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Zone/guid/tags

Retrieves the tags relationship.

Zone class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

container

NetworkContainer

1

Network container associated with the zone

firewall

Firewall

0..1

loadBalancer

LoadBalancer

0..1

Associated load balancer

networkInterfaces

NetworkInterface

0..*

Associated network interfaces

networks

Network

0..*

Networks that serve the zone

staticPools

StaticPool

0..*

Static pools associated with the zone

logicalZone

LogicalZone

0..1

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

isEnabled

Boolean

1

Indicates whether the zone is enabled.

isTemplate

Boolean

1

Indicates whether the zone 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

name

String

1

Human-readable name of the object

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.

Comments