Export (0) Print
Expand All
Expand Minimize
1 out of 1 rated this helpful - Rate this topic

Windows Server Essentials Cmdlets in Windows PowerShell

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

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 Essentials Cmdlets

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

 

Cmdlet Description

Add-HostedEmailAccount

Creates a hosted email account and assigns it to a network user account.

Add-O365User

Creates an Office 365 account and assigns it to a local user account.

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-WssMsoGroup

Adds a security group and assigns it to a Windows Server 2012 R2 Essentials user group.

Add-WssMsoUser

Add an online service account, and assign it to a user account.

Add-WssRemoteWebAccessLink

Adds a link to the the homepage of a Remote Web Access website.

Add-WssUser

Adds a new user account.

Add-WssUserGroup

Adds a user group to the Windows Server 2012 R2 Essentials dashboard.

Add-WssUserGroupMembership

Adds a user account to a user group.

Clear-AssignedHostedEmailAccount

Removes the relationship between a hosted email account and a local user account.

Clear-O365AssignedUser

Clears the assignment of an Office 365 account to a local network user account.

Clear-WssAlert

Deletes an alert.

Copy-WssClientRecoveryImage

Copies files needed to build a client recovery image to a USB device.

Disable-ExchangeIntegration

Disables on-premises Exchange Server Integration.

Disable-FolderRedirection

Disables the group policy setting for folder redirection.

Disable-HostedEmailAccount

Disables the hosted email account assigned to a local user account.

Disable-HostedEmailIntegration

Disables the hosted email integration module.

Disable-O365Integration

Disables the Office 365 Integration Module.

Disable-O365User

Disables an Office 365 account that is assigned to a local network user account.

Disable-SecurityPolicy

Disables predefined security group policies.

Disable-WssBranchCache

Disables BranchCache.

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-WssMsoIntegration

Disables integration between Windows Server 2012 R2 Essentials and Windows Azure AD.

Disable-WssMsoSharePointPermissionInheritance

Disables permission inheritance for a SharePoint Online securable object.

Disable-WssMsoUser

Disables an online service account.

Disable-WssRemoteWebAccess

Disables Remote Web Access.

Enable-ExchangeIntegration

Enables on-premises Exchange Server Integration.

Enable-FolderRedirection

Enables the group policy setting for folder redirection.

Enable-HostedEmailAccount

Enables the hosted email account assigned to a local user account.

Enable-HostedEmailIntegration

Enables the hosted email integration module.

Enable-O365Integration

Enables the Office 365 Integration Module.

Enable-O365User

Enables an Office 365 account that is assigned to a local network user account.

Enable-SecurityPolicy

Enables predefined security group policies.

Enable-WssAlert

Enables an alert.

Enable-WssBranchCache

Enables BranchCache.

Enable-WssClientBackup

Enables client backup for a computer.

Enable-WssClientBackupVolume

Enables backup for a volume on a computer.

Enable-WssIntuneIntegration

Enables integration between Windows Server 2012 R2 Essentials and Windows Intune.

Enable-WssMsoIntegration

Enables integration between Windows Server 2012 R2 Essentials and Windows Azure AD.

Enable-WssMsoSharePointPermissionInheritance

Enables permission inheritance for a SharePoint Online securable object.

Enable-WssMsoUser

Enables an online service account.

Enable-WssRemoteWebAccess

Enables Remote Web Access.

Get-HostedEmailAccount

Gets the hosted email account that is assigned to a local user account.

Get-HostedEmailDomains

Gets the configuration of hosted email domains.

Get-O365AssignedUser

Gets the Office 365 account assigned to a network user account.

Get-O365DnsRecord

Gets all DNS records that require configuration at your domain name provider.

Get-O365DomainConfiguration

Gets the Office 365 domain configuration.

Get-O365EmailAddresses

Gets subscription information for the Office 365 Integration Module.

Get-O365SubscriptionInfo

Gets the Office 365 subscription information.

Get-O365User

Gets an Office 365 account.

Get-WssAddIn

Gets installed add-ins.

Get-WssAlert

Gets alerts that the server generated.

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-WssBranchCacheStatus

Gets the current BranchCache status.

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-WssClientBmrMediaGenerationJob

Gets the client full system restore media generation job status for a full system restore.

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-WssMediaStreamingVideoQuality

Gets the video streaming quality of the videos that are streamed from the server.

Get-WssMountVhd

Gets a collection of VHDs from a backup set.

Get-WssMsoAssignedGroup

Gets a security group assigned to a user group.

Get-WssMsoAssignedUser

Gets the online service account for a user.

Get-WssMsoDomainConfiguration

Gets domain configuration information for Online Services.

Get-WssMsoGroup

Gets security groups.

