ServiceOfferingInstance class
The ServiceOfferingInstance class represents the instantiation of a particular service offering. It allows for the instantiated service offerings to be tracked and reported upon and acts as a management point for the cloud or customer administrator.
ServiceOfferingInstance class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the ServiceOfferingInstance class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a ServiceOfferingInstance object. | |
refresh | POST | Refreshes a ServiceOfferingInstance object. | |
search | POST | Searches for ServiceOfferingInstance objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
applyOptionChoice | POST | Applies an option choice to a target. | |
bulkCreate | POST | Creates multiple service offering instances. | |
bulkEvaluateSensors | POST | This operation refreshes ops Sensors for all ServiceOfferingInstances passed to it as parameter. | |
decommission | POST | Decommissions the specified service offering instance. | |
evaluateSensors | POST | This operation refreshes all sensors in the Service Offering Instance. | |
offboard | POST | Removes a service offering instance. | |
onboard | POST | Creates a service offering instance for an existing virtual machine. | |
opsDecommission | POST | This operation is invoked after service Offering Instance is successfully decommissioned. | |
opsProvision | POST | This operation is invoked after Service Offering Instance is successfully created. This is a dynamic operation that provisions Sensors for Service Offering Instance components as per Sensor specifications from ops blueprint. | |
restartCompute | POST | This API restarts compute on the service offering instance specified by the identifier in the URI. | |
share | POST | Refreshes the specified service offering instance. | |
start | POST | Starts the specified service offering instance. | |
startCompute | POST | Starts compute on the specified service offering instance. | |
startSoftwareContainer | POST | Start SoftwareContainer(s) which are a part of this SOI. | |
stop | POST | Stops the specified service offering instance. | |
stopCompute | POST | Stops compute on the specified service offering instance. | |
stopSoftwareContainer | POST | Stop SoftwareContainer(s) which are a part of this SOI. | |
transferOwnership | POST | Transfers the ownership from existing user to the new user | |
transferOwnershipAndShare | POST | Transfers the ownership from existing user to the new user |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the {{}} relationship. | |
relation | GET | Retrieves the {{}} relationship. | |
relation | GET | Retrieves the blueprintReference relationship. | |
relation | GET | Retrieves the contractLine relationship. | |
relation | GET | Retrieves the deploymentModel relationship. | |
relation | GET | Retrieves the deploymentParameterValue relationship. | |
relation | GET | Retrieves the functionalComponentConnection relationship. | |
relation | GET | Retrieves the functionalComponents relationship. | |
relation | GET | Retrieves the functionalModel relationship. | |
relation | GET | Retrieves the resourceSets relationship. | |
relation | GET | Retrieves the serviceOfferingContractLine relationship. | |
relation | GET | Retrieves the serviceRequest relationship. | |
relation | GET | Retrieves the tenant relationship. | |
relation | GET | Retrieves the users relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
ServiceOfferingInstance class relationships and attributes
The following tables list the relationships and attributes of the ServiceOfferingInstance class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
{{}} |
|
| |
{{}} |
|
| |
blueprintReference | 0..1 |
| |
contractLine | 0..1 | Contract line referenced by the service offering instance | |
deploymentModel | 1 | Deployment model implemented by the service offering instance | |
deploymentParameterValue | 0..* | Associated deployment parameter values | |
functionalComponentConnection | 0..* | Associated functional component connections | |
functionalComponents | 1..* | Functional components that make up the service offering instance | |
functionalModel | 1 | Functional model implemented by the service offering instance | |
resourceSets | 1..* |
| |
serviceOfferingContractLine | 0..1 | Associated service offering contract line | |
serviceRequest | 0..1 |
| |
tenant | 1 | Tenant for which the service offering instance is deployed | |
users | User | 0..* |
|
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 |
|---|---|---|---|
actualDecommissionDate | 0..1 | Date the service offering instance was decommissioned | |
isMonitoringEnabled | Boolean | 1 |
|
isMonitoringPoliciesEnabled | Boolean | 1 |
|
isOpsEvalEnabled | Boolean | 1 |
|
proposedDecommissionDate | 0..1 | Planned date for decommissioning the service offering instance. | |
provisionDate | 1 | Date the service offering instance was provisioned. | |
provisionedDeploymentModel | String | 0..1 | Provisioned deployment model |
provisionedFunctionalModel | String | 0..1 | Provisioned functional model |
provisionedServiceOfferingModel | String | 0..1 |
|
state | 1 | Current state of the service offering instance | |
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 |