RunningSoftware class

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

Name	HTTP method	URI	Description
modify	`PUT`	`csm/RunningSoftware/guid`	Modifies a `RunningSoftware` object.
get	`GET`	`csm/RunningSoftware/guid`	Retrieves a `RunningSoftware` object.
update	`POST`	`csm/RunningSoftware/guid/update`	Updates a `RunningSoftware` object.
search	`POST`	`csm/RunningSoftware/search`	Searches for `RunningSoftware` objects.

Operation APIs

Name	HTTP method	URI	Description
restart	`POST`	`csm/RunningSoftware/guid/restart`	Restart this `RunningSoftware`.
resume	`POST`	`csm/RunningSoftware/guid/resume`	Resume this `RunningSoftware`.
run	`POST`	`csm/RunningSoftware/guid/run`	Run this `RunningSoftware`.
shutdown	`POST`	`csm/RunningSoftware/guid/shutdown`	Shutdown this `RunningSoftware`. To force a shudown the `force` parameter should be set to 'true'.
suspend	`POST`	`csm/RunningSoftware/guid/suspend`	Suspend this `RunningSoftware`.
start	`POST`	`csm/RunningSoftware/guid/start`	Start the object specified by the <guid> in the URI.
stop	`POST`	`csm/RunningSoftware/guid/stop`	Stop the object specified by the <guid> in the URI.

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/RunningSoftware/guid/logicalCommunicationPaths`	Retrieves the `logicalCommunicationPaths` relationship.
relation	`GET`	`csm/RunningSoftware/guid/softwareContainer`	Retrieves the `softwareContainer` relationship.
relation	`GET`	`csm/RunningSoftware/guid/softwareHost`	Retrieves the `softwareHost` relationship.
relation	`GET`	`csm/RunningSoftware/guid/softwareResourceProperties`	Retrieves the `softwareResourceProperties` relationship.
relation	`GET`	`csm/RunningSoftware/guid/resourceSet`	Retrieves the `resourceSet` relationship.
relation	`GET`	`csm/RunningSoftware/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/RunningSoftware/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/RunningSoftware/guid/tags`	Retrieves the `tags` relationship.

RunningSoftware class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
`logicalCommunicationPaths`	`LogicalCommunicationPath`	0..*
`softwareContainer`	`SoftwareContainer`	0..1
`softwareHost`	`SoftwareHost`	0..1
`softwareResourceProperties`	`SoftwareResourceProperty`	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
`computeCapacity`	`Integer`	0..1
`edition`	`String`	0..1
`ioCapacity`	`Integer`	0..1
`memoryCapacity`	`Integer`	0..1
`platformArchitecture`	`String`	0..1
`provisionedDate`	`Date`	0..1
`role`	`String`	0..1
`state`	`ProvisionedResourceState`
`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`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object