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.

ContainerBlueprint class (Provider API)


The ContainerBlueprint class describes the configuration of a network container and its zones. It is used by BMC Network Automation to create network containers and is a transient object that is created by querying it.

ContainerBlueprint class APIs

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

Basic APIs

The ContainerBlueprint class has no basic APIs.

Operation APIs

Name

HTTP
method

URI

Description

offboard

POST

Offboards the specified container blueprint.

onboard

POST

Onboards the specified container blueprint.

Relationship APIs

The ContainerBlueprint class has no relationship APIs.

ContainerBlueprint class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

networkContainers

0..*

Network containers created from this container blueprint

pods

1..*

Pods that are compatible with this container blueprint

templateNetworkContainer

0..1

Template network container that is described by this container blueprint

Attributes

Name

Type

Multi-
plicity

Description

isLocked
Boolean

1

Indicates whether the a network container created from this container blueprint can be dynamically configured.

referenceHyperlink
String

0..1

Reference hyperlink

version
String

0..1

 

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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*