How many workflows are included in vCenter Orchestrator?
There are a considerable number of pre-built workflows that may be used to build your own orchestrator solutions. The environment this table is taken from has the VC, VIM3 (OPTIONAL), and Microsoft (OPTIONAL) vmoapps installed:
| Workflow | Description | |
|---|---|---|
| \\Library | ||
| \\Library\\JDBC | ||
| --- | JDBC URL generator | Sollicits information to generate a connection URL for JDBC database connections. The workflow emits the connection string it generates as output via the system log, and confirms the string can create a connection to the specified database. |
| \\Library\\JDBC\\JDBC Examples | ||
| ----- | Full JDBC cycle example | Tests the full JDBC cycle, namely: - Tests the connection - Creates the table - Inserts and logs entries - Deletes and logs entries - Empties table - Drops table |
| ----- | JDBC connection example | Tests JDBC connections |
| ----- | JDBC create table example | Tests table creation using JDBC. |
| ----- | JDBC delete all from table example | Tests the deletion of all entries in a table |
| ----- | JDBC delete entry from table example | Tests the deletion of an entry from a table. |
| ----- | JDBC drop table example | Tests dropping a table |
| ----- | JDBC insert into table example | Tests insertion of rows into a JDBC table. |
| ----- | JDBC select from table example | Test JDBC table select rows |
| \\Library\\Locking | ||
| --- | Display all locks | Shows all locks |
| --- | Locking test | Test workflow that creates a lock |
| --- | Locking test (x5) | Test workflow that creates 5 locks |
| --- | Release all locks | Releases all locks |
| \\Library\\Mail | ||
| --- | Example interaction with email | Simple example to illustrate how to send an email to respond to a query, known as a user interaction. NOTE: This workflow uses the default mail server configuration that you can set in the Orchestrator configuration interface. For information about setting the mail server configuration, see 'Define the Default SMTP Connection' in the Orchestrator Installation and Configuration Guide. |
| --- | Retrieve messages | Retrieves the messages of a given email account, without deleting them, using the POP3 protocol. |
| --- | Send interaction | Sends an email to answer a user interaction. The email body contains both the direct answer URL, and an interaction URL to process this request. Uses the default settings from the Orchestrator Configuration interface for the following optional input parameters: SMTP host, SMTP port, username, password, from Address and from Name. You can override these values by providing input parameters. |
| --- | Send notification | Sends an email with specified content to given email address. Uses the default settings from the Orchestrator Configuration interface for the following optional input parameters: SMTP host, SMTP port, username, password, from Address and from Name. You can override these values by providing input parameters. |
| --- | Send notification to mailing list | Sends an email with specified content to a given email address list, CC list, and BCC list. Uses the default settings from the Orchestrator Configuration interface for the following optional input parameters: SMTP host, SMTP port, username, password, from Address and from Name. You can override these values by providing input parameters. |
| \\Library\\Microsoft | ||
| \\Library\\Microsoft\\Active Directory | ||
| \\Library\\Microsoft\\Active Directory\\Computer | ||
| ------- | Create computer in group | Create an AD computer in a group |
| ------- | Create computer in organizational unit | Create an AD computer in an Organization Unit |
| ------- | Destroy Computer | Destroy a computer in the Active Directory |
| ------- | Disable computer | Disable a computer in the Active Directory |
| ------- | Enable computer | Enable a computer |
| \\Library\\Microsoft\\Active Directory\\Organizational Unit - Container | ||
| ------- | Create Organizational Unit | Create OU in OU |
| ------- | Destroy Organizational Unit | Destroy OU |
| \\Library\\Microsoft\\Active Directory\\User | ||
| ------- | Add user to usergroup | Add one user as member of a usergroup |
| ------- | Create user in Group | Create a user without specifing a password (Set password must change at next logon). Domain policies must allow users to have empty passwords! |
| ------- | Create user in Organizational Unit | Create a new user in an Organization Unit. Without SSL connection, you cannot specify the password. The domain passwords policy must let you create user without password. |
| ------- | Destroy user | Destroy an existing user |
| ------- | Disable user | Disable a user |
| ------- | Enable user | Enable a user |
| ------- | Remove user from user group | Remove a user from a usergroup |
| \\Library\\Microsoft\\Active Directory\\Usergroup | ||
| ------- | Add computers to group members | Add one or more computers as members of a usergroup |
| ------- | Add groups to group members | Add one or more usergroups as member of a usergroup. |
| ------- | Add users to group members | Add one or more users as members of a usergroup |
| ------- | Create usergroup in Group | Create a new usergroup in an existing container (group) |
| ------- | Create usergroup in OrganizationUnit (OU) | Create a new usergroup in an existing container (ou) |
| ------- | Destroy usergroup | Destroy a usergroup |
| ------- | Remove computers from group members | Remove one or more computer from a usergroups |
| ------- | Remove groups from group members | Remove one or more groups from group members |
| ------- | Remove users from group members | Remove one or more users from usergroup members |
| \\Library\\Microsoft\\Computer | ||
| ----- | Shutdown a computer | Shutdown or restart a computer |
| ----- | Shutdown a computer from AD | Shutdown or restart a computer |
| \\Library\\Microsoft\\Computer\\Devices | ||
| ------- | Add Printer Connection | Adds a printer to an existing Windows machine (needs to be an OS greater than Windows 2000/ NT4.0 and have WMI active) Return code: 0 - success 5 - access denied 1801 - invalid printer name 1930 - incompatible printer driver |
| \\Library\\Microsoft\\Computer\\Processes | ||
| ------- | Start a process | Start a new process on the remote host. Return the process ID Exception: - ConnectionError: Error when connecting to the computer - ProcessError: Errors returned by Win32_Process WMI Class |
| ------- | Start a process from AD | Start a new process on the remote host. Return the process ID Exception: - ConnectionError: Error when connecting to the computer - ProcessError: Errors returned by Win32_Process WMI Class |
| ------- | Terminate process | Terminate an existing process on the remote host. |
| ------- | Terminate process from AD | Terminate an existing process on the remote host. |
| \\Library\\Microsoft\\Computer\\Services | ||
| ------- | Change service start mode | Change the starting mode of a Windows Service. Most common options are: Automatic (automatically start when windows start), Manual and Disabled (Service cannot start) Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Change service start mode from AD | Change the starting mode of a Windows Service. Most common options are: Automatic (automatically start when windows start), Manual and Disabled (Service cannot start) Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Pause a service | Pause a running service, if applicable to the service. Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Pause a service from AD | Pause a running service, if applicable to the service. Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Resume a service | Resume a paused service, if applicable to the service. Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Resume a service from AD | Resume a paused service, if applicable to the service. Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Start a service | Start a stopped service, if applicable to the service. To be able to start, the service must be setted as Automatic or Manual Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Start a service from AD | Start a stopped service, if applicable to the service. To be able to start, the service must be setted as Automatic or Manual Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Stop a service | Stop a running service, if applicable. Take care that depending the service you stop, the remote Windows could shutdown or not respond Exception: - ConnectionError: Error when connecting to the computer |
| ------- | Stop a service from AD | Stop a running service, if applicable. Take care that depending the service you stop, the remote Windows could shutdown or not respond Exception: - ConnectionError: Error when connecting to the computer |
| \\Library\\Microsoft\\Favorites Management | ||
| ----- | Add Favorite Computer | Add a favorit computer |
| ----- | Add Favorite Group | Add a favortie group |
| ----- | Add Favorite OU | Add a favorite OU |
| ----- | Remove Favorite Computer | Remove a favorite |
| ----- | Remove Favorite Group | Remove a favorite |
| ----- | Remove Favorite OU | Remove a favorite |
| \\Library\\Orchestrator | ||
| \\Library\\Orchestrator\\Tasks | ||
| ----- | Create recurrent task | Creates a recurrent task. Returns the newly created task. Possible recurrenceCycle attribute values: - one-time: Task runs once only. - every-minutes: Task runs every minute - every-hours: Task runs hourly - every-days: Task runs daily - every-weeks: Task runs weekly - every-months: Task runs monthly Possible recurrencePattern attribute values depend on the recurrenceCycle attribute value: - one-time: Ignores the recurrencePattern attribute - every-minutes: Seconds into each minute at which the task starts, for example, "00" or "00, 30" - every-hours: Minutes and seconds into each hour at which the task starts, for example, "00:00" or "00:00, 30:00" - every-days: Time at which the task starts each day, for example, "18:30:00" or "12:00:00, 19:30:00" - every-weeks: Day and time at which the task starts each week, for example, "Mon 00:00:00" or "Mon 00:00:00, Wed 18:00:00" - every-months: Date and time at which the task starts each month, for example, "14 00:00:00" or "14 00:00:00, 28 18:00:00" |
| ----- | Create task | Schedules a workflow to run at a later time and date, as a task. |
| \\Library\\Orchestrator\\Workflows | ||
| ----- | Start workflows in a series | Runs a workflow multiple times in a series, one instance after the other. You provide workflow parameters in an array, providing a property list (with one property per workflow input) for each instance of the workflow that starts. |
| ----- | Start workflows in parallel | Starts the provided workflow multiple times, with different parameters. You provide workflow parameters in an array, providing a property list (with one property per workflow input) for each instance of the workflow that starts. |
| \\Library\\Refactoring | ||
| --- | Migrate package to vCenter Server 4 | Refactors legacy applications that use the VMware Infrastructure 3 plug-in to use the vCenter Server 4 plug-in. The new vCenter plug-in contains some changes in its class names and API, so you need to refactor legacy applications. |
| \\Library\\Refactoring\\Advanced | ||
| ----- | Copy VMware Infrastructure 3 application and migrate to vCenter Server 4 | Migrates VMware Infrastructure 3 applications to vCenter Server 4. The Migrate package to vCenter Server 4 workflow calls this workflow. |
| ----- | Copy VMware Infrastructure 3 application and migrate to vCenter Server 4, with a String input | Migrates VMware Infrastructure 3 applications to vCenter Server 4. The Migrate package to vCenter Server 4 workflow calls this workflow. |
| ----- | Create refactoring description XML file | Creates a refactoring description in XML format. The Migrate package to vCenter Server 4 workflow calls this workflow. |
| ----- | Refactor using resources | Runs the refactoring using an external resource. The Migrate package to vCenter Server 4 workflow calls this workflow. |
| ----- | Run refactoring | Runs the refactoring. The Migrate package to vCenter Server 4 workflow calls this workflow. |
| \\Library\\SSH | ||
| --- | Change key pair passphrase | Changes a key pair pass-phrase |
| --- | Generate key pair | Generate key pair to connect to an SSH host without a password |
| --- | Register vCO public key on host | Register the vCO public key (must be generated before) to a target host. |
| --- | Run SSH command | Runs an SSH command. |
| --- | SCP get command | Copies a file from a host to the vCO server using SSH/SCP. |
| --- | SCP put command | Copies a file from the vCO server to a target host using SSH/SCP. |
| \\Library\\Troubleshooting | ||
| --- | Export logs and application settings | Generates a ZIP archive of troubleshooting information that contains the following files: - Configuration files - Server, configuration, wrapper and installation log files - Workflow, action, Web view, configuration element, resource element, policy template, policy, authorization element and task information |
| \\Library\\vCenter | ||
| \\Library\\vCenter\\Batch | ||
| ----- | Fill batch configuration elements | Populates the configuration elements that the Run workflow on a selection of objects workflow uses. Performs the following tasks: - Resets the BatchObject and BatchAction configuration elements - Fills the BatchObject configuration element with all the workflows that have only one input parameter - Fills the BatchAction configuration element with all the actions that have only one parameter and have an array as the returnType |
| ----- | Run a workflow on a selection of objects | Runs a workflow on a selection of objects. You must have run the Fill batch configuration elements workflow before running this workflow. You can run this workflow in simulation mode, in which case the workflow will not modify any of the objects on which it runs. |
| \\Library\\vCenter\\Cluster and Compute resource | ||
| ----- | Create cluster | Creates a new cluster in a given host folder. |
| ----- | Delete cluster | Deletes a given cluster. |
| ----- | Disable HA on cluster | Disables HA on a given cluster. |
| ----- | Enable HA on cluster | Enables HA on a given cluster |
| ----- | Rename cluster | Renames a given cluster. |
| \\Library\\vCenter\\Custom attributes | ||
| ----- | Add custom attribute to a virtual machine | Adds a custom attribute for a virtual machine in vCenter Server |
| ----- | Add custom attribute to multiple virtual machines | Adds a custom attribute to multiple virtual machines in vCenter Server |
| ----- | Get custom attribute | Gets a custom attribute for a given virtual machine, in vCenter Server. |
| \\Library\\vCenter\\Datacenter | ||
| ----- | Create datacenter | Creates a new datacenter in a given datacenter folder. Returns the new datacenter. |
| ----- | Delete datacenter | Deletes a given datacenter. |
| ----- | Reload datacenter | Force vCenter Server to reload data from a datacenter. |
| ----- | Rename datacenter | Renames a given datacenter and waits the process to complete. |
| ----- | Rescan datacenter HBAs | Scans the hosts in a datacenter and initiates a re-scan on the hosts' HBAs to discover new storage. |
| \\Library\\vCenter\\Datastore and files | ||
| ----- | Delete all files | Deletes a list of files. |
| ----- | Delete all unused datastore files | Introspects all datastores in the vCenter Server and deletes all unused files. |
| ----- | Export unused datastore files | Introspects all datastores and lists all unused files in an XML descriptor file. |
| ----- | Find unused files in datastores | Searches vCenter Server for all unused disks (*.vmdk), virtual machines (*.vmx), and template (*.vmtx) files that are not associated to any vCenter Server instances that are registered with Orchestrator. |
| ----- | Get all configuration, template, and disk files from virtual machines | Returns a list of all virtual machine descriptor files and a list of all virtual machine disk files, for all datastores. |
| ----- | Log all datastores files | Prints a log for every virtual machine configuration file and every virtual machine disk file found in all datastores. |
| ----- | Log unused datastore files | Searches vCenter Server for all unused files that are registered on virtual machines and logs the files. Exports the files in a text file |
| \\Library\\vCenter\\Folder management | ||
| \\Library\\vCenter\\Folder management\\Datacenter folder | ||
| ------- | Create datacenter folder | Creates a new datacenter folder and returns it. |
| ------- | Delete datacenter folder | Deletes a datacenter folder and waits for the task to complete. |
| ------- | Rename datacenter folder | Renames a datacenter folder and waits for the task to complete. |
| \\Library\\vCenter\\Folder management\\Host folder | ||
| ------- | Create host folder | Creates a new host folder and returns it. |
| ------- | Delete host folder | Deletes a host folder and waits for the task to complete. |
| ------- | Rename host folder | Renames a host folder and waits for the task to complete. |
| \\Library\\vCenter\\Folder management\\VM folder | ||
| ------- | Create virtual machine folder | Creates a new virtual machine folder. |
| ------- | Delete virtual machine folder | Deletes a virtual machine folder and waits for the task to complete. |
| ------- | Rename virtual machine folder | Renames a virtual machine folder and waits for the task to complete. |
| \\Library\\vCenter\\Host management | ||
| \\Library\\vCenter\\Host management\\Basic | ||
| ------- | Enter maintenance mode | Puts the host in maintenance mode. While this task is running and when the host is in maintenance mode, virtual machines cannot be powered on and provisioning operations cannot be performed on the host. Once the call completes, it is safe to turn off a host without disrupting any virtual machines. The task completes once there are no powered-on virtual machines on the host and no provisioning operations in progress on the host. The operation does not directly initiate any operations to evacuate or power-down virtual machines. However, if the host is part of a cluster with VMware DRS enabled, DRS provides migration recommendations to evacuate the virtual machines. If DRS is in fully-automatic mode, it automatically schedules virtual machine evacuation. The task is cancellable. |
| ------- | Exit maintenance mode | Exits maintenance mode. The task can be canceled. |
| ------- | Move host into cluster | Moves an existing host into a cluster. The host must be part of the same datacenter, and if the host is part of a cluster, the host must be in maintenance mode. If the host is a stand-alone host, the stand-alone ComputeResource is removed as part of this operation. All virtual machines associated with the host, regardless of whether or not they are running, are moved with the host into the cluster. If there are virtual machines that should not be moved, then migrate those virtual machines off the host before initiating this operation. If the host is a stand-alone host, the cluster supports nested resource pools, and the user specifies the optional resourcePool argument, then the stand-alone host's root resource pool becomes the specified resource pool and the stand-alone host resource hierarchy is imported into the new nested resource pool. If the cluster does not support nested resource pools or the resourcePool argument is not specified, then the stand-alone host resource hierarchy is ignored. |
| ------- | Move host to folder | Moves a host into a folder as a standalone host (ComputeResource). The host must be part of a ClusterComputeResource in the same datacenter and the host must be in maintenance mode. Otherwise, the operation fails. |
| ------- | Reload host | Forces vCenter Server to reload data from an ESX host. |
| \\Library\\vCenter\\Host management\\Power | ||
| ------- | Reboot host | Reboots a host. If the Orchestrator client is connected directly to the host, it does not receive any indication of success in the returned task, but rather loses the connection to the host if the command succeeds. |
| ------- | Shut down host | Shuts down a host. If the Orchestrator client is connected directly to the host, it does not receive any indication of success in the returned task, but rather loses the connection to the host if the command succeeds. |
| \\Library\\vCenter\\Host management\\Registration | ||
| ------- | Add host to cluster | Adds a host to the cluster. If the cluster supports nested resource pools and the user specifies the optional ResourcePool argument, then the host's root resource pool becomes the specified resource pool. The stand-alone host resource hierarchy is imported into the new nested resource pool. If the cluster does not support nested resource pools, then the stand-alone host resource hierarchy is discarded and all virtual machines on the host are put under the cluster's root resource pool. |
| ------- | Add standalone host | Registers an ESX host as a standalone host, namely, as a ComputeResource. |
| ------- | Disconnect host | Disconnects an ESX host from vCenter Server. |
| ------- | Reconnect host | Reconnects a disconnected host by providing only the host information. |
| ------- | Reconnect host with all information | Reconnects a host by providing all information about the ESX host. |
| ------- | Remove host | Removes an ESX host and unregisters it from vCenter Server. If the ESX host is part of a cluster, you must put it in maintenance mode before attempting to remove it. |
| \\Library\\vCenter\\Resource Pool | ||
| ----- | Create resource pool | Creates a new resource pool with the default CPU and memory allocation values. To create a resource pool in a cluster, the cluster must be with VMware DRS enabled. |
| ----- | Create resource pool with specified values | Creates a resource pool with the specified CPU and memory allocation values. To create a resource pool in a cluster, the cluster must be with VMware DRS enabled. |
| ----- | Delete resource pool | Deletes a resource pool and waits for the task to complete. |
| ----- | Get resource pool information | Returns CPU and memory allocation infromation about a given resource pool. |
| ----- | Reconfigure resource pool | Reconfigures CPU and memory allocation configuration for a given resource pool. |
| ----- | Rename resource pool | Renames a resource pool and waits for the task to complete. |
| \\Library\\vCenter\\Storage | ||
| ----- | Create VMFS for all available disks | Creates a VMFS volume for all available disks of a given host. |
| ----- | Display all datastores and disks | Displays the existing datastores and available disks. |
| \\Library\\vCenter\\Virtual Machine management | ||
| \\Library\\vCenter\\Virtual Machine management\\Basic | ||
| ------- | Create custom virtual machine | Creates a virtual machine with the specified configuration options and additional devices. |
| ------- | Create simple dvPortGroup virtual machine | Creates a simple virtual machine. The network used is a Distributed Virtual Port Group. |
| ------- | Create simple virtual machine | Creates a virtual machine with the most common devices and configuration options. |
| ------- | Delete virtual machine | Removes a virtual machine from the Inventory and Datastore. |
| ------- | Mark as template | Converts an existing virtual machine to a template, not allowing it to start. Templates can be used to create new virtual machines. Warning: The workflow may finish before the virtual machine status is refreshed. |
| ------- | Mark as virtual machine | Converts an existing template to a virtual machine, allowing it to start. Warning: The workflow may finish before the VM status is refreshed |
| ------- | Move virtual machine to folder | Moves a virutal machine to the specified virtual machine folder. |
| ------- | Move virtual machine to resource pool | Moves a virtual machine to a resource pool. If the target resource pool is not in the same cluster, use the Migrate/Relocate workflows. |
| ------- | Move virtual machines to folder | Moves several virutal machines to the specified virtual machine folder. |
| ------- | Move virtual machines to resource pool | Moves several virtual machines to a resource pool. |
| ------- | Register virtual machine | Registers a virtual machine. The virtual machine files must be stored in an existing datastore and must not be already registered. |
| ------- | Reload virtual machine | Forces vCenter Server reload a virtual machine. |
| ------- | Rename virtual machine | Renames an existing virtual machine on vCenter Server or ESX host and not on the datastore. |
| ------- | Set virtual machine performance | Changes performance settings such as shares, min/max values, shaping for network, and disks access of a virtual machine. |
| ------- | Unregister virtual machine | Removes an existing virtual machine from the Inventory. |
| ------- | Upgrade virtual machine | Upgrades the virtual hardware to the latest revision that is supported by the virtual machine's current host. An input parameter allows a forced upgrade even if VMware Tools are out of date. |
| ------- | Upgrade VM Hardware (force if required) | Upgrades this virtual machine's virtual hardware to the latest revision that is supported by the virtual machine's current host. This workflow forces the upgrade to continue, even if the VMware Tools are out of date. If the VMware Tools are out of date, forcing the upgrade to continue will revert the guest network settings to the default settings. To avoid this first upgrade the VMware Tools before running this workflow. |
| ------- | Wait for task and answer virtual machine question | Waits for a vCenter task to complete or for the virtual machine to ask a question. If the virtual machine requires an answer, accepts user input and answers the question. |
| \\Library\\vCenter\\Virtual Machine management\\Clone | ||
| ------- | Clone virtual machine from properties | Clones virtual machines by using properties as input parameters. Properties of different types have the following prefixes: - VMware properties start with vm - Windows properties start with win - Linux properties with lin - Networks properties start with nic1, nic2, nic3 or nic4 - Other properties are ignored See the workflow attributes for the key name and object types. |
| ------- | Clone virtual machine, no customization | Clones a virtual machine without changing anything except the virtual machine UUID. |
| ------- | Customize virtual machines from properties | Clones virtual machines by using properties as input parameters. Properties of different types have the following prefixes: - VMware properties start with vm - Windows properties start with win - Linux properties with lin - Networks properties start with nic1, nic2, nic3 or nic4 - Other properties are ignored See the workflow attributes for the key name and object types. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Linked Clone | ||
| --------- | Linked clone, no customization | Creates a linked clone of a given virtual machine. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Linked Clone\\Helper | ||
| ----------- | Restore virtual machine from linked clone | Removes a virtual machine from a linked clone setup. |
| ----------- | Set up virtual machine for linked clone | Prepares the virtual machine to be link cloned. A linked clone is a copy of a virtual machine that shares virtual disks with the parent virtual machine. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Linked Clone\\Linux Customization | ||
| ----------- | Linked clone, Linux with multiple NICs | Creates a linked clone of a Linux virtual machine, performs the guest OS customization, and configures up to four virtual network cards. |
| ----------- | Linked clone, Linux with single NIC | Creates a linked clone of a Linux virtual machine, performs the guest OS customization, and configures one virtual network card. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Linked Clone\\Windows Customization | ||
| ----------- | Linked clone, Windows with multiple NICs and credential | Creates a linked clone of a Windows virtual machine, performing the guest OS customization. Configures up to four virtual network cards and a local administrator user account. Sysprep tools must be available on vCenter server. |
| ----------- | Linked clone, Windows with single NIC and credential | Creates a linked clone of a Windows virtual machine performing the guest OS customization. Configures one virtual network card and a local administrator user account. Sysprep tools must be available on vCenter server. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Linux Customization | ||
| --------- | Clone, Linux with multiple NICs | Clones a Linux virtual machine, performs guest OS customization and configures up to four virtual network cards. |
| --------- | Clone, Linux with single NIC | Clones a Linux virtual machine, performs guest OS customization and configures one virtual network card. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Tools | ||
| --------- | Get a VirtualEthernetCard to change the network | Returns a new ethernet card to update a virtual device. Contains only the device key of the given virtual device and the new network. |
| --------- | Get Linux customization | Returns the Linux customization preparation. |
| --------- | Get multiple VirtualEthernetCard device changes | Returns an array of VirtualDeviceConfigSpec objects for add and remove operations on VirtualEthernetCard objects. |
| --------- | Get NIC setting map | Returns the setting map for virtual network card by using VimAdapterMapping. Changes NIC information for workflows that clone and reconfigure virtual machines. Other clone workflows call this workflow. |
| --------- | Get Windows customization, Sysprep with credentials | Returns the customization information for Microsoft Sysprep process, with credentials. The different workflows for cloning Windows virtual machines use this workflow. |
| --------- | Get Windows customization, Sysprep with Unattended.txt | Returns the customization information for the Microsoft Sysprep process using an Unattended.txt file. The different workflows for cloning Windows virtual machines use this workflow. |
| --------- | Get Windows customizations for Sysprep | Returns the customization information for the Microsoft Sysprep process. The different workflows for cloning Windows virtual machines use this workflow. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Windows Customization | ||
| --------- | Clone thin provisioned, Windows with single NIC and credential | Clones a Windows virtual machine, performing the guest OS customization. Specifies virtual disk thin provisioning policy and configures one network card and a local administrator user account. Sysprep tools must be available on vCenter server. |
| --------- | Clone, Windows Sysprep with single NIC and credential | Clones a Windows virtual machine performing the guest OS customization. Configures one virtual network card and a local administrator user account. Sysprep tools must be available on vCenter server. |
| --------- | Clone, Windows with multiple NICs and credential | Clones a Windows virtual machine, performing guest OS customization. Configures the local administrator user account and up to four virtual network cards. Sysprep tools must be available on vCenter server. |
| --------- | Clone, Windows with single NIC | Clones a Windows virtual machine, performs guest OS customization and configures one virtual network card. Sysprep tools must be available on vCenter server. |
| --------- | Clone, Windows with single NIC and credential | Clones a Windows virtual machine, performing guest OS customization. Configures one network card and a local administrator user account. Sysprep tools must be available on vCenter server. |
| \\Library\\vCenter\\Virtual Machine management\\Clone\\Windows Customization\\Only Customize | ||
| ----------- | Customize, Windows with single NIC and credential | Performs guest OS customization, configures one virtual network card and a local administrator user account on a Windows virtual machine. |
| \\Library\\vCenter\\Virtual Machine management\\Device Management | ||
| ------- | Add CD-ROM | Adds a virtual CD-ROM to a virtual machine. If the virtual machine has no IDE controller, the workflow creates one. |
| ------- | Add disk | Adds a virtual disk to a virtual machine. |
| ------- | Change RAM | Changes the amount of RAM of a virtual machine. |
| ------- | Convert disks to thin provisioning | Converts thick-provisioned disks of virtual machines to thin-provisioned disks. Converting from thick to thin provisioning involves moving the virtual machine, as disks cannot change from thick to thin provisioning in situ. To perform the conversion, you must first choose the datastore from which to select virtual machines. When the workflow runs, you must choose a temporary datastore in which to host the virtual machines during the conversion process. You cannot convert virtual machines in the powered on state that have snapshots. However, you can convert powered on virtual machines that do not have snapshots, and you can convert virtual machines that have snapshots if they are powered off. NOTE: If a virtual machine is in datastore1, and this virtual machine has one thick-provisioned disk on datastore1 and another thick-provisioned disk on datastore2, you must move the virtual machine to a third datastore, datastore3. If you do not move the virtual machine to datastore3, only one disk will convert. |
| ------- | Convert independent disks | Converts all independent virtual machine disks to normal disks by removing the independent flag from the disks. |
| ------- | Disconnect all detachable devices from a running virtual machine | Disconnects all detachable devices, such as floppy disk and CD-ROM drives from a running virtual machine. The virtual machine must be running. |
| ------- | Mount floppy disk drive | Mounts a floppy disk drive FLP file from the ESX datastore. |
| \\Library\\vCenter\\Virtual Machine management\\Move and Migrate | ||
| ------- | Migrate virtual machine | Migrates a virtual machine from one host to another. Uses MigrateVM_Task from the vSphere API. |
| ------- | Migrate virtual machines using vMotion/Storage vMotion | Uses vMotion, storage vMotion, or both vMotion and Storage vMotion to migrate a single virtual machine, a selection of virtual machines, or all available virtual machines. NOTE: vCenter Server does not allow storage vMotion and vMotion in the same pass for a powered on virtual machine. You must power off the virtual machine to use storage vMotion and vMotion in the same pass. |
| ------- | Move VMs to another VC | Migrate a list of virtual machine to another VCenter |
| ------- | Quick virtual machine migration | Suspends a virtual machine and migrates it to another host. |
| ------- | Relocate virtual machine disks | Relocates a virtual machine's disks to another host or datastore while the virtual machine is in the powered off state. Uses the RelocateVM_Task from the vSphere API. |
| ------- | Storage vMotion | Perform storage vMotion for a virtual machine, all virtual machines that this plug-in knows, or a selection of virtual machines. To use "Select by action", you must run the 'Library > vCenter > Batch > Fill batch configuration elements' workflow before running this workflow. |
| \\Library\\vCenter\\Virtual Machine management\\Others | ||
| ------- | Extract virtual machine information | Returns the virtual machine folder, host system, resource pool, compute resource, datastore, hard drives sizes, CPU and memory, network, and IP address for a given virtual machine. Note: VMware Tools may need to be installed. |
| ------- | Find orphaned virtual machines | Lists all virtual machines in an orphaned state in the Orchestrator inventory. Lists the VMDK and VMTX files for all datastores in the Orchestrator inventory that have no association with any virtual machines in the Orchestrator inventory. Sends the lists by email (optional). |
| \\Library\\vCenter\\Virtual Machine management\\Power Management | ||
| ------- | Power off virtual machine and wait | Powers off a Virtual Machine and waits for the process to complete. |
| ------- | Reboot guest OS | Reboots the virtual machines's guest OS. Does not reset non-peristent virtual machines. VMware Tools must be running. |
| ------- | Reset virtual machine and wait | Resets a virtual machine and waits for the process to complete. |
| ------- | Resume virtual machine and wait | Resumes a suspended virtual machine and waits for the process to complete. |
| ------- | Set guest OS to standby | Sets the guest OS to standby. VMware tools must be running. |
| ------- | Shut down and delete virtual machine | Shuts down a virtual machine and deletes it from the inventory and disk. |
| ------- | Shut down guest OS and wait | Shuts down a guest OS and waits for the process to complete. |
| ------- | Start virtual machine and wait | Starts a virtual machine and waits for VMware Tools to start. |
| ------- | Suspend virtual machine and wait | Suspends a virtual machine and waits for the task to complete. |
| \\Library\\vCenter\\Virtual Machine management\\Snapshot | ||
| ------- | Create a snapshot | Creates a snapshot and returns it. |
| ------- | Create snapshots of all virtual machines in a resource pool | Creates a snapshot of each virtual machine in a resource pool. |
| ------- | Remove all snapshots | Removes all existing snapshots without reverting to a previous snapshot. |
| ------- | Remove excess snapshots | Finds virtual machines with more than a given number of snapshots and optionally deletes the oldest snapshots. Sends the results by email. |
| ------- | Remove old snapshots | Gets all snapshots that are older than a given number of days and prompts the user to select which ones to delete. |
| ------- | Remove snapshots of a given size | Gets all snapshots that are larger than a given size and prompts the user to select which ones to delete. |
| ------- | Revert to current snapshot | Reverts to the current snapshot. If the snapshot to which to revert was taken while the virtual machine was powered on, and if you run the Revert to current snapshot workflow when the virtual machine is powered off, the workflow powers on the virtual machine so as to emulate state of the snapshot. Use the host optional input parameter to specify a host on which to power on the virtual machine. If you do not set the host parameter and vBalance is set, a host is automatically selected. Otherwise, the virtual machine keeps its existing host affiliation. |
| ------- | Revert to snapshot and wait | Reverts to a specific snapshot. Does not delete the snapshot |
| \\Library\\vCenter\\Virtual Machine management\\VMware Tools | ||
| ------- | Mount tools installer | Mounts the tools installer on the virtual CD-ROM. |
| ------- | Set console screen resolution | Sets the console window's resolution. The virtual machine must be in the powered on state. |
| ------- | Turn on time synchronization | Turns on time synchronization between the virtual machine and the ESX server in VMware Tools. |
| ------- | Unmount tools installer | Unmounts the VMware Tools CD-ROM. |
| ------- | Upgrade tools | Upgrades VMware Tools on a virutal machine |
| ------- | Upgrade tools at next reboot | Upgrades VMware Tools on a virutal machine at the next reboot. |
| \\Library\\VIM 3 | ||
| \\Library\\VIM 3\\Cluster and Compute resource | ||
| ----- | Create cluster | Create a cluster in a given folder |
| ----- | Destroy cluster | Destroy a cluster. |
| ----- | Rename cluster | Rename a given cluster |
| \\Library\\VIM 3\\Custom attributes | ||
| ----- | Add custom attribute | Add a custom attribute (in Virtual Center) for multiple VMs |
| ----- | Get custom attribute | Get a custom attribute (in Virtual Center) for a given VM |
| \\Library\\VIM 3\\Datacenter | ||
| ----- | Create datacenter | Create a new datacenter in a given datacenter folder; return the new datacenter |
| ----- | Destroy datacenter | Destroy a given datacenter. |
| ----- | Reload datacenter | Force Virtual center to reload data from a datacenter. |
| ----- | Rename datacenter | Rename a given datacenter and wait the process to complete |
| \\Library\\VIM 3\\Folder management | ||
| \\Library\\VIM 3\\Folder management\\Datacenter folder | ||
| ------- | Create Datacenter folder | Create a new Datacenter folder and return it. |
| ------- | Destroy Datacenter folder | Destroy a Datacenter folder and wait for the task completion. |
| ------- | Rename Datacenter folder | Rename a Datacenter folder and wait for the task completion. |
| \\Library\\VIM 3\\Folder management\\Host folder | ||
| ------- | Create Host folder | Create a new host folder and return it. |
| ------- | Destroy Host folder | Destroy a VM folder and wait the task completion. |
| ------- | Rename Host folder | Rename a Host folder and wait the task completion. |
| \\Library\\VIM 3\\Folder management\\VM folder | ||
| ------- | Create VM folder | Create a new Folder. |
| ------- | Destroy VM folder | Destroy a VM folder and wait the task completion. |
| ------- | Rename VM folder | Rename a VM folder and wait the task completion. |
| \\Library\\VIM 3\\Host management | ||
| \\Library\\VIM 3\\Host management\\Basic | ||
| ------- | Enter maintenance mode | Puts the host in maintenance mode. While this task is running and when the host is in maintenance mode, no virtual machines can be powered on and no provisioning operations can be performed on the host. Once the call completes, it is safe to turn off a host without disrupting any virtual machines. The task completes once there are no powered-on virtual machines on the host and no provisioning operations in progress on the host. The operation does not directly initiate any operations to evacuate or power-down virtual machines. However, if the host is part of a cluster with VMware DRS enabled, DRS provides migration recommendations to evacuate the virtual machines. If DRS is in fully-automatic mode, these are automatically scheduled. The task is cancellable. |
| ------- | Exit maintenance mode | Puts the host in maintenance mode. While this task is running and when the host is in maintenance mode, no virtual machines can be powered on and no provisioning operations can be performed on the host. Once the call completes, it is safe to turn off a host without disrupting any virtual machines. The task completes once there are no powered-on virtual machines on the host and no provisioning operations in progress on the host. The operation does not directly initiate any operations to evacuate or power-down virtual machines. However, if the host is part of a cluster with VMware DRS enabled, DRS provides migration recommendations to evacuate the virtual machines. If DRS is in fully-automatic mode, these are automatically scheduled. The task is cancellable. |
| ------- | Move Host into Cluster | Put a host into a cluster. All discovered VMs are automatically put in the given resource pool |
| ------- | Move host to folder | Move host into a folder. Create a stand-alone host (ComputeResource). |
| ------- | Reload host | Force Virtual Center to reload data from an ESX host |
| \\Library\\VIM 3\\Host management\\Power | ||
| ------- | Reboot host | Reboots a host. If the command is successful, then the host has been rebooted. If connected directly to the host, the client never receives an indicator of success in the returned task but simply loses connection to the host, upon success. |
| ------- | Shutdown host | Shuts down a host. If the command is successful, then the host has been shut down. Thus, the client never receives an indicator of success in the returned task if connected directly to the host. |
| \\Library\\VIM 3\\Host management\\Registration | ||
| ------- | Add host to cluster | Resgister an ESX Host and add it to a cluster |
| ------- | Add standalone host | Register an ESX host as a Stand alone host (ComputeResource) |
| ------- | Disconnect host | Disconnect an ESX host from Virutal Center |
| ------- | Reconnect host (simple) | Reconnect a disconnected host, providing only the Host information |
| ------- | Reconnect host (with all info) | Reconnect a host, providing all information about the ESX host |
| ------- | Remove host | Remove an ESX host, unregistering it from Virtual Center If the ESX is part of a cluster, it must be put in maintenance mode before attempting the operation |
| \\Library\\VIM 3\\Resource Pool | ||
| ----- | Create resource pool | Create a resource pool. To be able to create Resource Pool in a Cluster, the cluster must be DRS enabled. |
| ----- | Create resource pool (with default values) | Create a new resource pool. All allocation values are set to default. To be able to create Resource Pool in a Cluster, the cluster must be DRS enabled. |
| ----- | Destroy resource pool | Destroy a resource pool and wait the task completion. |
| ----- | Reconfig resource pool | Reconfigure allocation configuration for a resource pool |
| ----- | Rename resource pool | Rename a resource pool and wait the task completion. |
| \\Library\\VIM 3\\SSH | ||
| ----- | (VIM3) Register vCO public key on host | This workflow will register the vCO public key (must be generated before) to a target host. |
| ----- | (VIM3) SCP Get | Copies a file from a host to the VS-O server using SSH/SCP. |
| ----- | (VIM3) SCP Put | Copies a file from the VS-O server to a target host using SSH/SCP. |
| ----- | (VIM3) SSH Execute command | Execute SSH command |
| \\Library\\VIM 3\\Virtual Machine management | ||
| \\Library\\VIM 3\\Virtual Machine management\\Basic | ||
| ------- | Create VM (Full) | Allow to create a new VM by specifing a lot of parameters |
| ------- | Create VM (Simple) | Allow to create a simple, basic VM. |
| ------- | Destroy VM | Destroy the Virtual Machine, removing it from the Inventory AND from the Datastore. |
| ------- | Mark as Template | Mark an existing VM as a template, preventing it to start |
| ------- | Mark as Virtual Machine | Mark an existing template as a Virutal Machine, allowing it to start |
| ------- | Move VM to folder | Move a Virutal Machine to a VM folder |
| ------- | Move VM to Resource pool | Move one VM to a resource pool. The target must be in the same cluster. Otherwise use Migrate / Relocate |
| ------- | Move VMs to Folder | Move multiple VMs in a vm folder. |
| ------- | Move VMs to Resource pool | Move multiple VMs to a resource pool |
| ------- | Register Virtual machine | Register a virtual machine. The VM must be stored on an existing datastore and must not be already registered. |
| ------- | Reload VM | Force Virtual Center to reload a VM |
| ------- | Rename VM | Rename an existing VM. This will only rename the VM in Virtual Center / ESX host, not on the datastore |
| ------- | Set VM Performance | Change a VM's performance settings (shares, min/max values, shaping for network, disks access) |
| ------- | Unregister VM | Unregister an existing Virtual Machine |
| ------- | Upgrade VM | Upgrades this virtual machine's virtual hardware to the latest revision that is supported by the virtual machine's current host. An input parameter allows a forced upgrade even if the VMware Tools are out of date. |
| \\Library\\VIM 3\\Virtual Machine management\\Clone | ||
| ------- | Clone VM (No customization at all) | Clone a VM, without changing anything (except VM UUID) |
| ------- | Clone VM from Properties | This workflow clones VM using Properties as input: - Properties about VMware start by vm - Properties about Windows start by win - Properties about Linux start by lin - Properties about network starts by nic1, nic2, nic3 or nic4 Other properties are ignored See workflow attributes for key name / object type. |
| \\Library\\VIM 3\\Virtual Machine management\\Clone\\Linux Customization | ||
| --------- | Clone VM (Linux customization, 1 Nic) | Clones a windows VM, doing customization of the guest (Sysprep) and configures one network card. Sysprep tools must be available on the Virtual Center. |
| --------- | Clone VM (Linux customization, Multiple Nic) | Clones a windows VM, doing customization of the guest (Sysprep) and configures 0 to 4 network card. Sysprep tools must be available on the Virtual Center. |
| \\Library\\VIM 3\\Virtual Machine management\\Clone\\Tools | ||
| --------- | Get 1 Nic Setting Map | Return a NIC setting (VimAdapterMapping). Allow to change Nic information for Clone and Reconfigure VMs workflows |
| --------- | Get a VirtualEthernetCard to change the network | Return a "new" ethernet card for updating a virtual device. Contains only the Device key of the given virtual device and the new network |
| --------- | Get Linux Customization | null |
| --------- | Get Multiple VirtualEthernetCard devices change (add/remove) | Returns an array of VirtualDeviceConfigSpec for change operations on VirtualEthernetCard objects. |
| --------- | Get Windows Customization (Sysprep) | Return the Customization information for Windows Sysprep process. This workflow is used by the Clone VM * workflows |
| --------- | Get Windows Customization (Sysprep, Credential) | Return the Customization information for Windows Sysprep process. This workflow is used by the Clone VM * workflows |
| --------- | Get Windows Customization (Unattended.txt) | Return the Customization information for Windows Sysprep process. This workflow is used by the Clone VM * workflows |
| \\Library\\VIM 3\\Virtual Machine management\\Clone\\Windows Customization | ||
| --------- | Clone VM (Windows customization (Sysprep.inf), 1 Nic, Credential) | Clones a windows VM, doing customization of the guest (Sysprep) and configures one network card. Sysprep tools must be available on the Virtual Center. |
| --------- | Clone VM (Windows customization, 1 Nic) | Clones a windows VM, doing customization of the guest (Sysprep) and configures one network card. Sysprep tools must be available on the Virtual Center. |
| --------- | Clone VM (Windows customization, 1 Nic, Credential) | Clones a windows VM, doing customization of the guest (Sysprep) and configures one network card. Sysprep tools must be available on the Virtual Center. |
| --------- | Clone VM (Windows customization, 1 Nic, Credential, Thin provisionned) | Clones a windows VM, doing customization of the guest (Sysprep) and configures one network card. Sysprep tools must be available on the Virtual Center. |
| --------- | Clone VM (Windows customization, Multiple Nic, Credential) | Clones a windows VM, doing customization of the guest (Sysprep) and configures one network card. Sysprep tools must be available on the Virtual Center. |
| \\Library\\VIM 3\\Virtual Machine management\\Clone\\Windows Customization\\Only Customize | ||
| ----------- | Customize VM (Windows customization, 1 Nic, Credential) | Customize a windows VM. |
| \\Library\\VIM 3\\Virtual Machine management\\Device Management | ||
| ------- | Add CD-ROM | Add a new Virtual CD-ROM on a VM. if no IDE controller present, the workflow create one. |
| ------- | Add Disk | Add a virtual disk to a VM. |
| ------- | Change RAM | Change RAM size. |
| ------- | Mount floppy | Mount a .flp file that is on ESX datastore |
| \\Library\\VIM 3\\Virtual Machine management\\Move and Migrate | ||
| ------- | Migrate VM | Migrate a VM from a host to another |
| ------- | Relocate VM | Relocate a Virtual machine to another host or datastore (While VM is power off) |
| \\Library\\VIM 3\\Virtual Machine management\\Others | ||
| ------- | Extract VM informations | null |
| \\Library\\VIM 3\\Virtual Machine management\\Power Management | ||
| ------- | Power off VM and wait | Power off a Virtual Machine. |
| ------- | Reboot guest OS | Send information to the VM guest OS to reboot. Don't reset VM not peristent. VMware Tools must be running. |
| ------- | Reset VM and wait | Resets the virtual machine. |
| ------- | Resume VM and wait | Resume a suspended Virtual Machine |
| ------- | Shutdown & Destroy VM | Shutdown a VM and delete it. |
| ------- | Shutdown guest OS and wait | Shutdown guest OS and wait. |
| ------- | Standby OS | Stand by the guest os. VMware tools must be running. |
| ------- | Start VM and wait | Starts a virtual machine and waits for the tools to be up and running. |
| ------- | Suspend VM and wait | Suspends a virtual machine and wait for the task to complete. |
| \\Library\\VIM 3\\Virtual Machine management\\Snapshot | ||
| ------- | Create a Snapshot | Create a snapshot and return it. |
| ------- | Remove all Snapshots | Remove all existing snapshot (without reverting) |
| ------- | Revert to current snapshot | Revert to the current snapshot. In the snapshot contains power on informations, and VM is not in a DRS cluster, the workflow provide the host for the operation. |
| ------- | Revert to snapshot and wait | Revert to a specific snapshot. This will not delete the snapshot |
| \\Library\\VIM 3\\Virtual Machine management\VMware Tools | ||
| ------- | Mount tools installer | Mount tools installer on the Virtual CD-ROM. |
| ------- | Set console screen resolution | Sets the console window's resolution as specified. The power state must be poweredOn. |
| ------- | Unmount tools installer | Unmount the VMware tools CD. |
| ------- | Upgrade tools | Upgrade VMware tools on a Virutal Machine |
| \\Library\\XML | ||
| \\Library\\XML\\Samples XML (Address Book) | ||
| ----- | Append address book stylesheet information | Appends stylesheet information for the address book example. |
| ----- | Create address book CSS | Creates CSS for the address book example |
| ----- | Create address book DTD | Creates a DTD for the address book example |
| ----- | Create address book XML | Creates XML for the address book example |
| ----- | Full address book test | Tests full address book cycle. Namely: - creates a directory - creates address book DTD, XML, and CSS - appends the stylesheet |
| \\Library\\XML\\Samples XML (Simple) | ||
| ----- | Create a simple XML document | Creates a simple XML document for testing purposes. |
| ----- | Find element in document | Finds an element in an XML file and logs it. |
| ----- | Modify XML document | Modifies an XML file by writing a new XML document in a new file. |
