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.

RunningSoftware class (Provider API)


The RunningSoftware class represents running instances of software designed to be run in some kind of software environment, i.e., to be hosted on a SoftwareHost. It models the runtime aspect (state and behavior) of such software as opposed to the deployed aspects.

RunningSoftware class APIs

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

Basic APIs

The RunningSoftware class has no basic APIs.

Operation APIs

Name

HTTP
method

URI

Description

shutdown

POST

Shutdown this RunningSoftware. To force a shudown the force parameter should be set to 'true'.

suspend

POST

Suspend this RunningSoftware.

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 RunningSoftware class has no relationship APIs.

RunningSoftware class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

softwareContainer

0..1

 

softwareHost

0..1

 

softwareResourceProperties

0..*

 

Attributes

Name

Type

Multi-
plicity

Description

computeCapacity
Integer

0..1

 

edition
String

0..1

 

ioCapacity
Integer

0..1

 

memoryCapacity
Integer

0..1

 

platformArchitecture
String

0..1

 

provisionedDate

0..1

 

role
String

0..1

 

state

 

 

subtype
String

0..1

 

type
String

1

 

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*