1. Docs
  2. Reference
  3. API
  4. @pulumi/vsphere
  5. types
  6. output

Module types/output

APIs

APIs

interface DistributedPortGroupVlanRange

interface DistributedPortGroupVlanRange

property maxVlan

maxVlan: number;

property minVlan

minVlan: number;

interface DistributedVirtualSwitchHost

interface DistributedVirtualSwitchHost

property devices

devices: string[];

The list of NIC devices to map to uplinks on the DVS, added in order they are specified.

property hostSystemId

hostSystemId: string;

The host system ID of the host to add to the DVS.

interface DistributedVirtualSwitchVlanRange

interface DistributedVirtualSwitchVlanRange

property maxVlan

maxVlan: number;

property minVlan

minVlan: number;

interface GetVirtualMachineDisk

interface GetVirtualMachineDisk

property eagerlyScrub

eagerlyScrub: boolean;

Set to true if the disk has been eager zeroed.

property size

size: number;

The size of the disk, in GIB.

property thinProvisioned

thinProvisioned: boolean;

Set to true if the disk has been thin provisioned.

interface HostPortGroupPorts

interface HostPortGroupPorts

property key

key: string;

The key for this port group as returned from the vSphere API.

property macAddresses

macAddresses: string[];

property type

type: string;

interface VirtualMachineCdrom

interface VirtualMachineCdrom

property clientDevice

clientDevice?: undefined | false | true;

Indicates whether the device should be backed by remote client device. Conflicts with datastoreId and path.

property datastoreId

datastoreId?: undefined | string;

The datastore ID that the ISO is located in. Requried for using a datastore ISO. Conflicts with clientDevice.

property deviceAddress

deviceAddress: string;

An address internal to this provider that helps locate the device when key is unavailable. This follows a convention of CONTROLLER_TYPE:BUS_NUMBER:UNIT_NUMBER. Example: scsi:0:1 means device unit 1 on SCSI bus 0.

property key

key: number;

The ID of the device within the virtual machine.

property path

path?: undefined | string;

The path to the ISO file. Required for using a datastore ISO. Conflicts with clientDevice.

interface VirtualMachineClone

interface VirtualMachineClone

property customize

customize?: outputs.VirtualMachineCloneCustomize;

property linkedClone

linkedClone?: undefined | false | true;

property ovfNetworkMap

ovfNetworkMap?: undefined | {[key: string]: string};

property ovfStorageMap

ovfStorageMap?: undefined | {[key: string]: string};

property templateUuid

templateUuid: string;

property timeout

timeout?: undefined | number;

interface VirtualMachineCloneCustomize

interface VirtualMachineCloneCustomize

property dnsServerLists

dnsServerLists?: string[];

property dnsSuffixLists

dnsSuffixLists?: string[];

property ipv4Gateway

ipv4Gateway?: undefined | string;

property ipv6Gateway

ipv6Gateway?: undefined | string;

property linuxOptions

linuxOptions?: outputs.VirtualMachineCloneCustomizeLinuxOptions;

property networkInterfaces

networkInterfaces?: VirtualMachineCloneCustomizeNetworkInterface[];

A specification for a virtual NIC on this virtual machine. See network interface options below.

property timeout

timeout?: undefined | number;

property windowsOptions

windowsOptions?: outputs.VirtualMachineCloneCustomizeWindowsOptions;

property windowsSysprepText

windowsSysprepText?: undefined | string;

interface VirtualMachineCloneCustomizeLinuxOptions

interface VirtualMachineCloneCustomizeLinuxOptions

property domain

domain: string;

property hostName

hostName: string;

property hwClockUtc

hwClockUtc?: undefined | false | true;

property timeZone

timeZone?: undefined | string;

interface VirtualMachineCloneCustomizeNetworkInterface

interface VirtualMachineCloneCustomizeNetworkInterface

property dnsDomain

dnsDomain?: undefined | string;

property dnsServerLists

dnsServerLists?: string[];

property ipv4Address

ipv4Address?: undefined | string;

property ipv4Netmask

ipv4Netmask?: undefined | number;

property ipv6Address

ipv6Address?: undefined | string;

property ipv6Netmask

ipv6Netmask?: undefined | number;

interface VirtualMachineCloneCustomizeWindowsOptions

interface VirtualMachineCloneCustomizeWindowsOptions

property adminPassword

adminPassword?: undefined | string;

property autoLogon

autoLogon?: undefined | false | true;

property autoLogonCount

autoLogonCount?: undefined | number;

property computerName

computerName: string;

property domainAdminPassword

domainAdminPassword?: undefined | string;

property domainAdminUser

domainAdminUser?: undefined | string;

property fullName

fullName?: undefined | string;

property joinDomain

joinDomain?: undefined | string;

property organizationName

organizationName?: undefined | string;

property productKey

productKey?: undefined | string;

property runOnceCommandLists

runOnceCommandLists?: string[];

property timeZone

timeZone?: undefined | number;

property workgroup

workgroup?: undefined | string;

interface VirtualMachineDisk

interface VirtualMachineDisk

property attach

attach?: undefined | false | true;

Attach an external disk instead of creating a new one. Implies and conflicts with keepOnRemove. If set, you cannot set size, eagerlyScrub, or thinProvisioned. Must set path if used.

property datastoreId

datastoreId?: undefined | string;

The datastore ID that the ISO is located in. Requried for using a datastore ISO. Conflicts with clientDevice.

property deviceAddress

deviceAddress: string;

An address internal to this provider that helps locate the device when key is unavailable. This follows a convention of CONTROLLER_TYPE:BUS_NUMBER:UNIT_NUMBER. Example: scsi:0:1 means device unit 1 on SCSI bus 0.

property diskMode

