Switch class
The Switch class represents a switch.
Switch class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the Switch class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a Switch object. | |
search | POST | Searches for Switch objects. |
Operation APIs
The Switch class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the pod relationship. | |
relation | GET | Retrieves the switchAccessSecurityDevice relationship. | |
relation | GET | Retrieves the switchPort relationship. | |
relation | GET | Retrieves the virtualCluster relationship. | |
relation | GET | Retrieves the virtualHost relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
Switch class relationships and attributes
The following tables list the relationships and attributes of the Switch class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
pod | 0..* | Associated pods | |
switchAccessSecurityDevice | 0..* |
| |
switchPort | 1..* | Associated switch ports | |
virtualCluster | 0..* | Virtual clusters that use the switch | |
virtualHost | 0..* | Virtual hosts that use the switch | |
tickets | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
networkIdentity | String | 0..1 | Network identity |
password | String | 0..1 |
|
privilegedPassword | String | 0..1 |
|
privilegedUserName | String | 0..1 |
|
userName | 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 |