Script execution through the vCenter server: Service details

This service template functions in the VMware vSphere environment to transmit the specified non-interactive script file from the target server to the guest OS on the virtual server through the vCenter server, and then runs the script file on the guest OS. The script file can be deleted if it is no longer needed.

The following is an overview of the processing:

1. Run the PowerCLI commandlet Copy-VMGuestFile on the target server to transmit the specified script from the target server to the guest OS on the virtual server.
2. Run the PowerCLI commandlet Invoke-VMScript on the target server to run the script transmitted in (1). Then, run the scripts on the virtual server by using the following codes.

   Windows batch file (extension .bat):

   "& 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest-property)' 'script-argument-(vmware.scriptParameter-property)' ; exit $LASTEXITCODE"

   Windows PowerShell script (extension .ps1):

   "Set-ExecutionPolicy RemoteSigned -Scope Process ; & 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest-property)' 'script-argument-(vmware.scriptParameter-property)' ; exit $LASTEXITCODE"

   Shell script (extension .sh):

   "/bin/bash 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest-property)' 'script-argument-(vmware.scriptParameter-property)' "

   The standard output and standard error output of each script run on the virtual server is stored in the file on the target server that is specified as the output file path (vmware.scriptOutputFilePath property) of the script.

3. If yes is specified for whether to delete the script (vmware.deleteScriptEnabled property), the script transmitted from the target server to the guest OS on the virtual server can be deleted. To delete the script, use the following code applicable to the virtual server environment.

   Windows-based OS:

   "Remove-Item -LiteralPath 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest-property)' -Force "

   Linux OS:

   "/bin/rm -f 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest-property)' "

Server requirements

The following servers are needed:

• vCenter server

  Server where VMware vCenter Server is installed.

• ESX server

  Server where VMware vSphere ESXi is installed.

• vCenter control server (execution target server)

  Server where VMware vSphere PowerCLI is installed. Plug-ins are transferred to this server and run by this product.

• Virtual server

  Virtual server that is managed by the vCenter server and VMware vSphere ESX.

Prerequisites

• VMware vSphere ESXi must be managed by VMware vCenter Server.
• Conditions related to the settings on VMware vCenter Server:
  • Virtual servers must have a unique name.
  • Server names are case-sensitive in VMware, but not in the vSphere PowerCLI instance run from this plug-in.
• Conditions related to the virtual server:
  • The virtual server must be running.
  • If the virtual server OS is a Windows-based OS, Windows PowerShell 2.0 or later must be installed.
  • VMwareTools must be installed on the virtual server.

Software requirements

One of the following is required:

• VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1
• VMware PowerCLI 6.5 Release1
• VMware PowerCLI 6.5.1, 6.5.4
• VMware PowerCLI 10.1.0, 10.1.1

Usage guidelines

• If a file with the same name exists in the location specified by the path to the script file on the guest OS (vmware.scriptFileOnGuest property) or the path to the output file for the script (vmware.scriptOutputFilePath property), the existing file is overwritten. If any of the folders specified by the file path do not exist, that folder is created and the file is transmitted. Delete the created folder if it is no longer necessary.
• If a folder with the same name exists in the location specified by the path to the script file on the guest OS (vmware.scriptFileOnGuest property), the target script file is transmitted and stored in the existing folder without any change to the file name. If this occurs, the script fails and the service ends abnormally.
• If an error occurs during file transmission, the file that is being transmitted to the virtual server is not deleted automatically. Delete this file if it is not necessary.
• Do not run interactive scripts that need user entry, or scripts that display a UI and do not end automatically.
• Do not run this service template on the same virtual server simultaneously.
• The script specified as the script file on the VMware vCenter control server (vmware.scriptFileOnHost property) is transferred to the guest OS in binary format. Create the script in advance on the guest OS by using executable line break codes and character codes.

Service Definition Properties

The following table lists the properties shown in the Service Definition window.

Service Definition and Submit Service Properties

The following table lists the properties shown in the Service Definition window and the Submit Service window.