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
method

URI

Description

create

POST

csm/NetworkContainer

Creates a NetworkContainer object.

delete

DELETE

csm/NetworkContainer/guid

Deletes a NetworkContainer object.

get

GET

csm/NetworkContainer/guid

Retrieves a NetworkContainer object.

refresh

POST

csm/NetworkContainer/guid

Refreshes a NetworkContainer object.

update

POST

csm/NetworkContainer/guid/update

Updates a NetworkContainer object.

search

POST

csm/NetworkContainer/search

Searches for NetworkContainer objects.




Operation APIs




Name

HTTP
method

URI

Description

acquireLock

POST

csm/NetworkContainer/guid/acquireLock

Acquires a lock on a network container.

releaseLock

POST

csm/NetworkContainer/guid/releaseLock

Releases a previously acquired lock on a network container.




Relationship APIs




Name

HTTP
method

URI

Description

relation

GET

csm/NetworkContainer/guid/assignedOrganizations

Retrieves the assignedOrganizations relationship.

Note: This API is deprecated. Instead, use csm/LogicalHostingEnvironment/guid/organization API from this LogicalHostingEnvironment class.

relation

GET

csm/NetworkContainer/guid/cloudParameter

Retrieves the cloudParameter relationship.

relation

GET

csm/NetworkContainer/guid/containerBlueprint

Retrieves the containerBlueprint relationship.

relation

GET

csm/NetworkContainer/guid/containerParameterValues

Retrieves the containerParameterValues relationship.

relation

GET

csm/NetworkContainer/guid/firewall

Retrieves the firewall relationship.

relation

GET

csm/NetworkContainer/guid/hostedResourceSets

Retrieves the hostedResourceSets relationship.

relation

GET

csm/NetworkContainer/guid/loadBalancer

Retrieves the loadBalancer relationship.

relation

GET

csm/NetworkContainer/guid/network

Retrieves the network relationship.

relation

GET

csm/NetworkContainer/guid/pod

Retrieves the pod relationship.

relation

GET

csm/NetworkContainer/guid/staticPools

Retrieves the staticPools relationship.

relation

GET

csm/NetworkContainer/guid/switchAccessSecurityDevice

Retrieves the switchAccessSecurityDevice relationship.

relation

GET

csm/NetworkContainer/guid/switchPort

Retrieves the switchPort relationship.

relation

GET

csm/NetworkContainer/guid/templateContainerBlueprint

Retrieves the templateContainerBlueprint relationship.

relation

GET

csm/NetworkContainer/guid/zones

Retrieves the zones relationship.

relation

GET

csm/NetworkContainer/guid/logicalHostingEnvironment

Retrieves the logicalHostingEnvironment relationship.

relation

GET

csm/NetworkContainer/guid/resourceDomainNameSystem

Retrieves the resourceDomainNameSystem relationship.

relation

GET

csm/NetworkContainer/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/NetworkContainer/guid/provider

Retrieves the provider relationship.

relation

GET

csm/NetworkContainer/guid/tags

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

Description


assignedOrganizations

Organization

0..*

Organizations assigned to the network container

cloudParameter

CloudParameter

0..*

containerBlueprint

ContainerBlueprint

0..1

The blueprint that defines the structure of the network container


containerParameterValues


ContainerParameterValue

0..*

Container parameter values

firewall

Firewall

0..*

The firewall associated with the zone

hostedResourceSets

ResourceSet

0..*

Resource sets hosted by 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

staticPools

StaticPool

0..*

Static pools mapped to the network container


switchAccessSecurityDevice


SwitchAccessSecurityDevice

0..*

switchPort

SwitchPort

0..*

Associated switch ports


templateContainerBlueprint

ContainerBlueprint

0..1

Associated template container blueprint

zones

Zone

0..*

Zones within the network container


logicalHostingEnvironment


LogicalHostingEnvironment

0..*

Associated logical hosting environments


resourceDomainNameSystem


ResourceDomainNameSystem

0..*

tickets

Ticket

0..*

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

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