Vdc | iland-sdk

Virtual Data Center.

Hierarchy

Entity
- Vdc

Implements

EntityWithPerfSamples

Index

Constructors

constructor

Properties

Constructors

constructor

new Vdc(_json: VdcJson): Vdc

Overrides Entity.constructor
- Defined in model/vdc/vdc.ts:55
Parameters
- _json: VdcJson
Returns Vdc

Properties

apiPrefix

apiPrefix: string = "/vdcs"

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

allocatedCpu

allocatedCpu:

Gets the amount of CPU allocated

allocatedMemory

allocatedMemory:

Gets the amount of memory allocated

allocationModel

allocationModel:

Gets the vDC allocation json

companyId

companyId:

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

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.

description

description:

Gets the description.

diskLimit

diskLimit:

Gets the disk limit within the vDc.

enabled

enabled:

Indicates whether the vDC is enabled.

entityType

entityType:

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Gets the datacenter location identifier.

maxHardwareVersion

maxHardwareVersion:

Gets the maximum hardware version of the vDC.

name

name:

Gets the name.

networkQuota

networkQuota:

Gets the network quota.

orgUuid

orgUuid:

Gets the UUID of the organization that the vDC is associated with.

reservedCpu

reservedCpu:

Gets the amount of reserved CPU

reservedMemory

reservedMemory:

Gets the amount of reserved memory.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

usedNetworkCount

usedNetworkCount:

Gets the number of networks that exist within this vDC.

uuid

uuid:

Gets the UUID.

vcenterHref

vcenterHref:

Gets the vCenter HREF

vcenterInstanceUuid

vcenterInstanceUuid:

Gets the vCenter instance UUID.

vcenterMoref

vcenterMoref:

Gets the vCenter HREF.

vcenterName

vcenterName:

Gets the vCenter name.

vcloudHref

vcloudHref:

Gets the vCloud HREF

Methods

addVappFromTemplate

addVappFromTemplate(vdcAddVappFromTemplateRequest: VdcAddVappFromTemplateRequest): Promise<Task>

- Defined in model/vdc/vdc.ts:299
Add a vApp from template to vDC.

Parameters
- vdcAddVappFromTemplateRequest: VdcAddVappFromTemplateRequest
Returns Promise<Task>

task promise

buildVapp

buildVapp(buildVappRequest: BuildVappRequestJson): Promise<Task>

- Defined in model/vdc/vdc.ts:275
Create a scratch vApp into the vDC.

Parameters
- buildVappRequest: BuildVappRequestJson
Returns Promise<Task>

task promise

createOrgVdcNetwork

createOrgVdcNetwork(network: OrgVdcNetworkCreateRequest): Promise<Task>

- Defined in model/vdc/vdc.ts:414
Creates a new org-vdc network in this vDC.

Parameters
- network: OrgVdcNetworkCreateRequest
  
  the specification for the new network
Returns Promise<Task>

a promise that resolves with a task

deleteMetadata

deleteMetadata(metadataKey: string): Promise<Task>

- Defined in model/vdc/vdc.ts:377
Deletes a metadata entry for vDC.

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

task promise

emailEventHistory

emailEventHistory(email: string): Promise<void>

- Defined in model/vdc/vdc.ts:601
Retrieve a CSV report email with all event history for a given vDC.

Parameters
- email: string
Returns Promise<void>

there is no response object.

generateVmInventoryReport

generateVmInventoryReport(emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/vdc/vdc.ts:559
Generate the vm inventory report for a given vDC.

Parameters
- Optional emailOnCompletion: undefined | false | true
  
  Whether to email the report upon successful generation
- Optional email: undefined | string
  
  email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified
Returns Promise<Task>

promise Promise that resolves with a Task

getBilling

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

- Defined in model/vdc/vdc.ts:458
Get billing for a specified billing period. If the billing period is not specified, the current billing period is used.

Parameters
- Optional year: undefined | number
  
  the year
- Optional month: undefined | number
  
  the month in range 0-11
Returns Promise<Bill>

a promise that resolves with the bill

getCostOverInvoicePeriodSerie

getCostOverInvoicePeriodSerie(year?: undefined | number, month?: undefined | number, additionalFields?: Array<string>): Promise<BillingSampleSerie>

- Defined in model/vdc/vdc.ts:537
Gets the cost over invoice period samples for the vDC and specified billing period.

Parameters
- Optional year: undefined | number
  
  the year
- Optional month: undefined | number
  
  the month in range 1-12
- Optional additionalFields: Array<string>
  
  any additional bill fields that should be included in the results
Returns Promise<BillingSampleSerie>

a promise that resolves with the sample series

getCurrentBilling

getCurrentBilling(): Promise<BillingSummary>

- Defined in model/vdc/vdc.ts:443
Gets the current billing information

Returns Promise<BillingSummary>

a promise that resolves with the current billing information

getEdges

getEdges(): Promise<Array<Edge>>

- Defined in model/vdc/vdc.ts:389
Get the edges for the vDC.

Returns Promise<Array<Edge>>

promise that resolves with a list of edges

getMedias

getMedias(): Promise<Array<Media>>

- Defined in model/vdc/vdc.ts:312
Get media for the vDC.

Returns Promise<Array<Media>>

promise that is resolved with a list of media

getMetadata

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

- Defined in model/vdc/vdc.ts:323
Gets the vDC metadata.

Returns Promise<Array<Metadata<MetadataType>>>

getOrgVdcNetworks

getOrgVdcNetworks(): Promise<Array<InternalNetwork>>

- Defined in model/vdc/vdc.ts:401
Gets all org-vdc networks within this vDC.

Returns Promise<Array<InternalNetwork>>

a promise that resolves with the list of org-vdc networks.

getStorageProfileSummary

getStorageProfileSummary(year?: undefined | number, month?: undefined | number): Promise<VdcStorageProfileSummary>

- Defined in model/vdc/vdc.ts:517
Gets the storage profile summary for this vDC and the specified billing period.

Parameters
- Optional year: undefined | number
  
  the year
- Optional month: undefined | number
  
  the month in range 1-12.
Returns Promise<VdcStorageProfileSummary>

a promise that resolves with the storage profile summary

getStorageProfiles

getStorageProfiles(includeDisabled?: undefined | false | true): Promise<Array<StorageProfile>>

- Defined in model/vdc/vdc.ts:427
Get all storage profiles for the vDC.

Parameters
- Optional includeDisabled: undefined | false | true
  
  whether to also return disabled storage profiles
Returns Promise<Array<StorageProfile>>

a promise that resolves with the list of storage profiles

getSummary

getSummary(): Promise<VdcSummary>

- Defined in model/vdc/vdc.ts:286
Gets the vDCs Summary.

Returns Promise<VdcSummary>

promise that resolved with a vDC summary

getVappBills

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

- Defined in model/vdc/vdc.ts:478
Get bills for all child vapps for the specified billing period. If the billing period is not specified, the current billing period is used.

Parameters
- Optional month: undefined | number
  
  the month in range 0-11
- Optional year: undefined | number
  
  the year
Returns Promise<Array<Bill>>

a promise that resolves with the list of vapp bills

getVappResourceSummaries

getVappResourceSummaries(): Promise<VappResourceSummaryMap>

- Defined in model/vdc/vdc.ts:577
Gets all child vApp resource summaries.

Returns Promise<VappResourceSummaryMap>

a promise that resolves with a map of vApp resource summaries, keyed by UUID.

getVapps

getVapps(): Promise<Array<Vapp>>

- Defined in model/vdc/vdc.ts:252
Gets the vDCs child vApps.

Returns Promise<Array<Vapp>>

promise that resolves with an array of child vApps

getVmBills

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

- Defined in model/vdc/vdc.ts:498
Get bills for all child VMs for the specified billing period. If the billing period is not specified, the current billing period is used.

Parameters
- Optional month: undefined | number
  
  the month in range 0-11
- Optional year: undefined | number
  
  the year
Returns Promise<Array<Bill>>

a promise that resolves with the list of VM bills

getVmInventoryReports

getVmInventoryReports(format?: ReportFormat): Promise<Array<ReportHeader>>

- Defined in model/vdc/vdc.ts:348
Get the VM inventory reports available for download for the given vDC.

Parameters
- Optional format: ReportFormat
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of report headers

getVmResourceSummaries

getVmResourceSummaries(): Promise<VmResourceSummaryMap>

- Defined in model/vdc/vdc.ts:590
Gets resource summaries for all child VMs.

Returns Promise<VmResourceSummaryMap>

a promise that resolves with a map of VM resource summaries, keyed by UUID.

getVms

getVms(): Promise<Array<Vm>>

- Defined in model/vdc/vdc.ts:263
Gets the vDCs child VMs.

Returns Promise<Array<Vm>>

promise that resolves with an array of child VMs

refresh

refresh(): Promise<Vdc>

- Defined in model/vdc/vdc.ts:241
Refreshes the vDC data by retrieving it from the API again.

Returns Promise<Vdc>

toString

toString(): string

- Defined in model/vdc/vdc.ts:225
JSON format.

Returns string

updateMetadata

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

- Defined in model/vdc/vdc.ts:364
Updates the vDC metadata.

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

task promise

Static getVdc

getVdc(uuid: string): Promise<Vdc>

- Defined in model/vdc/vdc.ts:66
Gets a vDC by UUID.

Parameters
- uuid: string
  
  vDC UUID
Returns Promise<Vdc>

promise that resolves with the vDC

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_json: VdcJson

Returns Vdc

Properties

apiPrefix

getPerfCounters

Type declaration

Returns Promise<Array<PerfCounter>>

getPerfSamples

Type declaration

Parameters

request: PerfSamplesRequest

Returns Promise<PerfSamplesSeries>

Accessors

allocatedCpu

allocatedMemory

allocationModel

companyId

deleted

deletedDate

description

diskLimit

enabled

entityType

json

locationId

maxHardwareVersion

name

networkQuota

orgUuid

reservedCpu

reservedMemory

updatedDate

usedNetworkCount

uuid

vcenterHref

vcenterInstanceUuid

vcenterMoref

vcenterName

vcloudHref

Methods

addVappFromTemplate

Parameters

vdcAddVappFromTemplateRequest: VdcAddVappFromTemplateRequest

Returns Promise<Task>

buildVapp

Parameters

buildVappRequest: BuildVappRequestJson

Returns Promise<Task>

createOrgVdcNetwork

Parameters

network: OrgVdcNetworkCreateRequest

Returns Promise<Task>

deleteMetadata

Parameters

metadataKey: string

Returns Promise<Task>

emailEventHistory

Parameters

email: string

Returns Promise<void>

generateVmInventoryReport

Parameters

Optional emailOnCompletion: undefined | false | true

Optional email: undefined | string

Returns Promise<Task>

getBilling

Parameters

Optional year: undefined | number

Optional month: undefined | number

Returns Promise<Bill>