iland-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Virtual Machine.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

apiPrefix

apiPrefix: string = "/vms"

getPerfCounters

getPerfCounters: function

Type declaration

getPerfSamples

getPerfSamples: function

Type declaration

Accessors

allocationModel

allocationModel:

Gets the VM's Vdc Allocation Model.

companyId

companyId:

Gets the ID of the company that the entity belongs to.

coresPerSocket

coresPerSocket:

Gets the number of cores per CPU socket.

createdDate

createdDate:

Gets the date that the VM was created.

deleted

deleted:

Indicates whether the entity is deleted.

deletedDate

deletedDate:

Gets the date that the entity was deleted, or null if it is not deleted.

deployed

deployed:

Indicates whether the VM is deployed.

description

description:

Gets the VM's description.

entityType

entityType:

hardwareVersion

hardwareVersion:

Gets the VM's hardware version.

insertedMediaName

insertedMediaName:

Gets the name of the media that is currently inserted in the VM.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Gets the datacenter location identifier for the VM.

mediaInserted

mediaInserted:

Indicates whether there is currently a media inserted in the VM.

memorySize

memorySize:

Gets the VM's configured memory in MB.

name

name:

Gets the name.

numberOfCpus

numberOfCpus:

Gets the number of CPUs for the VM.

operatingSystem

operatingSystem:

Gets the VM's operating system.

orgUuid

orgUuid:

Gets the UUID of the Organization that the VM belongs to.

powerStatus

powerStatus:

Gets the power status of the VM.

storageProfiles

storageProfiles:

Gets the list of storage profiles that are available to this VM.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

vappUuid

vappUuid:

Gets the UUID of the vApp that this VM belongs to.

vcenterHref

vcenterHref:

Gets the HREF of the vCenter instance that the VM is associated with.

vcenterInstanceUuid

vcenterInstanceUuid:

Gets the UUID of the vCenter instance that the VM is associated with.

vcenterMoRef

vcenterMoRef:

Gets the VM'r vCenter reference.

vcenterName

vcenterName:

Gets the name of the vCenter server that the VM is associated with.

vcloudHref

vcloudHref:

Gets the HREF of the vCloud Director instance that this VM is associated with.

vdcUuid

vdcUuid:

Gets the UUID of the vDC that the VM belongs to.

vimDatastoreRef

vimDatastoreRef:

Gets the VM's datastore reference.

vmLocalId

vmLocalId:

Gets the VM's local ID.

Methods

copy

createSnapshot

createVirtualDisk

delete

  • delete(): Promise<Task>

deleteMetadata

  • deleteMetadata(metadataKey: string): Promise<Task>

  • Deletes a metadata entry.

    Parameters

    • metadataKey: string

      the key of the metadata entry to delete

    Returns Promise<Task>

    task promise

deleteSnapshot

  • deleteSnapshot(): Promise<Task>

deleteVirtualDisk

  • deleteVirtualDisk(name: string): Promise<Task>

  • Delete a virtual disk.

    Parameters

    • name: string

      the name of the disk to delete

    Returns Promise<Task>

    task promise

deleteVnic

  • deleteVnic(vnicId: number): Promise<Task>

  • Delete a VNIC from this VM.

    Parameters

    • vnicId: number

    Returns Promise<Task>

    a promise that resolves with the task

disableNestedHypervisor

  • disableNestedHypervisor(): Promise<Task>

ejectMedia

  • ejectMedia(): Promise<Task>

emailEventHistory

  • emailEventHistory(email: string): Promise<void>

  • Retrieve a CSV report email with all event history for a given Vm.

    Parameters

    • email: string

    Returns Promise<void>

    there is no response object.

enableNestedHypervisor

  • enableNestedHypervisor(): Promise<Task>

getAvailableStorageProfiles

  • Gets the VM's available storage profiles.

    Returns Promise<Array<StorageProfile>>

    a promise that resolves with the available storage profiles

getBackupRestorePoints

  • Gets the VMs available backup restore points.

    Returns Promise<Array<BackupRestorePoint>>

    promise that resolves with the list of backup restore points

getBill

  • getBill(month?: undefined | number, year?: undefined | number): Promise<Bill>

  • Gets the bill for the VM for the specified month and year. Month and year default to current month and year if left unspecified.

    Parameters

    • Optional month: undefined | number
    • Optional year: undefined | number

    Returns Promise<Bill>

    promise that resolves with the Bill

getBootOptions

getCapabilities

getCurrentBilling

getGuestCustomization

  • Gets the VM guest customization section includes properties of the guest operating system that can be modified such as passwords, and domain names.

    Returns Promise<GuestCustomization>

    promise that resolves with the vm guest customization object

getGuestToolsInfo

  • Gets the VM guest tools information

    Returns Promise<GuestTools>

    promise that resolves with the vm guest tools

getMetadata

getMksScreenTicket

  • Gets the VMs MKS screen ticket for a remote console connection.

    Returns Promise<MksScreenTicket>

    promise that resolves with the MKS screen ticket

getNetworks

getRecommendedDiskBusType

  • getRecommendedDiskBusType(): Promise<DiskType>

  • Gets the VM recommended disk bus type

    Returns Promise<DiskType>

    promise that resolves with the vm recommended disk bus type

