Pod class

The Pod class represents a set of physical devices. From the perspective of BMC Network Automation, a pod is an instantiation of a pod blueprint in which physical devices are assigned to each of the types of devices described in the pod blueprint. A pod blueprint is a description of a pod that lists the types of devices that must be included in a pod created from the blueprint. For example, a pod blueprint might specify that a pod must contain two aggregation switches, two services devices, and an edge switch.

Pod class APIs

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

Basic APIs

Name	HTTP method	URI	Description
get	GET	csm/Pod/guid	Retrieves a Pod object.
refresh	POST	csm/Pod/guid	Refreshes a Pod object.
search	POST	csm/Pod/search	Searches for Pod objects.

Operation APIs

Name	HTTP method	URI	Description
getCompatibleBlueprints	POST	csm/Pod/guid/getCompatibleBlueprints	The getCompatibleBlueprints operation retrieves all LogicalHostingEnvironment blueprints that are compatible with this pod. If the isOnboarded flag is set to false, the operation will retrieve all non-onboarded blueprints from the on-premise provider. If the isOnboarded flag is set to true, the operation will retrieve all the blueprints that exist in the cloud database. This operation replaces a blanket ContainerBlueprint.search operation.
offboard	POST	csm/Pod/guid/offboard	Offboards the specified pod.
onboard	POST	csm/Pod/onboard	Onboards pods.

Relationship APIs

Name	HTTP method	URI	Description
relation	GET	csm/Pod/guid/containerBlueprints	Retrieves the containerBlueprints relationship.
relation	GET	csm/Pod/guid/containers	Retrieves the containers relationship.
relation	GET	csm/Pod/guid/location	Retrieves the location relationship.
relation	GET	csm/Pod/guid/networks	Retrieves the networks relationship.
relation	GET	csm/Pod/guid/staticPools	Retrieves the staticPools relationship.
relation	GET	csm/Pod/guid/switch	Retrieves the switch relationship.
relation	GET	csm/Pod/guid/switchAccessSecurityDevice	Retrieves the switchAccessSecurityDevice relationship.
relation	GET	csm/Pod/guid/switchPort	Retrieves the switchPort relationship.
relation	GET	csm/Pod/guid/tickets	Retrieves the tickets relationship.
relation	GET	csm/Pod/guid/provider	Retrieves the provider relationship.
relation	GET	csm/Pod/guid/tags	Retrieves the tags relationship.

Pod class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
containerBlueprints	ContainerBlueprint	0..*	Container blueprints that are compatible with the pod
containers	NetworkContainer	1..*	Network containers in the pod
location	Location	1	Location of the pod
networks	Network	0..*	Networks served by the pod
staticPools	StaticPool	0..*	Static pools associated with the pod
switch	Switch	0..*	Associated switches
switchAccessSecurityDevice	SwitchAccessSecurityDevice	0..*
switchPort	SwitchPort	0..*	Associated switch ports
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
referenceHyperlink	String	0..1	Reference hyperlink
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