Active Administrator 8.7 - User Guide

PowerShell cmdlets

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. Active Administrator supports the use of PowerShell cmdlets.

Topics 

•	What are cmdlets?

•	Using Active Administrator cmdlets

•	Using cmdlets to get information about the Active Administrator server

•	Using cmdlets to manage the Active Administrator server

•	Using cmdlets to manage Active Administrator tasks

What are cmdlets?

What are cmdlets?

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 Active Administrator®, the Active Administrator cmdlets were automatically installed and registered with Windows PowerShell.

The examples in this section show you leverage the cmdlets available in Active Administrator. These cmdlets allow you to perform many of the functions of Active Administrator in an automation environment. The cmdlets also can be of great use in any environment where a repetitive process involving Active Administrator is needed.

The complete set of cmdlets shipped with the module AA.ServerManagerPowerShellModule.dll is as follows.

 

NOTE: All cmdlets should be run while logged on as an Administrator. Some Active Administrator cmdlets must be run as an Administrator with elevated privileges (if UAC is enabled). The Active Administrator cmdlets should be used only by those familiar with Windows PowerShell. NOTE: Those scripts that run under standard privileges are marked with an asterisk, others require elevated privileges.

 

Table 149. AA Server Manager cmdlets for use with Windows PowerShell®

Cmdlet	Module	Reference
Clear-AFSCache	AA.ServerManagerPowerShellModule	Clearing the AFS cache
Get-AAFeaturesLicenseStatus*	AA.ServerManagerPowerShellModule	Getting the status of Active Administrator licenses
Get-AAWebServerConfiguration	AA.ServerManagerPowerShellModule	Getting configuration settings for the Web server
Get-ADSLoggingStatus	AA.ServerManagerPowerShellModule	Getting logging status for ADS
Get-ADSOperationStatus*	AA.ServerManagerPowerShellModule	Getting operation status for ADS
Get-ADSPort	AA.ServerManagerPowerShellModule	Getting the port number for ADS
Get-AFSLoggingStatus	AA.ServerManagerPowerShellModule	Getting logging status for AFS
Get-AFSOperationStatus*	AA.ServerManagerPowerShellModule	Getting operation status for AFS
Get-AFSPort	AA.ServerManagerPowerShellModule	Getting the port number for AFS
Get-AFSHTTPOperationStatus	AA.ServerManagerPowerShellModule	Getting operation status for the HTTP service
Get-FullTextSearchStatus	AA.ServerManagerPowerShellModule	Getting the status of Full-Text Search
Get-NotificationService OperationStatus*	AA.ServerManagerPowerShellModule	Getting operation status for the Active Administrator Notification Service
Set-AALicense	AA.ServerManagerPowerShellModule	Updating the Active Administrator license
Set-AAWebServerConfiguration	AA.ServerManagerPowerShellModule	Setting configuration for the Active Administrator Web server
Set-ADSPort	AA.ServerManagerPowerShellModule	Setting the port for ADS
Set-AFSAndADSStartup Account	AA.ServerManagerPowerShellModule	Setting the startup account for AFS and ADS
Set-AFSPort	AA.ServerManagerPowerShellModule	Setting the port for AFS
Set-NotificationServiceStartup Account	AA.ServerManagerPowerShellModule	Setting the startup account for the Active Administrator Notification Service
Switch-ADSLoggingStatus	AA.ServerManagerPowerShellModule	Switching logging status of ADS
Switch-ADSOperationStatus	AA.ServerManagerPowerShellModule	Switching operation status of ADS
Switch-AFSLoggingStatus	AA.ServerManagerPowerShellModule	Switching logging status of AFS
Switch-AFSOperationStatus	AA.ServerManagerPowerShellModule	Switching operation status of AFS
Switch-AFSHTTPOperationSatus	AA.ServerManagerPowerShellModule	Switching operation status of the HTTP service
Switch-FullTextSearchStatus	AA.ServerManagerPowerShellModule	Switching the setting of Full-Text Search
Switch-NotificationService OperationStatus	AA.ServerManagerPowerShellModule	Switching operation status of the Active Administrator Notification Service

Using Active Administrator cmdlets

Using Active Administrator cmdlets

 

IMPORTANT: All command utilities should be run while logged on as an Administrator. Some cmdlets must be run as an administrator with elevated privileges (if UAC is enabled). The cmdlets should be used only by those familiar with Windows PowerShell®.

The Active Administrator® cmdlets function very similarly to the included utilities in the AA Server Manager application. The cmdlets are located at C:\Program Files\Quest\Active Administrator\Server\PowerShell.

Viewing help

You can view help by typing the cmdlt name with no arguments or by using get-help.

Running cmdlets

You can run the cmdlets from the PowerShell console (right-click the cmdlet, and choose Run with PowerShell) or PowerShell ISE (open the cmdlet in ISE and click Run).

Using cmdlets manually

If you want to use the cmdlets manually, you must include the two cross-cutting scripts for configuration (ConfigAndLoadModule.ps1) and rights management (EnsureElevatedPrivileges.ps1).

•	ConfigAndLoadModule.ps1 loads the module and updates PowerShell configuration with necessary settings.

Example

if(-Not(&($PSScriptRoot + "\ConfigAndLoadModule.ps1"))){ exit; }

•

EnsureElevatedPrivileges.ps1 uses UAC to rerun the script at the given path with elevated privileges if it finds that the script was run without proper permissions granted. It accepts as a parameter the path to the script that is to be rerun. The script can run from another script as follows, with the caller path detected at run time.

 

NOTE: To run the elevated privileges cmdlet manually, the PowerShell should just be run as administrator.

Example

if(-Not(&($PSScriptRoot + "\EnsureElevatedPrivileges.ps1") -scriptPath $myinvocation.mycommand.definition)){ exit; }

Using cmdlets to get information about the Active Administrator server

Using cmdlets to get information about the Active Administrator server

Use these Active Administrator® cmdlets to see the current settings for the Active Administrator server.

NOTE: These cmdlets use <CommonParameters>, which are a set of PowerShell® cmdlet parameters that you can use with any cmdlet.

Topics 

•	Getting the status of Active Administrator licenses

•	Getting configuration settings for the Web server

•	Getting logging status for ADS

•	Getting operation status for ADS

•	Getting the port number for ADS

•	Getting logging status for AFS

•	Getting operation status for AFS

•	Getting the port number for AFS

•	Getting operation status for the HTTP service

•	Getting the status of Full-Text Search

•	Getting operation status for the Active Administrator Notification Service