Virtual Server Management module utility workflows for VMware

The Utilities folder contains workflows grouped by environment. This section describes the following Virtual Server Management workflows in the VMware folder:

Add Disk Space workflow 

This workflow adds disk space to a virtual machine when it is in a powered-off state. This workflow supports dynamic targeting.

Add Disk Space workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

capacity in KB

Specifies the capacity of this virtual disk

Yes

backing persistence mode

Specifies the disk persistence mode

Valid values:

  • persistent
  • independent_persistent
  • independent_nonpersistent
  • nonpersistent
  • undoable
  • append

Yes

backing file type split flag

Indicates the type of virtual disk file: split or monolithic
Valid values:

  • true; virtual disk is stored in multiple 2-GB files
  • false; virtual disk is stored in one file

No

backing file thin provisioned flag

Indicates to the underlying file system whether the virtual disk backing file should be allocated lazily (using thin provisioning)
This flag is used only for file systems that support configuring the provisioning policy on a per file basis, such as VMFS3.
Valid values: true, false

No

backing write through flag

Indicates whether writes should go directly to the file system or should be buffered.
Valid values: true, false

No

shares

Specifies the number of shares allocated; determines resource allocation in case of resource contention
This value is used only if the level is set to custom ; otherwise, it is ignored. Only shares with custom values can be compared. This value has no unit. It is a relative measure based on the settings for other resource pools.
Valid value: Integer

No

shares level

Specifies the allocation level, which is a simplified view of shares
Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.
Valid values:

  • custom: Shares are specified in the Shares column.
  • high
    • CPU: Shares = 2000 * number of virtual CPUs
    • Memory: Shares = 20 * VM memory size in megabytes
    • Disk: Shares = 2000
  • low
    • CPU: Shares = 500 * number of virtual CPUs
    • Memory: Shares = 5 * VM memory size in megabytes
    • Disk: Shares = 500
  • normal
    • CPU: Shares = 1000 * number of virtual CPUs
    • Memory: Shares = 10 * VM memory size in megabytes
    • Disk: Shares = 1000

No

virtual center

Specifies the name or IP address of the virtual center on which the given VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Add Disk Space workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Clone VM workflow 

This workflow clones a VM. This workflow supports dynamic targeting.

Clone VM workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

datacenter

Specifies the name of the datacenter

Yes

cloned vm name

Specifies the name for the cloned VM

Yes

template

Specifies whether the new VM should be marked as a template
Valid values: true, false

Yes

power on

Specifies whether the new VM should be powered on after creation
As part of a customization, this flag is normally set to true, because the first power-on operation completes the customization process. This flag is ignored if a template is being created.
Valid values: true, false

Yes

folder

Specifies the folder of the new VM

No

virtual center

Specifies the name or IP address of the virtual center on which the new VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Clone VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Create VM Snapshot workflow 

This workflow creates a snapshot of the VM. This workflow supports dynamic targeting.

Create VM Snapshot workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

snapshot name

Specifies the name for this snapshot

Note

The name does not need to be unique for this VM.

Yes

memory

Specifies whether to include a dump of the internal state of the VM (basically a memory dump) in the snapshot

Memory snapshots consume time and resources, taking longer to create.

Valid values: true, false

Yes

quiesce

Specifies whether to use VMware Tools to quiesce the file system in the powered-on VM when the snapshot is taken

Setting this flag assures that a disk snapshot represents a consistent state of the guest file systems.

 Valid values: true, false

Yes

virtual center

Specifies the name or IP address of the virtual center on which the given VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

snapshot description

Contains a description for this snapshot If omitted, a default description may be provided.

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Create VM Snapshot workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Create VM workflow 

Create VM workflow inputs

Input

Description

Required

cluster compute resource

Specifies the cluster name to which the host-system is attached

No

folder

Specifies the folder of the new VM

No

host

Specifies the DNS name of the target host for the VM
If not specified:

  • If the resource pool is not specified, then the current host is used.
  • If a resource pool is specified and the target pool represents a stand-alone host, the host is used.
  • If a resource pool is specified and the target pool represents a DRS-enabled cluster, a host selected by DRS is used.
  • If a resource pool is specified and the target pool represents a cluster without DRS enabled, an InvalidArgument exception appears.

No

datacenter

Specifies the name of the datacenter where the VM is created

Yes

vm name

Specifies the display name of the VM

Yes

guest os

Specifies the guest operating system

Yes

datastore

Specifies the datastore location to the configuration file for the VM (for example, the .vmx file)

Yes

resource pool

Specifies the resource pool to which the VM is attached

No

memory

Specifies the size of a VM's memory, in MB

No

no of cpu

Specifies the number of virtual processors in a VM

No

alternate SOAP URL

Specifies the virtual center server SOAP URL used to execute the request

No

alternate transport

Specifies the virtual center server transport protocol used to execute the request

No

alternate username

Specifies the user name used to handle the request

No

alternate password

Specifies the password used to handle the request

No

Note

