Windows Server Essentials Cmdlets in Windows PowerShell
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.
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 |
|---|---|
Creates a hosted email account and assigns it to a network user account. |
|
Creates an Office 365 account and assigns it to a local user account. |
|
Adds a backup file specification to a volume that is part of a backup. |
|
Adds a date and time to a backup policy for use as a backup schedule. |
|
Adds a bare metal recovery option to a scheduled backup policy. |
|
Adds a backup target to a scheduled backup. |
|
Adds a volume to a scheduled backup policy. |
|
Creates a relationship between a user and a computer for Remote Web Access. |
|
Adds physical disks to a storage pool. |
|
Creates a new server folder. |
|
Adds or renews a certificate for the current computer. |
|
Adds a security group and assigns it to a Windows Server 2012 R2 Essentials user group. |
|
Add an online service account, and assign it to a user account. |
|
Adds a link to the the homepage of a Remote Web Access website. |
|
Adds a new user account. |
|
Adds a user group to the Windows Server 2012 R2 Essentials dashboard. |
|
Adds a user account to a user group. |
|
Removes the relationship between a hosted email account and a local user account. |
|
Clears the assignment of an Office 365 account to a local network user account. |
|
Deletes an alert. |
|
Copies files needed to build a client recovery image to a USB device. |
|
Disables on-premises Exchange Server Integration. |
|
Disables the group policy setting for folder redirection. |
|
Disables the hosted email account assigned to a local user account. |
|
Disables the hosted email integration module. |
|
Disables the Office 365 Integration Module. |
|
Disables an Office 365 account that is assigned to a local network user account. |
|
Disables predefined security group policies. |
|
Disables BranchCache. |
|
Disables and ignores an alert. |
|
Disables and removes a scheduled server backup policy. |
|
Disables client backup for a computer. |
|
Disables backup for a volume on a client. |
|
Disables integration between Windows Server 2012 R2 Essentials and Windows Azure AD. |
|
Disables permission inheritance for a SharePoint Online securable object. |
|
Disables an online service account. |
|
Disables Remote Web Access. |
|
Enables on-premises Exchange Server Integration. |
|
Enables the group policy setting for folder redirection. |
|
Enables the hosted email account assigned to a local user account. |
|
Enables the hosted email integration module. |
|
Enables the Office 365 Integration Module. |
|
Enables an Office 365 account that is assigned to a local network user account. |
|
Enables predefined security group policies. |
|
Enables an alert. |
|
Enables BranchCache. |
|
Enables client backup for a computer. |
|
Enables backup for a volume on a computer. |
|
Enables integration between Windows Server 2012 R2 Essentials and Windows Intune. |
|
Enables integration between Windows Server 2012 R2 Essentials and Windows Azure AD. |
|
Enables permission inheritance for a SharePoint Online securable object. |
|
Enables an online service account. |
|
Enables Remote Web Access. |
|
Gets the hosted email account that is assigned to a local user account. |
|
Gets the configuration of hosted email domains. |
|
Gets the Office 365 account assigned to a network user account. |
|
Gets all DNS records that require configuration at your domain name provider. |
|
Gets the Office 365 domain configuration. |
|
Gets subscription information for the Office 365 Integration Module. |
|
Gets the Office 365 subscription information. |
|
Gets an Office 365 account. |
|
Gets installed add-ins. |
|
Gets alerts that the server generated. |
|
Gets file specifications from a volume that is part of a backup. Retrieves files specifications from a volume that is to be backed up. |
|
Gets a list of online hard disks that can be backup targets and can store server backups. |
|
Gets the status of current or previous backup jobs. |
|
Gets the current scheduled backup policy. |
|
Gets the backup schedule from a scheduled backup policy. |
|
Gets a collection of backup sets from a server backup. |
|
Gets a bare metal recovery option from a scheduled backup policy. |
|
Retrieves all backup targets from a scheduled backup policy. |
|
Gets backup volumes from a server, from a scheduled backup policy, or from existing backups. |
|
Gets the current BranchCache status. |
|
Gets information about client backup jobs. |
|
Gets a list of clients that the server can back up. |
|
Gets the status of backup-related operations. |
|
Gets the volume configuration of a computer. |
|
Gets backup information for a backup volume job. |
|
Gets the client full system restore media generation job status for a full system restore. |
|
Gets device information objects for the computers in a network. |
|
Gets an object that represents a disk. |
|
Gets the domain name configuration of Windows Server 2012. |
|
Gets an object that represents a drive. |
|
Checks whether a drive is in use. |
|
Gets the File History configuration settings for the server. |
|
Gets the File History managed status of a computer. |
|
Gets an object that represents a folder. |
|
Gets the current global client backup policy. |
|
Gets the name of the Media Library. |
|
Gets the status of media streaming for a server. |
|
Gets the shared folders included in the Media Library. |
|
Gets the video streaming quality of the videos that are streamed from the server. |
|
Gets a collection of VHDs from a backup set. |
|
Gets a security group assigned to a user group. |
|
Gets the online service account for a user. |
|
Gets domain configuration information for Online Services. |
|
Gets security groups. |
|
Retrieves a SharePoint Online library. |
|
Gets permission settings for a SharePoint Online securable object. |
|
Gets all SharePoint 2013 principal objects, including users and groups. |
|
Gets SharePoint Online site configuration. |
|
Gets subscription information for Online Services. |
|
Gets the online service account for a user. |
|
Gets the current password policy for a server. |
|
Gets the path of a personal folder. |
|
Gets disks to use to create storage space. |
|
Gets child recovery items from a parent recovery item. |
|
Retrieves a listing of remote connections from Remote Web Access clients, VPN clients, or Web API applications. |
|
Retrieves the filename of the background image displayed on the Remote Web Access website. |
|
Retrieves the collection of links on the home page of a Remote Web Access website. |
|
Retrieves the name of the file that contains the logo for the Remote Web Access website. |
|
Retrieves the status of a Remote Web Access website. |
|
Retrieves the title string of a Remote Web Access website. |
|
Gets the full list of unexpired health reports. |
|
Gets the email settings of a health report. |
|
Gets the HTML string of a specific health report. |
|
Gets the schedule of an automated health report. |
|
Gets a listing of the sections to include in a health report. |
|
Retrieves information about the router for the local network. |
|
Retrieves the server connection option. |
|
Retrieves a storage pool, or all storage pools in the system. |
|
Retrieves a user account by name or security identifier. |
|
Gets Windows Server 2012 R2 Essentials user groups. |
|
Gets the Windows Experience Index processor subscore. |
|
Retrieves a setting that determines if a user can configure the CPU assessment. |
|
Prepares a disk for, or removes a disk from, a Windows Server® 2012 Essentials backup. |
|
Initializes a disk for Windows Server 2012 Essentials storage. |
|
Installs or redeploys an add-in package. |
|
Installs a VPN server. |
|
Calculates the size of a given server folder. |
|
Moves a server folder to a different drive. |
|
Creates a file specification that specifies the files and folders to include in or exclude from a backup. |
|
Creates a backup target from a backup disk. |
|
Creates a SharePoint Online library. |
|
Adds a personal folder to the current server. |
|
Creates a recovery configuration for a file restore operation. |
|
Creates a health report instance. |
|
Creates a two-way mirrored storage space. |
|
Removes the hosted email account assigned to a local user account. |
|
Removes the current Internet domain. |
|
Removes an Office 365 account that is assigned to a local user account. |
|
Removes a file specification from a backup volume. |
|
Removes a backup schedule from a scheduled backup policy. |
|
Removes a bare metal recovery option from a scheduled backup policy. |
|
Removes a backup target from a scheduled backup policy. |
|
Removes a backup volume from a scheduled backup policy. |
|
Removes a client computer identity, backup, and properties from the network. |
|
Removes a relationship between a user and a computer for Remote Web Access. |
|
Removes a server folder. |
|
Removes a security group that is assigned to a user group. |
|
Removes the assignment of a security group to a user group. |
|
Removes a SharePoint Online library. |
|
Removes a permission relationship between a SharePoint 2013 user or group and a library or site. |
|
Removes an online service account. |
|
Removes the assignment between an online service account and an account. |
|
Removes a link from the home page of a Remote Web Access website. |
|
Removes a health report instance. |
|
Deletes a user. |
|
Removes a user group. |
|
Removes a user from a user group. |
|
Modifies the online service account for a user. |
|
Repairs an alert. |
|
Repairs the database that stores information for media streaming. |
|
Repairs Remote Web Access. |
|
Repairs the router configuration. |
|
Resumes the scheduled task that runs server backup in TaskScheduler. |
|
Selects a VHD from a backup set to mount for a file restore operation. |
|
Sends out a health report instance. |
|
Assigns a hosted email account to a network user account. |
|
Assigns an Office 365 account to a network user account. |
|
Sets up a domain for Office 365. |
|
Sets up email addresses for a user. |
|
Creates or changes a scheduled backup policy. |
|
Changes job retention policy and description for a client backup. |
|
Specifies folders to exclude from client backup on a computer. |
|
Changes the domain name configuration of the server. |
|
Changes drive name or whether to enable snapshots. |
|
Changes the File History configurations settings for the server. |
|
Changes the File History managed status of a computer. |
|
Changes the settings of a server folder. |
|
Changes the global client backup policy. |
|
Includes or excludes the specified shared folder from the Media Library. |
|
Changes the name of the Media Library. |
|
Enables or disables media streaming on a server. |
|
Modifies the video streaming quality of videos that are streamed from the server. |
|
Assigns a security group to a user group. |
|
Sets the properties of a SharePoint Online library. |
|
Sets permission settings for a SharePoint Online securable object. |
|
Assigns an online service account to a user account. |
|
Assigns licenses to an account in Windows Azure AD. |
|
Modifies password policy requirements for the server. |
|
Sets the background image for a Remote Web Access website. |
|
Sets the path and filename of the logo image for the Remote Web Access website. |
|
Modifies the title string of a Remote Web Access website. |
|
Configures the email settings of health report. |
|
Sets the health report schedule. |
|
Sets the sections to include in a health report. |
|
Modifies the server connection option. |
|
Modifies the user access setting. |
|
Modifies whether to make a user account visible in the dashboard. |
|
Modifies properties of a Windows Server 2012 R2 Essentials user group. |
|
Modifies access for user groups. |
|
Modifies the Windows Experience Index processor subscore. |
|
Starts a manual server backup. |
|
Starts a client backup for a computer. |
|
Starts an attempt to repair the database of client computer backups. |
|
Starts the client full system restore media generation job. |
|
Configures port forwarding for routers. |
|
Starts a file restore operation. |
|
Starts a volume restore operation. |
|
Cancels the currently running backup job. |
|
Cancels a client backup for a computer. |
|
Stops the attempt to repair a database of client computer backups. |
|
Stops a client full system restore media generation job. |
|
Stops a scheduled task from running the next scheduled backup. |
|
Updates user and user group account information from the domain controller. |
|
Checks a drive for file system errors, and optionally repairs errors. |
|
Performs an evaluation of all health checks. |
|
Checks for an installation of VPN server. |
|
Uninstalls an add-in. |
|
Uninstalls a VPN server. |
|
Updates the email name for an Office 365 user account. |
Note
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