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 | URI | Description |
|---|---|---|---|
get | GET | Retrieves a Zone object. | |
search | POST | Searches for Zone objects. |
Operation APIs
The Zone class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the container relationship. | |
relation | GET | Retrieves the firewall relationship. | |
relation | GET | Retrieves the loadBalancer relationship. | |
relation | GET | Retrieves the networkInterfaces relationship. | |
relation | GET | Retrieves the networks relationship. | |
relation | GET | Retrieves the staticPools relationship. | |
relation | GET | Retrieves the logicalZone relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | 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- | Description |
|---|---|---|---|
container | 1 | Network container associated with the zone | |
firewall | 0..1 |
| |
loadBalancer | 0..1 | Associated load balancer | |
networkInterfaces | 0..* | Associated network interfaces | |
networks | 0..* | Networks that serve the zone | |
staticPools | 0..* | Static pools associated with the zone | |
logicalZone | 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 |
|---|---|---|---|
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 |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |