About this Resource

Modified: for 6.0.0

Defines a Virtual Machine on ASM

REST API Methods for this Resource

Resource Schema

Inventory

Parameter Name Description Data Type Possible Values
ItemIndex Index of the VM described in this IE. int
Description Description of the VM.
State State of the VM. EnumPossible values:
  • 0 - avmsUnknown
  • 1 - avmsRunning
  • 2 - avmsStopped
  • 3 - avmsStopping
  • 4 - avmsSaved
  • 5 - avmsPaused
  • 6 - avmsStarting
  • 7 - avmsSaving
LogicalCpu Number of logical CPU assign (1-8). int
CpuUsage Current usage of the CPU (0-100). int
AssignedMemory Amount of memory assigned for this virtual machine MB. int
MemoryDemand Amount of memory used by this virtual machine MB. int
Uptime Displays the amount of time the ASM has been running. long
NetworkAdapter Define which network adapter is attached on the VM. EnumPossible values:
  • 0 - avmnNone
  • 1 - avmnOne
  • 2 - avmnTwo
  • 3 - avmnOneTwo
  • 4 - avmnUnknown
MaxNetworkAdapter Number of virtual switch available of the ASM. int
ipGateway Specifies the default gateway for a manually configured address on this VM. May be overwrited when DHCP is enabled. string
MACAddress1 Contains the MAC address for the ethernet port 1. string
DHCPEnabled1 Enables Dynamic Host Configuration Protocol (DHCP) for the ethernet port 1. If DHCP is enabled, it overrides the IP address and DNS settings. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
ipAddress1 Specifies a manually configured address on the ethernet port 1. Applicable when DHCP is not enabled. string
ipNetmask1 Specifies the netmask for a manually configured address on the ethernet port 1. Applicable when DHCP is not enabled. string
DNSServerPref1 Specifies a manually configured Domain Name Server address for IP name resolution on the ethernet port 1. This server is used first for DNS requests. Applicable when DHCP is not enabled. string
DNSServerAlt1 Specifies a manually configured Domain Name Server address for IP name resolution on the ethernet port 1. This server is used when the Preferred DNS server is slow or unreachable. Applicable when DHCP is not enabled. string
MACAddress2 Contains the MAC address for the ethernet port 2. string
DHCPEnabled2 Enables Dynamic Host Configuration Protocol (DHCP) for the ethernet port 2. If DHCP is enabled, it overrides the IP address and DNS settings. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
ipAddress2 Specifies a manually configured address on the ethernet port 2. Applicable when DHCP is not enabled. string
ipNetmask2 Specifies the netmask for a manually configured address on the ethernet port 2. Applicable when DHCP is not enabled. string
DNSServerPref2 Specifies a manually configured Domain Name Server address for IP name resolution on the ethernet port 2. This server is used first for DNS requests. Applicable when DHCP is not enabled. string
DNSServerAlt2 Specifies a manually configured Domain Name Server address for IP name resolution on the ethernet port 2. This server is used when the Preferred DNS server is slow or unreachable. Applicable when DHCP is not enabled. string
InterfaceName1 Displays the name of the ethernet port 1. string
InterfaceName2 Displays the name of the ethernet port 2. string
WindowsLicenseState Indicates the Windows License State for the VM, if it's running a Windows guest OS. EnumPossible values:
  • 0 - wlsNotLicensed
  • 1 - wlsLicensed
  • 2 - wlsUnknown
Hostname Windows Hostname of the VM.