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.

CustomContainer class (Provider API)

CustomContainer class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

create

POST

Creates a CustomContainer object.

delete

DELETE

Deletes a CustomContainer object.

Operation APIs

Name

HTTP
method

URI

Description

compare

POST

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.

decommission

POST

 

getQualifiedHostingContainers

POST

If this SoftwareContainer is supported, then return the subset of candidateHostingContainers that qualify as hosts. Otherwise, return an error that indicates this SoftwareContainer is not supported. The semantics of a "qualifying host" is provider-dependent and may consider any substantive attributes of the software containers (but not attributes such as guid, name, description, externalId, isOnboarded, etc.)

getSupportedEditions

POST

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

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

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

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

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

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

 

onboard

POST

 

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

CustomContainer class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

componentRunningSoftware

0..*

 

componentSoftwareContainer

0..*

 

compositeSoftwareContainer

0..1

 

softwareResourceProperties

0..*

 

applicationSoftware

0..*

 

hostedRunningSoftware

0..*

 

Attributes

Name

Type

Multi-
plicity

Description

adminUserName
String

0..1

 

edition
String

0..1

 

hardwareArchitecture

0..1

 

installableResource
String

0..1

 

installableResourceType
String

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

1

 

state

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

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*