DisasterRecoveryRunbook | iland-sdk

Disaster recovery runbook

Hierarchy

DisasterRecoveryRunbook

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new DisasterRecoveryRunbook(_json: DisasterRecoveryRunbookJson): DisasterRecoveryRunbook

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:22
Parameters
- _json: DisasterRecoveryRunbookJson
Returns DisasterRecoveryRunbook

Accessors

companyId

companyId:

Get company id.

createdDate

createdDate:

Get created date.

deleted

deleted:

Get deleted.

deletedDate

deletedDate:

Get deleted date.

description

description:

Get description.

json

json:

Get the json representation of this class.

lastTest

lastTest:

Get last test.

locationId

locationId:

Get location id.

name

name:

Get name.

orgUuid

orgUuid:

Get org uuid.

recoveryGroups

recoveryGroups:

Get recovery groups.

updatedDate

updatedDate:

Get updated date.

uuid

uuid:

Get uuid.

Methods

abort

abort(abortRequest: DisasterRecoveryRunbookAbortRequest): Promise<Task>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:189
Abort a disaster recovery runbook.

Parameters
- abortRequest: DisasterRecoveryRunbookAbortRequest
Returns Promise<Task>

delete

delete(): Promise<any>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:168
Deletes a DisasterRecoveryRunbook.

Returns Promise<any>

a promise that resolves when the operation completes

execute

execute(executeRequest: DisasterRecoveryRunbookExecuteRequest): Promise<Task>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:202
Execute a runbook.

Parameters
- executeRequest: DisasterRecoveryRunbookExecuteRequest
Returns Promise<Task>

finalizeExecution

finalizeExecution(finalizeExecutionRequest: DisasterRecoveryRunbookFinalizeExecutionRequest): Promise<Task>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:215
Finalize runbook execution.

Parameters
- finalizeExecutionRequest: DisasterRecoveryRunbookFinalizeExecutionRequest
Returns Promise<Task>

getReportHref

getReportHref(reportUuid: string, filename?: undefined | string): Observable<string>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:242
Get report href.

Parameters
- reportUuid: string
- Optional filename: undefined | string
Returns Observable<string>

getRunbookTaskDetails

getRunbookTaskDetails(taskUuid: string): Promise<DisasterRecoveryRunbookReportDetails>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:257
Get runbook task details

Parameters
- taskUuid: string
Returns Promise<DisasterRecoveryRunbookReportDetails>

refresh

refresh(): Promise<DisasterRecoveryRunbook>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:157
Refreshes the DisasterRecoveryRunbook data by retrieving it from the API again.

Returns Promise<DisasterRecoveryRunbook>

promise that resolves with this object

test

test(): Promise<Task>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:228
Run a runbook test.

Returns Promise<Task>

toString

toString(): string

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:149
Get the string representation of this class.

Returns string

update

update(request: DisasterRecoveryRunbookUpdateRequest): Promise<DisasterRecoveryRunbook>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:177
Updates a disaster recovery runbook.

Parameters
- request: DisasterRecoveryRunbookUpdateRequest
  
  the update request
Returns Promise<DisasterRecoveryRunbook>

a promise that resolves with the updated runbook.

Static getDisasterRecoveryRunbook

getDisasterRecoveryRunbook(uuid: string): Promise<DisasterRecoveryRunbook>

- Defined in model/org/disaster-recovery-runbook/disaster-recovery-runbook.ts:32
Gets an DisasterRecoveryRunbook by UUID.

Parameters
- uuid: string
  
  DisasterRecoveryRunbook UUID
Returns Promise<DisasterRecoveryRunbook>

promise that resolves with the DisasterRecoveryRunbook

Generated using TypeDoc