Cisco Cisco Process Orchestrator 3.1 User Guide

Page of 786
15-1
Cisco Process Orchestrator 3.1 User Guide
 
C H A P T E R
 
15
Using the PowerShell Snap-in CLI
The Cisco Process Orchestrator Command Line Interface (CLI) Snap-In leverages the Windows 
PowerShell console to execute scripts using Cisco Process Orchestrator commandlets. If you have the 
appropriate privileges, you can use the CLI commands to more easily control system administration and 
accelerate automation. The CLI is included in the standard Process Orchestrator installation and will 
only execute against the local Process Orchestrator server under the credentials of the current user 
running the CLI command.
Process Orchestrator PowerShell CLI Snap-in consists the of commandlets that allow you to view details 
of the existing processes and targets in the Process Orchestrator server. Using the PowerShell CLI 
Snap-in, you can generate a list of processes and targets, as well as enable and disable specific processes 
and targets.
Step 1
To see a list of all the Process Orchestrator commands, run the following command in the PowerShell 
console:
Get-Command *-Orchestrator*
This will reveal commands such as Export-OrchestratorAutomationPack and 
Import-OrchestratorAutomationPack.
Step 2
Use the Get-Help command to view the syntax help for a command. For example:
  •
To view the syntax for exporting automation packs, enter:
Get-Help Export-OrchestratorAutomationPack –full
  •
To view the syntax for importing automation packs, enter:
Get-Help Import-OrchestratorAutomationPackFile –full
Related Topics
  •
Windows PowerShell 
Owner’s Manual
.
  •
Install Windows PowerShell 2.0
 on the Microsoft web site to 
access the free Windows PowerShell download. Note that you only need to install Powershell 2.0 on 
Windows 2008 because Powershell 2.0 is installed and integrated in Windows 2008R2 and later.