You can invoke the request on a virtual center whose credentials are stored in the module configuration. The alternate SOAP URL, alternate transport, alternate user name, and alternate password are the parameters for the virtual center. The name of the virtual center from the request is used to extract the relevant parameters from module configuration. The parameters are called alternate because if the virtual center name is not passed in the request, then the default virtual center is selected (the one on which the VMware adapter has been activated).

Create VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Delete Disk Space workflow 

This workflow removes a virtual disk from a VM if the VM is powered off. This workflow supports dynamic targeting.

Delete Disk Space workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

disk name

Specifies the name of the virtual disk to be removed

Yes

virtual center

Specifies the name or IP address of the virtual center on which the given VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Delete Disk Space workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Delete VM Snapshot workflow 

This workflow removes a snapshot. This workflow supports dynamic targeting.

Delete Snapshot workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

snapshot name

Specifies the name for this snapshot

Note

The name need not be unique for this VM.

Yes

remove children

Sets a flag to specify removal of the entire snapshot subtree or not Valid values: true, false

Yes

snapshot id

Specifies the snapshot ID internally generated by the virtual center Because the virtual center allows duplicate snapshot names, the snapshot ID is used.

Yes

virtual center

Specifies the name or IP address of the virtual center on which the given VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Delete Snapshot workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Delete VM workflow 

This workflow removes a VM, if the VM is in a powered-off state. This workflow supports dynamic targeting.

Delete VM workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

virtual center

Specifies the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Delete VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Task Status workflow 

This workflow retrieves the status of a task. This workflow supports dynamic targeting.

Get Task Status workflow inputs

Input

Description

Required

virtual machine task id

Specifies the unique ID for each action submitted in the virtual center

Yes

virtual center

Specifies the virtual center on which the VM is hosted

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Get Task Status workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

adapter response

Contains an XML file that provides the response from the adapter

Back to top

Get VM Configuration workflow 

This workflow retrieves the configuration of a VM. This workflow supports dynamic targeting.

Get VM Configuration workflow inputs

Input

Description

Required

vm name

Specifies the VM whose configuration is to be queried

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Get VM Configuration workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

adapter response

Contains an XML file that provides the response from the adapter

Back to top

Get VM Power Status workflow 

This workflow retrieves the power status of a VM. This workflow supports dynamic targeting.

Get VM Power Status workflow inputs

Input

Description

Required

vm name

Specifies the VM whose power status is to be queried

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Get VM Power Status workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

powerStatus

Returns the VM power status

Back to top

Poll VM Power Status workflow 

This workflow polls for the power status of a VM. This workflow supports dynamic targeting.

Poll VM Power Status workflow inputs

Input

Description

Required

virtual machine task id

Specifies the unique ID for each action submitted in the virtual center

Yes

check status

Specifies the expected VM power status
Valid values:

  • Started
  • Stopped
  • Suspended

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Poll VM Power Status workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

powerStatus

Returns the VM power status

Back to top

Poll Virtual Center Task Status workflow 

This workflow polls the virtual center task status. This workflow supports dynamic targeting.

Poll Virtual Center Task Status workflow inputs

Input

Description

Required

vm name

Specifies the VM whose power status is to be queried

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Poll Virtual Center Task Status workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Restart Guest OS workflow 

This workflow restarts a guest operating system. This workflow supports dynamic targeting.

Restart Guest OS workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Restart Guest OS workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

power status

Provides the power state of the VM

Back to top

Resume VM workflow 

This workflow resumes the activity of the specified VM. This workflow supports dynamic targeting.

Resume VM workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Resume VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

power status

Provides the power state of the VM

Back to top

Revert VM Snapshot workflow 

This workflow reverts the VM to a specified snapshot. This workflow supports dynamic targeting.

Revert VM Snapshot workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

snapshot name

Snapshot name to which the VM reverts

Yes

snapshot id

Specifies the snapshot ID internally generated by the virtual center Because the virtual center allows duplicate snapshot names, the snapshot ID is used to identify names.

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Revert VM Snapshot workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Shutdown Guest OS workflow 

This workflow shuts down a guest operating system. This workflow supports dynamic targeting.

Shutdown Guest OS workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Shutdown Guest OS workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

power status

Provides the power state of the VM.
Valid values:

  • Started
  • Stopped
  • Suspended

Back to top

Start VM workflow 

This workflow starts a VM. This workflow supports dynamic targeting.

Start VM workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Start VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

power status

Provides the power state of the VM
Valid values:

  • Started
  • Stopped
  • Suspended

Back to top

Stop VM workflow 

This workflow stops a VM and changes the VM power status to Stopped. This workflow supports dynamic targeting.

Stop VM workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Stop VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

power status

Provides the power state of the VM

Back to top

Suspend VM workflow 

This workflow suspends a VM. This workflow supports dynamic targeting.

Suspend VM workflow inputs

Input

Description

Required

vm name

Specifies the display name of the VM

Yes

virtual center

Specifies the name or IP address of the virtual center on which the VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Suspend VM workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

power status

Provides the power state of the VM

Back to top

Update CPU Configuration workflow 

This workflow updates the configuration of a VM's CPU. This workflow supports dynamic targeting.

Update CPU Configuration workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

