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 | URI | Description |
|---|---|---|---|
get | GET | Retrieves a OperatingSystem object. | |
search | POST | Searches for OperatingSystem objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
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
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the computeContainer relationship. | |
relation | GET | Retrieves the functionalComponent relationship. | |
relation | GET | Retrieves the server relationship. | |
relation | GET | Retrieves the applicationSoftware relationship. | |
relation | GET | Retrieves the hostedRunningSoftware relationship. | |
relation | GET | Retrieves the resourceSet relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | 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- | Description |
|---|---|---|---|
computeContainer | 0..1 | Compute container associated with the operatiing system instance | |
functionalComponent | 1 | Functional component running the operating system | |
server | 1 | Server associated with the operating system instance | |
applicationSoftware | 0..* |
| |
hostedRunningSoftware | 0..* |
| |
resourceSet | 1 | Resource set to which the software belongs | |
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 |
|---|---|---|---|
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 |