VMware Guest - Log out |
Declaration
<AMVMWAREGUEST ACTIVITY="logout" HOSTTYPE="text (options)" SERVER="text" USERNAME="text" PASSWORD="text (encrypted)" VMPATH="text" GUESTUSERNAME="text" CONSOLE="YES/NO" LAUNCHGUI="YES/NO" TIMEOUT="number" GUESTPASSWORD="text (encrypted)" OPENVMTIMEOUT="number" POWERONTIMEOUT="number" TOOLSTIMEOUT="number" LOGINTIMEOUT="number" CONNECTIONTIMEOUT="number" /> |
Description
Removes any guest operating system authentication context created by a previous Login activity.
Practical Usage
Logs out of a currently logged in session.
Parameters
Connection
Property |
Type |
Required |
Default |
Markup |
Description |
Connection |
--- |
--- |
--- |
--- |
Indicates where connection details, guest credentials and other preferences should originate from. This is a visual mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:The available options are:
|
Session |
Text |
Yes if Connection set to Session |
GuestOSOpsSession1 |
SESSION="MySession" |
The name of an existing session to associate this activity with. This parameter is available only if the Connection parameter is set to Session. |
Host type |
Text (options) |
Yes if Connection set to Host |
VMWare VI Server |
|
Indicates the VMware software type running on the host where the virtual machine is located. If you are using VMware Server to connect to a remote host, it does not matter which VMware product (if any) is running on the local host. This parameter is available only if the Connection parameter is set to Host. The available options are:
|
Host name |
Text |
Yes |
(Empty) |
|
The host name or IP address of the computer where the virtual machine is located. This parameter is active only if the Host type parameter is set to VMWare Server (1.0x) or VMWare VI Server (ESX/ESXi, vCenter, VMWare Server 2.0). |
[Host] Username |
Text |
Yes |
(Empty) |
USERNAME="theUser" |
The username identifying a valid user account on the virtual machine. This parameter is active only if the Host type parameter is set to VMWare Server (1.0x) or VMWare VI Server (ESX/ESXi, vCenter, VMWare Server 2.0). |
[Host] Password |
Text |
Yes |
(Empty) |
PASSWORD="encrypted" |
The password identifying a valid user account on the virtual machine. This parameter is active only if the Host type parameter is set to VMWare Server (1.0x) or VMWare VI Server (ESX/ESXi, vCenter, VMWare Server 2.0). |
Virtual machine path |
Text |
Yes |
(Empty) |
VMPATH= "c:\My Virtual Machines\<vm_name>.vmx" |
The path to the virtual machine. (Example: c:\My Virtual Machines\<virtual_machine_name>.vmx ). |
[Guest] Username |
Text |
Yes |
(Empty) |
GUESTUSERNAME="user" |
The username to authenticate the guest user. |
[Guest] Password |
Text |
Yes |
(Empty) |
GUESTPASSWORD="encrypted" |
The password to authenticate the guest user. |
Log onto console session |
Yes/No |
No |
No |
CONSOLE="yes" |
If selected, the user will be logged onto the console session. This parameter is disabled by default. |
Launch GUI |
Yes/No |
No |
No |
LAUNCHGUI="yes" |
If selected, a GUI (Graphic User Interface) will appear on the desktop upon connection. If disabled (default), no GUI will be launched and operations will execute in the background. |
Open VM timeout |
Number |
No |
60 |
OPENVMTIMEOUT="2" |
The maximum time period in seconds during which this activity must be completed or the step times out. The default value is 60 seconds. |
Power on timeout |
Number |
No |
60 |
POWERONTIMEOUT="3" |
The maximum time period in seconds during which the VM must power on or the step times out. The default value is 60 seconds. |
VMware tools timeout |
Number |
No |
300 |
TOOLSTIMEOUT="4" |
The maximum time period in seconds during which VMWare Tools must start on the guest operating system or the step times out. The default value is 300 seconds. |
Log on timeout |
Number |
No |
60 |
LOGINTIMEOUT="5" |
The maximum time period in seconds during which the log on process must be completed or the step times out. The default value is 60 seconds. |
Connection timeout |
Number |
No |
60 |
CONNECTIONTIMEOUT="6" |
The maximum time period in seconds during which a connection must be established or the step times out. The default value is 60 seconds. |
Guest OS Operations
Property |
Type |
Required |
Default |
Markup |
Description |
Timeout (seconds) |
Text |
Yes |
(Empty) |
TIMEOUT="20" |
The maximum value in seconds that this activity should be allowed to execute. |
example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
Logoff guest operating system. Timeout is 120 seconds. Use "theSess1" GuestOS session.the File Exists activity. If the guest file exists, it is copied over to the host machine using the Copy activity. The task ends with a Disconnect step. Comments are included in the task to explain each step.
<AMVMWAREGUEST ACTIVITY="logout" TIMEOUT="120" SESSION="theSess1" /> |