iland Javascript SDK

Javascript SDK for the browser and node, written in TypeScript.

Full TypeDoc reference is available here .

Developers

Required:

[x] NodeJS >=6.2.2

Clone repo then execute: yarn install or npm install

Tests

For tests you'll have to add following environment variables, you can add them to your bash_rc ou bash_profile file:

export ILAND_USERNAME="<Production_username>"

export ILAND_PASSWORD="<Production_password>"

export ILAND_CLIENT_ID="<Client_ID>"

export ILAND_CLIENT_SECRET="<Client_secret>"

To run tests:

yarn test or npm run test

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AccessType

AccessType: "WRITE" | "READ"

ActiveProcessStage

ActiveProcessStage: "IN_TEST" | "STARTING" | "STOPPING" | "NONE"

Enumeration of possible Active Process Stage types.

AdapterType

Enumeration of the available adapter types for a VM.

AffinityRuleType

AffinityRuleType: "AFFINITY" | "ANTI_AFFINITY"

Enumeration of possible VM affinity rule types.

ApiErrorType

Enumeration of possible API error types.

AuthenticationMode

AuthenticationMode: "PSK" | "CERTIFICATE"

Authentication Mode

BillField

CommitPolicy

CommitPolicy: "ROLLBACK" | "COMMIT" | "NONE"

Enumeration of possible commit policy types

ContactType

ContactType: "PHONE" | "EMAIL"

Contact type interface.

CurrencyCode

CurrencyCode: "USD" | "EUR" | "GBP" | "SGD" | "AUD"

Enumeration of supported currency codes.

DHGroup

DHGroup: "DH2" | "DH5" | "DH14"

DH Group

DNSRecordType

DNSRecordType: "A" | "AAAA" | "CNAME" | "COMMENT" | "DIRECTIVE" | "DNAME" | "DNSKEY" | "DS" | "INCLUDE" | "IPSECKEY" | "KEY" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT"

Enumeration of possible DNS record types.

DiskType

Enumeration of the available disk types for a VM.

DnsRecordType

DnsRecordType: "A" | "AAAA" | "CNAME" | "COMMENT" | "DIRECTIVE" | "DNAME" | "DNSKEY" | "DS" | "INCLUDE" | "IPSECKEY" | "KEY" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT"

Enumeration of possible DNS record types.

DomainType

DomainType: "COMPANY" | "SHARED" | "SYSTEM_ADMIN" | "READ_ONLY_SYSTEM_ADMIN"

EdgeBackingConfigurationType

EdgeBackingConfigurationType: "compact" | "full"

Enumeration of possible edge backing configuration types.

EdgeFirewallLogType

EdgeFirewallLogType: "action_source" | "destination_port" | "destination_port_and_protocol"

EdgeInterfaceType

EdgeInterfaceType: "internal" | "uplink"

Enumeration of possible edge interface types.

EdgeSslVpnAuthServerType

EdgeSslVpnAuthServerType: "LOCAL" | "LDAP" | "AD" | "RADIUS" | "RSA"

EdgeStatus

EdgeStatus: "UP" | "DOWN"

Edge status enumeration.

EncryptionAlgorithm

EncryptionAlgorithm: "AES" | "AE256" | "AES_GCM" | "_3DES"

Encryption Algorithm

EntityType

Enumerates the core entity types.

EnvironmentType

EnvironmentType: "VC_VPG" | "VC_VAPP" | "VCD_VAPP" | "PUBLIC_CLOUD" | "HYPERV"

Enumeration of possible environment types.

EventOwnerType

EventOwnerType: "COMPANY" | "USER"

Enumeration of possible event owner types.

EventType

Enumeration of possible event types.

FenceModeType

FenceModeType: "BRIDGED" | "NAT_ROUTED" | "ISOLATED"

FileProgressObservable

FileProgressObservable: Observable<FileProgress>

IamEntityType

InventoryUpdateType

InventoryUpdateType: "CREATE" | "DELETE" | "UPDATE"

IpAddressingModeType

IpAddressingModeType: "DHCP" | "MANUAL" | "POOL" | "NONE"

MessageFolder

MessageFolder: "INBOX" | "ARCHIVE" | "DELETED"

Message Folder.

MessageSelection

MessageSelection: "ALL" | "READ" | "UNREAD"

Message Selection.

MetadataAccessMode

MetadataAccessMode: "READ_WRITE" | "READONLY" | "PRIVATE"

Enumeration of possible metadata access modes.

MetadataType

MetadataType: string | number | boolean | Date

Enumeration of possible metadata types.

MetadataTypeKey

MetadataTypeKey: "string" | "number" | "datetime" | "boolean"

Enumeration of possible metadata type keys.

OperatingSystem

Enumeration of possible VM operating system identifiers.

OrgVdcNetworkUpdateFenceMode

OrgVdcNetworkUpdateFenceMode: "NAT_ROUTED" | "ISOLATED"

PagingOrder

PagingOrder: "ASC" | "DESC"

Paging Order.

PerfGroupType

PerfGroupType: "cpu" | "disk" | "mem" | "net"

PerfIntervalType

