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.

Database class

Database class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

modify

PUT

csm/Database/guid

Modifies a Database object.

get

GET

csm/Database/guid

Retrieves a Database object.

refresh

POST

csm/Database/guid

Refreshes a Database object.

update

POST

csm/Database/guid/update

Updates a Database object.

search

POST

csm/Database/search

Searches for Database objects.

Operation APIs

Name

HTTP
method

URI

Description

restore

POST

csm/Database/guid/restore

Restore the Database from a snapshot.

restoreFromSnapshot

POST

csm/Database/guid/restoreFromSnapshot

Restore the Database to the specified snapshot.

snapshot

POST

csm/Database/guid/snapshot

addInstance

POST

csm/Database/guid/addInstance

Add an instance of the specified role to the clustered SoftwareContainer.

compare

POST

csm/Database/compare

Compare the referenceSoftwareContainer to the otherSoftwareConatiner. If isCompatibe is true, then return true iff said containers are compatible. Otherwise, return true iff the containers are incompatible.

executeScript

POST

csm/Database/guid/executeScript

Execute the names script on this SoftwareContainer using the specified parameters.

getSupportedEditions

POST

csm/Database/getSupportedEditions

Return all supported container editions, if any.
The result is a set of (name,value) pairs, where:
name = "<provider-uri>:<type>:<subtype>"
value = "<edition>"
Meaning that <edition> is supported for the (<provider-uri>, <type>, <subtype>) tuple.
The * quantifier can be used to denote that an edition is supported to any type or subtype.

getSupportedHardwarePlatforms

POST

csm/Database/getSupportedHardwarePlatforms

Return all supported container hardware platforms, if any.
The result is a set of (name,value) pairs, where:
name = "<provider-uri>:<type>:<subtype>:<edition>"
value = "<hardware-platform>"
Meaning that <edition> is supported for the (<provider-uri>, <type>, <subtype>, <edition>) tuple.
The * quantifier can be used to denote that a software platform is supported on any type, subtype, etc.

getSupportedSoftwarePlatforms

POST

csm/Database/getSupportedSoftwarePlatforms

Return all supported container software platforms, if any.
The result is a set of (name,value) pairs, where:
name = "<provider-uri>:<type>:<subtype>:<edition>:<hardware-platform>"
value = "<software-platform>"
Meaning that <edition> is supported for the (<provider-uri>, <type>, <subtype>, <edition>, <hardware-platform>) tuple.
The * quantifier can be used to denote that a software platform is supported on any type, subtype, etc.

getSupportedSubtypes

POST

csm/Database/getSupportedSubtypes

Return all supported container subtypes, if any.
The result is a set of (name,value) pairs, where:
name = "<provider URI>:<type>"
value = "<subtype>"
Meaning that <subtype> is supported for the provider <<provider URI> and the type <type>.
To denote that a specific <subtype> is supported for any type use the * quantifier.

getSupportedTypes

POST

csm/Database/getSupportedTypes

Return all container types supported by the implementing provider.
The result is a set of (name,value) pairs, where:
name = "<provider-uri>"
value = "<type>"
Meaning that the <type> is supported for the <provider-uri> provider.

getSupportedVersions

POST

csm/Database/getSupportedVersions

Return all supported container versions, if any.
The result is a set of (name,value) pairs, where:
name = "<provider-uri>:<type>:<subtype>:<edition>:<hardware-platform>:<software-platform>"
value = "<software-platform>"
Meaning that <edition> is supported for the (<provider-uri>, <type>, <subtype>, <edition>, <hardware-platform>, <software-platform>) tuple.
The * quantifier can be used to denote that a software platform is supported on any type, subtype, etc.

offboard

POST

csm/Database/guid/offboard

Offboard a SoftwareContainer.

onboard

POST

csm/Database/onboard

Onboard a SoftwareContainer.

quiesce

POST

csm/Database/guid/quiesce

Quiesce this SoftwareContainer.

removeInstance

POST

csm/Database/guid/removeInstance

Remove an instance from a clustered SoftwareContainer.

restart

POST

csm/Database/guid/restart

Restart this SoftwareContainer.

run

POST

csm/Database/guid/run

Start this SoftwareConatiner

share

POST

csm/Database/guid/share

Share the computecontainer with specified users

shutdown

POST

csm/Database/guid/shutdown

Stop this SoftwareConatiner, possibly forcefully.

unquiesce

POST

csm/Database/guid/unquiesce

Unquiesce this SoftwareContainer.

start

POST

csm/Database/guid/start

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

stop

POST

csm/Database/guid/stop

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

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Database/guid/componentRunningSoftware

Retrieves the componentRunningSoftware relationship.

relation

GET

csm/Database/guid/componentSoftwareContainer

Retrieves the componentSoftwareContainer relationship.

relation

GET

csm/Database/guid/compositeSoftwareContainer

Retrieves the compositeSoftwareContainer relationship.

relation

GET

csm/Database/guid/inPool

Retrieves the inPool relationship.

relation

GET

csm/Database/guid/logicalCommunicationPaths

Retrieves the logicalCommunicationPaths relationship.

relation

GET

csm/Database/guid/resourceSet

Retrieves the resourceSet relationship.

relation

GET

csm/Database/guid/softwareResourceProperties

Retrieves the softwareResourceProperties relationship.

relation

GET

csm/Database/guid/applicationSoftware

Retrieves the applicationSoftware relationship.

relation

GET

csm/Database/guid/hostedRunningSoftware

Retrieves the hostedRunningSoftware relationship.

relation

GET

csm/Database/guid/resourceSet

Retrieves the resourceSet relationship.

relation

GET

csm/Database/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Database/guid/tags

Retrieves the tags relationship.

Database class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

componentRunningSoftware

RunningSoftware

0..*

componentSoftwareContainer

SoftwareContainer

0..*

compositeSoftwareContainer

SoftwareContainer

0..1

inPool

StaticPool

0..1

logicalCommunicationPaths

LogicalCommunicationPath

0..*

resourceSet

ResourceSet

0..1

softwareResourceProperties

SoftwareResourceProperty

0..*

applicationSoftware

ApplicationSoftware

0..*

hostedRunningSoftware

RunningSoftware

0..*

resourceSet

ResourceSet

1

Resource set to which the software belongs

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

backupRetentionPeriod

Integer

0..1

dataCapacity

Integer

0..1

dataCapacityUnits

String

0..1

adminUserName

String

0..1

edition

String

0..1

hardwareArchitecture

HardwareArchitectureType

0..1

instanceCount

Integer

0..1

isClustered

Boolean

1

isOnboarded

Boolean

0..1

Is true iff the SoftwareContainer was onboarded and has yet to be offboarded.
Is false iff the SoftwareContainer was offboarded and yet to be onboarded.
Null, otherwise.

platformArchitecture

String

0..1

provisionedDate

Date

1

state

ProvisionedResourceState

1

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

name

String

1

Human-readable name of the object

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.

Comments