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.

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
method

URI

Description

get

GET

csm/Switch/guid

Retrieves a Switch object.

search

POST

csm/Switch/search

Searches for Switch objects.

Operation APIs

The Switch class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Switch/guid/pod

Retrieves the pod relationship.

relation

GET

csm/Switch/guid/switchAccessSecurityDevice

Retrieves the switchAccessSecurityDevice relationship.

relation

GET

csm/Switch/guid/switchPort

Retrieves the switchPort relationship.

relation

GET

csm/Switch/guid/virtualCluster

Retrieves the virtualCluster relationship.

relation

GET

csm/Switch/guid/virtualHost

Retrieves the virtualHost relationship.

relation

GET

csm/Switch/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Switch/guid/tags

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-
plicity

Description

pod

Pod

0..*

Associated pods

switchAccessSecurityDevice

SwitchAccessSecurityDevice

0..*

switchPort

SwitchPort

1..*

Associated switch ports

virtualCluster

VirtualCluster

0..*

Virtual clusters that use the switch

virtualHost

VirtualHost

0..*

Virtual hosts that use the switch

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

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

name

String

1

Human-readable name of the object

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.

Comments