NetworkContainer class (Provider API)

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
method

URI

Description

create

POST

csm/NetworkContainer

Creates a NetworkContainer object.

delete

DELETE

csm/NetworkContainer/guid

Deletes a NetworkContainer object.

update

POST

csm/NetworkContainer/guid/update

Updates a NetworkContainer object.

Operation APIs

Name

HTTP
method

URI

Description

acquireNATAddress

POST

csm/NetworkContainer/guid/acquireNATAddress

Acquires a NAT address for a device.

releaseNATAddress

POST

csm/NetworkContainer/guid/releaseNATAddress

Releases a NAT address from a device

upgradeNetworkPaths

POST

csm/NetworkContainer/guid/upgradeNetworkPaths

Relationship APIs

The NetworkContainer class has no relationship APIs.

NetworkContainer class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

containerBlueprint

ContainerBlueprint

0..1

The blueprint that defines the structure of the network container

firewall

Firewall

0..*

The firewall associated with the zone

ipAddressPools

IPAddressPool

0..*

IP address pools assigned to the network container

loadBalancer

LoadBalancer

0..*

The load balancer associated with the zone

network

Network

0..*

Associated networks

pod

Pod

1

The pod the network container belongs to

templateContainerBlueprint

ContainerBlueprint

0..1

Associated template container blueprint

zones

Zone

0..*

Zones within the network container

Attributes

Name

Type

Multi-
plicity

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

ResourceHostingEnvironmentState

1

hostingEnvironmentType

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

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments