Virtual Server Management module root-level workflows

This section describes the following Virtual Server Management module root-level workflows:

Add Disk Space workflow

This workflow creates a new virtual disk for the specified VM, as long as that VM is powered off. If the specified VM is powered up, the workflow does not execute.

This workflow supports dynamic targeting.

Add Disk Space workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

Yes

capacity in KB

Specifies the capacity of the virtual disk to be created

No

backing persistence mode

Specifies the disk persistence mode
Valid values:

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

No

backing file type split flag

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

  • true: virtual disk is stored in multiple 2GB 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: any integer

No

shares level

Specifies the allocation level, which is a simplified view of the shares parameter
The levels map to predetermined numeric values for the shares parameter. If the shares value does not map to a predefined size, then the shares level parameter is set to 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

Create Snapshot workflow

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

Create Snapshot workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

Yes

snapshot name

Specifies the name for this snapshot; the name does not need to be unique for this VM

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

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

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

snapshot description

Specifies a description for this snapshot If omitted, a default description might 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 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 from a Template workflow

This workflow creates a VM using a template.

Create VM from a Template workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BladeLogic

Yes

virtual server

Contains an XML document that provides the data template for concept elements
The virtual server concept is an XML document containing specific elements used to assign multiple values to a single context item. Each value is associated with an element of the concept.

Yes

Create VM from a Template 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

file maintenance success status

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

file maintenance status message

Provides a process-specific explanation for the value of file maintenance success status

Back to top

Create VM workflow

This workflow creates a VM.

Create VM workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BladeLogic

Yes

virtual server

Contains an XML document that provides the data template for concept elements
The virtual server concept is an XML document containing specific elements used to assign multiple values to a single context item. Each value is associated with an element of the concept.

Yes

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

file maintenance success status

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

file maintenance 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

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

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 Snapshot workflow

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

Delete Snapshot workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

Yes

snapshot name

Specifies the name for the snapshot

Yes

remove children

Specifies removal of the entire snapshot subtree or not
Valid values: true, false

Yes

snapshot id

Specifies a 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 from the virtual center, if the VM is in a powered-off state. This workflow supports dynamic targeting.

Delete VM workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BladeLogic, VMware

Yes

vm name

Specifies the name of the virtual server

Yes

virtual center

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

No

timeout

Specifies the timeout in milliseconds for BMC BladeLogic connection details

Note

This parameter is for BMC BladeLogic environments only.

No

user role

Specifies the user role for BMC BladeLogic connection details

Note

This parameter is for BMCBladeLogic environments only.

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

Restart Guest OS workflow

This workflow restarts the guest operating system running on the VM. This workflow supports dynamic targeting.

Restart Guest OS workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

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

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

Restore Snapshot workflow

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

Restore Snapshot workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

Yes

snapshot name

Specifies the 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.

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

Restore 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

Resume VM workflow

This workflow resumes the activity of a suspended VM. This workflow supports dynamic targeting.

Resume VM workflow inputs

Input

Description

Required

vm name

Specifies the name of the virtual server

Yes

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

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

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

Shutdown Guest OS workflow

This workflow shuts down the guest operating system running on the VM. This workflow supports dynamic targeting.

Shutdown Guest OS workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

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

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

Back to top

Start VM workflow

This workflow starts a virtual machine. This workflow supports dynamic targeting.

Start VM workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BladeLogic, VMware

Yes

vm name

Specifies the name of the virtual server

Yes

timeout

Specifies the timeout in milliseconds for BMC BladeLogic connection details

Note

This parameter is used only by BMC BladeLogic.

No

user role

Specifies the user role for BMC BladeLogic connection details

Note

This parameter is used only by BMC BladeLogic.

No

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

Back to top

Stop VM workflow

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

Stop VM workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BladeLogic, VMware

Yes

vm name

Specifies the name of the virtual server

Yes

timeout

Specifies the timeout in milliseconds for BMC BladeLogic connection details

Note

This parameter is used only by BMC BladeLogic.

No

user role

Specifies the user role for BMC BladeLogic connection details

Note

This parameter is used only by BMC BladeLogic.

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

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 the activity of a VM. This workflow supports dynamic targeting.

Suspend VM workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

vm name

Specifies the name of the virtual server

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

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 VM CPU configuration. This workflow supports dynamic targeting.

Update CPU Configuration workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

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 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 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, used primarily in BMC Cloud Lifecycle Management implementations. This workflow supports dynamic targeting.

Update Ethernet Adapter workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

virtual machine

Specifies the name of the VM

Yes

ethernet adapter

Specifies the name of the ethernet adapter to be updated

Yes

virtual center

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

No

host system

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

No

delay

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

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 port group

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 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

connection details

Specifies the connection details of the virtual center

<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

configuration name

Specifies a configuration group defined in the module configuration
Valid value: VMware

Yes

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 only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, 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

memory allocation level

Specifies the allocation level
The level 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: Shares = 20 * VM memory size in MB
  • low: Shares = 5 * VM memory size in MB
  • normal: Shares = 10 * VM memory size in MB

No

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

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

Update VM Expiry Date workflow

This workflow updates the date when the VM expires.

Update VM Expiry Date workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BladeLogic

Yes

expiry date

Specifies the new expiry date

Yes

vm name

Specifies the name of the virtual server

Yes

timeout

Specifies the timeout in milliseconds for BMC BladeLogic connection details

No

user role

Specifies the user role for BMC BladeLogic connection details

No

Update VM Expiry Date 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 VM Property workflow

This workflow updates the specified property of the specified VM.

Update VM Property workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BladeLogic

Yes

vm name

Specifies the name of the virtual server

Yes

attribute value

Specifies the value of the attribute that is updated

Yes

property name

Specifies the property to be updated

Yes

timeout

Specifies the timeout in milliseconds for BMC BladeLogic connection details

No

user role

Specifies the user role for BMC BladeLogic connection details

No

Update VM Property 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