ContainerBlueprint class

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

Name	HTTP method	URI	Description
get	`GET`	`csm/ContainerBlueprint/guid`	Retrieves a `ContainerBlueprint` object.
search	`POST`	`csm/ContainerBlueprint/search`	Searches for `ContainerBlueprint` objects.

Operation APIs

Name	HTTP method	URI	Description
offboard	`POST`	`csm/ContainerBlueprint/guid/offboard`	Offboards the specified container blueprint.
onboard	`POST`	`csm/ContainerBlueprint/onboard`	Onboards container blueprints.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/ContainerBlueprint/guid/networkContainers`	Retrieves the `networkContainers` relationship.
relation	`GET`	`csm/ContainerBlueprint/guid/pods`	Retrieves the `pods` relationship.
relation	`GET`	`csm/ContainerBlueprint/guid/templateNetworkContainer`	Retrieves the `templateNetworkContainer` relationship.
relation	`GET`	`csm/ContainerBlueprint/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/ContainerBlueprint/guid/tags`	Retrieves the `tags` relationship.

ContainerBlueprint class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
`networkContainers`	`NetworkContainer`	0..*	Network containers created from this container blueprint
`pods`	`Pod`	1..*	Pods that are compatible with this container blueprint
`templateNetworkContainer`	`NetworkContainer`	0..1	Template network container that is described by this container blueprint
`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
`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
`name`	`String`	1	Human-readable name of the object