Windows Server Solutions Cmdlets in Windows PowerShell

Article
11/01/2013

Applies To: Windows Server 2012 Essentials

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Windows Server Solutions Cmdlets

This reference provides cmdlet descriptions and syntax for all WSS cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

Cmdlet	Description
Add-WssBackupConfiguration	Adds a backup file specification to a volume that is part of a backup.
Add-WssBackupSchedule	Adds a date and time to a backup policy for use as a backup schedule.
Add-WssBackupSystemRecovery	Adds a bare metal recovery option to a scheduled backup policy.
Add-WssBackupTarget	Adds a backup target to a scheduled backup.
Add-WssBackupVolume	Adds a volume to a scheduled backup policy.
Add-WssComputerAccess	Creates a relationship between a user and a computer for Remote Web Access.
Add-WssDisksToSpacesPool	Adds physical disks to a storage pool.
Add-WssFolder	Creates a new server folder.
Add-WssLocalMachineCert	Adds or renews a certificate for the current computer.
Add-WssRemoteWebAccessLink	Adds a link to the the homepage of a Remote Web Access website.
Add-WssUser	Adds a new user account.
Clear-WssAlert	Deletes an alert.
Copy-WssClientRecoveryImage	Copies files needed to build a client recovery image to a USB device.
Disable-FolderRedirection	Disables the group policy setting for folder redirection.
Disable-SecurityPolicy	Disables predefined security group policies.
Disable-WssAlert	Disables and ignores an alert.
Disable-WssBackupPolicy	Disables and removes a scheduled server backup policy.
Disable-WssClientBackup	Disables client backup for a computer.
Disable-WssClientBackupVolume	Disables backup for a volume on a client.
Disable-WssRemoteWebAccess	Disables Remote Web Access.
Enable-FolderRedirection	Enables the group policy setting for folder redirection.
Enable-SecurityPolicy	Enables predefined security group policies.
Enable-WssAlert	Enables an alert.
Enable-WssClientBackup	Enables client backup for a computer.
Enable-WssClientBackupVolume	Enables backup for a volume on a computer.
Enable-WssRemoteWebAccess	Enables Remote Web Access.
Exit-WssDomain	Removes a server from a domain.
Get-WssAddIn	Gets installed add-ins.
Get-WssAlert	Gets alerts that the server generated.
Get-WssAlertEmailSetting	Gets settings for alert email notification.
Get-WssBackupConfiguration	Gets file specifications from a volume that is part of a backup. Retrieves files specifications from a volume that is to be backed up.
Get-WssBackupDisk	Gets a list of online hard disks that can be backup targets and can store server backups.
Get-WssBackupJob	Gets the status of current or previous backup jobs.
Get-WssBackupPolicy	Gets the current scheduled backup policy.
Get-WssBackupSchedule	Gets the backup schedule from a scheduled backup policy.
Get-WssBackupSet	Gets a collection of backup sets from a server backup.
Get-WssBackupSystemRecovery	Gets a bare metal recovery option from a scheduled backup policy.
Get-WssBackupTarget	Retrieves all backup targets from a scheduled backup policy.
Get-WssBackupVolume	Gets backup volumes from a server, from a scheduled backup policy, or from existing backups.
Get-WssClientBackup	Gets information about client backup jobs.
Get-WssClientBackupClient	Gets a list of clients that the server can back up.
Get-WssClientBackupOperationStatus	Gets the status of backup-related operations.
Get-WssClientBackupVolume	Gets the volume configuration of a computer.
Get-WssClientBackupVolumeJob	Gets backup information for a backup volume job.
Get-WssComputer	Gets device information objects for the computers in a network.
Get-WssDisk	Gets an object that represents a disk.
Get-WssDomainNameConfiguration	Gets the domain name configuration of Windows Server 2012.
Get-WssDrive	Gets an object that represents a drive.
Get-WssDriveInUse	Checks whether a drive is in use.
Get-WssFileHistoryConfiguration	Gets the File History configuration settings for the server.
Get-WssFileHistoryManagementStatus	Gets the File History managed status of a computer.
Get-WssFolder	Gets an object that represents a folder.
Get-WssGlobalClientBackupPolicy	Gets the current global client backup policy.
Get-WssMediaLibraryName	Gets the name of the Media Library.
Get-WssMediaServerEnabled	Gets the status of media streaming for a server.
Get-WssMediaSharedFolder	Gets the shared folders included in the Media Library.
Get-WssMountVhd	Gets a collection of VHDs from a backup set.
Get-WssPasswordPolicy	Gets the current password policy for a server.
Get-WssRecoveryItem	Gets child recovery items from a parent recovery item.
Get-WssRemoteConnection	Retrieves a listing of remote connections from Remote Web Access clients, VPN clients, or Web API applications.
Get-WssRemoteWebAccessBackgroundImage	Retrieves the filename of the background image displayed on the Remote Web Access website.
Get-WssRemoteWebAccessLink	Retrieves the collection of links on the home page of a Remote Web Access website.
Get-WssRemoteWebAccessLogo	Retrieves the name of the file that contains the logo for the Remote Web Access website.
Get-WssRemoteWebAccessStatus	Retrieves the status of a Remote Web Access website.
Get-WssRemoteWebAccessTitle	Retrieves the title string of a Remote Web Access website.
Get-WssRouterInformation	Retrieves information about the router for the local network.
Get-WssServerConnectionOption	Retrieves the server connection option.
Get-WssSpacesPool	Retrieves a storage pool, or all storage pools in the system.
Get-WssUser	Retrieves a user account by name or security identifier.
Get-WssWinSatCpuScore	Gets the Windows Experience Index processor subscore.
Get-WssWinSatCpuScoreUserConfigurable	Retrieves a setting that determines if a user can configure the CPU assessment.
Import-WssUser	Imports a user from Active Directory.
Initialize-WssBackupDisk	Prepares a disk for, or removes a disk from, a Windows Server® 2012 Essentials backup.
Initialize-WssDisk	Initializes a disk for Windows Server 2012 Essentials storage.
Install-WssAddIn	Installs or redeploys an add-in package.
Install-WssVpnServer	Installs a VPN server.
Invoke-WssBpaScan	Starts a BPA scan.
Join-WssDomain	Joins the server to a domain.
Measure-WssFolder	Calculates the size of a given server folder.
Move-WssFolder	Moves a server folder to a different drive.
New-WssBackupConfiguration	Creates a file specification that specifies the files and folders to include in or exclude from a backup.
New-WssBackupTarget	Creates a backup target from a backup disk.
New-WssRecoveryOption	Creates a recovery configuration for a file restore operation.
Remove-WssBackupConfiguration	Removes a file specification from a backup volume.
Remove-WssBackupSchedule	Removes a backup schedule from a scheduled backup policy.
Remove-WssBackupSystemRecovery	Removes a bare metal recovery option from a scheduled backup policy.
Remove-WssBackupTarget	Removes a backup target from a scheduled backup policy.
Remove-WssBackupVolume	Removes a backup volume from a scheduled backup policy.
Remove-WssComputer	Removes a client computer identity, backup, and properties from the network.
Remove-WssComputerAccess	Removes a relationship between a user and a computer for Remote Web Access.
Remove-WssFolder	Removes a server folder.
Remove-WssRemoteWebAccessLink	Removes a link from the home page of a Remote Web Access website.
Remove-WssUser	Deletes a user.
Repair-WssAlert	Repairs an alert.
Repair-WssMediaStreamingMetadata	Repairs the database that stores information for media streaming.
Repair-WssRemoteWebAccess	Repairs Remote Web Access.
Repair-WssRouterConfiguration	Repairs the router configuration.
Resume-WssBackupPolicy	Resumes the scheduled task that runs server backup in TaskScheduler.
Select-WssMountVhd	Selects a VHD from a backup set to mount for a file restore operation.
Set-WssAlertEmailSetting	Changes settings for alert email notification.
Set-WssBackupPolicy	Creates or changes a scheduled backup policy.
Set-WssClientBackup	Changes job retention policy and description for a client backup.
Set-WssClientBackupVolumeExcludedFolder	Specifies folders to exclude from client backup on a computer.
Set-WssDomainNameConfiguration	Changes the domain name configuration of the server.
Set-WssDrive	Changes drive name or whether to enable snapshots.
Set-WssFileHistoryConfiguration	Changes the File History configurations settings for the server.
Set-WssFileHistoryManagementStatus	Changes the File History managed status of a computer.
Set-WssFolder	Changes the settings of a server folder.
Set-WssGlobalClientBackupPolicy	Changes the global client backup policy.
Set-WssImportGroup	Specifies a security group for the NAS Limit.
Set-WssMediaLibraryInclusion	Includes or excludes the specified shared folder from the Media Library.
Set-WssMediaLibraryName	Changes the name of the Media Library.
Set-WssMediaServerEnabled	Enables or disables media streaming on a server.
Set-WssRemoteWebAccessBackgroundImage	Sets the background image for a Remote Web Access website.
Set-WssRemoteWebAccessLogo	Sets the path and filename of the logo image for the Remote Web Access website.
Set-WssRemoteWebAccessTitle	Modifies the title string of a Remote Web Access website.
Set-WssServerConnectionOption	Modifies the server connection option.
Set-WssUserAccess	Modifies the user access setting.
Set-WssWinSatCpuScore	Modifies the Windows Experience Index processor subscore.
Start-WssBackupJob	Starts a manual server backup.
Start-WssClientBackup	Starts a client backup for a computer.
Start-WssClientBackupRepair	Starts an attempt to repair the database of client computer backups.
Start-WssServerFileRestore	Starts a file restore operation.
Start-WssServerVolumeRestore	Starts a volume restore operation.
Stop-WssBackupJob	Cancels the currently running backup job.
Stop-WssClientBackup	Cancels a client backup for a computer.
Stop-WssClientBackupRepair	Stops the attempt to repair a database of client computer backups.
Suspend-WssBackupPolicy	Stops a scheduled task from running the next scheduled backup.
Sync-WssUser	Refreshes user account information from a domain controller.
Test-WssAlertEmail	Sends a test alert email.
Test-WssDrive	Checks a drive for file system errors, and optionally repairs errors.
Test-WssHealth	Performs an evaluation of all health checks.
Test-WssVpnServerInstallation	Checks for an installation of VPN server.
Uninstall-WssAddIn	Uninstalls an add-in.
Uninstall-WssVpnServer	Uninstalls a VPN server.

Note

To list all the cmdlets that are available, use the Get-Command –Module WindowsServerSolutions cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

● Get-Help <cmdlet name> -Detailed
● Get-Help <cmdlet name> -Examples
● Get-Help <cmdlet name> -Full

Windows Server Solutions Cmdlets in Windows PowerShell

Windows Server Solutions Cmdlets

Additional resources