NetworkContainer class
The NetworkContainer class represents a virtual data center called a network container. Network containers provide a secure logical separation of resources within a pod. A cloud environment can have multiple network containers. A private cloud might have only one network container, while a public cloud is likely to have a separate network container for each tenant. From the perspective of BMC Network Automation, a network container is an instantiation of a container blueprint. A container blueprint describes a network container and includes information such as the number of secure zones in the container and the resources needed to support the container (for example, a firewall services module (FWSM) and virtual local area networks (VLANs)).
NetworkContainer class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the NetworkContainer class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
create | POST | Creates a NetworkContainer object. | |
delete | DELETE | Deletes a NetworkContainer object. | |
get | GET | Retrieves a NetworkContainer object. | |
refresh | POST | Refreshes a NetworkContainer object. | |
update | POST | Updates a NetworkContainer object. | |
search | POST | Searches for NetworkContainer objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
acquireLock | POST | Acquires a lock on a network container. | |
releaseLock | POST | Releases a previously acquired lock on a network container. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the assignedOrganizations relationship. Note: This API is deprecated. Instead, use csm/LogicalHostingEnvironment/guid/organization API from this LogicalHostingEnvironment-class. | |
relation | GET | Retrieves the cloudParameter relationship. | |
relation | GET | Retrieves the containerBlueprint relationship. | |
relation | GET | Retrieves the containerParameterValues relationship. | |
relation | GET | Retrieves the firewall relationship. | |
relation | GET | Retrieves the hostedResourceSets relationship. | |
relation | GET | Retrieves the loadBalancer relationship. | |
relation | GET | Retrieves the network relationship. | |
relation | GET | Retrieves the pod relationship. | |
relation | GET | Retrieves the staticPools relationship. | |
relation | GET | Retrieves the switchAccessSecurityDevice relationship. | |
relation | GET | Retrieves the switchPort relationship. | |
relation | GET | Retrieves the templateContainerBlueprint relationship. | |
relation | GET | Retrieves the zones 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. |
NetworkContainer class relationships and attributes
The following tables list the relationships and attributes of the NetworkContainer class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
assignedOrganizations | 0..* | Organizations assigned to the network container | |
cloudParameter | 0..* |
| |
containerBlueprint | 0..1 | The blueprint that defines the structure of the network container | |
containerParameterValues | 0..* | Container parameter values | |
firewall | 0..* | The firewall associated with the zone | |
hostedResourceSets | 0..* | Resource sets hosted by the network container | |
loadBalancer | 0..* | The load balancer associated with the zone | |
network | 0..* | Associated networks | |
pod | 1 | The pod the network container belongs to | |
staticPools | 0..* | Static pools mapped to the network container | |
switchAccessSecurityDevice | 0..* |
| |
switchPort | 0..* | Associated switch ports | |
templateContainerBlueprint | 0..1 | Associated template container blueprint | |
zones | 0..* | Zones within the network container | |
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- | Description |
|---|---|---|---|
allowsPublicIP | Boolean | 1 | Indicates whether the network container allows a public IP address. |
publicIPAddress | String | 0..1 | Public IP address for the network container |
publicIPMask | String | 0..1 | Public IP address mask for the network container |
state | 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 |