OperatingSystem class

The OperatingSystem class represents an executing instance of some operating system. It also captures the install aspect via the SoftwareResource inheritance relation. OperatingSystem is a type of SoftwareHost that executes on bare metal, rather than on some other SoftwareHost.

OperatingSystem class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/OperatingSystem/guid

Retrieves a OperatingSystem object.

search

POST

csm/OperatingSystem/search

Searches for OperatingSystem objects.

Operation APIs

Name

HTTP
method

URI

Description

start

POST

csm/OperatingSystem/guid/start

Start the object specified by the <guid> in the URI.

stop

POST

csm/OperatingSystem/guid/stop

Stop the object specified by the <guid> in the URI.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/OperatingSystem/guid/computeContainer

Retrieves the computeContainer relationship.

relation

GET

csm/OperatingSystem/guid/functionalComponent

Retrieves the functionalComponent relationship.

relation

GET

csm/OperatingSystem/guid/server

Retrieves the server relationship.

relation

GET

csm/OperatingSystem/guid/applicationSoftware

Retrieves the applicationSoftware relationship.

relation

GET

csm/OperatingSystem/guid/hostedRunningSoftware

Retrieves the hostedRunningSoftware relationship.

relation

GET

csm/OperatingSystem/guid/resourceSet

Retrieves the resourceSet relationship.

relation

GET

csm/OperatingSystem/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/OperatingSystem/guid/provider

Retrieves the provider relationship.

relation

GET

csm/OperatingSystem/guid/tags

Retrieves the tags relationship.

OperatingSystem class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

computeContainer

ComputeContainer

0..1

Compute container associated with the operatiing system instance

functionalComponent

FunctionalComponent

1

Functional component running the operating system

server

Server

1

Server associated with the operating system instance

applicationSoftware

ApplicationSoftware

0..*

hostedRunningSoftware

RunningSoftware

0..*

resourceSet

ResourceSet

1

Resource set to which the software belongs

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

manufacturer

String

1

Name of the software manufacturer

patchLevel

String

0..1

Patch level of the software

productCatalogId

String

0..1

Product catalog identifier for the software

productName

String

1

Name of the software product

version

String

0..1

Software version

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