no of cpu

Specifies the number of virtual processors in a VM

Yes

cpu allocation reservation

Specifies the amount of resource (in MHz) that is certain to be available to the VM or resource pool
Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be used by other running VMs.

No

cpu allocation limit

Specifies the maximum resource utilization (in MHz) of a virtual machine or a resource pool, regardless of available resources
This parameter is typically used to ensure a consistent performance of VMs and resource pools independent of available resources. If set to -1, there is no fixed limit on resource usage; it is bounded only by available resources and shares.

No

cpu allocation shares

Specifies the number of shares allocated, which is used to determine resource allocation in case of resource contention
This value is set only if the cpu allocation level parameter is set to custom. Only shares with custom values can be compared. There is no unit for this value. It is a relative measure based on the settings for other resource pools.

No

cpu allocation level

Specifies the allocation level
The level is a simplified view of shares. Levels map to predetermined numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.
Valid values:

  • custom: Shares are specified in the Shares column.
  • high: Shares = 2000 * number of virtual CPUs
  • low: Shares = 500 * number of virtual CPUs
  • normal: Shares = 1000 * number of virtual CPUs

No

virtual center

Specifies the name or IP address of the virtual center on which the specified VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Update CPU Configuration workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Update Ethernet Adapter workflow 

This workflow updates an ethernet adapter configuration. This workflow supports dynamic targeting.

Update Ethernet Adapter workflow inputs

Input

Description

Required

virtual machine

Specifies the name of the VM

Yes

ethernet adapter

Specifies the name of the ethernet adapter to be udpated

Yes

virtual center

Specifies the name or IP address of the virtual center on which the specified VM is hosted

No

host system

Specifies the host system associated with the distributed virtual (DV) port group and DV switch

No

device type

Specifies the device type
Supported values:

  • VirtualE1000
  • VirtualPCNet32 (default)
  • VirtualVmxnet

No

backing type

Valid values:

  • VirtualEthernetCardDistributedVirtualPortBackingInfo
  • VirtualEthernetCardNetworkBackingInfo

No

backing device name

Specifies the name of the device on the host system

No

backing dv switch

Specifies the name of the DV switch

No

backing dv portgroup

Specifies the name of the DV port group

No

start connected

Specifies information about restrictions on removing this device while a VM is running
Valid values: true, false

No

allow guest control

Specifies information about restrictions on removing this device while a VM is running
Valid values: true, false

No

connected

Specifies information about restrictions on removing this device while a VM is running
Valid values: true, false

No

address type

Specifies the MAC address type
Valid values:

  • Manual
  • Statically assigned MAC address: generated
  • Automatically generated MAC address: assigned
  • MAC address assigned by VirtualCenter.

No

mac address

Specifies the MAC address assigned to the virtual network adapter
Clients can set this property to any of the allowed address types. The server might override the specified value for generated or assigned if it does not fall in the right ranges or is determined to be a duplicate.

No

wake on lan enabled

Indicates whether wake-on-LAN is enabled on this virtual network adapter
Clients can set this property to selectively enable or disable wake-on-LAN.

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

connection details

Specifies the connection details for the VMware adapter

<connection-parameters>
  <soap-url></soap-url>
  <transport></transport>
  <user-name></user-name>
  <password></password>
</connection-parameters>

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Update Ethernet Adapter workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Update Memory Configuration workflow 

This workflow updates the memory configuration of a VM. This workflow supports dynamic targeting.

Update Memory Configuration workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

memory

Specifies the size of a VM's memory, in MB

Yes

memory allocation reservation

Specifies the amount of resource (in MB) that is guaranteed available to the VM or resource pool
Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running VMs.

No

memory allocation limit

Specifies the maximum resource utilization (in MB) of a virtual machine or a resource pool, regardless of available resources
This parameter is typically used to ensure a consistent performance of VMs and resource pools independent of available resources. If set to -1, there is no fixed limit on resource usage; it is bounded only by available resources and shares.

No

memory allocation shares

Specifies the number of shares allocated which is used to determine resource allocation in case of resource contention
This value is used only if level is set to custom ; otherwise, it is ignored.Only shares with custom values can be compared. This value has no unit. It is a relative measure based on the settings for other resource pools.

No

memory allocation level

Specifies the allocation level
The level is a simplified view of shares. Levels map to a predetermined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.
Valid values:

  • custom: Shares are specified in the Shares column.
  • high: Shares = 20 * VM memory size in megabytes
  • low: Shares = 5 * VM memory size in megabytes
  • normal: Shares = 10 * VM memory size in megabytes

No

virtual center

Specifies the name or IP address of the virtual center on which the given VM is hosted

No

delay

Specifies the number of seconds to wait before polling for the virtual center task status

No

soap url

Specifies the URL for the remote soap service running on the VMware virtual center

No

username

Specifies the user name that will be used for HTTP basic authentication on the VMware virtual center

No

password

Specifies the password corresponding to the specified user name

No

transport

Specifies the transport protocol for the message

No

Update Memory Configuration workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Was this page helpful? Yes No Submitting... Thank you

Comments