Org | iland-sdk

IaaS Organization.

Hierarchy

Entity
- Org

Index

Constructors

constructor

Methods

Constructors

constructor

new Org(_json: OrgJson): Org

Overrides Entity.constructor
- Defined in model/org/org.ts:108
Parameters
- _json: OrgJson
Returns Org

Accessors

companyId

companyId:

Gets the company ID (CRM).

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.

enabled

enabled:

Indicates whether the Org is enabled.

entityType

entityType:

fullName

fullName:

Gets the full name of the organization.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Gets the datacenter location identifier.

name

name:

Gets the name.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

vappDeletedOnStorageLeaseExpiration

vappDeletedOnStorageLeaseExpiration:

Indicates whether the Org is configured such that vApps are deleted upon storage lease expiration vs. being marked as an expired item.

vappMaxRuntimeLease

vappMaxRuntimeLease:

Gets the Orgs max vApp runtime lease setting.

vappMaxStorageLease

vappMaxStorageLease:

Gets the vApps max storage lease setting.

vappTemplateDeletedOnStorageLeaseExpiration

vappTemplateDeletedOnStorageLeaseExpiration:

Indicates whether the Org is configured such that vApp templates are deleted upon storage lease expiration vs. being marked as an expired item.

vappTemplateMaxStorageLease

vappTemplateMaxStorageLease:

Gets the Orgs vApp template max storage lease setting.

vccrTarget

vccrTarget:

Indicates whether the Org is a VCCR continuity target.

vcloudHref

vcloudHref:

Gets the vCloud HREF

zertoTarget

zertoTarget:

Indicates whether the Org is a Zerto continuity target.

Methods

addDnsRecord

addDnsRecord(record: DnsRecordCreateRequest): Promise<DnsRecord>

- Defined in model/org/org.ts:457
Adds a new DNS record for the org.

Parameters
- record: DnsRecordCreateRequest
  
  the new record
Returns Promise<DnsRecord>

a promise that resolves with the new record

addDnsZone

addDnsZone(zoneSpec: DnsZoneCreateRequest): Promise<DnsZone>

- Defined in model/org/org.ts:501
Adds a new DNS zone within the org.

Parameters
- zoneSpec: DnsZoneCreateRequest
  
  the new DNS zone details
Returns Promise<DnsZone>

a promise that resolves with the newly created DNS zone

batchFailover

batchFailover(params: BatchFailoverParamsRequest): Promise<Task>

- Defined in model/org/org.ts:1739
Initiates a batch live failover on one or more VPGs withing an org.

Parameters
- params: BatchFailoverParamsRequest
  
  the batch failover parameters
Returns Promise<Task>

promise promise that resolves with a Task

batchFailoverTest

batchFailoverTest(params: BatchFailoverTestParamsRequest): Promise<Task>

- Defined in model/org/org.ts:1726
Batch test failover for one or more VPGs within an org.

Parameters
- params: BatchFailoverTestParamsRequest
  
  the batch failover test parameters
Returns Promise<Task>

promise Promise that resolves with a Task

checkDnsZone

checkDnsZone(zoneId: number): Promise<CheckDnsZone>

- Defined in model/org/org.ts:522
Checks the status of a DNS zone within the org.

Parameters
- zoneId: number
  
  the ID of the zone
Returns Promise<CheckDnsZone>

a promise that resolves with the zone check results

createCatalog

createCatalog(request: CatalogCreateRequest): Promise<Task>

- Defined in model/org/org.ts:1652
Creates a catalog.

Parameters
- request: CatalogCreateRequest
  
  the create catalog request.
Returns Promise<Task>

a promise that resolves with a task

createRecoveryRunbook

createRecoveryRunbook(spec: DisasterRecoveryRunbookCreateRequest): Promise<DisasterRecoveryRunbook>

- Defined in model/org/org.ts:1434
Creates a new disaster recovery runbook.

Parameters
- spec: DisasterRecoveryRunbookCreateRequest
  
  the new runbook specification