diskMode?: undefined | string;

The mode of this this virtual disk for purposes of writes and snapshotting. Can be one of append, independentNonpersistent, independentPersistent, nonpersistent, persistent, or undoable. Default: persistent. For an explanation of options, click [here][vmware-docs-disk-mode].

property diskSharing

diskSharing?: undefined | string;

The sharing mode of this virtual disk. Can be one of sharingMultiWriter or sharingNone. Default: sharingNone.

property eagerlyScrub

eagerlyScrub?: undefined | false | true;

If set to true, the disk space is zeroed out on VM creation. This will delay the creation of the disk or virtual machine. Cannot be set to true when thinProvisioned is true. See the section on picking a disk type. Default: false.

property ioLimit

ioLimit?: undefined | number;

The upper limit of IOPS that this disk can use. The default is no limit.

property ioReservation

ioReservation?: undefined | number;

The I/O reservation (guarantee) that this disk has, in IOPS. The default is no reservation.

property ioShareCount

ioShareCount?: undefined | number;

The share count for this disk when the share level is custom.

property ioShareLevel

ioShareLevel?: undefined | string;

The share allocation level for this disk. Can be one of low, normal, high, or custom. Default: normal.

property keepOnRemove

keepOnRemove?: undefined | false | true;

Keep this disk when removing the device or destroying the virtual machine. Default: false.

property key

key: number;

The ID of the device within the virtual machine.

property label

label?: undefined | string;

A label for the disk. Forces a new disk if changed.

property name

name?: undefined | string;

An alias for both label and path, the latter when using attach. Required if not using label.

property path

path: string;

The path to the ISO file. Required for using a datastore ISO. Conflicts with clientDevice.

property size

size?: undefined | number;

The size of the disk, in GB.

property storagePolicyId

storagePolicyId?: undefined | string;

The UUID of the storage policy to assign to this disk.

property thinProvisioned

thinProvisioned?: undefined | false | true;

If true, this disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set to true when eagerlyScrub is true. See the section on picking a disk type. Default: true.

property unitNumber

unitNumber?: undefined | number;

The disk number on the SCSI bus. The maximum value for this setting is the value of scsiControllerCount times 15, minus 1 (so 14, 29, 44, and 59, for 1-4 controllers respectively). The default is 0, for which one disk must be set to. Duplicate unit numbers are not allowed.

property uuid

uuid: string;

The UUID of the virtual disk’s VMDK file. This is used to track the virtual disk on the virtual machine.

property writeThrough

writeThrough?: undefined | false | true;

If true, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default: false.

interface VirtualMachineNetworkInterface

interface VirtualMachineNetworkInterface

property adapterType

adapterType?: undefined | string;

The network interface type. Can be one of e1000, e1000e, or vmxnet3. Default: vmxnet3.

property bandwidthLimit

bandwidthLimit?: undefined | number;

The upper bandwidth limit of this network interface, in Mbits/sec. The default is no limit.

property bandwidthReservation

bandwidthReservation?: undefined | number;

The bandwidth reservation of this network interface, in Mbits/sec. The default is no reservation.

property bandwidthShareCount

bandwidthShareCount: number;

The share count for this network interface when the share level is custom.

property bandwidthShareLevel

bandwidthShareLevel?: undefined | string;

The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom. Default: normal.

property deviceAddress

deviceAddress: string;

An address internal to this provider that helps locate the device when key is unavailable. This follows a convention of CONTROLLER_TYPE:BUS_NUMBER:UNIT_NUMBER. Example: scsi:0:1 means device unit 1 on SCSI bus 0.

property key

key: number;

The ID of the device within the virtual machine.

property macAddress

macAddress: string;

The MAC address of this network interface. Can only be manually set if useStaticMac is true, otherwise this is a computed value that gives the current MAC address of this interface.

property networkId

networkId: string;

The managed object reference ID of the network to connect this interface to.

property ovfMapping

ovfMapping?: undefined | string;

Specifies which OVF NIC the networkInterface should be associated with. Only applies at creation and only when deploying from an OVF source.

property useStaticMac

useStaticMac?: undefined | false | true;

If true, the macAddress field is treated as a static MAC address and set accordingly. Setting this to true requires macAddress to be set. Default: false.

interface VirtualMachineOvfDeploy

interface VirtualMachineOvfDeploy

property diskProvisioning

diskProvisioning?: undefined | string;

property ipAllocationPolicy

ipAllocationPolicy?: undefined | string;

property ipProtocol

ipProtocol?: undefined | string;

property localOvfPath

localOvfPath?: undefined | string;

property ovfNetworkMap

ovfNetworkMap?: undefined | {[key: string]: string};

property remoteOvfUrl

remoteOvfUrl?: undefined | string;

interface VirtualMachineVapp

interface VirtualMachineVapp

property properties

properties?: undefined | {[key: string]: string};

interface VnicIpv4

interface VnicIpv4

property dhcp

dhcp?: undefined | false | true;

Use DHCP to configure the interface’s IPv4 stack.

property gw

gw?: undefined | string;

IP address of the default gateway, if DHCP or autoconfig is not set.

property ip

ip?: undefined | string;

Address of the interface, if DHCP is not set.

property netmask

netmask?: undefined | string;

Netmask of the interface, if DHCP is not set.

interface VnicIpv6

interface VnicIpv6

property addresses

addresses?: string[];

List of IPv6 addresses

property autoconfig

autoconfig?: undefined | false | true;

Use IPv6 Autoconfiguration (RFC2462).

property dhcp

dhcp?: undefined | false | true;

Use DHCP to configure the interface’s IPv4 stack.

property gw

gw?: undefined | string;

IP address of the default gateway, if DHCP or autoconfig is not set.