SoftLayer_Virtual_Guest_Block_Device_Template_Group


SoftLayer_Virtual_Guest_Block_Device_Template_Group

Description

The virtual guest block device template group service provides a common interface to an accounts archived image templates The interaction with various third party APIs is not needed when implementing this service to administer your guests.

Methods

addByolAttribute

This method allows you to mark this image template as customer managed software license (BYOL)

addCloudInitAttribute

This method allows you to mark this image template as cloud init

addLocations

SoftLayer_Virtual_Guest_Block_Device can be made available in all storage locations. This method will create transaction(s) to add available locations to an archive image template.

addSupportedBootMode

This method allows you to mark this image’s supported boot modes as ‘HVM’ or ‘PV’.

copyToExternalSource

This method generates a transaction to export/copy a template to an external source.

copyToIcos

This method generates a transaction to export/copy a template to IBM Cloud Object Storage (ICOS)

createFromExternalSource

This method generates a transaction to import a disk image from an external source and create a standard image template.

createFromIcos

This method generates a process instance to import a disk image from ICOS and create a standard image template.

createPublicArchiveTransaction

SoftLayer_Virtual_Guest_Block_Device can be published together in a public repository for use by everyone. This method generates a transaction to perform a public image of the provided archived block devices.

deleteByolAttribute

This method allows you to remove BYOL attribute for a given image template.

deleteCloudInitAttribute

This method allows you to remove cloud init attribute for a given image template.

deleteObject

Create a transaction that will remove all block device templates from the group and delete the disk images associated with them.

denySharingAccess

Deny another SoftLayer customer account’s previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child.

editObject

Edit an image template group’s name and note.

findGcImagesByCurrentUser

Fetch a sorted collection of GC enabled cloudinit images for the account of the current active customer user.

getAccount

A block device template group’s SoftLayer_Account.

getAccountReferences

The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.

getAllAvailableCompatiblePlatformNames

Get all available compatible platform names that can be added to a template group.

getBlockDevices

The block devices that are part of an image template group

getBlockDevicesDiskSpaceTotal

The total disk space of all images in a image template group.

getBootMode

This method returns the boot mode, if any, set on a given image template.

getByolFlag

A flag indicating that customer is providing the software licenses.

getChildren

The image template groups that are clones of an image template group.

getCurrentCompatiblePlatformNames

Get compatible platform names currently set on the template group.

getDatacenter

The location containing this image template group. Will only be populated for child template group objects.

getDatacenters

A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.

getDefaultBootMode

This method returns the default boot mode set by the software description

getEncryptionAttributes

This method returns an array of encryption values, or empty array if none are found

getFirstChild

The first clone of the image template group

getFlexImageFlag

A flag indicating if this is a flex image.

getGlobalIdentifier

An image template’s universally unique identifier.

getImageType

The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent.

getImageTypeKeyName

The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent.

getNextGenFlag

A flag indicating if this is a next generation image.

getObject

Retrieve a SoftLayer_Virtual_Guest_Block_Device_Template_Group record.

getParent

The image template group that another image template group was cloned from.

getPublicCustomerOwnedImages

Gets all public customer owned image templates that the user is allowed to see.

getPublicImages

Gets all public image templates that the user is allowed to see.

getSshKeys

The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.

getStatus

A template group’s status.

getStorageLocations

The available locations for public image storage.

getStorageRepository

The storage repository that an image template group resides on.

getSupportedBootModes

This method indicates which boot modes are supported by the image.

getTagReferences

The tags associated with this image template group.

getTemplateDataCenterName

This method allows you to grab the first data center that the image(s) reside on so we can pull it from there.

getTransaction

A transaction that is being performed on a image template group.

getVhdImportSoftwareDescriptions

Returns the software descriptions supported for VHD imports.

isByol

This method indicates whether or not this image is a customer supplied license image.

isByolCapableOperatingSystem

This method indicates whether or not this image uses an operating system capable of using a customer supplied license image.

isByolOnlyOperatingSystem

This method indicates whether or not this image uses an operating system that requires using a customer supplied license image

isCloudInit

This method indicates whether or not this image is a cloud-init image.

isCloudInitOnlyOperatingSystem

This method indicates whether or not this image uses an operating system that requires cloud init

isEncrypted

This method indicates whether this image template contains an encrypted disk image.

permitSharingAccess

Permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child.

removeCompatiblePlatforms

Removes compatible platforms on the template group.

removeLocations

SoftLayer_Virtual_Guest_Block_Device can be made available in all storage locations. This method will create transaction(s) to remove available locations from an archive image template.

removeSupportedBootMode

This method allows you to remove a supported boot mode attribute for a given image template.

setAvailableLocations

This method generates the necessary transaction(s) to set available locations for archived block devices.

setBootMode

This method allows you to specify the boot mode for a given image template.

setCompatiblePlatforms

Sets compatible platforms on the template group.

setTags

Set the tags for this template group.