Returns Promise<DisasterRecoveryRunbook>

a promise that resolves with the new runbook

deleteDnsRecord

deleteDnsRecord(recordId: number): Promise<any>

- Defined in model/org/org.ts:481
Deletes a DNS record within the org.

Parameters
- recordId: number
  
  the record ID
Returns Promise<any>

a promise that resolves when the operation completes

deleteDnsZone

deleteDnsZone(zoneId: number): Promise<any>

- Defined in model/org/org.ts:513
Deletes a DNS zone from the org.

Parameters
- zoneId: number
  
  the ID of the zone
Returns Promise<any>

a promise that resolves when the operation completes

emailEventHistory

emailEventHistory(email: string): Promise<void>

- Defined in model/org/org.ts:1861
Retrieve a CSV report email with all event history for a given Org.

Parameters
- email: string
Returns Promise<void>

there is no response object.

generateAntiMalwareReport

generateAntiMalwareReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1005
Generate the anti-malware report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateBillingReport

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

- Defined in model/org/org.ts:1031
Generate the billing report for a given organization.

Parameters
- billingReportSpec: BillingReportRequest
  
  Billing report (Doc)
- 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

generateContinuityProtectionSummaryReport

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

- Defined in model/org/org.ts:1053
Generate a continuity protection summary report for the given organization.

Parameters
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateDPIEventHistoryReport

generateDPIEventHistoryReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1078
Generate the DPI event history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateDRAdminReport

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

- Defined in model/org/org.ts:1103
Generate the dr admin report for the given organization.

Parameters
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateEcsEventHistoryReport

generateEcsEventHistoryReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1127
Generate the ecs event history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateFirewallEventHistoryReport

generateFirewallEventHistoryReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1154
Generate the firewall event history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateHipaaReport

generateHipaaReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1181
Generate the HIPAA report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateIntegrityEventHistoryReport

generateIntegrityEventHistoryReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1208
Generate the integrity event history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateLogInspectionReport

generateLogInspectionReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1235
Generate the log inspection report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateLoginEventHistoryReport

generateLoginEventHistoryReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1262
Generate the login event history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateSupportRequestReport

generateSupportRequestReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1289
Generate the support request history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateVmEncryptionReport

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

- Defined in model/org/org.ts:1314
Generate the VM encryption report for the given organization.

Parameters
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- Optional emailOnCompletion: undefined | false | true
  
  Whether to email the report upon successful generation
- Optional email: undefined | string
  
  3mail 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

generateVmInventoryReport

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

- Defined in model/org/org.ts:1335
Generate the vm inventory report for a given organization.

Parameters
- Optional emailOnCompletion: undefined | false | true
  
  Whether to email the report upon successful generation
- Optional email: undefined | string
  
  3mail 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

generateVulnerabilityReport

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

- Defined in model/org/org.ts:1356
Generate the vulnerability report for the given organization.

Parameters
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

generateWebReputationEventHistoryReport

generateWebReputationEventHistoryReport(start?: undefined | number, end?: undefined | number, format?: undefined | string, emailOnCompletion?: undefined | false | true, email?: undefined | string): Promise<Task>

- Defined in model/org/org.ts:1380
Generate the web reputation event history report for the given organization and time range.

Parameters
- Optional start: undefined | number
  
  Start date as timestamp
- Optional end: undefined | number
  
  End date as timestamp
- Optional format: undefined | string
  
  Report format ('pdf' or 'html')
- 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

getAntimalwareEventReports

getAntimalwareEventReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:826
Get the anti-malware event reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getAntimalwareOverTimeSerie

getAntimalwareOverTimeSerie(start?: undefined | number, end?: undefined | number, limit?: undefined | number): Promise<AntimalwareOverTime>

- Defined in model/org/org.ts:894
Get the antimalware over time serie for the given organization and date range.

Parameters
- Optional start: undefined | number
  
  Start date (defaults to one month prior to end param)
