VMware

VMware vCenter Orchestrator Plug-In for Microsoft Windows PowerShell 1.0.4 Release Notes

VMware vCenter Orchestrator Plug-In for Microsoft Windows PowerShell 1.0.4 | 22 April 2014 | Build 1736639

VMware vCenter Orchestrator 5.5.1 | 11 March 2014 | Build 1617131

Check frequently for additions and updates to these release notes.

What's in the Release Notes

The release notes cover the following topics:

Introduction to the VMware vCenter Orchestrator Plug-In for Microsoft Windows PowerShell

The VMware vCenter Orchestrator plug-in for Microsoft Windows PowerShell allows customers to leverage their investment in existing Windows PowerShell and VMware vSphere PowerCLI scripts to develop broader orchestration workflows for cloud environments.

Many organizations already rely on PowerCLI cmdlets and scripts to automate various tasks in their vSphere environment. As the organizations move from virtualized to full-scale cloud platforms, many of these organizations see a need to augment their automation toolset with cross-system orchestration capabilities. With the PowerShell plug-in, customers can benefit from vCenter Orchestrator capabilities without having to rewrite existing scripts as Orchestrator workflows. With the plug-in, customers can extend their existing PowerShell scripts by invoking them as Orchestrator actions and adding workflow steps such as sending out e-mails, updating change requests, or other typical orchestration operations.

The plug-in offers many capabilities to workflow developers, such as:

  • Invoking unmodified scripts by copying and pasting them into workflows
  • Invoking external scripts and passing workflow parameters as script inputs
  • Generating a new Orchestrator action from a PowerShell script
  • Generating a new Orchestrator action for a PowerCLI cmdlet
  • Browsing snap-ins and their associated cmdlets in the Orchestrator workflow editor
  • Invoking scripts from the Orchestrator JavaScript API
  • Converting vCenter Server objects in Orchestrator workflows to PowerShell objects and the reverse

The plug-in is compatible with Windows PowerShell 1.0, 2.0, 3.0, and 4.0. It requires WinRM 2.0 or OpenSSH 5.9. For instructions about installing and configuring the plug-in, see Using the vCenter Orchestrator Plug-In for Microsoft Windows PowerShell 1.0.x.

IMPORTANT The Orchestrator plug-in for PowerShell does not support Single Sign-On authentication. If vCenter Orchestrator is configured in Single Sign-On mode, you can configure the plugin by providing the credentials explicitly in shared session mode.

To upgrade the plug-in, you must install version 1.0.4 on your existing installation. You can download version 1.0.4 from the VMware vCenter Orchestrator plug-in for Microsoft Windows PowerShell download page.

What's New in VMware vCenter Orchestrator Plug-In for Microsoft Windows PowerShell 1.0.4

This release introduces support for Microsoft Windows PowerShell 4.0 and improved host management capabilities. You are now able to to set the authentication type (Basic or Kerberos) when updating an existing PowerShell host. Due to the common SSL trusted store support, all SSL certificates of the PowerShell hosts are now managed by the Import a certificate from URL workflow. This worklfow is shipped with the platform as part of the vCenter Orchestrator Configuration plug-in. Orchestrator Plug-In for Microsoft Windows PowerShell 1.0.4 uses the new plug-in configuration API and is not compatible with vCenter Orchestrator versions earlier than 5.5.1.

Top of Page

Known Issues

The following issues are known to occur in the VMware vCenter Orchestrator Plug-In for Microsoft Windows PowerShell 1.0.4 release:


  • Possible memory-related issues

    If you run a PowerShell script in a large-scale environment, you might receive a generic system out-of-memory error.

    Note: To verify whether the script is problematic and causes the out-of-memory error, test the script without using Orchestrator and the PowerShell plug-in. Debug the script and try to serialize the output by using the Export‑CLIXML cmdlet (see the Windows PowerShell documentation for details). If the Export‑CLIXML cmdlet returns an out-of-memory error, you must apply the workaround. If the Export‑CLIXML cmdlet does not return an out-of-memory error, there might be another issue with the script, which the workaround might not resolve. You should inspect the script for a possible memory overflow condition, such as creating large objects in an infinite loop or infinite recursion.

    Workaround: After you verify that the script you are running follows good programming principles and does not return unexpected results, increase the value of the MaxMemoryPerShellMB property of WinRM. The MaxMemoryPerShellMB property represents the maximum amount of memory allocated per shell, including the shell's child processes. The default value of the property is 150 MB. Configure the MaxMemoryPerShellMB value by running the following command.
    c:\> winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="value_in_megabytes"}'

  • WinRM session expiration

    By default, a session between the PowerShell plug-in and a WinRM host times out after 180 seconds, and the host closes the connection. If the PowerShell plug-in tries to communicate with the WinRM host after the connection has expired, the following error message appears: The Windows Remote Shell cannot process the request; the selector value FA3925EF-9051-4FC2-B574-4BB28FD6D684 specified in the request was not found. , document in [EMPTY], document out [EMPTY], (Dynamic Script Module name : invokeCommand#14).

    Workaround: Configure the timeout period on the WinRM host by running the following command.
    c:\> winrm set winrm/config/winrs @{IdleTimeout=value_in_seconds}

  • The Generate an action from a PowerShell script workflow might fail

    The Generate an action from a PowerShell script workflow might fail with the message java.lang.NullPointerException (Workflow:Generate an action from a PowerShell script / Generate action (item0)#4, if the generate a workflow parameter is set to No.

    Workaround: Set the generate a workflow parameter to Yes and choose a workflow category. Then set back generate a workflow to No and run the workflow.

Top of Page