Vpg | iland-sdk

Virtual Protection Group

Hierarchy

Entity
- Vpg

Index

Constructors

constructor

Methods

Constructors

constructor

new Vpg(_json: VpgJson): Vpg

Overrides Entity.constructor
- Defined in model/vpg/vpg.ts:33
Parameters
- _json: VpgJson
Returns Vpg

Accessors

activeProcessStage

activeProcessStage:

Get active provess stage for Vpg

actualRpo

actualRpo:

Get actual rpo of Vpg

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.

entities

entities:

Get entities for Vpg

entityType

entityType:

iops

iops:

Get iops for Vpg

isBackupEnabled

isBackupEnabled:

Get is backup enabled boolean for Vpg

json

json:

Gets the raw JSON object from the API.

lastTest

lastTest:

Get last test for Vpg

locationId

locationId:

Get the location id of Vpg

name

name:

Gets the name.

orgName

orgName:

Get org name of Vpg

orgUuid

orgUuid:

Get the org uuid of Vpg

priority

priority:

Get priority of Vpg

protectedSiteIdentifier

protectedSiteIdentifier:

Get protected site identifer for Vpg

provisionedStorageInMb

provisionedStorageInMb:

Get provisioned storage in mb for Vpg

recoveryJournalProvisionedStorageInMb

recoveryJournalProvisionedStorageInMb:

Get recovery journal provisioned storage in mb for Vpg

recoveryJournalUsedStorageInMb

recoveryJournalUsedStorageInMb:

Get recovery journal used storage in mb for Vpg

recoverySiteIdentifier

recoverySiteIdentifier:

Get recovery site identifier for Vpg

serviceProfile

serviceProfile:

Get service profile for Vpg.

serviceProfileIdentifier

serviceProfileIdentifier:

Get service profile identifier for Vpg

serviceProfileUuid

serviceProfileUuid:

Get service profile uuid of Vpg

sourceSite

sourceSite:

Get source site for Vpg

status

status:

Get status of Vpg

subStatus

subStatus:

Get sub status of Vpg

targetSite

targetSite:

Get target site for Vpg

throughputInMb

throughputInMb:

Get throughput in mb for Vpg

updatedDate

updatedDate:

Gets the last date that the entity was updated.

usedStorageInMb

usedStorageInMb:

Get used storage in percent for Vpg

uuid

uuid:

Gets the UUID.

vms

vms:

Get VMs for Vpg

vmsCount

vmsCount:

Get VMs count for Vpg

vpgIdentifier

vpgIdentifier:

Get the Vpg identifier of Vpg

vpgName

vpgName:

Get the Vpg name

Methods

addVpgFailoverTestAlert

addVpgFailoverTestAlert(alertRequest: VpgFailoverTestAlertRequest): Promise<VpgFailoverTestAlert>

- Defined in model/vpg/vpg.ts:324
Add a Vpg Failover Test Alert

Parameters
- alertRequest: VpgFailoverTestAlertRequest
Returns Promise<VpgFailoverTestAlert>

commitFailover

commitFailover(): Promise<Task>

- Defined in model/vpg/vpg.ts:434
Commits changes after a live failover for Vpg

Returns Promise<Task>

task

downloadFailoverReport

downloadFailoverReport(reportUuid: string, fileName?: undefined | string): Observable<String>

- Defined in model/vpg/vpg.ts:481
Get a failover report file for a task

Parameters
- reportUuid: string
  
  the UUID of the task to retrieve the report for
- Optional fileName: undefined | string
Returns Observable<String>

failover

failover(failoverCreateRequest: VpgFailoverCreateRequest): Promise<Task>

- Defined in model/vpg/vpg.ts:423
Initiates a live failover on the Vpg

Parameters
- failoverCreateRequest: VpgFailoverCreateRequest
Returns Promise<Task>

task

failoverTest

failoverTest(checkpointId: string): Promise<Task>

- Defined in model/vpg/vpg.ts:367
Test failover for Vpg.

Parameters
- checkpointId: string
Returns Promise<Task>

task

failoverTestStop

failoverTestStop(success: boolean, summary: string): Promise<Task>

- Defined in model/vpg/vpg.ts:384
Stop a Vpg failover test and provide feedback as to whether the test was successful

Parameters
- success: boolean
- summary: string
Returns Promise<Task>

task

getCheckpoints

getCheckpoints(): Promise<Array<VpgCheckpoint>>

- Defined in model/vpg/vpg.ts:456
Get checkpoints for Vpg

Returns Promise<Array<VpgCheckpoint>>

