SwitchPort class

The SwitchPort class represents a switch port.

SwitchPort class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/SwitchPort/guid

Retrieves a SwitchPort object.

search

POST

csm/SwitchPort/search

Searches for SwitchPort objects.

Operation APIs

The SwitchPort class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/SwitchPort/guid/network

Retrieves the network relationship.

relation

GET

csm/SwitchPort/guid/networkContainer

Retrieves the networkContainer relationship.

relation

GET

csm/SwitchPort/guid/pod

Retrieves the pod relationship.

relation

GET

csm/SwitchPort/guid/serverNetworkInterface

Retrieves the serverNetworkInterface relationship.

relation

GET

csm/SwitchPort/guid/switch

Retrieves the switch relationship.

relation

GET

csm/SwitchPort/guid/switchAccessSecurityDeviceNIC

Retrieves the switchAccessSecurityDeviceNIC relationship.

relation

GET

csm/SwitchPort/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/SwitchPort/guid/provider

Retrieves the provider relationship.

relation

GET

csm/SwitchPort/guid/tags

Retrieves the tags relationship.

SwitchPort class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

network

Network

0..1

Associated network

networkContainer

NetworkContainer

0..*

Associated network containers

pod

Pod

0..1

Associated pod

serverNetworkInterface

ServerNetworkInterface

0..*

Associated server network interfaces

switch

Switch

1

Associated switch

switchAccessSecurityDeviceNIC

SwitchAccessSecurityDeviceNetworkInterface

0..*

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

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

Was this page helpful? Yes No Submitting... Thank you

Comments