Edge | iland-sdk

Edge Gateway.

Hierarchy

Entity
- Edge

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Edge(_json: EdgeJson): Edge

Overrides Entity.constructor
- Defined in model/edge/edge.ts:71
Parameters
- _json: EdgeJson
Returns Edge

Accessors

backingConfigurationType

backingConfigurationType:

Gets the type of backing configuration.

backwardCompatibilityMode

backwardCompatibilityMode:

Indicates whether the edge is in backwards compatibility mode.

companyId

companyId:

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

defaultDnsRelayRoute

defaultDnsRelayRoute:

Indicates whether this edge is the default DNS relay route.

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.

entityType

entityType:

highAvailabilityEnabled

highAvailabilityEnabled:

Indicates whether high availability mode is enabled.

interfaces

interfaces:

Gets the Edges network interfaces.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Gets the data center location ID that the edge is associated with.

name

name:

Gets the name.

orgUuid

orgUuid:

Gets the UUID of the associated Org.

status

status:

Gets the status of the Edge gateway.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

vcloudHref

vcloudHref:

Gets the vCloud HREF.

vdcUuid

vdcUuid:

Gets the UUID of the associated vDC.

Methods

getDhcp

getDhcp(): Promise<Dhcp>

- Defined in model/edge/edge.ts:213
Get the Edge Dhcp pool

Returns Promise<Dhcp>

getExportFirewallHref

getExportFirewallHref(filename?: undefined | string): Observable<string>

- Defined in model/edge/edge.ts:277
Export an Edge Firewall configuration file that can be imported/applied to other edges.

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

getExportIpsecVpnHref

getExportIpsecVpnHref(filename?: undefined | string): Observable<string>

- Defined in model/edge/edge.ts:302
Get a link to download an Ipsec vpn export.

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

getExportNatHref

getExportNatHref(filename?: undefined | string): Observable<string>

- Defined in model/edge/edge.ts:360
Export an Edge NAT configuration file that can be imported/applied to other edges.

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

getFirewall

getFirewall(): Promise<Firewall>

- Defined in model/edge/edge.ts:223
Get the Edge firewall

Returns Promise<Firewall>

getFirewallCheckpoint

getFirewallCheckpoint(checkpointUuid: string): Promise<Checkpoint>

- Defined in model/edge/edge.ts:267
Get an edge firewall checkpoint by edge uuid and checkpoint.

description

The actual firewall config of the checkpoint will be included in the return.

Parameters
- checkpointUuid: string
Returns Promise<Checkpoint>

getFirewallCheckpoints

getFirewallCheckpoints(): Promise<Array<Checkpoint>>

- Defined in model/edge/edge.ts:255
Get a list of edge firewall checkpoints that are snapshots of an edge firewall in time.

description

These checkpoints can be used to restore the edge firewall to a previous state in time.

Returns Promise<Array<Checkpoint>>

getFirewallConfiguration

getFirewallConfiguration(): Promise<FirewallConfiguration>

- Defined in model/edge/edge.ts:628
Get the Edge firewall configuration.

Returns Promise<FirewallConfiguration>

getFirewallLogs

getFirewallLogs(type?: EdgeFirewallLogType, start?: undefined | number, end?: undefined | number): Promise<Array<FirewallLog>>

- Defined in model/edge/edge.ts:238
Gets firewall traffic log analysis in different formats that summarize the count of actions that have occurred against a particular edge firewall.

description

By default the endpoint uses 'action_source' analysis type if a specific type is not specified. The time range also defaults to the last hour if no start and end epoch milliseconds are specified. If one of the start or end timestamps are specified the hour range immediately after or before, respectively, are defaulted to.

Parameters
- Optional type: EdgeFirewallLogType
- Optional start: undefined | number
- Optional end: undefined | number
Returns Promise<Array<FirewallLog>>

getIpsecVpn

getIpsecVpn(): Promise<IpsecVpn>

- Defined in model/edge/edge.ts:291
Gets IpSec VPN Service details for an edge

Returns Promise<IpsecVpn>

getIpsecVpnConfiguration

getIpsecVpnConfiguration(): Promise<IpsecVpnConfiguration>

- Defined in model/edge/edge.ts:652
Gets IpSec VPN Service configuration for an edge.

Returns Promise<IpsecVpnConfiguration>

getLoadBalancer

getLoadBalancer(): Promise<LoadBalancer>

- Defined in model/edge/edge.ts:316
Gets Load Balancer Service details for an edge.

Returns Promise<LoadBalancer>

getNat

getNat(): Promise<NatService>

- Defined in model/edge/edge.ts:326
Gets the NAT service configuration for a VCD edge gateway.

Returns Promise<NatService>

getNatCheckpoint

getNatCheckpoint(checkpointUuid: string): Promise<Checkpoint>

- Defined in model/edge/edge.ts:349
Get a NAT checkpoint by edge uuid and checkpoint.

description

The actual NAT config of the checkpoint will be included in the return.

Parameters
- checkpointUuid: string
Returns Promise<Checkpoint>

getNatCheckpoints

getNatCheckpoints(): Promise<Array<Checkpoint>>

- Defined in model/edge/edge.ts:337
Get a list of edge NAT checkpoints that are snapshots of an edge NAT service in time

description

These checkpoints can be used to restore the edge NAT service to a previous state in time.

Returns Promise<Array<Checkpoint>>

getNatConfiguration

getNatConfiguration(): Promise<NatServiceConfiguration>

- Defined in model/edge/edge.ts:676
Gets the NAT service configuration for a VCD edge gateway.

Returns Promise<NatServiceConfiguration>

getPerformance

getPerformance(group: PerfGroupType, name: string, type: PerfStatsType, start?: undefined | number, end?: undefined | number): Promise<NetworkPerfSampleSerie>

- Defined in model/edge/edge.ts:399
Gets statistics data for a VCD edge gateway.

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

getSslVpn

getSslVpn(): Promise<EdgeSslVpnService>

- Defined in model/edge/edge.ts:374
Gets SSL VPN configuration details for an edge gateway.

Returns Promise<EdgeSslVpnService>

getStaticRouting

getStaticRouting(): Promise<StaticRouting>

- Defined in model/edge/edge.ts:384
Gets static routing details for a VCD edge.

Returns Promise<StaticRouting>

importFirewallConfiguration

importFirewallConfiguration(firewall: FirewallConfiguration): Promise<Task>

- Defined in model/edge/edge.ts:640
Import an edge firewall from a configuration.

Parameters
- firewall: FirewallConfiguration
Returns Promise<Task>

importIpSecVpnConfiguration

importIpSecVpnConfiguration(vpn: IpsecVpnConfiguration): Promise<Task>

- Defined in model/edge/edge.ts:664
Import an Ipsec VPN service configuration.

Parameters
- vpn: IpsecVpnConfiguration
Returns Promise<Task>

importNATConfiguration

importNATConfiguration(nat: NatServiceConfiguration): Promise<Task>

- Defined in model/edge/edge.ts:688
Import a NAT service configuration.

Parameters
- nat: NatServiceConfiguration
Returns Promise<Task>

refresh

refresh(): Promise<Edge>

- Defined in model/edge/edge.ts:202
Refreshes the Edge data by retrieving it from the API again.

Returns Promise<Edge>

promise that resolves with this object

restoreFirewallFromCheckpoint

restoreFirewallFromCheckpoint(checkpointUuid: string): Promise<Task>

- Defined in model/edge/edge.ts:443
Restore firewall from checkpoint.

Parameters
- checkpointUuid: string
Returns Promise<Task>

restoreNATFromCheckpoint

restoreNATFromCheckpoint(checkpointUuid: string): Promise<Task>

- Defined in model/edge/edge.ts:457
Restore NAT service from checkpoint.

Parameters
- checkpointUuid: string
Returns Promise<Task>

toString

toString(): string

- Defined in model/edge/edge.ts:186
JSON format.

Returns string

updateDHCP

updateDHCP(request: DhcpServiceUpdateRequest): Promise<Task>

- Defined in model/edge/edge.ts:430
Update the DHCP service.

Parameters
- request: DhcpServiceUpdateRequest
Returns Promise<Task>

updateFirewall

updateFirewall(firewall: EdgeFirewallUpdateRequest): Promise<Task>

- Defined in model/edge/edge.ts:471
Update the edge firewall.

Parameters
- firewall: EdgeFirewallUpdateRequest
Returns Promise<Task>

updateInterface

updateInterface(request: EdgeInterfaceUpdateRequest): Promise<Task>

- Defined in model/edge/edge.ts:484
Update the edge interface.

Parameters
- request: EdgeInterfaceUpdateRequest
Returns Promise<Task>

updateIpSecVpn

updateIpSecVpn(ipSecVpnService: EdgeIpSecVpnServiceUpdateRequest): Promise<IpsecVpn>

- Defined in model/edge/edge.ts:523
Update the edge ip sec vpn service.

Parameters
- ipSecVpnService: EdgeIpSecVpnServiceUpdateRequest
Returns Promise<IpsecVpn>

updateLoadBalancer

updateLoadBalancer(request: LoadBalancerServiceUpdateRequest): Promise<Task>

- Defined in model/edge/edge.ts:510
Update the load balancer service.

Parameters
- request: LoadBalancerServiceUpdateRequest
Returns Promise<Task>

updateNAT

updateNAT(request: NATServiceUpdateRequest): Promise<Task>

- Defined in model/edge/edge.ts:497
Updates the NAT service for a VCD edge gateway.

Parameters
- request: NATServiceUpdateRequest
  
  NAT service update request
Returns Promise<Task>

promise Promise that resoves with a task

updateSslVpnAuthentication

updateSslVpnAuthentication(request: EdgeSslVpnAuthenticationUpdateRequest): Promise<EdgeSslVpnAuthentication>