PerfIntervalType: "HOUR" | "DAY"

PerfStatsType

PerfStatsType: "absolute" | "delta" | "rate"

PermissionType

Enumeration of iland Permission keys.

PolicyType

PolicyType: "ADMIN" | "READ_ONLY" | "CUSTOM"

PublicAssignmentType

Org Public IP Assignment Type.

PushUpdatetype

PushUpdatetype: "EVENT" | "TASK"

RecoveryGroupType

RecoveryGroupType: "ZERTO_VPG"

ReportFormat

ReportFormat: "PDF" | "HTML" | "CSV"

ReportType

ReportType: "CUSTOM" | "BASIC" | "DETAILED"

ReportTypeJson

RoleType

RoleType: "CUSTOM" | "BUILT_IN"

SerieType

SerieType: "VULNERABILITY" | "ANTI_MALWARE" | "LOG_INSPECTION" | "FIREWALL"

SeverityType

SeverityType: "PRODUCTION_SYSTEM_DOWN" | "SYSTEM_IMPAIRED" | "GENERAL_GUIDANCE"

Severity type interface.

ShutdownPolicy

ShutdownPolicy: "NONE" | "SHUTDOWN" | "FORCE_SHUTDOWN"

Enumeration of possible shutdown policy types

Status

Status: "FETCHING" | "GENERATING" | "READY" | "ERROR"

Enumeration for possible Status types

StatusJson

StatusJson: "WAITING" | "GENERATING" | "READY" | "ERROR"

SupportTicketCommentType

SupportTicketCommentType: "DISCUSSION" | "RESOLUTION"

SupportTicketSeverity

SupportTicketSeverity: "PRODUCTION_SYSTEM_DOWN" | "SYSTEM_IMPAIRED" | "GENERAL_GUIDANCE"

SupportTicketStatus

TaskOperation

Enumeration of possible task operation values.

TaskStatus

Enumeration of possible task status values.

TaskType

Enumeration of possible task types.

TemplateUploadType

TemplateUploadType: "OVF" | "OVA"

ToolsUpgradePolicy

ToolsUpgradePolicy: "MANUAL" | "UPGRADE_AT_POWER_CYCLE"

Enumeration of possible Tools upgrade policy from the API.

UpdateType

UpdateType: "DELETE" | "MARK_AS_READ" | "ARCHIVE" | "MOVE_TO_INBOX"

Update Type.

UserType

UserType: "SYSTEM_ADMIN" | "READ_ONLY_SYSTEM_ADMIN" | "CUSTOMER"

Enumeration of possible user types.

VappNetworkNATServiceType

VappNetworkNATServiceType: "PORT_FORWARDING" | "IP_TRANSLATION"

VappPowerStatus

VappPowerStatus: VappStatus | "PARTIALLY_POWERED_OFF"

Enumeration of possible vApp power statuses.

VappStatus

Enumeration of possible vApp statuses from the API.

VccFailoverPlanStatus

VccFailoverPlanStatus: "UNKNOWN" | "FAILING_OVER" | "READY"

VdcAllocationModel

VdcAllocationModel: "paygo" | "allocation_pool" | "reservation_pool"

Enumerates the possible vDC allocation json options.

VmAffinityRuleOperation

VmAffinityRuleOperation: "UPDATE" | "DELETE" | "ADD"

Enumeration of possible VM affinity rule update types.

VmPowerOperation

Enumeration of the available power operations for a VM.

VmPowerStatus

VmPowerStatus: VmStatus | "PARTIALLY_POWERED_OFF"

Enumeration of possible VM power statuses.

VmStatus

Enumeration of possible VM statuses from the API.

VnicAddressMode

VnicAddressMode: "DHCP" | "MANUAL" | "POOL" | "NONE"

Enumeration of possible VNIC addressing modes.

VpgPriority

VpgPriority: "LOW" | "MEDIUM" | "HIGH"

Enumeration of possible Vpg Priority types.

VpgStatus

Enumeration of possible Vpg Status types.

VpgSubEntityRequest

VpgSubEntityRequest: "VPG_VM" | "SERVICE_PROFILE"

Enumeration for Vpg Sub Entity Request types.

VpgSubStatus

Enumeration of possible Vpg Sub Status types.

catalogItemDownloadType

catalogItemDownloadType: "vapp_template" | "media"

Variables

Const DEFAULT_API_URL

DEFAULT_API_URL: string = `${BasicConfiguration.getApiUrl()}/v1`

Const DEFAULT_API_VERSION

DEFAULT_API_VERSION: 1 = 1

Const DEFAULT_AUTH_URL

DEFAULT_AUTH_URL: string = `${BasicConfiguration.getAuthorizationUrl()}/auth`

Const DEFAULT_REALM

DEFAULT_REALM: "iland-core" = "iland-core"

Const ILAND_MIME_VND_PREFIX

ILAND_MIME_VND_PREFIX: "vnd.ilandcloud.api" = "vnd.ilandcloud.api"

Const TOKEN_REFRESH_THRESHOLD

TOKEN_REFRESH_THRESHOLD: 10 = 10

Generated using TypeDoc