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.

VirtualGuestTemplate class


The VirtualGuestTemplate class represents a template for a virtual guest.

VirtualGuestTemplate class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

search

POST

Searches for VirtualGuestTemplate objects.

Operation APIs

The VirtualGuestTemplate class has no operation APIs.

Relationship APIs

The VirtualGuestTemplate class has no relationship APIs.

VirtualGuestTemplate class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

installableResourceDisks

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-
plicity

Description

administratorPassword
String

0..1

 

operatingSystemLicenseKey
String

0..1

 

categorizationTier1
String

0..1

Should be "Software" for all entries

categorizationTier2
String

0..1

Should be "Package" for all Product Catalog entries that are installable packages.

categorizationTier3
String

0..1

Indicates the type of package, such as Blade, Amazon or VMWare (ovf)

installablePackageID1
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageID2
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageID3
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageID4
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageID5
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageName1
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageName2
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageName3
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageName4
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

installablePackageName5
String

0..1

Packages are to be referenced by key-value pairs. The semantics of these pairs is dependent on the package provider and is to be established out of band. For BBSA, the key (name) might be "PackageName" with the value (Id) being the actual package name.

manufacturer
String

1

Manufacturer name

patchLevel
String

0..1

Patch level

productCatalogID
String

1

Product catalog identifier

productName
String

1

Product name

softwareType

0..1

Type of software

version
String

0..1

Version number

isOnboarded
Boolean

1

Indicates whether the object is onboarded

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*