Pod class (Provider API)
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
The Pod class has no basic APIs.
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
offboard | POST | Offboards a pod. | |
onboard | POST | Onboards a pod. |
Relationship APIs
The Pod class has no relationship APIs.
Pod class relationships and attributes
The following tables list the relationships and attributes of the Pod class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
containerBlueprints | 0..* | Container blueprints that are compatible with the pod | |
containers | 1..* | Network containers in the pod | |
ipAddressPools | 0..* | IP address pools associated with the pod | |
networks | 0..* | Networks served by the pod |
Attributes
Name | Type | Multi- | 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 | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |