

Wikiversity has learning resources about PowerShell
- PowerShell on GitHub
- Windows PowerShell Survival Guide on TechNet Wiki
August 23, 2023
Citrix Federated Authentication Service provides various Microsoft Windows PowerShell cmdlets in a PowerShell snapin. These cmdlets allow you to perform advanced configuration functions.
Microsoft designed PowerShell to provide more task automation and configuration management tools based
on the .NET Framework. PowerShell includes a command line shell and an extensive scripting language that uses small programs called “cmdlets”.
PowerShell’s capabilities provide creative ways to simplify and automate tedious and repetitive tasks
by creating scripts and combining them with multiple commands.
Extension | Description |
---|---|
.ps1 | Script file[111] |
.psd1 | Module’s manifest file; usually comes with a script module or binary module[112] |
.psm1 | Script module file[113] |
.dll | DLL-compliant[a] binary module file[114] |
.ps1xml | Format and type definitions file[49][115] |
.xml | XML-compliant[b] serialized data file[116] |
.psc1 | Console file[117] |
.pssc | Session configuration file[118] |
.psrc | Role Capability file[119] |
- cmdlets (.NET Framework programs designed to interact with PowerShell)
- PowerShell scripts (files suffixed by
.ps1
) - PowerShell functions
- Standalone executable programs
Extended Type System
The number of cmdlets included in the base PowerShell install has generally increased with each version:
Version | Cmdlets | Ref |
---|---|---|
Windows PowerShell 1.0 | [38] | |
Windows PowerShell 2.0 | [39] | |
Windows PowerShell 3.0 | [40] | |
Windows PowerShell 4.0 | ? | |
Windows PowerShell 5.0 | [41] | |
Windows PowerShell 5.1 | [] | |
PowerShell Core 6.0 | ? | |
PowerShell Core 6.1 | ? | |
PowerShell Core 6.2 | ? | |
PowerShell 7.0 | [] | |
PowerShell 7.1 | ? | |
PowerShell 7.2 | ? | |
PowerShell 7.4 |
# Definition of static parameters # Definition of dynamic parameters # Set of instruction to run at the start of the pipeline # Main instruction sets, ran for each item in the pipeline # Set of instruction to run at the end of the pipeline
![]() | |
![]() Screenshot of a PowerShell 7 session in Windows Terminal | |
Paradigm | Imperative, pipeline, object-oriented, functional and reflective |
---|---|
Designed by | Jeffrey Snover, Bruce Payette, James Truher (et al.) |
Developer | Microsoft |
First appeared | November 14, 2006; 17 years ago |
Stable release | |
Typing discipline | Strong, safe, implicit and dynamic |
Implementation language | C# |
Platform | PowerShell: .NET Windows PowerShell: .NET Framework |
OS | |
License | MIT License[2] (but the Windows component remains proprietary) |
Filename extensions |
|
Website | |
Influenced by | |
Python, Ksh, Perl, C#, CL, DCL, SQL, Tcl, Tk,[3] Chef, Puppet |
PowerShell includes its own extensive, console-based help (similar to man pages in Unix shells) accessible via the Get-Help
cmdlet. Updated local help contents can be retrieved from the Internet via the Update-Help
cmdlet. Alternatively, help from the web can be acquired on a case-by-case basis via the -online
switch to Get-Help
.
Application | Version | Cmdlets | Provider | Management GUI |
---|---|---|---|---|
Exchange Server | 2007 | 402 | Yes | Yes |
Windows Server | 2008 | Yes | Yes | No |
Microsoft SQL Server | 2008 | Yes | Yes | No |
Microsoft SharePoint | 2010 | Yes | Yes | No |
System Center Configuration Manager | 2012 R2 | 400+ | Yes | No |
System Center Operations Manager | 2007 | 74 | Yes | No |
System Center Virtual Machine Manager | 2007 | Yes | Yes | Yes |
System Center Data Protection Manager | 2007 | Yes | No | No |
Windows Compute Cluster Server | 2007 | Yes | Yes | No |
Microsoft Transporter Suite for Lotus Domino[120] | 08.02.0012 | 47 | No | No |
Microsoft PowerTools for Open XML[121] | 1.0 | 33 | No | No |
IBM WebSphere MQ[122] | 6.0.2.2 | 44 | No | No |
IoT Core Add-ons[123] | 74 | Unknown | Unknown | |
Quest Management Shell for Active Directory[124] | 1.7 | 95 | No | No |
Special Operations Software Specops Command[125] | 1.0 | Yes | No | Yes |
VMware vSphere PowerCLI[126] | 6.5 R1 | 500+ | Yes | Yes |
Internet Information Services[127] | 7.0 | 54 | Yes | No |
Windows 7 Troubleshooting Center[128] | 6.1 | Yes | No | Yes |
Microsoft Deployment Toolkit[129] | 2010 | Yes | Yes | Yes |
NetApp PowerShell Toolkit[130][131] | 4.2 | 2000+ | Yes | Yes |
JAMS Scheduler – Job Access & Management System[132] | 5.0 | 52 | Yes | Yes |
UIAutomation[133] | 0.8 | 432 | No | No |
Dell Equallogic[134] | 3.5 | 55 | No | No |
LOGINventory[135] | 5.8 | Yes | Yes | Yes |
SePSX[136] | 0.4.1 | 39 | No | No |
Initially using the code name “Monad”, PowerShell was first shown publicly at the Professional Developers Conference in October 2003 in Los Angeles. All major releases are still supported, and each major release has featured backwards compatibility with preceding versions.
Windows PowerShell 1.0

Windows PowerShell 2.0

Windows PowerShell 3.0
- Scheduled jobs: Jobs can be scheduled to run on a preset time and date using the Windows Task Scheduler infrastructure.
- Session connectivity: Sessions can be disconnected and reconnected. Remote sessions have become more tolerant of temporary network failures.
- Improved code writing: Code completion (IntelliSense) and snippets are added. PowerShell ISE allows users to use dialog boxes to fill in parameters for PowerShell cmdlets.
- Delegation support: Administrative tasks can be delegated to users who do not have permissions for that type of task, without granting them perpetual additional permissions.
- Help update: Help documentations can be updated via Update-Help command.
- Automatic module detection: Modules are loaded implicitly whenever a command from that module is invoked. Code completion works for unloaded modules as well.
- New commands: Dozens of new modules were added, including functionality to manage disks
get-WmiObject win32_logicaldisk
, volumes, firewalls, network connections, and printers, which had previously been performed via WMI.[further explanation needed]
Windows PowerShell 4.0
New features in PowerShell 4.0 include:
- Desired State Configuration:[83][84][85] Declarative language extensions and tools that enable the deployment and management of configuration data for systems using the DMTF management standards and WS-Management Protocol
- New default execution policy: On Windows Servers, the default execution policy is now
RemoteSigned
. - Save-Help: Help can now be saved for modules that are installed on remote computers.
- Enhanced debugging: The debugger now supports debugging workflows, remote script execution and preserving debugging sessions across PowerShell session reconnections.
- -PipelineVariable switch: A new ubiquitous parameter to expose the current pipeline object as a variable for programming purposes
- Network diagnostics to manage physical and Hyper-V‘s virtualized network switches
- Where and ForEach method syntax provides an alternate method of filtering and iterating over objects.
Windows PowerShell 5.0

Key features included:
- The new
class
keyword that creates classes for object-oriented programming - The new
enum
keyword that creates enums OneGet
cmdlets to support the Chocolatey package manager[87]- Extending support for switch management to layer 2 network switches.[88]
- Debugging for PowerShell background jobs and instances of PowerShell hosted in other processes (each of which is called a “runspace”)
- Desired State Configuration (DSC) Local Configuration Manager (LCM) version 2.0
- DSC partial configurations
- DSC Local Configuration Manager meta-configurations
- Authoring of DSC resources using PowerShell classes
Windows PowerShell 5.1
PowerShell Core 6
- The
-Parallel
switch for theForEach-Object
cmdlet to help handle parallel processing - Near parity with Windows PowerShell in terms of compatibility with built-in Windows modules
- A new error view
- The
Get-Error
cmdlet - Pipeline chaining operators (
&&
and||
) that allow conditional execution of the next cmdlet in the pipeline - The ?: operator for ternary operation
- The
??
operator for null coalescing - The
??=
operator for null coalescing assignment - Cross-platform
Invoke-DscResource
(experimental) - Return of the
Out-GridView
cmdlet - Return of the
-ShowWindow
switch for theGet-Help
Desired State Configuration
Upon running a configuration, DSC will ensure that the system gets the state described in the configuration. DSC configurations are idempotent. The Local Configuration Manager (LCM) periodically polls the system using the control flow described by resources (imperative pieces of DSC) to make sure that the state of a configuration is maintained.
Cmdlets
Was this helpful
Send us your feedback
Instructions for Contributors
Citrix Federated Authentication Service 2112 PowerShell cmdlets
August 23, 2023
August 23, 2023
In this article
Was this helpful
Send us your feedback
Instructions for Contributors
0 PowerShell Cmdlets for Environment Configuration
Did you find this summary helpful?
Thank you for your feedback
Version 9.0 comes with a bundle of new PowerShell cmdlets to configure your Real-Time DX environment.
What’s New?
Install and configure ControlUp Monitors
Change the Real-Time security policy
Allow remediation actions
Azure cloud connections
Horizon EUC environment connections
Before version 9.0, you were required to install monitors using the Real-Time DX Console. Now, you can deploy via the ControlUp Automation module. The updates include:
ControlUp.Automation module installation. You install the monitor with the module using the token.
Download the PowerShell module here.
Import ControlUp Automation Module
After you download the module, you can starting using the module. Run all cmdlets locally on the machine on which you want to deploy, upgrade or uninstall the monitor.
Install-Module ControlUp.Automation
Import-Module ControlUp.Automation
Install and configure monitors
Installs a new ControlUp Monitor on the machine | |
Updates a previously installed 9.0 ControlUp monitor. | |
Uninstalls ControlUp Monitor from the local machine. |
Invoke-CUMonitorUpdate
Invoke-CUMonitorUpdate
-ZipFilePath <string>
-Version or -Latest <string>
-ProxySettings <ProxySettingsObject>
To update the existing 9.0 ControlUp Monitor, you have two options: either supply the ZIP file containing the latest version or specify the desired version directly using the -Version
parameter. When using -Version
, the system automatically downloads the appropriate ZIP file from the ControlUp Cloud and places it on the local machine for installation. Note, however, that upgrading the monitors from version 8.8 with this cmdlet isn’t supported yet.
Specify the full path to the ZIP folder containing the ControlUp Monitor installation files. If you don’t have the ZIP file, please request it from our support team. In the absence of this parameter, the latest ControlUp Monitor version (hosted in our cloud) will be used. | ||
Switch parameter for -Latest, full name of the monitor version. | Yes, if no -Latest | |
Switch parameter for -Version, latest monitor version. If provided, overrides -Version. | Yes, if no -Version | |
Proxy settings that the monitor will use to connect to the ControlUp services. If not provided, the default system proxy settings will be used. Example to create proxy settings variable:
|
Uninstall-CUMonitor
Uninstall-CUMonitor
-Force
<CommonParameters>
Uninstalls the ControlUp Monitor from the local machine.
Uninstalls the monitor even if backend errors occur. |
Change security policy
Creates new security policy role columns in the Security Policy panel with the Manage Solve and Use Web Application permissions set to Allow. You must configure the New-CUPolicyRoleDescriptor cmdlet before you run Add-CUPolicyRoles. Possible configurations include adding role members with New-CUPolicyRoleMember and configuring permissions set for folder with New-PolicyRoleAcl. | |
Retrieves list of all security policy roles and members. | |
Retrieves list of all available permission entries. | |
Adds a new policy role description. | |
Adds a new policy role member. | |
Adds a new policy role to the Access Control List (ACL) with permission to open the web UI without entering UPN credentials. |
Customers. Creates new role to add members and to configure the Manage Solve and Use Web Application permissions.
$role=New-CUPolicyRoleDescription -RoleName "ControlUp Admins"
New-CUPolicyRoleMember -Role $role -SecurityIdentifier 7d1a5930-0739-4eb5-8825-36ee10edd233 -DisplayName "Organization Engineer DW"
$customer=New-CUPolicyRoleDescription -RoleName "Customers"
New-CUPolicyRoleMember -Role $customer -SecurityIdentifier d09e999a-29ff-4be3-aeff-384ecf92b1d2 -DisplayName "Organization Customer DW"
$permissions=@{ `"1B5974A1-3487-4054-8DF9-941318F7E2B6"=$true; ` # Use solve
"5AD549BF-A0AA-4241-A5F6-B11FFBD21F3A"=$false ` # Manage solve}
New-CUPolicyRoleAcl -Role $customer -FolderId 00000000-0000-0000-0000-000000000000 -Entries $permissions
Add-CUPolicyRoles -Roles $role, $customer
Allow remediation actions
Allows ControlUp to perform remediation actions on monitors. |
Set-MonitorMgmtAllowed -MonitorMgmtAllowed $true
Manage API tokens
Retrieves your current active profile. | |
Enables you to switch between different profiles. Syntax example: Set-CUAPIProfile -Profile <org-name> | |
Your tokens are securely stored and associated with profile names in the .cuapi file, for example:
{
"current": "username-dev",
"profiles": [
{
"name": "default",
"token": "<encrypted token>"
},
{
"name": "controlup demo",
"token": "<encrypted token>"
},
{
"name": "username-dev",
"token": "<encrypted token>"
}
]
Manage cloud connections
In version 9.0, you can use these cmdlets to manage Azure cloud connections only.
Creates a new cloud connection with Azure connection type. | |
Retrieves list of all cloud connections. | |
Removes a connection by unique ID. | |
Updates your existing site with the subscription credentials of another site that you add and configure. |
Add-CUCloudConnection syntax example:
Add-CUCloudConnection
-Type Azure
-TenantID <TenantID>
-Site <SiteID>
-Credentials <Credentials>
-Proxy <ProxyName>
-DataCollectors <DataCollector1, DataCollector2>
-EnableAvd <true>
Manage Horizon EUC environment connections
Only Horizon Standard architecture is supported for Horizon EUC environment connection cmdlets, not Cloud Pod Architecture (CPA).
Creates a new Horizon connection. | |
Retrieves list of all EUC connections. | |
Removes an EUC connection by unique ID. | |
Removes the existing Horizon connection. |
Was this article helpful?
Comparison of cmdlets with similar commands
-
ls
andman
aliases are absent in the Linux version of PowerShell Core. - Clear-Host is implemented as a predefined PowerShell function.
- Available in Windows NT 4, Windows 98 Resource Kit, Windows 2000 Support Tools
- Introduced in Windows XP Professional Edition
- Also used in UNIX to send a process any signal, the “Terminate” signal is merely the default
-
curl
andwget
aliases are absent from PowerShell Core, so as to not interfere with invoking similarly named native commands.
About the Enterprise Vault Management Shell
In earlier versions of Enterprise Vault, you needed to import certain modules to use PowerShell cmdlets that the Enterprise Vault Management Shell did not automatically load. This is not the case in Enterprise Vault 12.3 and later, where all the Enterprise Vault PowerShell cmdlets are immediately available in the Management Shell.
Do you want to run software from this untrusted publisher?
To stop the prompt from reappearing, type A (for Always run). This option installs a code signing certificate that lets you load and run all the Enterprise Vault PowerShell cmdlets on the system.
To access and run the cmdlets
Start a shell in PowerShell.
JAMS PowerShell Cmdlets
The PowerShell cmdlets listed below cannot be used with PowerShell
Core.
Installation
- Install the Federated Authentication Service.
- Install the Federated Authentication Service PowerShell snapin using the following command:
Add-PSSnapin Citrix.Authentication.FederatedAuthenticationService.V1
<!--NeedCopy-->
In a PowerShell window, you can use Get-Help <cmdlet name> to display cmdlet help.