- Optional end: undefined | number
  
  End date (defaults to current time if not provided)
- Optional limit: undefined | number
  
  Limit on number of samples to return (defaults to 730)
Returns Promise<AntimalwareOverTime>

promise Promise that resolves with a AntimalwareOverTime serie

getAvailableIpsForPtrRecords

getAvailableIpsForPtrRecords(): Promise<IpAddressSet>

- Defined in model/org/org.ts:533
Gets all IP addresses available for assignment in PTR records.

Returns Promise<IpAddressSet>

a promise that resolves with the set of available IP addresses

getBandwidthSummation

getBandwidthSummation(type?: undefined | string, start?: undefined | number, end?: undefined | number): Promise<Array<NetworkPerfSampleSerie>>

- Defined in model/org/org.ts:1825
Get the network usage summary for the organization

Parameters
- Optional type: undefined | string
  
  Type
- Optional start: undefined | number
  
  Start Date
- Optional end: undefined | number
  
  End Date
Returns Promise<Array<NetworkPerfSampleSerie>>

getBandwidthUsage

getBandwidthUsage(month?: undefined | number, year?: undefined | number): Promise<BandwidthUsageSummary>

- Defined in model/org/org.ts:1845
Gets the bandwidth usage information for the organization.

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

a promise that resolves with the bandwidth usage information

getBill

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

- Defined in model/org/org.ts:335
Gets the organization's bill for the specified month/year.

Parameters
- Optional month: undefined | number
  
  a month specified as an integer in the range 1-12
- Optional year: undefined | number
  
  a year
Returns Promise<Bill>

a promise that resolves with the bill

getBillingByVdc

getBillingByVdc(month?: undefined | number, year?: undefined | number): Promise<OrgVdcBills | null>

- Defined in model/org/org.ts:323
Gets the list of bills for each vDC within the org, for the specified billing month/year.

Parameters
- Optional month: undefined | number
  
  the month to get vDC bills for in the range 1-12
- Optional year: undefined | number
  
  the year to get vDC bills for
Returns Promise<OrgVdcBills | null>

a promise that resolves with the org vdc bill object or null if none exists for the specified month

getBillingByVdcInRange

getBillingByVdcInRange(startMonth?: undefined | number, startYear?: undefined | number, endMonth?: undefined | number, endYear?: undefined | number): Promise<Array<OrgVdcBills>>

- Defined in model/org/org.ts:301
Gets the list of bills for each vDC within the org, for the specified range of billing periods.

Parameters
- Optional startMonth: undefined | number
  
  the begin range month specified as an integer in the range 1-12
- Optional startYear: undefined | number
  
  the begin range year
- Optional endMonth: undefined | number
  
  the end range month specified as an integer in the range 1-12
- Optional endYear: undefined | number
  
  the end range month
Returns Promise<Array<OrgVdcBills>>

a promise that resolves with the list of org vdc bill objects

getBillingCurrencyCode

getBillingCurrencyCode(): Promise<OrgCurrencyCode>

- Defined in model/org/org.ts:1677
Gets the billing currency code for this org.

Returns Promise<OrgCurrencyCode>

a promise that resolves with the org's currency code.

getBillingReports

getBillingReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:597
Get the billing reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getBillingSummary

getBillingSummary(): Promise<BillingSummary>

- Defined in model/org/org.ts:286
Gets the organization's current billing summary.

Returns Promise<BillingSummary>

promise that resolves with the current billing summary

getCloudEventReports