getScreen

  • Gets the current screen JPEG thumbnail image.

    Returns Promise<JpegImage>

    promise Promise that resolves with a JpegImage

getScreenTicket

  • Gets the VMs screen ticket for a remote console connection.

    Returns Promise<ScreenTicket>

    promise that resolves with the screen ticket

getSnapshot

  • Gets the VMs snapshot details.

    throws

    {ApiError} as NotFoundError if the VM doesn't currently have a snapshot

    Returns Promise<Snapshot>

    promise that resolves with the current snapshot details

getSummary

getToolUpgradePolicy

getVirtualDisks

getVmSummary

getVnics

  • getVnics(): Promise<Array<Vnic>>

hasSnapshot

  • hasSnapshot(): Promise<boolean>

  • Returns true if VM has a snapshot

    Returns Promise<boolean>

    promise that resolves with a boolean that indicates if VM has a snapshot

insertMedia

  • insertMedia(mediaUuid: string): Promise<Task>

  • Inserts a specified media into the VM.

    Parameters

    • mediaUuid: string

      the UUID of the media to insert

    Returns Promise<Task>

    task promise

installVmWareTools

  • installVmWareTools(): Promise<Task>

moveVm

performPowerOperation

  • performPowerOperation(type: VmPowerOperation, forceGuestCustomization?: undefined | false | true): Promise<Task>

  • Performs a power operation on the VM.

    Parameters

    • type: VmPowerOperation

      the type of power operation to perform

    • Optional forceGuestCustomization: undefined | false | true

      whether to force guest customization (only applicable when powering on)

    Returns Promise<Task>

    task promise

powerOff

  • powerOff(): Promise<Task>

powerOn

  • powerOn(forceGuestCustomization?: undefined | false | true): Promise<Task>

  • Powers on the VM.

    Parameters

    • Optional forceGuestCustomization: undefined | false | true

      whether to force guest customization

    Returns Promise<Task>

    task promise

rebootGuestOs

  • rebootGuestOs(): Promise<Task>

reconfigure

  • Update the name and description of the VM as well as the guest customization section, the cpu, memory, and disk specifications. Any sections left out of the VmReconfigureRequest will be left unchanged.

    Parameters

    Returns Promise<Task>

refresh

  • refresh(): Promise<Vm>

  • Refreshes the VM data by retrieving it from the API again.

    Returns Promise<Vm>

relocate

  • relocate(storageProfileUuid: string): Promise<Task>

  • Move the VM to a different storage profile.

    Parameters

    • storageProfileUuid: string

    Returns Promise<Task>

    task promise

reset

  • reset(): Promise<Task>

resetMacAddresses

  • resetMacAddresses(): Promise<Task>

restoreBackup

  • restoreBackup(timestamp: Date): Promise<Task>

  • Restores a backup of the VM.

    Parameters

    • timestamp: Date

      the timestamp of the restore point to be restored

    Returns Promise<Task>

    task promise

restoreBackupIntoVapp

  • restoreBackupIntoVapp(timestamp: Date, vappUuid: string): Promise<Task>

  • Restore a backup of the VM into another vApp.

    Parameters

    • timestamp: Date

      the timestamp of the restore point to be restored

    • vappUuid: string

      the uuid of the vApp in which VM will be restored

    Returns Promise<Task>

restoreSnapshot

  • restoreSnapshot(): Promise<Task>

shutdownGuestOs

  • shutdownGuestOs(): Promise<Task>

suspend

  • suspend(): Promise<Task>

toString

  • toString(): string

updateBootOptions

  • updateBootOptions(bootDelay: number, enterBios: boolean): Promise<Task>

  • Update VM boot options

    Parameters

    • bootDelay: number
    • enterBios: boolean

    Returns Promise<Task>

updateCapabilities

updateCpuCount

updateDescription

  • updateDescription(description: string): Promise<Task>

  • Updates the VM's description.

    Parameters

    • description: string

      the new description

    Returns Promise<Task>

    task promise

updateGuestCustomization

updateMemorySize

  • updateMemorySize(memorySizeMb: number): Promise<Task>

  • Edit the memory size of the VM.

    Parameters

    • memorySizeMb: number

      the new memory size in MB

    Returns Promise<Task>

    task promise

updateMetadata

updateName

  • updateName(newName: string): Promise<Task>

  • Updates the VM's name.

    Parameters

    • newName: string

      the new name

    Returns Promise<Task>

    task promise

updateToolsUpgradePolicy

updateVirtualDisk

  • Update a virtual disk that is attached to this VM.

    Parameters

    Returns Promise<Task>

    task promise

updateVirtualDisks

updateVirtualHardwareVersion

  • updateVirtualHardwareVersion(): Promise<Task>

  • Updates the VM's virtual hardware to the latest version available.

    Returns Promise<Task>

    task promise

updateVnics

  • updateVnics(vnics: Array<Vnic>): Promise<Task>

upgradeGuestTools

  • upgradeGuestTools(): Promise<Task>

Static getVm

  • getVm(uuid: string): Promise<Vm>

  • Gets a VM by UUID.

    Parameters

    • uuid: string

      VM UUID

    Returns Promise<Vm>

    promise that resolves with the VM

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc