Vapp | iland-sdk

Virtual Application.

Hierarchy

Entity
- Vapp

Implements

EntityWithPerfSamples

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Vapp(_json: VappJson): Vapp

Overrides Entity.constructor
- Defined in model/vapp/vapp.ts:56
Parameters
- _json: VappJson
Returns Vapp

Properties

apiPrefix

apiPrefix: string = "/vapps"

getPerfCounters

getPerfCounters: function

Type declaration

- (): Promise<Array<PerfCounter>>
- Returns Promise<Array<PerfCounter>>

getPerfSamples

getPerfSamples: function

Type declaration

- (request: PerfSamplesRequest): Promise<PerfSamplesSeries>
- Parameters
  - request: PerfSamplesRequest
  Returns Promise<PerfSamplesSeries>

Accessors

allocationModel

allocationModel:

Get Vapp's Vdc Allocation Model

companyId

companyId:

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

creationDate

creationDate:

Gets the date that this vApp 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 this vApp is currently deployed.

description

description:

Gets the vApps description.

entityType

entityType:

expired

expired:

Indicates whether this vApp is currently in the expired items bin.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Gets the datacenter location identifier for the vApp.

name

name:

Gets the name.

orgUuid

orgUuid:

Gets the UUID of the Org that this vApp is associated with.

powerStatus

powerStatus:

Gets the vApps current power status.

runtimeLease

runtimeLease:

Gets the runtime lease setting, in seconds.

runtimeLeaseExpirationDate

runtimeLeaseExpirationDate:

Gets the expiration date of the runtime lease, if one is currently active.

storageLease

storageLease:

Gets the storage lease setting, in seconds.

storageLeaseExpirationDate

storageLeaseExpirationDate:

Gets the expiration date of the storage lease, if one is currently active.

storageProfiles

storageProfiles:

Gets the storage profiles that are associated with this VM

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

vcloudHref

vcloudHref:

Gets the vCloud HREF of the vApp.

vdcUuid

vdcUuid:

Gets the UUID of the vDC that this vApp is associated with.

Methods

addOrgVdcNetwork

addOrgVdcNetwork(networkUuid: string): Promise<Task>

- Defined in model/vapp/vapp.ts:682
Adds an org vDC network to the vApp.

Parameters
- networkUuid: string
  
  the UUID of the org vDC network
Returns Promise<Task>

a promise that resolves with the task details

addVappNetwork

