Windows
Windows
Windows plugin has been designed to perform actions on a Windows machine.
Compatibility:
Windows 7, Windows Server 2008
Prerequisites:
- Enable WinRM Protocol and set trusted host list value to * on local as well as target system (Refer Appendix 11: Power Shell Remote Connection).
- WMI access on local and target machine (Required for Windows: Create Event Log, Restart Machine and Shutdown Machine steps). This is discussed below.
- PowerShell version 5 and above. This is discussed below.
Following are the steps to provide WMI access on local and target machines.
- Under Control Panel click Windows Firewall
- Click the link – Allow a program or feature through Windows Firewall.
- Enable to allow Windows Management Instrumentation (WMI) at all levels as shown below.
Following are the steps to setup Power Shell version 5 or above,
- Set PowerShell Execution Policy:
- Open PowerShell command prompt in Run as administrator mode
(Go to Start-> Search PowerShell -> Right Click on Windows PowerShell -> Click Run as administrator option)
- Change execution policy of computer to allow running PowerShell scripts by using below:
command: Set-ExecutionPolicy unrestricted –Force
- Check if execution policy is changed by using below command:
command: Get-ExecutionPolicy
- Updating PowerShell Version:
- Download Windows Management Framework from below url: (to update to Windows PowerShell version 5.1or higher)
https://www.microsoft.com/en-us/download/details.aspx?id=54616
System requirements:
- WMF 5.1 requires Microsoft .NET Framework 4.5 or above. You can install Microsoft .NET Framework 4.5 or above by following the instructions at Installing the .NET Framework.
- Use a 64-bit version of Windows.
- Need to restart machine once “Windows Management Framework 5.1“installation is completed.
Note: Open PowerShell by right clicking and select Run As Administrator
- Check if PowerShell version is updated to 5.1 or higher using below command:
Command: $PSVersionTable
Expected output:
Name Value
---- -----
PSVersion 5.1.14409.1005
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.14409.1005
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
Windows: Get Disk Utilization
Description
Windows: Get Disk Utilization plugin step returns the utilization of logical disks on a local or remote windows machine. This is a row generating step.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name (FQDN)/IP address of Windows machine.
2
Username
Specify the username of Windows account to authenticate. You may also provide username in the format <Domain name>\username or <Computer name>\username.
However if you need to connect to a remote machine you need to provide <Domain name>\username.
This field is mandatory.
3
Password
Specify the Password of the Username. Password is stored in encrypted format in the AutomationEdge workflow file. This field is mandatory.
Output Tab:
No.
Field Name
Description
Output Fields Table:
1
Property Name
2
Output Field
Specify an output field to hold the result values for the property. The corresponding Output Field is mandatory.
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button field values are checked. If any required field values are missing, then validation error message is displayed.
If all the required field values are provided then it will save the field values.
2
Cancel
Click this button to cancel the window without saving any values.
Windows: Get Service Status
Description
Windows: Get Service Status plugin step gets the status of a service on a local or remote computer.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name (FQDN)/IP address of Windows machine.
3
Username
Specify the username of Windows account to authenticate. You may also provide username in the format <Domain name>\username or <Computer name>\username.
However, if you need to connect to a remote machine you need to provide <Domain name>\username.
This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
4
Password
Specify the password of the Windows Account. Password is encrypted and is not stored in the .psw workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. This field is mandatory.
5
Service Name
Specify the Service Name to get status. This field is a String.
Output Tab:
No.
Field Name
Description
Output Field:
1
Result
Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”.
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values
Windows: Pause Service
Description
Windows: Pause Service plugin step pause’s a service on a local or remote windows machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name (FQDN)/IP address of Windows machine.
3
Username
Specify the username of Windows account to authenticate. You may also provide username in the format <Domain name>\username or <Computer name>\username.
However, if you need to connect to a remote machine you need to provide <Domain name>\username.
This field is mandatory.
4
Password
Specify the Password of the Username. Password is stored in encrypted format in the AutomationEdge workflow file. This field is mandatory.
5
Service Name
Specify the Windows Service Name to be paused.
Only Windows services that have a pause option can be specified. This field is a String. This field is mandatory.
Make sure to get the Windows Service name by right clicking on the service and clicking Properties. Copy the ‘Service name’
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button field values are checked. If any required field values are missing then validation error message is displayed.
If all the required field values are provided then it will save the field values.
2
Cancel
Click this button to cancel the window without saving any values.
Windows: Restart Machine
Description
Windows: Restart Machine plugin step restarts a remote windows machine.
This step restarts the remote machine only. Do not use this step to restart local machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of a remote Windows machine to be restarted.
The data type is String. This field is mandatory.
3
Username
Specify the username of Windows account to authenticate.
This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
4
Password
Specify the password of the Windows Account. Password is encrypted and is not stored in the .psw workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. This field is mandatory.
5
Force Restart
Force Restart. Allowed values are only “ ‘YES’, ‘NO’”.
This field is mandatory. The data type is a String.
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing, then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values
Windows: Restart Service
Description
Windows: Restart Service plugin step restarts a service on a local or remote windows machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of Windows machine. This field is mandatory.
3
Username
Specify the username of Windows account to authenticate.
This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
4
Password
Specify the password of the Windows Account. Password is encrypted and is not stored in the .psw workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. This field is mandatory.
5
Service Name
Specify the Service Name to be restarted.
This field is mandatory. This field is a String.
6
Force Restart
Force Restart. Allowed values are only “ ’YES’, ‘NO’”
Note: In case of exception a windows Return value does not occur if Force Stop option is YES.
This field is mandatory. This data type is a String.
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values
Windows: Resume Service
Description
Windows: Resume Service plugin step resumes a paused service on a local or remote windows machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name (FQDN)/IP address of Windows machine.
3
Username
Specify a Windows username to authenticate. You may also provide username in the format <Domain name>\username or <Computer name>\username.
However if you need to connect to a remote machine you need to provide <Domain name>\username.
This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
4
Password
Specify the Password of the Username. Password is stored in encrypted format in the AutomationEdge workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. This field is mandatory.
5
Service Name
Specify the Windows Service Name of a paused service to be resumed. Only Windows services that have pause and resume options can be specified.
This field is a String. The field is mandatory.
Make sure to get the Windows Service name by right clicking on the service and clicking Properties. Copy the ‘Service name’
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing, then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values
Windows: Shutdown Machine
Description
Windows: Shutdown Machine plugin step shuts down a remote windows machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of a remote Windows machine to be Shutdown.
The data type is string. This field is mandatory.
3
Username
Specify the username of Windows account to authenticate.
The data type is string. This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
The data type is string. This field is mandatory.
4
Password
Specify the password of the Windows Account. Password is encrypted and is not stored in the .psw workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.
The data type is string. This field is mandatory.
5
Force Shutdown
Allowed values for Force Shutdown are “’YES’, ‘NO’”.
The data type is string. This field is mandatory.
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing, then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values
Windows: Start Service
Description
Windows: Start Service plugin step starts a service on a local or remote windows machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of Windows machine. This field is mandatory.
3
Username
Specify the username of Windows account to authenticate.
This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
4
Password
Specify the Password of the Username. Password is stored in encrypted format in the AutomationEdge workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. This field is mandatory.
5
Service Name
Specify the Windows Service Name to be started.
Make sure to get the Windows Service name by right clicking on the service and clicking Properties. Copy the ‘Service name’
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values
Windows: Stop Service
Description
Windows: Stop Service plugin step stops a service on a local or remote windows machine.
Configurations
Input Tab:
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
1
Host
Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of Windows machine.
The data type is string. This field is mandatory.
3
Username
Specify the username of Windows account to authenticate.
The data type is string. This field is mandatory.
Password:
3
Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
The data type is string. This field is mandatory.
4
Password
Specify the password of the Windows Account. Password is encrypted and is not stored in the .psw workflow file.
Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.
The data type is string. This field is mandatory.
5
Service Name
Specify the Service Name to be stopped.
The data type is string. This field is mandatory.
6
Force Stop
Force Stop option. Allowed values are only “’YES’, ‘NO’”.
The data type is string. This field is mandatory.
Note: In case of exception a windows Return value does not occur if Force Stop option is YES.
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values