getCloudEventReports(orgUuid: string, format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:655
Get the cloud event reports available for download for the given organization.

Parameters
- orgUuid: string
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getComplianceOverTimeSerie

getComplianceOverTimeSerie(type?: SerieType, start?: undefined | number, end?: undefined | number, limit?: undefined | number): Promise<ComplianceOverTime>

- Defined in model/org/org.ts:916
Get the compliance over time serie for the given organization and serie name.

Parameters
- Optional type: SerieType
  
  Type of the series (ANTI_MALWARE, VULNERABILITY, LOG_INSPECTION, FIREWALL)
- Optional start: undefined | number
  
  Start date (defaults to one month prior to end param)
- Optional end: undefined | number
  
  End date (defaults to current time if not provided)
- Optional limit: undefined | number
  
  Limit on number of samples to return (defaults to 60)
Returns Promise<ComplianceOverTime>

promise Promise that resolves with a ComplianceOverTime serie

getContinuityProtectionReports

getContinuityProtectionReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:559
Get the continuity protection reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getDPIEventReports

getDPIEventReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:750
Get the DPI event reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getDisasterRecoveryAdminReports

getDisasterRecoveryAdminReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:578
Get the disaster recovery admin reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getDnsRecords

getDnsRecords(): Promise<Array<DnsRecord>>

- Defined in model/org/org.ts:445
Gets all DNS records for the organization.

Returns Promise<Array<DnsRecord>>

a promise that resolves with a list of DNS records.

getDnsZones

getDnsZones(): Promise<Array<DnsZone>>

- Defined in model/org/org.ts:489
Gets all DNS zones that exist within the org.

Returns Promise<Array<DnsZone>>

a promise that resolves with the list of DNS zones

getDrsAffinityRules

getDrsAffinityRules(): Promise<Array<VmAffinityRule>>

- Defined in model/org/org.ts:1470
Gets the org's current DRS affinity rules.

Returns Promise<Array<VmAffinityRule>>

a promise that resolves with the list of DRS affinity rules

getEdgeNetworkUsageOverTime

getEdgeNetworkUsageOverTime(type?: undefined | string, start?: undefined | number, end?: undefined | number): Promise<Array<NetworkPerfSampleSerie>>

- Defined in model/org/org.ts:1782
Gets usage data for a VCD edge gateway. Returns a time series showing the average inbound and outbound network thoughput in KBps.

Parameters
- Optional type: undefined | string
  
  Type
- Optional start: undefined | number
  
  Start date
- Optional end: undefined | number
  
  End date
Returns Promise<Array<NetworkPerfSampleSerie>>

getEdgeNetworkUsageSummary

getEdgeNetworkUsageSummary(type?: undefined | string, start?: undefined | number, end?: undefined | number): Promise<Array<NetworkPerfSampleSerie>>

- Defined in model/org/org.ts:1759
Gets a vCD edge gateway usage summary, summarizing the total bandwidth used for both inbound and outbound edge network traffic.

If no start/end dates are provided it will default to the latest hour range. If you pass a custom time range both start and end date must be passed together

Parameters
- Optional type: undefined | string
  
  Type
- Optional start: undefined | number
  
  Start date
- Optional end: undefined | number
  
  End date
Returns Promise<Array<NetworkPerfSampleSerie>>

getEdges

getEdges(): Promise<Array<Edge>>

- Defined in model/org/org.ts:384
Gets the Orgs child Edges.

Returns Promise<Array<Edge>>

promise that resolves with an array of child Edges

getExternalNetworks

getExternalNetworks(): Promise<Array<ExternalNetwork>>

- Defined in model/org/org.ts:1458
Get all external networks that are associated with the specified organization.

Returns Promise<Array<ExternalNetwork>>

promise Promise that resolves with an Array of ExternalNetworks

getFirewallEventReports

getFirewallEventReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:788
Get the firewall event reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getFirewallOverTimeSerie

getFirewallOverTimeSerie(start?: undefined | number, end?: undefined | number, limit?: undefined | number): Promise<FirewallOverTime>

- Defined in model/org/org.ts:939
Get the firewall over time serie for the given organization and date range.

Parameters
- Optional start: undefined | number
  
  Start date (defaults to Jan 1, 1970)
- Optional end: undefined | number
  
  End date (defaults to current time if not provided)
- Optional limit: undefined | number
  
  Limit on number of samples to return (defaults to 730)
Returns Promise<FirewallOverTime>

promise Promise that resolves with a FirewallOverTime serie

getHIPAAReports

getHIPAAReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:712
Get the HIPAA reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getHistoricalBilling

getHistoricalBilling(start: Date, end: Date): Promise<Array<Bill>>

- Defined in model/org/org.ts:270
Gets a list of historical bills for the organization. All bills with timestamps between the start and end parameters are returned.

Parameters
- start: Date
  
  the begin timestamp of the query range
- end: Date
  
  the end timestamp of the query range
Returns Promise<Array<Bill>>

promise that resolves with the list of historical bills

getIntegrityEventReports

getIntegrityEventReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:769
Get the integrity event reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getInternalNetworks

getInternalNetworks(): Promise<Array<InternalNetwork>>

- Defined in model/org/org.ts:395
Gets the Orgs child internal networks.

Returns Promise<Array<InternalNetwork>>

promise that resolves with an array of child Internal networks

getLogInspectionEventReports

getLogInspectionEventReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:807
Get the log inspection event reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getLogInspectionOverTimeSerie

getLogInspectionOverTimeSerie(start?: undefined | number, end?: undefined | number, limit?: undefined | number): Promise<LogInspectionOverTime>

- Defined in model/org/org.ts:960
Get the log inspection over time serie for the given organization and date range.

Parameters
- Optional start: undefined | number
  
  Start date (defaults to Jan 1, 1970)
- Optional end: undefined | number
  
  End date (defaults to current time if not provided)
- Optional limit: undefined | number
  
  Limit on number of samples to return (defaults to 730)
Returns Promise<LogInspectionOverTime>

promise Promise that resolves with a LogInspectionOverTime serie

getLoginEventReports

getLoginEventReports(orgUuid: string, format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:674
Get the login event reports available for download for the given organization.

Parameters
- orgUuid: string
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getNessusScanOptOutPreferences

getNessusScanOptOutPreferences(): Promise<NessusScanOptOut>

- Defined in model/org/org.ts:1622
Gets Nessus scan opt out preferences.

Returns Promise<NessusScanOptOut>

a promise that resolves with the orgs Nessus scan opt out details

getNessusScanResult

getNessusScanResult(scanResultUuid: string): Promise<NessusScanDetails>

- Defined in model/org/org.ts:1581
Get Nessus scan result.

Parameters
- scanResultUuid: string
  
  the UUID of the result to retrieve
Returns Promise<NessusScanDetails>

a promise that resolves with the nessus sacan details

getNessusScanResultsForTemplate

getNessusScanResultsForTemplate(scanTemplateId: number, offset?: undefined | number, limit?: undefined | number): Promise<Array<NessusScan>>

- Defined in model/org/org.ts:1562
Gets the Nessus scan results for a specified template.

Parameters
- scanTemplateId: number
  
  the ID of the template
- Optional offset: undefined | number
  
  the paging offset
- Optional limit: undefined | number
  
  the paging limit
Returns Promise<Array<NessusScan>>

a promise that resolves with the list of nessus scan results

getNessusScanTemplates

getNessusScanTemplates(offset?: undefined | number, limit?: undefined | number): Promise<Array<NessusScan>>

- Defined in model/org/org.ts:1542
Gets all Nessus scan templates for the org.

Parameters
- Optional offset: undefined | number
  
  paging offset
- Optional limit: undefined | number
  
  paging limit
Returns Promise<Array<NessusScan>>

a promise that resolves with the list of Nessus scans

getOrgBandwidthUsage

getOrgBandwidthUsage(type?: undefined | string, start?: undefined | number, end?: undefined | number): Promise<Array<NetworkPerfSampleSerie>>

- Defined in model/org/org.ts:1804
Get the network usage for the organization

Parameters
- Optional type: undefined | string
  
  Type
- Optional start: undefined | number
  
  Start Date
- Optional end: undefined | number
  
  End Date
Returns Promise<Array<NetworkPerfSampleSerie>>

getOrgCatalogs

getOrgCatalogs(): Promise<Array<Catalog>>

- Defined in model/org/org.ts:545
Gets all catalogs within the organization.

Returns Promise<Array<Catalog>>

returns a promise that resolves with the list of organization catalogs

getPublicIpAssignments

getPublicIpAssignments(): Promise<Array<PublicIpAssignment>>

- Defined in model/org/org.ts:1689
Gets the org's public IP assignments.

Returns Promise<Array<PublicIpAssignment>>

a promise that resolves with the org's public ip assignments

getRecoveryRunbooks

getRecoveryRunbooks(): Promise<Array<DisasterRecoveryRunbook>>

- Defined in model/org/org.ts:1421
Gets all disaster recovery runbooks in the org.

Returns Promise<Array<DisasterRecoveryRunbook>>

a promise that resolves with all runbooks in the org

Private getReportWithContent

getReportWithContent(reportUuid: string): Promise<ReportWithContent>

- Defined in model/org/org.ts:865
Get a report with its JSON content. This endpoint is experimental.

Parameters
- reportUuid: string
Returns Promise<ReportWithContent>

promise Promise that resolves with the report with content

Private getReportWithSummary

getReportWithSummary(reportUuid: string): Promise<ReportWithSummary>

- Defined in model/org/org.ts:879
Get a report with its JSON summary. This endpoint is experimental.

Parameters
- reportUuid: string
Returns Promise<ReportWithSummary>

promise Promise that resolves with the report with summary

getReportsCount

getReportsCount(reportType?: undefined | string, start?: undefined | number, end?: undefined | number): Promise<number>

- Defined in model/org/org.ts:1404
Get the number of events for the given organization, date range, and report type.

Parameters
- Optional reportType: undefined | string
- Optional start: undefined | number
  
  Start date (defaults to yesterday)
- Optional end: undefined | number
  
  End date (defaults to today)
Returns Promise<number>

promise Promise that resolves with the reports count

getSupportRequestReports

getSupportRequestReports(orgUuid: string, format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:635
Get the support request reports available for download for the given organization.

Parameters
- orgUuid: string
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getVMEncryptionReports

getVMEncryptionReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:693
Get the VM encryption reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getVappNetworks

getVappNetworks(): Promise<Array<VappNetwork>>

- Defined in model/org/org.ts:406
Gets the Orgs child vApp networks.

Returns Promise<Array<VappNetwork>>

promise that resolves with an array of child vApp networks

getVappTemplates

getVappTemplates(): Promise<Array<VappTemplate>>

- Defined in model/org/org.ts:1446
Gets all vApp templates within the org.

Returns Promise<Array<VappTemplate>>

a promise that resolves with the list of vapp templates

getVapps

getVapps(): Promise<Array<Vapp>>

- Defined in model/org/org.ts:362
Gets the Orgs child vApps.

Returns Promise<Array<Vapp>>

promise that resolves with an array of child vApps

getVccFailoverPlans

getVccFailoverPlans(): Promise<Array<VCCFailoverPlan>>

- Defined in model/org/org.ts:1871
Retrieve the VCC Failover Plans within this org.

Returns Promise<Array<VCCFailoverPlan>>

getVdcCostOverInvoicePeriodSeries

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

- Defined in model/org/org.ts:1706
Get a list of series detailing the hourly cost over an invoice period for all vDCs in a given Organization.

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

promise Promise that resolves with a list of series of samples detailing hourly vDC total cost by hour for the invoice period

getVdcs

getVdcs(): Promise<Array<Vdc>>

- Defined in model/org/org.ts:351
Gets the Orgs child vDCs.

Returns Promise<Array<Vdc>>

promise that resolves with an array of child vDCs

getVmInventoryReports

getVmInventoryReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:616
Get the VM inventory reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getVms

getVms(): Promise<Array<Vm>>

- Defined in model/org/org.ts:373
Gets the Orgs child VMs.

Returns Promise<Array<Vm>>

promise that resolves with an array of child VMs

getVpgs

getVpgs(expand?: Array<VpgSubEntityRequest>): Promise<Array<ExpandedVpg>>

- Defined in model/org/org.ts:1635
Get all VPGs that belong to the org.

Parameters
- Optional expand: Array<VpgSubEntityRequest>
  
  the list of expansions to include in the response
Returns Promise<Array<ExpandedVpg>>

a promise that resolves with the vpgs

getVpgsProtectionSummary

getVpgsProtectionSummary(): Promise<VpgsProtectionInfo>

- Defined in model/org/org.ts:1882
Retrieve the org's VPG protection summary.

Returns Promise<VpgsProtectionInfo>

getVulnerabilityOverTimeSerie

getVulnerabilityOverTimeSerie(start?: undefined | number, end?: undefined | number, limit?: undefined | number): Promise<VulnerabilityOverTime>

- Defined in model/org/org.ts:981
Get the vulnerability over time serie for the given organization and date range.

Parameters
- Optional start: undefined | number
  
  Start date (defaults to Jan 1, 1970)
- Optional end: undefined | number
  
  End date (defaults to current time if not provided)
- Optional limit: undefined | number
  
  Limit on number of samples to return (defaults to 730)
Returns Promise<VulnerabilityOverTime>

promise Promise that resolves with a ComplianceOverTime serie

getVulnerabilityReports

getVulnerabilityReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:846
Get the vulnerability event reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

getWebReputationEventReports

getWebReputationEventReports(format?: ReportFormat, latest?: undefined | false | true): Promise<Array<ReportHeader>>

- Defined in model/org/org.ts:731
Get the web reputation reports available for download for the given organization.

Parameters
- Optional format: ReportFormat
- Optional latest: undefined | false | true
Returns Promise<Array<ReportHeader>>

promise Promise that resolves with a list of Report

isAdvancedSecurityOrg

isAdvancedSecurityOrg(): Promise<IsComplianceOrg>

- Defined in model/org/org.ts:1665
Indicates whether the org is an advanced security org.

Returns Promise<IsComplianceOrg>

a promise that resolves with the result indicating whether this is an advanced security org

launchNessusScan

launchNessusScan(scanTemplateId: number): Promise<NessusLaunch>

- Defined in model/org/org.ts:1497
Launches a new Nessus scan.

Parameters
- scanTemplateId: number
  
  the ID of the template for the scan
Returns Promise<NessusLaunch>

a promise that resolves with the launch result

pauseNessusScan

pauseNessusScan(scanTemplateId: number): Promise<any>

- Defined in model/org/org.ts:1511
Pauses a Nessus scan.

Parameters
- scanTemplateId: number
  
  the ID of the template that the scan is derived from
Returns Promise<any>

a promise that resolves when the operation completes

refresh

refresh(): Promise<Org>

- Defined in model/org/org.ts:256
Refreshes the Org data by retrieving it from the API again.

Returns Promise<Org>

promise that resolves with this object

resumeNessusScan

resumeNessusScan(scanTemplateId: number): Promise<any>

- Defined in model/org/org.ts:1531
Resumes a Nessus scan.

Parameters
- scanTemplateId: number
  
  the ID of the template that the scan is derived from.
Returns Promise<any>

a promise that resolves when the operation completes

stopNessusScan

stopNessusScan(scanTemplateId: number): Promise<any>

- Defined in model/org/org.ts:1521
Stops a Nessus scan.

Parameters
- scanTemplateId: number
  
  the ID of the template that the scan is derived from
Returns Promise<any>

a promise that resolves when the operation completes.

toString

toString(): string

- Defined in model/org/org.ts:240
JSON format.

Returns string

updateDnsRecord

updateDnsRecord(record: DnsRecordUpdateRequest): Promise<DnsRecord>

- Defined in model/org/org.ts:469
Updates a DNS record within the org.

Parameters
- record: DnsRecordUpdateRequest
  
  the updated record
Returns Promise<DnsRecord>

a promise that resolves with the updated record

updateDrsAffinityRules

updateDrsAffinityRules(ruleSpecs: Array<VmAffinityRuleUpdateRequest>): Promise<Task>

- Defined in model/org/org.ts:1483
Update the orgs DRS affinity rules.

Parameters
- ruleSpecs: Array<VmAffinityRuleUpdateRequest>
  
  list of rule specifications
Returns Promise<Task>

a promise that resolves with a task

updateNessusScanOptOutPreferences

updateNessusScanOptOutPreferences(request: NessusScanOptOutCreateRequest): Promise<NessusScanOptOut>

- Defined in model/org/org.ts:1609
Update Nessus scan opt out preferences.

Parameters
- request: NessusScanOptOutCreateRequest
  
  opt out request
Returns Promise<NessusScanOptOut>

a promise that resolves with the opt out details

updateNessusScanTemplate

updateNessusScanTemplate(scanTemplateId: number, spec: NessusScanUpdateRequest): Promise<NessusScanUpdate>

- Defined in model/org/org.ts:1595
Update a nessus scan template.

Parameters
- scanTemplateId: number
  
  the template ID
- spec: NessusScanUpdateRequest
  
  the udpate spec
Returns Promise<NessusScanUpdate>

a promise that resolves with the scan update result

updateOrgVappLeaseSettings

updateOrgVappLeaseSettings(spec: OrgVappLeaseUpdateRequest): Promise<Org>

- Defined in model/org/org.ts:433
Updates the organization's vApp lease settings.

Parameters
- spec: OrgVappLeaseUpdateRequest
  
  the new lease settings
Returns Promise<Org>

a promise that resolves with the updated org

updateVappTemplateLeaseSettings

updateVappTemplateLeaseSettings(spec: OrgVappTemplateLeaseUpdateRequest): Promise<Org>

- Defined in model/org/org.ts:419
Updates the organizations vapp template lease settings.

Parameters
- spec: OrgVappTemplateLeaseUpdateRequest
  
  the new lease settings
Returns Promise<Org>

a promise that resolves with the updated org

Static getOrg

getOrg(uuid: string): Promise<Org>

- Defined in model/org/org.ts:119
Gets an Org by UUID.

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

promise that resolves with the Org

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_json: OrgJson

Returns Org

Accessors

companyId

deleted

deletedDate

description

enabled

entityType

fullName

json

locationId

name

updatedDate

uuid

vappDeletedOnStorageLeaseExpiration

vappMaxRuntimeLease

vappMaxStorageLease

vappTemplateDeletedOnStorageLeaseExpiration

vappTemplateMaxStorageLease

vccrTarget

vcloudHref

zertoTarget

Methods

addDnsRecord

Parameters

record: DnsRecordCreateRequest

Returns Promise<DnsRecord>

addDnsZone

Parameters

zoneSpec: DnsZoneCreateRequest

Returns Promise<DnsZone>

batchFailover

Parameters

params: BatchFailoverParamsRequest

Returns Promise<Task>

batchFailoverTest

Parameters

params: BatchFailoverTestParamsRequest

Returns Promise<Task>

checkDnsZone

Parameters

zoneId: number

Returns Promise<CheckDnsZone>

createCatalog

Parameters

request: CatalogCreateRequest

Returns Promise<Task>

createRecoveryRunbook

Parameters

spec: DisasterRecoveryRunbookCreateRequest

Returns Promise<DisasterRecoveryRunbook>

deleteDnsRecord

Parameters

recordId: number

Returns Promise<any>

deleteDnsZone

Parameters

zoneId: number

Returns Promise<any>

emailEventHistory

Parameters

email: string

Returns Promise<void>

generateAntiMalwareReport

Parameters

Optional start: undefined | number

Optional end: undefined | number

Optional format: undefined | string

Optional emailOnCompletion: undefined | false | true

Optional email: undefined | string

Returns Promise<Task>