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.

OperatingSystem class (Provider API)


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

create

POST

Creates a OperatingSystem object.

Operation APIs

Name

HTTP
method

URI

Description

destructor

POST

Destructor for an OperatingSystem class object

start

POST

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

stop

POST

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

Relationship APIs

The OperatingSystem class has no relationship APIs.

OperatingSystem class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

server

1

Server associated with the operating system instance

applicationSoftware

0..*

 

hostedRunningSoftware

0..*

 

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

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*