addVappNetwork(vappNetworkCreateRequest: VappNetworkCreateRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:565
Add a vapp-network to vapp.

Parameters
- vappNetworkCreateRequest: VappNetworkCreateRequest
Returns Promise<Task>

buildVms

buildVms(buildVmRequestList: Array<BuildVmRequestJson>): Promise<Task>

- Defined in model/vapp/vapp.ts:280
Creates VMs in vApp.

Parameters
- buildVmRequestList: Array<BuildVmRequestJson>
Returns Promise<Task>

task response

copyVapp

copyVapp(spec: VappCopyMoveRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:579
Copy a vApp.

Parameters
- spec: VappCopyMoveRequest
Returns Promise<Task>

promise Promise that resolves with a Task

createSnapshot

createSnapshot(request: SnapshotCreateRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:432
Create a snapshot.

Parameters
- request: SnapshotCreateRequest
  
  the snapshot creation request
Returns Promise<Task>

promise Promise that resolves with a Task

deleteMetadata

deleteMetadata(metadataKey: string): Promise<Task>

- Defined in model/vapp/vapp.ts:507
Deletes a metadata entry.

Parameters
- metadataKey: string
  
  the key of the metadata entry to delete
Returns Promise<Task>

task promise

deleteVapp

deleteVapp(): Promise<Task>

- Defined in model/vapp/vapp.ts:292
Delete the vApp.

Returns Promise<Task>

promise Promise that resolves with a Task

emailEventHistory

emailEventHistory(email: string): Promise<void>

- Defined in model/vapp/vapp.ts:705
Retrieve a CSV report email with all event history for a given vApp.

Parameters
- email: string
Returns Promise<void>

there is no response object.

enableDownload

enableDownload(): Promise<Task>

- Defined in model/vapp/vapp.ts:644
Enable the download of the vapp. Returns a TaskResponse which monitors the progress of the download.

Returns Promise<Task>

promise Promise that resolves with a Task

getAvailableStorageProfiles

getAvailableStorageProfiles(): Promise<Array<StorageProfile>>

- Defined in model/vapp/vapp.ts:694
Gets the vApp's available storage profiles.

Returns Promise<Array<StorageProfile>>

a promise that resolves with the available storage profiles

getBilling

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

- Defined in model/vapp/vapp.ts:522
Returns vApp Billing for a given invoice period. If month and year are not explicitly supplied the current invoice period is used.

Parameters
- Optional year: undefined | number
  
  the invoice period year (defaults to current year)
- Optional month: undefined | number
  
  the invoice period month (defaults to the current month) must be in range 1-12
Returns Promise<Bill>

promise Promise that resolves with billing for the vApp and given invoice period

getCurrentBilling

getCurrentBilling(): Promise<BillingSummary>

- Defined in model/vapp/vapp.ts:539
Get the current billing for a vApp.

Returns Promise<BillingSummary>

promise Promise that resolves with vapp billing

getDownloadDetails

getDownloadDetails(): Promise<VappDownloadDetails>

- Defined in model/vapp/vapp.ts:657
Gets download details for the vApp. Details include whether the vapp is enabled for download, and, if enabled, the size and name of the download.

Returns Promise<VappDownloadDetails>

promise Promise that resolves with VappDownloadDetails

getMetadata

getMetadata(): Promise<Array<Metadata<MetadataType>>>

- Defined in model/vapp/vapp.ts:468
Gets the vApp's metadata.

throws

Error if type not found for metadata

Returns Promise<Array<Metadata<MetadataType>>>

getSnapshot

getSnapshot(): Promise<Snapshot>

- Defined in model/vapp/vapp.ts:407
Get the snapshot for the given vApp.

Returns Promise<Snapshot>

promise Promise that resolves with Snapshot

getStartupSection

getStartupSection(): Promise<Array<VappStartupSectionItem>>

- Defined in model/vapp/vapp.ts:552
Get the startup section for a particular Vapp.

Returns Promise<Array<VappStartupSectionItem>>

promise Promise that resolves with a list of VappStartupSectionItem

getSummary

getSummary(): Promise<VappResourceSummary>

- Defined in model/vapp/vapp.ts:395
Get the resource summary for the given vApp.

Returns Promise<VappResourceSummary>

promise Promise that resolves with VappResourceSummary

getVappNetworks

getVappNetworks(): Promise<Array<VappNetwork>>

- Defined in model/vapp/vapp.ts:268
Gets the vApps child vApp Networks.

Returns Promise<Array<VappNetwork>>

promise that resolves with an array of child vApp Networks

getVmResourceSummaryMap

getVmResourceSummaryMap(): Promise<VmResourceSummaryMapResponse>

- Defined in model/vapp/vapp.ts:669
Get vm resource summary map.

Returns Promise<VmResourceSummaryMapResponse>

getVms

getVms(): Promise<Array<Vm>>

- Defined in model/vapp/vapp.ts:257
Gets the vApps child VMs.

Returns Promise<Array<Vm>>

promise that resolves with an array of child VMs

hasVappSnapshot

hasVappSnapshot(): Promise<HasSnapshot>

- Defined in model/vapp/vapp.ts:419
Get whether the given vApp has a snapshot.

Returns Promise<HasSnapshot>

promise Promise that resolves with HasSnapshot

managedShutdown

managedShutdown(): Promise<Task>

- Defined in model/vapp/vapp.ts:334
Managed shutdown of the vApp using the vApp's startup section settings.

Returns Promise<Task>

promise Promise that resolves with a Task

moveVapp

moveVapp(spec: VappCopyMoveRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:592
Move a vApp.

Parameters
- spec: VappCopyMoveRequest
Returns Promise<Task>

promise Promise that resolves with a Task

powerOffVapp

powerOffVapp(): Promise<Task>

- Defined in model/vapp/vapp.ts:322
Power off the vApp.

Returns Promise<Task>

promise Promise that resolves with a Task

powerOnVapp

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

- Defined in model/vapp/vapp.ts:306
Power on the vApp.

Parameters
- Optional forceGuestCustomization: undefined | false | true
  
  Optional param to force guest re-customization on restart defaults to false
Returns Promise<Task>

promise Promise that resolves with a Task

rebootVapp

rebootVapp(): Promise<Task>

- Defined in model/vapp/vapp.ts:383
Reboot the vApp.

Returns Promise<Task>

promise Promise that resolves with a Task

refresh

refresh(): Promise<Vapp>

- Defined in model/vapp/vapp.ts:222
Refreshes the vApp data by retrieving it from the API again.

Returns Promise<Vapp>

removeSnapshot

removeSnapshot(): Promise<Task>

- Defined in model/vapp/vapp.ts:456
Remove a snapshot.

Returns Promise<Task>

promise Promise that resolves with a Task

resetVapp

resetVapp(): Promise<Task>

- Defined in model/vapp/vapp.ts:371
Reset the vApp.

Returns Promise<Task>

promise Promise that resolves with a Task

restoreSnapshot

restoreSnapshot(): Promise<Task>

- Defined in model/vapp/vapp.ts:444
Restore a snapshot.

Returns Promise<Task>

promise Promise that resolves with a Task

shutdownVapp

shutdownVapp(): Promise<Task>

- Defined in model/vapp/vapp.ts:359
Shutdown the vApp. This action requires VMWare Tools to be installed on each VM in the vApp.

Returns Promise<Task>

promise Promise that resolves with a Task

suspendVapp

suspendVapp(): Promise<Task>

- Defined in model/vapp/vapp.ts:346
Suspend the vApp.

Returns Promise<Task>

promise Promise that resolves with a Task

toString

toString(): string

- Defined in model/vapp/vapp.ts:206
JSON format.

Returns string

updateDescription

updateDescription(request: VappDescriptionUpdateRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:246
Update the vApp description.

Parameters
- request: VappDescriptionUpdateRequest
Returns Promise<Task>

promise Promise that resolves with a Task

updateMetadata

updateMetadata(metadata: Array<Metadata<MetadataType>>): Promise<Task>

- Defined in model/vapp/vapp.ts:492
Updates the vApp's metadata.

Parameters
- metadata: Array<Metadata<MetadataType>>
  
  the new array of metadata
Returns Promise<Task>

task promise

updateName

updateName(request: VappRenameRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:234
Update the vApp name.

Parameters
- request: VappRenameRequest
Returns Promise<Task>

promise Promise that resolves with a Task

updateRuntimeLease

updateRuntimeLease(request: RuntimeLeaseUpdateRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:604
Update a vApp runtime lease.

Parameters
- request: RuntimeLeaseUpdateRequest
Returns Promise<Task>

promise Promise that resolves with a Task

updateStartupSection

updateStartupSection(startupSection: Array<VappStartupSectionItemRequest>): Promise<Task>

- Defined in model/vapp/vapp.ts:630
Update the startup section of a particular Vapp.

Parameters
- startupSection: Array<VappStartupSectionItemRequest>
Returns Promise<Task>

promise Promise that resolves with a Task

updateStorageLease

updateStorageLease(request: StorageLeaseUpdateRequest): Promise<Task>

- Defined in model/vapp/vapp.ts:617
Update a vApp storage lease.

Parameters
- request: StorageLeaseUpdateRequest
Returns Promise<Task>

promise Promise that resolves with a Task

Static getVapp

getVapp(uuid: string): Promise<Vapp>

- Defined in model/vapp/vapp.ts:67
Gets a vApp by UUID.

Parameters
- uuid: string
  
  vApp UUID
Returns Promise<Vapp>

promise that resolves with the vApp

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_json: VappJson

Returns Vapp

Properties

apiPrefix

getPerfCounters

Type declaration

Returns Promise<Array<PerfCounter>>

getPerfSamples

Type declaration

Parameters

request: PerfSamplesRequest

Returns Promise<PerfSamplesSeries>

Accessors

allocationModel

companyId

creationDate

deleted

deletedDate

deployed

description

entityType

expired

json

locationId

name

orgUuid

powerStatus

runtimeLease

runtimeLeaseExpirationDate

storageLease

storageLeaseExpirationDate

storageProfiles

updatedDate

uuid

vcloudHref

vdcUuid

Methods

addOrgVdcNetwork

Parameters

networkUuid: string

Returns Promise<Task>

addVappNetwork

Parameters

vappNetworkCreateRequest: VappNetworkCreateRequest

Returns Promise<Task>

buildVms

Parameters

buildVmRequestList: Array<BuildVmRequestJson>

Returns Promise<Task>

copyVapp

Parameters

spec: VappCopyMoveRequest

Returns Promise<Task>

createSnapshot

Parameters

request: SnapshotCreateRequest

Returns Promise<Task>

deleteMetadata

Parameters

metadataKey: string

Returns Promise<Task>

deleteVapp

Returns Promise<Task>

emailEventHistory

Parameters

email: string

Returns Promise<void>

enableDownload

Returns Promise<Task>

getAvailableStorageProfiles