Versions Compared

Old Version 4

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About this Resource

Available_since
Type Available Since
Release6.0.0
Excerpt

Defines a Virtual Machine on ASM

REST API Methods for this Resource

Resource Schema

Inventory

Parameter Name Description Data Type Possible Values
ItemIndexIndex of the VM described in this IE.int
DescriptionDescription of the VM.
StateState of the VM.EnumPossible values:
  • 0 - avmsUnknown
  • 1 - avmsRunning
  • 2 - avmsStopped
  • 3 - avmsStopping
  • 4 - avmsSaved
  • 5 - avmsPaused
  • 6 - avmsStarting
  • 7 - avmsSaving
LogicalCpuNumber of logical CPU assign (1-8).int
CpuUsageCurrent usage of the CPU (0-100).int
AssignedMemoryAmount of memory assigned for this virtual machine MB.int
MemoryDemandAmount of memory used by this virtual machine MB.int
UptimeDisplays the amount of time the ASM has been running.long
NetworkAdapterDefine which network adapter is attached on the VM.EnumPossible values:
  • 0 - avmnNone
  • 1 - avmnOne
  • 2 - avmnTwo
  • 3 - avmnOneTwo
  • 4 - avmnUnknown
MaxNetworkAdapterNumber of virtual switch available of the ASM.int
ipGatewaySpecifies the default gateway for a manually configured address on this VM. May be overwrited when DHCP is enabled.string
MACAddress1Contains the MAC address for the ethernet port 1.string
DHCPEnabled1Enables 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
ipAddress1Specifies a manually configured address on the ethernet port 1. Applicable when DHCP is not enabled.string
ipNetmask1Specifies the netmask for a manually configured address on the ethernet port 1. Applicable when DHCP is not enabled.string
DNSServerPref1Specifies 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
DNSServerAlt1Specifies 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
MACAddress2Contains the MAC address for the ethernet port 2.string
DHCPEnabled2Enables 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
ipAddress2Specifies a manually configured address on the ethernet port 2. Applicable when DHCP is not enabled.string
ipNetmask2Specifies the netmask for a manually configured address on the ethernet port 2. Applicable when DHCP is not enabled.string
DNSServerPref2Specifies 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
DNSServerAlt2Specifies 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
InterfaceName1Displays the name of the ethernet port 1.string
InterfaceName2Displays the name of the ethernet port 2.string
WindowsLicenseStateIndicates the Windows License State for the VM, if it's running a Windows guest OS.EnumPossible values:
  • 0 - wlsNotLicensed
  • 1 - wlsLicensed
  • 2 - wlsUnknown
HostnameWindows Hostname of the VM.