- Defined in model/edge/edge.ts:536
Updates authentication configuration of SSL VPN for an edge gateway.

Parameters
- request: EdgeSslVpnAuthenticationUpdateRequest
Returns Promise<EdgeSslVpnAuthentication>

updateSslVpnClientInstallPackages

updateSslVpnClientInstallPackages(requests: Array<EdgeSslVpnClientInstallPackageUpdateRequest>): Promise<Array<EdgeSslVpnClientInstallPackage>>

- Defined in model/edge/edge.ts:549
Updates client install package configuration of SSL VPN for an edge gateway.

Parameters
- requests: Array<EdgeSslVpnClientInstallPackageUpdateRequest>
Returns Promise<Array<EdgeSslVpnClientInstallPackage>>

updateSslVpnIpPools

updateSslVpnIpPools(requests: Array<EdgeSslVpnIpPoolUpdateRequest>): Promise<Array<EdgeSslVpnIpPool>>

- Defined in model/edge/edge.ts:564
Updates the SSL VPN IP pools for an edge gateway.

Parameters
- requests: Array<EdgeSslVpnIpPoolUpdateRequest>
Returns Promise<Array<EdgeSslVpnIpPool>>

updateSslVpnPrivateNetworks

updateSslVpnPrivateNetworks(requests: Array<EdgeSslVpnPrivateNetworkUpdateRequest>): Promise<Array<EdgeSslVpnPrivateNetwork>>

- Defined in model/edge/edge.ts:578
Updates list of private networks that are reachable through an SSL VPN for an edge gateway.

Parameters
- requests: Array<EdgeSslVpnPrivateNetworkUpdateRequest>
Returns Promise<Array<EdgeSslVpnPrivateNetwork>>

updateSslVpnServerConfig

updateSslVpnServerConfig(request: EdgeSslVpnServerConfigUpdateRequest): Promise<any>

- Defined in model/edge/edge.ts:593
Updates SSL VPN configuration for an edge gateway.

Parameters
- request: EdgeSslVpnServerConfigUpdateRequest
Returns Promise<any>

updateSslVpnServerSettings

updateSslVpnServerSettings(serverSettings: EdgeSslVpnServiceUpdateRequest): Promise<EdgeSslVpnService>

- Defined in model/edge/edge.ts:603
Updates SSL VPN server settings for an edge gateway.

Parameters
- serverSettings: EdgeSslVpnServiceUpdateRequest
Returns Promise<EdgeSslVpnService>

updateSslVpnUser

updateSslVpnUser(userId: string, request: EdgeSslVpnUserUpdateRequest): Promise<EdgeSslVpnUser>

- Defined in model/edge/edge.ts:617
Updates an edge SSL VPN user.

Parameters
- userId: string
- request: EdgeSslVpnUserUpdateRequest
Returns Promise<EdgeSslVpnUser>

updateStaticRouting

updateStaticRouting(request: StaticRoutingUpdateRequest): Promise<Task>

- Defined in model/edge/edge.ts:417
Update the static routing service.

Parameters
- request: StaticRoutingUpdateRequest
Returns Promise<Task>

Static getEdge

getEdge(uuid: string): Promise<Edge>

- Defined in model/edge/edge.ts:82
Gets an Edge by UUID.

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

promise that resolves with the Edge

Generated using TypeDoc

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_json: EdgeJson

Returns Edge

Accessors

backingConfigurationType

backwardCompatibilityMode

companyId

defaultDnsRelayRoute

deleted

deletedDate

description

entityType

highAvailabilityEnabled

interfaces

json

locationId

name

orgUuid

status

updatedDate

uuid

vcloudHref

vdcUuid

Methods

getDhcp

Returns Promise<Dhcp>

getExportFirewallHref

Parameters

Optional filename: undefined | string

Returns Observable<string>

getExportIpsecVpnHref

Parameters

Optional filename: undefined | string

Returns Observable<string>

getExportNatHref

Parameters

Optional filename: undefined | string

Returns Observable<string>

getFirewall

Returns Promise<Firewall>

getFirewallCheckpoint

Parameters

checkpointUuid: string

Returns Promise<Checkpoint>

getFirewallCheckpoints

Returns Promise<Array<Checkpoint>>

getFirewallConfiguration

Returns Promise<FirewallConfiguration>

getFirewallLogs

Parameters

Optional type: EdgeFirewallLogType

Optional start: undefined | number

Optional end: undefined | number

Returns Promise<Array<FirewallLog>>

getIpsecVpn

Returns Promise<IpsecVpn>

getIpsecVpnConfiguration

Returns Promise<IpsecVpnConfiguration>

getLoadBalancer

Returns Promise<LoadBalancer>

getNat

Returns Promise<NatService>

getNatCheckpoint

Parameters

checkpointUuid: string

Returns Promise<Checkpoint>

getNatCheckpoints

Returns Promise<Array<Checkpoint>>

getNatConfiguration

Returns Promise<NatServiceConfiguration>

getPerformance

Parameters

group: PerfGroupType