Get-WssMsoSharePointLibrary

Retrieves a SharePoint Online library.

Get-WssMsoSharePointPermission

Gets permission settings for a SharePoint Online securable object.

Get-WssMsoSharePointPrincipal

Gets all SharePoint 2013 principal objects, including users and groups.

Get-WssMsoSharePointSite

Gets SharePoint Online site configuration.

Get-WssMsoSubscription

Gets subscription information for Online Services.

Get-WssMsoUser

Gets the online service account for a user.

Get-WssPasswordPolicy

Gets the current password policy for a server.

Get-WssPersonalFolder

Gets the path of a personal folder.

Get-WssPoolableDisk

Gets disks to use to create storage space.

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-WssReport

Gets the full list of unexpired health reports.

Get-WssReportEmailSetting

Gets the email settings of a health report.

Get-WssReportHtml

Gets the HTML string of a specific health report.

Get-WssReportSchedule

Gets the schedule of an automated health report.

Get-WssReportSection

Gets a listing of the sections to include in a health report.

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-WssUserGroup

Gets Windows Server 2012 R2 Essentials user groups.

Get-WssWinSatCpuScore

Gets the Windows Experience Index processor subscore.

Get-WssWinSatCpuScoreUserConfigurable

Retrieves a setting that determines if a user can configure the CPU assessment.

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.

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-WssMsoSharePointLibrary

Creates a SharePoint Online library.

New-WssPersonalFolder

Adds a personal folder to the current server.

New-WssRecoveryOption

Creates a recovery configuration for a file restore operation.

New-WssReport

Creates a health report instance.

New-WssStorageSpace

Creates a two-way mirrored storage space.

Remove-HostedEmailAccount

Removes the hosted email account assigned to a local user account.

Remove-O365Domain

Removes the current Internet domain.

Remove-O365User

Removes an Office 365 account that is assigned to a local user account.

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-WssMsoGroup

Removes a security group that is assigned to a user group.

Remove-WssMsoGroupAssignment

Removes the assignment of a security group to a user group.

Remove-WssMsoSharePointLibrary

Removes a SharePoint Online library.

Remove-WssMsoSharePointPermission

Removes a permission relationship between a SharePoint 2013 user or group and a library or site.

Remove-WssMsoUser

Removes an online service account.

Remove-WssMsoUserAssignment

Removes the assignment between an online service account and an account.

Remove-WssRemoteWebAccessLink

Removes a link from the home page of a Remote Web Access website.

Remove-WssReport

Removes a health report instance.

Remove-WssUser

Deletes a user.

Remove-WssUserGroup

Removes a user group.

Remove-WssUserGroupMembership

Removes a user from a user group.

Rename-WssMsoAssignedUser

Modifies the online service account for 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.

Send-WssReport

Sends out a health report instance.

Set-HostedEmailAccount

Assigns a hosted email account to a network user account.

Set-O365AssignedUser

Assigns an Office 365 account to a network user account.

Set-O365Domain

Sets up a domain for Office 365.

Set-O365EmailAddresses

Sets up email addresses for a user.

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-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-WssMediaStreamingVideoQuality

Modifies the video streaming quality of videos that are streamed from the server.

Set-WssMsoGroupAssignment

Assigns a security group to a user group.

Set-WssMsoSharePointLibrary

Sets the properties of a SharePoint Online library.

Set-WssMsoSharePointPermission

Sets permission settings for a SharePoint Online securable object.

Set-WssMsoUserAssignment

Assigns an online service account to a user account.

Set-WssMsoUserLicense

Assigns licenses to an account in Windows Azure AD.

Set-WssPasswordPolicy

Modifies password policy requirements for the 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-WssReportEmailSetting

Configures the email settings of health report.

Set-WssReportSchedule

Sets the health report schedule.

Set-WssReportSection

Sets the sections to include in a health report.

Set-WssServerConnectionOption

Modifies the server connection option.

Set-WssUserAccess

Modifies the user access setting.

Set-WssUserDashboardVisibility

Modifies whether to make a user account visible in the dashboard.

Set-WssUserGroup

Modifies properties of a Windows Server 2012 R2 Essentials user group.

Set-WssUserGroupAccess

Modifies access for user groups.

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-WssClientBmrMediaGenerationJob

Starts the client full system restore media generation job.

Start-WssRouterConfiguration

Configures port forwarding for routers.

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.

Stop-WssClientBmrMediaGenerationJob

Stops a client full system restore media generation job.

Suspend-WssBackupPolicy

Stops a scheduled task from running the next scheduled backup.

Sync-WssAccount

Updates user and user group account information from the domain controller.

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.

Update-O365AccountName

Updates the email name for an Office 365 user account.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module wsscmdlets 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

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.