vpg checkpoints

getFailoverTaskDetails

getFailoverTaskDetails(taskUuid: string): Promise<VpgFailoverReportDetails>

- Defined in model/vpg/vpg.ts:468
Gets failover task details for a failover.

Parameters
- taskUuid: string
Returns Promise<VpgFailoverReportDetails>

vpg failover report detail

getPerformanceCounters

getPerformanceCounters(): Promise<Array<PerfCounter>>

- Defined in model/vpg/vpg.ts:496
Get performance counters for vpg.

Returns Promise<Array<PerfCounter>>

performance counters

getServiceProfile

getServiceProfile(): Promise<ServiceProfile>

- Defined in model/vpg/vpg.ts:411
Gets the service profile for the Vpg

Returns Promise<ServiceProfile>

service profile

getVmsForVpg

getVmsForVpg(): Promise<Array<VpgVm>>

- Defined in model/vpg/vpg.ts:400
Gets the VMs that belong to the Vpg

Returns Promise<Array<VpgVm>>

vpg vms

getVpgFailoverTestAlert

getVpgFailoverTestAlert(): Promise<VpgFailoverTestAlert>

- Defined in model/vpg/vpg.ts:312
Get the failover test alert for Vpg

Returns Promise<VpgFailoverTestAlert>

vpg failover test alert

getVpgPerfFor

getVpgPerfFor(group: string, name: string, type: string, start?: undefined | number, end?: undefined | number): Promise<PerfSamplesSeries>

- Defined in model/vpg/vpg.ts:349
Returns VPG performance samples given a performance series information

Parameters
- group: string
- name: string
- type: string
- Optional start: undefined | number
- Optional end: undefined | number
Returns Promise<PerfSamplesSeries>

perf sample serie

isFailingOver

isFailingOver(): boolean

- Defined in model/vpg/vpg.ts:288
Return whether or not the vpg is failing over or not.

Returns boolean

refresh

refresh(): Promise<Vpg>

- Defined in model/vpg/vpg.ts:507
Refreshes the Vpg data by retrieving it from the API again.

Returns Promise<Vpg>

promise that resolves with this object

removeVpgFailoverTestAlert

removeVpgFailoverTestAlert(): Promise<any>

- Defined in model/vpg/vpg.ts:336
Remove a Vpg Failover Test Alert

Returns Promise<any>

rollbackFailover

rollbackFailover(): Promise<Task>

- Defined in model/vpg/vpg.ts:445
Rolls back changes after a live failover for Vpg

Returns Promise<Task>

task

toString

toString(): string

- Defined in model/vpg/vpg.ts:296
JSON format.

Returns string

Static getVpg

getVpg(uuid: string, vpgSubEntities: Array<VpgSubEntityRequest>): Promise<Vpg>

- Defined in model/vpg/vpg.ts:45
Gets a Vpg by UUID.

Parameters
- uuid: string
  
  vpg UUID
- vpgSubEntities: Array<VpgSubEntityRequest>
  
  query params
Returns Promise<Vpg>

promise that resolves with the Vpg

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_json: VpgJson

Returns Vpg

Accessors

activeProcessStage

actualRpo

companyId

deleted

deletedDate

entities

entityType

iops

isBackupEnabled

json

lastTest

locationId

name

orgName

orgUuid

priority

protectedSiteIdentifier

provisionedStorageInMb

recoveryJournalProvisionedStorageInMb

recoveryJournalUsedStorageInMb

recoverySiteIdentifier

serviceProfile

serviceProfileIdentifier

serviceProfileUuid

sourceSite

status

subStatus

targetSite

throughputInMb

updatedDate

usedStorageInMb

uuid

vms

vmsCount

vpgIdentifier

vpgName

Methods

addVpgFailoverTestAlert

Parameters

alertRequest: VpgFailoverTestAlertRequest

Returns Promise<VpgFailoverTestAlert>

commitFailover

Returns Promise<Task>

downloadFailoverReport

Parameters

reportUuid: string

Optional fileName: undefined | string

Returns Observable<String>

failover

Parameters

failoverCreateRequest: VpgFailoverCreateRequest

Returns Promise<Task>

failoverTest

Parameters

checkpointId: string

Returns Promise<Task>

failoverTestStop

Parameters

success: boolean

summary: string

Returns Promise<Task>

getCheckpoints

Returns Promise<Array<VpgCheckpoint>>

getFailoverTaskDetails

Parameters

taskUuid: string

Returns Promise<VpgFailoverReportDetails>

getPerformanceCounters

Returns Promise<Array<PerfCounter>>