PowerShell cmdlets
Previous
Microsoft® Windows PowerShell® is a Windows® command-line shell and scripting language designed specifically for system administrators and built on top of the Microsoft .NET Framework. Secure Copy® supports the use of PowerShell cmdlets.
Topics:
● Using the PowerShell cmdlets
● Running the File System Statistics Analyzer
What are cmdlets?
Previous
Windows PowerShell® has the concept of cmdlets. A cmdlet is a simple, single-function command that manipulates objects and is designed to be used in combination with other cmdlets.
If you already had Windows PowerShell installed on your computer before you installed Secure Copy®, the Secure Copy cmdlets were automatically installed and registered with Windows PowerShell.
The examples in this section show you leverage the cmdlets available in Secure Copy. These cmdlets allow you to perform some of the functions of Secure Copy in an automation environment. The cmdlets also can be of great use in any environment where a repetitive process involving Secure Copy is needed.
The complete set of Secure Copy PowerShell cmdlets is as follows.
Table 28. Secure Copy cmdlets for use with Windows PowerShell
|
Cmdlet |
Module |
Reference |
|
Start-SecureCopyJob |
SCYPowerShellCore |
|
|
Remove-SecureCopyJob |
SCYPowerShellCore |
|
|
Start-FileSystemStatistics |
FileSystemStatisticsPowerShell |
|
|
NOTE: All cmdlets should be run while logged on as an Administrator. The Secure Copy cmdlets should be used only by those familiar with Windows PowerShell. |
Using the PowerShell cmdlets
Previous
You can run Secure Copy from the PowerShell cmdlets in the SCYPowerShellCore PowerShell module. You can run the File System Statistics Analyzer from the PowerShell cmdlets in the FileSystemStatisticsPowerShell PowerShell module.
To use the Secure Copy PowerShell cmdlets, you need to import the modules, which are located in the Secure Copy 7 installation folder.
To import the PowerShell modules, run the following:
Import-Module "C:\Program Files\Quest\Secure Copy 7\SCYPowerShellCore.dll"
Import-Module "C:\Program Files\Quest\Secure Copy 7\Analyzer\FileSystemStatisticsPowerShell.dll"
Managing copy jobs
Previous
Similar to the SecureCopyCmd.exe runs from the command line, the SCYPowerShellCore PowerShell module offers only limited options to script, because it references the features of a saved job by using the name of that job.
|
|
NOTE: You must use SCYPowerShellCore PowerShell module from a computer that has a fully licensed version of Secure Copy 7 installed. You cannot copy the SCYPowerShellCore PowerShell module from computer to computer. |
The SCYPowerShellCore PowerShell module contains two cmdlets: