All of the available 'WSS' PowerShell Commands for the Essentials Role & SKU. Current as of 20/11/2013

For additional Essentials specific commands for service integration like Office 365, or  On Prem Exchange visit : http://technet.microsoft.com/en-us/library/dn205088.aspx

NAME
    Add-WssBackupConfiguration
    
SYNOPSIS
    Adds a backup file specification to a volume that is part of a backup.
    
SYNTAX
    Add-WssBackupConfiguration [-Volume] <BackupVolume> [-Configuration] <BackupFileSpec> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssBackupConfiguration cmdlet adds a backup file specification to a volume that is part of a backup.
    

PARAMETERS
    -Configuration <BackupFileSpec>
        Specifies the backup file specification to add.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Volume <BackupVolume>
        Specifies the volume on which to create the backup file specification.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupVolume
        
        
    
        This cmdlet generates the backup source volume with the added file specification.
    
    
    Example : 1: Add a backup file specification to a volume
    
    PS C:\>$ContosoBUVolume10 = Get-WssBackupVolume -AllVolumesPS C:\>$ContosoBUConfig10 = Get-WssBackupConfiguration
    -Volume $ContosoBUVolume10[3]PS C:\>Add-WssBackupConfiguration -FileSpec $ContosoBUConfig10 -Volume
    $ContosoBUVolume10[5]
    
    
    This example adds a backup configuration to a backup volume.
    
    The first command gets a list of backup volumes from the server and stores them in the variable named
    $ContosoBUVolume10.
    
    The second command gets the backup file specification from the fourth item (located in position 3) in the
    $ContosoBUVolume10 array.
    
    The third command adds the backup file specification in $ContosoBUConfig10 to the sixth item (located in position
    5) in the $ContosoBUVolume10 array.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298268
    Get-WssBackupConfiguration
    New-WssBackupConfiguration
    Remove-WssBackupConfiguration

NAME
    Add-WssBackupSchedule
    
SYNOPSIS
    Adds a date and time to a backup policy for use as a backup schedule.
    
SYNTAX
    Add-WssBackupSchedule [-BackupPolicy] <ScheduledBackupPolicy> [-BackupTime] <DateTime> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssBackupSchedule cmdlet adds a date and time to a backup policy. The backup process uses this date and
    time as a backup schedule.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the backup policy to which to add the backup schedule.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -BackupTime <DateTime>
        Specifies the backup date and time to add to the scheduled backup policy.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet returns the BackupPolicy parameter.
    
    
    Example 1: Add a backup schedule to a backup policy
    
    PS C:\>$ContosoBUPolicy25 = Get-WssBackupPolicy
    PS C:\> Add-WssBackupSchedule -BackupPolicy $ContosoBUPolicy25 -BackupTime 5:00
    
    
    This example adds a backup schedule to a backup policy.
    
    The first command gets the backup policy for the computer and stores it in the $ContosoBUPolicy25 variable.
    
    The second command adds 5:00 A.M. daily as a backup schedule for the backup policy stored in $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298282
    Get-WssBackupSchedule
    Remove-WssBackupSchedule

NAME
    Add-WssBackupSystemRecovery
    
SYNOPSIS
    Adds a bare metal recovery option to a scheduled backup policy.
    
SYNTAX
    Add-WssBackupSystemRecovery [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssBackupSystemRecovery cmdlet adds a bare metal recovery option to a scheduled backup policy. Use a
    backup policy with a full metal recovery option to recover the full operating system, including critical volumes,
    from the backup.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to which to add the option for bare metal recovery.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet returns the BackupPolicy parameter.
    
    
    Example 1: Add a bare metal recovery option to a backup policy
    
    PS C:\>$ContosoBUPolicy25 = Get-WssBackupPolicy
    PS C:\> Add-WssBackupSystemRecovery -BackupPolicy $ContosoBUPolicy25
    
    
    This command adds a bare metal recovery option to a backup policy.
    
    The first command gets the backup policy for the computer and stores it in the variable named $ContosoBUPolicy25.
    
    The second command adds bare metal recovery to the backup policy that is stored in $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298286
    Get-WssBackupSystemRecovery
    Remove-WssBackupSystemRecovery

NAME
    Add-WssBackupTarget
    
SYNOPSIS
    Adds a backup target to a scheduled backup.
    
SYNTAX
    Add-WssBackupTarget [-BackupPolicy] <ScheduledBackupPolicy> [-BackupTarget] <BackupTarget> [-Force]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssBackupTarget cmdlet adds a backup target to a scheduled backup policy. A scheduled backup policy is a
    backup file specification that has a backup schedule associated with it. When you add a backup target to the
    backup policy, the backup job adds the files in the backup policy that you specify to the new target location.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to which to add the backup target.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -BackupTarget <BackupTarget>
        Specifies the backup target to add.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupTarget
        
        
    
        This cmdlet returns the list of backup targets.
    
    
    Example 1: Add a backup target to a scheduled backup policy
    
    PS C:\>$ContosoBUPolicy213 = Get-WssBackupPolicy
    PS C:\> $ContosoBUTarget05 = New-WBBackupTarget –VolumePath "F:\"
    PS C:\> Add-WssBackupTarget -BackupPolicy $ContosoBUPolicy213 -BackupTarget $ContosoBUTarget05
    
    
    This example adds a backup target to a backup policy.
    
    The first command gets the current backup policy for the computer and stores it in the variable named
    $ContosoBUPolicy213.
    
    The second command creates a new backup target from the volume on drive F: and stores it in the variable named
    $ContosoBUTarget05.
    
    The third command adds the backup target that is stored in $ContosoBUTarget05 to the backup policy that is stored
    in $ContosoBUPolicy213.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298289
    Get-WssBackupTarget
    New-WssBackupTarget
    Remove-WssBackupTarget
    

NAME
    Add-WssBackupVolume
    
SYNOPSIS
    Adds a volume to a scheduled backup policy.
    
SYNTAX
    Add-WssBackupVolume [-BackupPolicy] <ScheduledBackupPolicy> [-BackupVolume] <BackupVolume> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssBackupVolume cmdlet adds a volume to a scheduled backup policy. Use the cmdlet to add volumes and the
    files they contain to a backup.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to which to add the volume.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -BackupVolume <BackupVolume>
        Specifies the volume to add to the scheduled backup policy.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupVolume
        
        
    
        This cmdlet returns the backup volume.
    
    
    Example 1: Add a backup volume to a backup policy
    
    PS C:\>$ContosoBUPolicy24 = Get-WBPolicy -Editable
    PS C:\> $ContosoEmpData10 = Get-WBVolume –VolumePath F:\
    PS C:\> Add-WssBackupVolume -BackupPolicy $ContosoBUPolicy24 -BackupVolume $ContosoEmpData10
    
    
    This example adds a backup volume to scheduled backup policy.
    
    The first command gets the current backup policy for the computer, makes it editable, and stores it in the
    variable named $ContosoBUPolicy24.
    
    The second command creates a backup volume from drive F: and stores it in the variable named $ContosoEmpData10.
    
    The third command adds the backup volume that is stored in $ContosoEmpData10 to the scheduled backup policy that
    is stored in $ContosoBUPolicy24.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298293
    Get-WssBackupVolume
    Remove-WssBackupVolume
    

NAME
    Add-WssComputerAccess
    
SYNOPSIS
    Creates a relationship between a user and a computer for Remote Web Access.
    
SYNTAX
    Add-WssComputerAccess [-GroupName <String>] [-UserName <String>] -ComputerName <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssComputerAccess cmdlet creates a relationship between a user account and a computer to use for Remote
    Web Access. You can use the Remove-WssComputerAccess cmdlet to delete an access relationship.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -GroupName <String>
        Specifies the name of a group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserName <String>
        Specifies the user name of an account.
        
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Add computer access for a user
    
    PS C:\> Add-WssComputerAccess -ComputerName "Workstation033" -UserName "SarahJones"
    
    
    This command creates a relationship between the user SarahJones and the computer named Workstation033. The user
    can now use Remote Web Access to connect to this computer.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298319
    Remove-WssComputerAccess

NAME
    Add-WssDisksToSpacesPool
    
SYNOPSIS
    Adds physical disks to a storage pool.
    
SYNTAX
    Add-WssDisksToSpacesPool [-Pool] <SpacesPool> [-Disks] <ICollection<Disk>> [-Force] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssDisksToSpacesPool cmdlet adds physical disks to a storage pool.
    

PARAMETERS
    -Disks <ICollection<Disk>>
        Specifies the physical disks to add to the storage pool.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Pool <SpacesPool>
        Specifies a StoragePool object. To obtain a StoragePool object, use theGet-WssSpacesPool cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.SpacesPool
        
        
    
        This cmdlet returns the storage pool into which the physical disks are added.
    
    
    Example 1: Add a physical disk to a storage pool
    
    PS C:\>$Disk = Get-WssDisk -ID "26a21bda-a627-11d7-9931-806e6f6e6963"
    PS C:\> $Pool = Get-WssSpacesPool -ID "13c41bda-a627-22d7-4631-806e6f6e6963"
    PS C:\> Add-WssDisksToSpacesPool -Disks $Disk -Pool $Pool
    
    
    The first command gets the Disk object that has the ID 26a21bda-a627-11d7-9931-806e6f6e6963, and stores it in the
    $Disk variable.
    
    The second command gets the storage pool that has the ID 13c41bda-a627-22d7-4631-806e6f6e6963, and stores it in
    the $Pool variable.
    
    The third command adds the physical disk stored in the $Disk variable to the storage pool stored in the $Pool
    variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298326
    Get-WssSpacesPool
    Get-WssDisk

NAME
    Add-WssFolder
    
SYNOPSIS
    Creates a new server folder.
    
SYNTAX
    Add-WssFolder [-Name] <String> [-Path] <String> -Description] <String>] [[-HideFolderFromRemoteAccess
    [[-ComputerName] <String>] [-KeepPermission] [<CommonParameters>]
    
    Add-WssFolder [-Id] <Guid> [-Path] <String> -Description] <String>] [[-HideFolderFromRemoteAccess
    [[-ComputerName] <String>] [-KeepPermission] [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssFolder cmdlet creates a server folder.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    false
        Position?                    5
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Description <String>
        Specifies a description for the server folder.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -HideFolderFromRemoteAccess [<SwitchParameter>]
        Specifies whether to hide the folder in Remote Desktop Web Access or Web service applications.
        
        Required?                    false
        Position?                    4
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Id <Guid>
        Specifies the GUID for a built-in server folder. Specify this parameter to re-create a default shared folder,
        such as the Music folder or the Pictures folder.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -KeepPermission [<SwitchParameter>]
        Indicates that the folder keeps the permissions of the parent folder.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies a name for the folder.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Path <String>
        Specifies the path of the folder.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Folder
        
        
    
        This cmdlet returns the new server folder.
    
    
    Example 1: Create a server folder
    
    PS C:\> Add-WssFolder -Name "ProjectsEast" -Path "D:\Contoso\Main"
    
    
    This command creates the folder named ProjectsEast in D:\Contoso\Main.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298337
    Get-WssFolder
    Set-WssFolder
    Move-WssFolder
    Remove-WssFolder
    Measure-WssFolder

NAME
    Add-WssLocalMachineCert
    
SYNOPSIS
    Adds or renews a certificate for the current computer.
    
SYNTAX
    Add-WssLocalMachineCert [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssLocalMachineCert cmdlet adds or renews a self-issued root certificate for the current server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Add or renew a certificate
    
    PS C:\> Add-WssLocalMachineCert
    
    
    This command adds or renews a certificate for the server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298345

NAME
    Add-WssMsoGroup
    
SYNOPSIS
    Adds a security group and assigns it to a user group.
    
SYNTAX
    Add-WssMsoGroup [-WssGroupName] <String> [[-MsoGroupName] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssMsoGroup cmdlet adds a Windows Azure Active Directory (Windows Azure AD) security group, and assigns
    that group to a Windows Server Essentials user group.
    

PARAMETERS
    -MsoGroupName <String>
        Specifies a name for the security group.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -WssGroupName <String>
        Specifies the name of a user group. The cmdlet assigns the security group to the user group that you specify.
        If you do not specify a name for the security group by using the MsoGroupName parameter, the cmdlet uses the
        value that you specify as the name for the security group.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssGroupName
        Type: System.String
        Description: local network account name of user group
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Create a security group
    
    PS C:\> Add-WssMSOGroup - WssGroupName "Local Network Admins" -MsoGroupName "Network Admins"
    
    
    This command creates a security group named Network Admins and associates it to the local network user group named
    Local Network Admins.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298368
    Get-WssMsoGroup
    Remove-WssMsoGroup

NAME
    Add-WssMsoUser
    
SYNOPSIS
    Add an online service account, and assign it to a user account.
    
SYNTAX
    Add-WssMsoUser [-WssUserName] <String> [-MsoUserName] <String> [[-License] <MSOLicense[]>] [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssMsoUser cmdlet adds and enables an online service account to Windows Azure Active Directory (Windows
    Azure AD), and assigns that account to a local network user account.
    

PARAMETERS
    -License <MSOLicense[]>
        Specifies an array of user licenses. Specifies an array of licenses as MSOLicense objects. The cmdlet assigns
        the licenses that you specify to the user account. To obtain MSOLicense objects, use the
        Get-WssMsoSubscription cmdlet to get subscription information. Subscription information contains the
        MSOLicenseSuite array that refers to MSOLicense objects.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -MsoUserName <String>
        Specifies a user principal name (UPN). The cmdlet adds an online service account that has the UPN that you
        specify.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet assigns an online service account to the user account that
        you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Add an online account
    
    PS C:\> Add-WSSMSOUser -WssUserName "DavidChew" -MsoUserName "DavidChew@TSQA.Contoso.com"
    
    
    This command adds an online service account DavidChew@TSQA.Contoso.com and assigns it to the local network user
    account named DavidChew.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298386
    Disable-WssMsoUser
    Enable-WssMsoUser
    Get-WssMsoUser
    Remove-WssMsoUser

NAME
    Add-WssRemoteWebAccessLink
    
SYNOPSIS
    Adds a link to the home page of a Remote Web Access website.
    
SYNTAX
    Add-WssRemoteWebAccessLink -Text <String> -Url <Uri> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssRemoteWebAccessLink cmdlet adds a link to the home page of a Remote Web Access website.
    
    To remove a link from the home page of a Remote Web Access website, use the Remove-WssRemoteWebAccessLink cmdlet.
    

PARAMETERS
    -Text <String>
        Specifies a text string for a link that displays on the home page.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Url <Uri>
        Specifies a web address for the link, as an absolute URI.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Add a link to a home page
    
    PS C:\> Add-WssRemoteWebAccessLink -Text "Link1" -Url "http://Contoso.com/About-Contoso-Page.html"
    
    
    This command adds a link to the home page for a Remote Web Access website.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298408
    Get-WssRemoteWebAccessLink
    Remove-WssRemoteWebAccessLink

NAME
    Add-WssUser
    
SYNOPSIS
    Adds a new user account.
    
SYNTAX
    Add-WssUser [-Name] <String> [-Password] <SecureString> [-AccessLevel <String>] [-AllowRemoteAccess]
    [-AllowVpnAccess] [-FirstName <String>] [-GroupName <String>] [-LastName <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssUser cmdlet adds a new user account to the Windows Server 2012 Essentials server. Use the parameters to
    grant the account access to services or set access levels.
    

PARAMETERS
    -AccessLevel <String>
        Specifies the access level for a user. To give the user administrative access, specify Administrator;
        otherwise, specify User for a standard user.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -AllowRemoteAccess [<SwitchParameter>]
        Indicates that the user can access the Remote Web Access website.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -AllowVpnAccess [<SwitchParameter>]
        Indicates that the user can access the VPN server.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -FirstName <String>
        Specifies the first name of a user.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -GroupName <String>
        Specifies the name of a group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -LastName <String>
        Specifies the last name of a user.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies a user account name.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Password <SecureString>
        Specifies a password for a user, as a secure string.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Users.User
        
        
    
        This cmdlet returns the user object created by this cmdlet.
    
    
    Example 1: Add a user
    
    PS C:\> Add-WssUser -AccessLevel "Administrator" -Name "SarahJones" -FirstName "Sarah" -LastName "Jones"
    -AllowRemoteAccess
    
    
    This command adds a user with administrative access and remote web access to a Windows Server 2012 Essentials
    server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298437
    Get-WssUser
    Import-WssUser
    Remove-WssUser
    Sync-WssUser

NAME
    Add-WssUserGroup
    
SYNOPSIS
    Adds a user group to the dashboard.
    
SYNTAX
    Add-WssUserGroup [-AllowRemoteAccess] [-AllowVpnAccess] [-Description <String>] -Name <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssUserGroup cmdlet adds a user group to the Windows Server Essentials dashboard.
    

PARAMETERS
    -AllowRemoteAccess [<SwitchParameter>]
        Indicates that members of the group can access the Remote Web Access website.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -AllowVpnAccess [<SwitchParameter>]
        Indicates that members of the group can access the VPN server.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Description <String>
        Specifies a description. The cmdlet assigns the user group the description that you specify.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies a name. The cmdlet uses this name for the user group.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Add user group
    
    PS C:\> Add-WssUserGroup -Name "Support" -Description "Customer Support Team"
    
    
    This command adds a user group.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298443
    Get-WssUserGroup
    Remove-WssUserGroup
    Set-WssUserGroup

NAME
    Add-WssUserGroupMembership
    
SYNOPSIS
    Adds a user account to a user group.
    
SYNTAX
    Add-WssUserGroupMembership -GroupName <String> -UserName <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Add-WssUserGroupMembership cmdlet adds a user account to a user group.
    

PARAMETERS
    -GroupName <String>
        Specifies the name of a user group. The cmdlet adds a user account to the group that you specify.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserName <String>
        Specifies the name of a user account. The cmdlet adds the account that you specify to a user group.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Add a user account to a user group
    
    PS C:\> Add-WssUserGroupMembership -GroupName "Support" -UserName "PattiFuller"
    
    
    This command adds the user account named PattiFuller to the user group named Support.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298246
    Remove-WssUserGroupMembership

NAME
    Clear-WssAlert
    
SYNOPSIS
    Deletes an alert.
    
SYNTAX
    Clear-WssAlert [-FeatureName] <String> [-HealthDefinitionName] <String> [[-MachineName] <String>] [-PassThru]
    [<CommonParameters>]
    
    Clear-WssAlert [-Alert] <Alert> [-PassThru] [<CommonParameters>]
    
    
DESCRIPTION
    The Clear-WssAlert cmdlet deletes an alert from the server at the next network health evaluation cycle. If you
    delete an alert and the server detects the problem again in the health evaluation cycle, it generates a new alert.
    By default, the server refreshes alerts every thirty minutes.
    

PARAMETERS
    -Alert <Alert>
        Specifies a WssAlert object. To obtain a WssAlert object, use the Get-WssAlert cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -FeatureName <String>
        Specifies the name of the feature associated with the alert.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -HealthDefinitionName <String>
        Specifies the name of the health definition associated with the alert.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -MachineName <String>
        Specifies the name of the computer on which the server generated the alert.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -PassThru [<SwitchParameter>]
        Returns an object representing the item with which you are working. By default, this cmdlet does not generate
        any output.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.NetworkHealth.AlertFramework.Alert
        
        
    
        Description: alert object
    
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Delete an alert
    
    PS C:\> Clear-WssAlert -FeatureName "MicrosoftServicing" -HealthDefinitionName "MUOptIn"
    
    
    This command deletes the alert associated with the feature named MicrosoftServicing and the health definition
    named MUOptIn.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298219
    Get-WssAlert
    Enable-WssAlert
    Disable-WssAlert
    Repair-WssAlert

NAME
    Copy-WssClientRecoveryImage
    
SYNOPSIS
    Copies files needed to build a client recovery image to a USB device.
    
SYNTAX
    Copy-WssClientRecoveryImage [-Target] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Copy-WssClientRecoveryImage cmdlet copies files needed to build a client recovery image to a USB device.
    Specify the partition for the device.
    
    Before you use this cmdlet, use the DiskPart utility to clean the USB device, create a primary partition, format
    that partition as NTFS, and activate the partition. For more information about the DiskPart utility, see DiskPart
    (http://technet.microsoft.com/en-us/library/cc770877.aspx).
    

PARAMETERS
    -Target <String>
        Specifies the target partition. The cmdlet copies the image to the root folder of the specified location.
        Specify the target partition by drive letter.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Copy client recovery image
    
    PS C:\> Copy-WssClientRecoveryImage -Target "F:"
    
    
    This command copies necessary files to the USB device specified as F:. Before you begin, use the DiskPart utility
    to prepare the device.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298316

NAME
    Disable-WssAlert
    
SYNOPSIS
    Disables and ignores an alert.
    
SYNTAX
    Disable-WssAlert [-FeatureName] <String> [-HealthDefinitionName] <String> [[-MachineName] <String>]
    [<CommonParameters>]
    
    Disable-WssAlert [-Alert] <Alert> [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssAlert cmdlet disables and ignores an alert. When you disable and ignore an alert, the alert becomes
    inactive and the server does not include the alert in the overall health assessment of the computer in the
    network. Use the Enable-WssAlert cmdlet to activate an alert.
    

PARAMETERS
    -Alert <Alert>
        Specifies a WssAlert object. To obtain a WssAlert object, use the Get-WssAlert cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -FeatureName <String>
        Specifies the name of the feature associated with the alert.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -HealthDefinitionName <String>
        Specifies the name of the health definition associated with the alert.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -MachineName <String>
        Specifies the name of the computer on which the server generated the alert.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.NetworkHealth.AlertFramework.Alert
        
        
    
        Description: alert
    
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Disable an alert
    
    PS C:\> Disable-WssAlert -FeatureName "MicrosoftServicing" -HealthDefinitionName "MUOptIn"
    
    
    This command disables and ignores the alert associated with the feature named MicrosoftServicing and the health
    definition named MUOptIn.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298220
    Get-WssAlert
    Enable-WssAlert
    Clear-WssAlert
    Repair-WssAlert
    Enable-WssAlert

NAME
    Disable-WssBackupPolicy
    
SYNOPSIS
    Disables and removes a scheduled server backup policy.
    
SYNTAX
    Disable-WssBackupPolicy [-BackupPolicy] <ScheduledBackupPolicy> [-Force] [-PassThru] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssBackupPolicy cmdlet disables and removes a scheduled server backup policy. When you disable a
    scheduled server backup policy, the scheduled daily backups in the backup policy do not run.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to disable and remove.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -PassThru [<SwitchParameter>]
        Indicates that the cmdlet creates an object that you can use in a pipeline. By default, this cmdlet does not
        generate any output.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This command returns the current backup policy after the operation if you specify the PassThru parameter.
    
    
    Example 1: Remove a scheduled server backup policy
    
    PS C:\>$ContosoBUPolicy25 = Get-WssBackupPolicy
    PS C:\> Disable-WssBackupPolicy -BackupPolicy $ContosoBUPolicy25
    
    
    This example disables and removes a scheduled server backup policy.
    
    The first command gets the backup policy for the computer and stores the result in the $ContosoBUPolicy25 variable
    
    The second command disables and removes the backup policy stored in $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298278
    Get-WssBackupPolicy
    Resume-WssBackupPolicy
    Set-WssBackupPolicy
    Suspend-WssBackupPolicy
    

NAME
    Disable-WssBranchCache
    
SYNOPSIS
    Disables BranchCache.
    
SYNTAX
    Disable-WssBranchCache [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssBranchCache cmdlet disables BranchCache in Windows Server Essentials. BranchCache copies content
    from on-premise content servers or hosted cloud content servers and caches the content at branch office locations.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Disable BranchCache
    
    PS C:\> Disable-WssBranchCache
    
    
    This command disables BranchCache on the server where you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298297
    Enable-WssBranchCache

NAME
    Disable-WssClientBackup
    
SYNOPSIS
    Disables client backup for a computer.
    
SYNTAX
    Disable-WssClientBackup [-ComputerName] <String> [-Force] [-RemoveBackup] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Disable-WssClientBackup [-ComputerSid] <String> [-Force] [-RemoveBackup] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssClientBackup cmdlet disables client backup for a computer. Specify a computer by name or security
    identifier (SID). Use the RemoveBackup parameter to remove existing backups.
    
    This cmdlet prevents client backups from the current time forward. If you want to stop only a current backup
    operation, use the Stop-WssClientBackup cmdlet.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -RemoveBackup [<SwitchParameter>]
        Indicates that the cmdlet removes the current client backup for the specified computer.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Disable client backup for a computer
    
    PS C:\> Disable-WssClientBackup -ComputerName "Workstation073" -RemoveBackup
    
    
    This command disables client backups for a computer named Workstation073, and removes any existing backup.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298301
    Enable-WssClientBackup
    Get-WssClientBackup
    Set-WssClientBackup
    Start-WssClientBackup
    Stop-WssClientBackup

NAME
    Disable-WssClientBackupVolume
    
SYNOPSIS
    Disables backup for a volume on a client.
    
SYNTAX
    Disable-WssClientBackupVolume [-ComputerName] <String> [-VolumeGuid] <Guid> [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    Disable-WssClientBackupVolume [-ComputerSid] <String> [-VolumeGuid] <Guid> [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssClientBackupVolume cmdlet disables client backup for a volume on a computer. Specify a computer by
    name or security identifier (SID). Specify a volume by using its GUID.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -VolumeGuid <Guid>
        Specifies the GUID of a volume.
        
        Required?                    true
        Position?                    4
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Disable backup for a volume
    
    PS C:\> Disable-WssClientBackupVolume -ComputerName "Workstation073" -VolumeGuid
    b6b093a2-1860-4172-a4a5-07ce2aebfa13
    
    
    This command disables backup for the specified volume on the computer named Workstation073.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298311
    Enable-WssClientBackupVolume
    Get-WssClientBackupVolume
    Get-WssClientBackupVolumeJob

NAME
    Disable-WssMsoIntegration
    
SYNOPSIS
    Disables Windows Azure AD integration.
    
SYNTAX
    Disable-WssMsoIntegration -Force [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssMsoIntegration cmdlet disables integration between Windows Server Essentials and Windows Azure
    Active Directory (Windows Azure AD) and the configuration data associated with the integration is removed.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Disable integration
    
    PS C:\> Disable-WssMsoIntegration
    
    
    This command disables integration between Windows Server Essentials and Windows Azure AD. Before it disables
    integration, the cmdlet prompts you for confirmation.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298373
    Enable-WssMsoIntegration

NAME
    Disable-WssMsoSharePointPermissionInheritance
    
SYNOPSIS
    Disables permission inheritance for a SharePoint Online securable object.
    
SYNTAX
    Disable-WssMsoSharePointPermissionInheritance [-Library] <SharePointLibrary> [<CommonParameters>]
    
    Disable-WssMsoSharePointPermissionInheritance [-Site] <SharePointSite> [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssMsoSharePointPermissionInheritance cmdlet disables permission inheritance for a Microsoft®
    SharePoint® Online securable object. Securable objects include sites, lists, libraries, folders, documents, or
    items.
    

PARAMETERS
    -Library <SharePointLibrary>
        Specifies a SharePoint 2013 library. The cmdlet disables permission inheritance for a library that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a SharePoint 2013 site. The cmdlet disables permission inheritance for a site that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary,Microsoft.WindowsServerSolutions.O365Integration
    .SharePointSite
        
        
    
        Library
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        Description: SharePoint library
        
        Site
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointSite
        
        Description: SharePoint site
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Disable SharePoint permission inheritance
    
    PS C:\> $Library = Get-WssMsoSharePointLibrary | Select-Object -First 1
    PS C:\> Disable-WssMsoSharePointPermissionInheritance -SharePointLibrary $Library
    
    
    The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the
    $Library variable.
    
    The second command disables permission inheritance for the library named $Library.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298381
    Enable-WssMsoSharePointPermissionInheritance
    

NAME
    Disable-WssMsoUser
    
SYNOPSIS
    Disables an online service account.
    
SYNTAX
    Disable-WssMsoUser [-WssUserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssMsoUser cmdlet disables the online service account that is assigned to a local user account. This
    prevents the disabled account from using the online portal.
    

PARAMETERS
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet disables the online service account that is assigned to the
        account that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName - local network account name of user.
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Disable a Microsoft account
    
    PS C:\> Disable-WssMsoUser -WssUserName "PattiFuller"
    
    
    This command disables the online service account that is assigned to the user account named PattiFuller.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298387
    Add-WssMsoUser
    Enable-WssMsoUser
    Get-WssMsoUser
    Remove-WssMsoUser

NAME
    Disable-WssRemoteWebAccess
    
SYNOPSIS
    Disables Remote Web Access.
    
SYNTAX
    Disable-WssRemoteWebAccess [<CommonParameters>]
    
    
DESCRIPTION
    The Disable-WssRemoteWebAccess cmdlet disables Remote Web Access on the Windows Server 2012 Essentials server.
    
    To enable Remote Web Access, use the Enable-WssRemoteWebAccess cmdlet.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Disable Remote Web Access
    
    PS C:\> Disable-WssRemoteWebAccess
    
    
    This command disables Remote Web Access on the server.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298403
    Enable-WssRemoteWebAccess
    Repair-WssRemoteWebAccess

NAME
    Enable-WssAlert
    
SYNOPSIS
    Enables an alert.
    
SYNTAX
    Enable-WssAlert [-FeatureName] <String> [-HealthDefinitionName] <String> [[-MachineName] <String>]
    [<CommonParameters>]
    
    Enable-WssAlert [-Alert] <Alert> [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssAlert cmdlet enables an alert that you have disabled or ignored. Specify an alert object or specify
    the feature and health definition file associated with an alert.
    

PARAMETERS
    -Alert <Alert>
        Specifies a WssAlert object. To obtain a WssAlert object, use the Get-WssAlert cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -FeatureName <String>
        Specifies the name of the feature associated with the alert.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -HealthDefinitionName <String>
        Specifies the name of the health definition associated with the alert.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -MachineName <String>
        Specifies the name of a computer.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String,System.String
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Enable an alert
    
    PS C:\> Enable-WssAlert -FeatureName "MicrosoftServicing" -HealthDefinitionName "MUOptIn"
    
    
    This command enables the alert associated with the feature named MicrosoftServicing and the health definition
    named MUOptIn.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298221
    Get-WssAlert
    Disable-WssAlert
    Clear-WssAlert
    Repair-WssAlert

NAME
    Enable-WssBranchCache
    
SYNOPSIS
    Enables BranchCache.
    
SYNTAX
    Enable-WssBranchCache [<CommonParameters>]
    
    
DESCRIPTION
    The Enables-WssBranchCache cmdlet enables BranchCache in Windows Server Essentials. BranchCache copies content
    from on-premise content servers or hosted cloud content servers and caches the content at branch office locations.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Enable BranchCache
    
    PS C:\> Enable-WssBranchCache
    
    
    This command enables BranchCache on the server where you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298298
    Disable-WssBranchCache

NAME
    Enable-WssClientBackup
    
SYNOPSIS
    Enables client backup for a computer.
    
SYNTAX
    Enable-WssClientBackup [-ComputerName] <String> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Enable-WssClientBackup [-ComputerSid] <String> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssClientBackup cmdlet enables client backup for a computer. Specify a computer by name or security
    identifier (SID).
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Enable client backup for a computer
    
    PS C:\> Enable-WssClientBackup -ComputerName "Workstation073"
    
    
    This command enables client backup for a computer named Workstation073.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298302
    Disable-WssClientBackup
    Get-WssClientBackup
    Set-WssClientBackup
    Start-WssClientBackup
    Stop-WssClientBackup

NAME
    Enable-WssClientBackupVolume
    
SYNOPSIS
    Enables backup for a volume on a computer.
    
SYNTAX
    Enable-WssClientBackupVolume [-ComputerName] <String> [-VolumeGuid] <Guid> [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    Enable-WssClientBackupVolume [-ComputerSid] <String> [-VolumeGuid] <Guid> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssClientBackupVolume cmdlet enables client backup for a volume on a computer. Specify a computer by
    name or security identifier (SID). Specify a volume by using its GUID.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -VolumeGuid <Guid>
        Specifies the GUID of a volume.
        
        Required?                    true
        Position?                    4
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Enable backup for a volume
    
    PS C:\> Enable-WssClientBackupVolume -ComputerName "Workstation073" -VolumeGuid
    b6b093a2-1860-4172-a4a5-07ce2aebfa13
    
    
    This command enables backup for the specified volume on the computer named Workstation073.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298312
    Disable-WssClientBackupVolume
    Get-WssClientBackupVolume
    Get-WssClientBackupVolumeJob

NAME
    Enable-WssIntuneIntegration
    
SYNOPSIS
    Enable integration between Windows Server Essential and Windows Intune.
    
SYNTAX
    Enable-WssIntuneIntegration -IntuneUserName] <String>] [[-Password] <SecureString>] [[-Force [-Confirm]
    [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    Enable integration between Windows Server Essential and Windows Intune.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Force the Cmdlet operation without confirmation.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -IntuneUserName <String>
        user's principle name
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Password <SecureString>
        user's password
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1
    
    PS C:\>Enable-WssIntuneIntegration -IntuneUserName admin@wse.onmicrosoft.com -Password xxxxxxx
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/p/?linkid=324317

NAME
    Enable-WssMsoIntegration
    
SYNOPSIS
    Enables Windows Azure AD integration.
    
SYNTAX
    Enable-WssMsoIntegration [-MsoUserName] <String> [-Password] <SecureString> -Force [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssMsoIntegration cmdlet enables integration between Windows Server Essentials and Windows Azure Active
    Directory (Windows Azure AD). You must integrate these two products before you can further integrate Windows
    Server Essentials with Microsoft® Office 365 and Windows Intune™.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -MsoUserName <String>
        Specifies the user principal name (UPN) of the account with administrator permissions that is to be used to
        manage the online user accounts.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Password <SecureString>
        Specifies a password for a user, as a secure string. To obtain a secure string, use the ConvertTo-SecureString
        cmdlet. For more information, type Get-Help ConvertTo-SecureString. The password that you specify belongs to
        the online service account specified by the MsoUserName parameter.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        The MsoUserName in UPN form for the administrator account to be used to administer the online user accounts.
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Enable integration
    
    PS C:\> $Password = ConvertTo-SecureString "PassWord1" -AsPlainText -Force
    PS C:\> Enable-WssMsoIntegration -MsoUserName "PattiFuller@TSQA.Contoso.com" -Password $Password
    
    
    This example enables integration between Windows Server Essentials and Windows Azure AD. To enable integration,
    supply an online service account and a secure string that contains the password for that account.
    
    The first command creates a secure string by using the ConvertTo-SecureString cmdlet, and then stores it in the
    $Password variable. For more information, type Get-Help ConvertTo-SecureString.
    
    The second command enables integration. The command specifies the UPN of the online service account and the
    password stored in the $Password variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298374
    ConvertTo-SecureString
    Disable-WssMsoIntegration

NAME
    Enable-WssMsoSharePointPermissionInheritance
    
SYNOPSIS
    Enables permission inheritance for a SharePoint Online securable object.
    
SYNTAX
    Enable-WssMsoSharePointPermissionInheritance [-Library] <SharePointLibrary> [<CommonParameters>]
    
    Enable-WssMsoSharePointPermissionInheritance [-Site] <SharePointSite> [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssMsoSharePointPermissionInheritance cmdlet enables permission inheritance for a SharePoint Online
    securable object. Securable objects include sites, lists, libraries, folders, documents, or items.
    

PARAMETERS
    -Library <SharePointLibrary>
        Specifies a SharePoint library. The cmdlet enables permission inheritance for a library that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a SharePoint site. The cmdlet enables permission inheritance for a site that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary,Microsoft.WindowsServerSolutions.O365Integration
    .SharePointSite
        
        
    
        Library
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        Description: SharePoint library
        
        Site
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointSite
        
        Description: SharePoint site
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Enable SharePoint permission inheritance
    
    PS C:\> $Library = Get-WssMsoSharePointLibrary | Select-Object -First 1
    PS C:\> Enable-WssMsoSharePointPermissionInheritance -SharePointLibrary $Library
    
    
    The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the
    $Library variable.
    
    The second command enables permission inheritance for the library named $Library.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298382
    Disable-WssMsoSharePointPermissionInheritance
    

NAME
    Enable-WssMsoUser
    
SYNOPSIS
    Enables an online service account.
    
SYNTAX
    Enable-WssMsoUser [-WssUserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssMsoUser cmdlet enables the online service account that is assigned to a local network user account.
    You can use this command after disabling an account with Disable-WssMsoUser.
    

PARAMETERS
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet enables the online service account that is assigned to the
        user account that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName – the local account name of user to be enabled.
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Enable an online service account
    
    PS C:\> Enable-WssMsoUser -WssUserName "DavidChew"
    
    
    This command enables the online service account that is assigned to the user account named DavidChew.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298388
    Add-WssMsoUser
    Disable-WssMsoUser
    Get-WssMsoUser
    Remove-WssMsoUser

NAME
    Enable-WssRemoteWebAccess
    
SYNOPSIS
    Enables Remote Web Access.
    
SYNTAX
    Enable-WssRemoteWebAccess [-ApplyToExistingUsers] [-DenyAccessByDefault] [-SkipRouter] [<CommonParameters>]
    
    
DESCRIPTION
    The Enable-WssRemoteWebAccess cmdlet enables Remote Web Access on the Windows Server 2012 Essentials server.
    
    To disable Remote Web Access, use the Disable-WssRemoteWebAccess cmdlet.
    

PARAMETERS
    -ApplyToExistingUsers [<SwitchParameter>]
        Indicates that the cmdlet enables remote access for existing users. If you specify both DenyAccessByDefault
        and ApplyToExistingUsers, the cmdlet disables the remote access permission for existing users.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -DenyAccessByDefault [<SwitchParameter>]
        Indicates that the cmdlet denies Remote Web Access by default. If you specify both DenyAccessByDefault and
        ApplyToExistingUsers, the cmdlet disables remote access permission for existing users.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -SkipRouter [<SwitchParameter>]
        Indicates that the cmdlet skips the router configuration task. Use this parameter when you want to manually
        configure a router.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Enable Remote Web Access
    
    PS C:\> Enable-WssRemoteWebAccess -SkipRouter
    
    
    This command enables Remote Web Access but skips the router configuration task.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298404
    Repair-WssRemoteWebAccess

NAME
    Get-WindowsSearchSetting
    
SYNOPSIS
    Gets the values of settings for Windows Search.
    
SYNTAX
    Get-WindowsSearchSetting [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WindowsSearchSettings cmdlet gets the values of settings for Windows Search. You can view settings for
    whether Windows Search displays web results or suggestions and whether to display web results and suggestions
    while using a metered network. You can view settings for whether Windows Search personalizes results, including
    whether Windows Search employs  the specific location of the user. You can also see SafeSearch settings.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    WindowsSearchSetting
        
        
    
        Returns the values of properties that control Windows Search:
        
        -- EnableMeteredWebResultsSetting. Whether Windows Search displays web results and suggestions while using a
        metered network.
        -- EnableWebResultsSetting. Whether Windows Search displays web results and suggestions.
        -- SearchExperienceSetting. The experience setting.
        -- WindowsSafeSearchSetting. The value of SafeSearch that Windows Search uses for queries.
        
        SearchExperienceSetting has the following possible values:
        
        -- PersonlizedAndLocation. Personalize Windows Search and other Microsoft experiences by using search history,
        some Microsoft account information, and specific location of the user.
        -- Personalized. Personalize Windows Search and other Microsoft experiences by using search history and some
        Microsoft account information, but do not use specific location of the user.
        -- NotPersonalized. Do not personalize Windows Search and other Microsoft experiences or use specific location
        of the user.
        
        WindowsSafeSearchSetting has the following possible values:
        
        -- Off. Windows Search does not remove adult content from results.
        -- Moderate. Windows Search excludes adult images and videos, but not text, from results.
        -- Strict. Windows Search excludes adult images, videos, and text from results.
    
    
    Example 1: Get Windows Search settings
    
    PS C:\> Get-WindowsSearchSetting
    Setting                                                     Value
    -------                                                     -----
    EnableWebResultsSetting                                     True
    EnableMeteredWebResultsSetting                              True
    SearchExperience                                            PersonalizedAndLocation
    WindowsSafeSearchSetting                                    Moderate
    
    
    This command gets Windows Search settings. The console displays the values for the settings.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=294363
    Set-WindowsSearchSetting

NAME
    Get-WssAddIn
    
SYNOPSIS
    Gets installed add-ins.
    
SYNTAX
    Get-WssAddIn [[-Id] <Guid>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssAddIn cmdlet gets the add-ins for an installed package. If you do not specify the Id parameter, the
    cmdlet gets all installed add-ins on the local computer.
    

PARAMETERS
    -Id <Guid>
        Specifies the GUID for an installed package.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.AddinInfrastructure.PackageInfo
        
        
    
        This cmdlet returns package information of specific add-ins.
    
    
    Example 1: Get all installed add-ins
    
    PS C:\> Get-WssAddIn
    
    
    This command gets all add-ins installed on the local computer.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298264
    Install-WssAddIn
    Uninstall-WssAddIn

NAME
    Get-WssAlert
    
SYNOPSIS
    Gets alerts that the server generated.
    
SYNTAX
    Get-WssAlert -Network [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssAlert cmdlet gets alerts that the server generated for issues that relate to computer backups, server
    storage, low disk space, files system, and hard drives. Specify the Network parameter to get the alerts that the
    server generates for the local computer and the computers in your network that the server monitors.
    

PARAMETERS
    -Network [<SwitchParameter>]
        Indicates that the cmdlet gets alerts for all computers in the home network.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.Collections.IEnumerable<Microsoft.WindowsServerSolutions.NetworkHealth.AlertFramework.Alert
        
        
    
        This cmdlet returns a collection of alert objects.
    
    
    Example 1: Get alerts
    
    PS C:\> Get-WssAlert
    
    
    This command gets alerts that the server generated.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298222
    Enable-WssAlert
    Disable-WssAlert
    Clear-WssAlert
    Repair-WssAlert

NAME
    Get-WssBackupConfiguration
    
SYNOPSIS
    Gets file specifications from a volume that is part of a backup.
    
SYNTAX
    Get-WssBackupConfiguration [-Volume] <BackupVolume> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupConfiguration cmdlet gets file specifications from a volume that is part of a backup.
    

PARAMETERS
    -Volume <BackupVolume>
        Specifies the volume to back up.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupVolume
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupFileSpec
        
        
    
        This cmdlet returns the object that specifies whether files or folders are included in the server backup.
    
    
    Example 1: Get a backup file specification
    
    PS C:\>$ContosoBUVolume13 = Get-WssBackupVolume -AllVolumes
    PS C:\> $ContosoBUFSpec15 = Get-WssBackupConfiguration -Volume $ContosoBUVolume13[0]
    
    
    This example gets a backup file specification from a volume.
    
    The first command gets the backup volumes from the server and stores them in the $ContosoBUVolume13 variable.
    
    The second command gets the backup file specification from the first item (located in position 0) in
    $ContosoBUVolume13 and stores the backup file specification in the $ContosoBUFSpec15 variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298267
    Add-WssBackupConfiguration
    New-WssBackupConfiguration
    Remove-WssBackupConfiguration
    

NAME
    Get-WssBackupDisk
    
SYNOPSIS
    Gets a list of online hard disks that can be backup targets and can store server backups..
    
SYNTAX
    Get-WssBackupDisk [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupDisk cmdlet gets all online hard disks that can be  backup targets and can store server backups.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupDisk
        
        
    
        This cmdlet returns the disks which can be used as server backup targets.
    
    
    Example 1: Get a list of backup targets
    
    PS C:\> $ContosoBUDisk215 = Get-WssBackupDisk
    
    
    This command gets the list of currently available backup targets and stores the list in the variable named
    $ContosoBUDisk215.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298271
    Initialize-WssBackupDisk
    

NAME
    Get-WssBackupJob
    
SYNOPSIS
    Gets the status of current or previous backup jobs.
    
SYNTAX
    Get-WssBackupJob [[-JobCount] <UInt32>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupJob cmdlet gets the status of current or previous backup jobs.
    

PARAMETERS
    -JobCount <UInt32>
        Specifies how many past backup jobs to retrieve.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupJob
        
        
    
        This cmdlet returns the backup jobs retrieved.
    
    
    Example 1: Get status past backup jobs
    
    PS C:\> $ContosoBUJobs11 = Get-WssBackupJob -JobCount 10
    
    
    This command gets the status of the previous 10 backup jobs and stores the status in the variable named
    $ContosoBUJobs11.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298273
    Start-WssBackupJob
    Stop-WssBackupJob

NAME
    Get-WssBackupPolicy
    
SYNOPSIS
    Gets the current scheduled backup policy.
    
SYNTAX
    Get-WssBackupPolicy [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupPolicy cmdlet gets the current scheduled backup policy. The cmdlet returns an empty scheduled
    backup policy if no backup policy is configured.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet returns the server backup policy that specifies backup options such as backup targets, backup
        volume and schedule time.
    
    
    Example 1 Get the current scheduled backup policy
    
    PS C:\> $ContosoBUPol12 = Get-WssBackupPolicy
    
    
    This command gets the currently scheduled backup policy and stores it in the $ContosoBUPol12 variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298276
    Disable-WssBackupPolicy
    Resume-WssBackupPolicy
    Set-WssBackupPolicy
    Suspend-WssBackupPolicy

NAME
    Get-WssBackupSchedule
    
SYNOPSIS
    Gets the backup schedule from a scheduled backup policy.
    
SYNTAX
    Get-WssBackupSchedule [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupSchedule cmdlet gets the backup schedule from a scheduled backup policy.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy from which  to get the schedule.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.DateTime
        
        
    
        This cmdlet returns a list of backup schedule times.
    
    
    Example 1: Get a backup schedule from a scheduled backup policy
    
    PS C:\>$ContosoBUPolicy25 = Get-WssBackupPolicy
    PS C:\> Get-WssBackupSchedule -BackupPolicy $ContosoBUPolicy25
    
    
    This example gets the backup schedule from a scheduled backup policy.
    
    The first command gets the backup policy for the computer and stores the result in the $ContosoBUPolicy25 variable
    
    The second command gets the backup schedule from the scheduled backup policy stored in
    $ContosoBUPolicy25$ContosoBUSched25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298281
    Add-WssBackupSchedule
    Remove-WssBackupSchedule

NAME
    Get-WssBackupSet
    
SYNOPSIS
    Gets a collection of backup sets from a server backup.
    
SYNTAX
    Get-WssBackupSet [[-BackupTarget] <BackupTarget>] [[-MachineName] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupSet cmdlet gets a collection of backup sets from a server backup. A backup set is the output of a
    successful backup operation.
    

PARAMETERS
    -BackupTarget <BackupTarget>
        Specifies the target volume from which to get the backup sets.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -MachineName <String>
        Specifies the name of the server whose data is in the backup set.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupSet
        
        
    
        This cmdlet returns a backup set.
    
    
    Example 1: Get backup sets from a server backup
    
    PS C:\> Get-WssBackupSet -BackupTarget $ContosoWest01
    
    
    This command gets a list of backup sets from the server backup that is stored in the variable named $ContosoWest01.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298284
    Get-WssBackupJob
    Start-WssBackupJob
    Stop-WssBackupJob

NAME
    Get-WssBackupSystemRecovery
    
SYNOPSIS
    Gets a bare metal restore option from a scheduled backup policy.
    
SYNTAX
    Get-WssBackupSystemRecovery [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupSystemRecovery cmdlet gets a value that indicates whether a backup policy can perform bare metal
    restore operations. It gets this value from a scheduled backup policy. A bare metal restore operation restores a
    full operating system, including critical volumes, from a backup.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy for which to display information.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
     
    
OUTPUTS
    System.Boolean
        
        
    
        This cmdlet indicates whether BMR is enabled.
    
    
    Example 1: Get bare metal restore options from a backup policy
    
    PS C:\> Get-WssBackupSystemRecovery -BackupPolicy $ContosoBUPolicy25
    
    
    This command gets the bare metal restore option from the scheduled backup policy that is stored in the variable
    named $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298285
    Add-WssBackupSystemRecovery
    Remove-WssBackupSystemRecovery

NAME
    Get-WssBackupTarget
    
SYNOPSIS
    Retrieves all backup targets from a scheduled backup policy.
    
SYNTAX
    Get-WssBackupTarget [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupTarget cmdlet retrieves all backup targets from a scheduled backup policy. A scheduled backup
    policy is a backup file specification that has a backup schedule associated with it.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy from which to retrieve the backup target.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupTarget
        
        
    
        This cmdlet returns a list of backup targets.
    
    
    Example 1: Get all backup targets from a scheduled backup policy
    
    PS C:\> Get-WssBackupTarget -BackupPolicy $ContosoBUPolicy213
    
    
    This command gets all backup targets from the backup policy that is stored in the variable named
    $ContosoBUPolicy213.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298288
    Add-WssBackupTarget
    New-WssBackupTarget
    Remove-WssBackupTarget

NAME
    Get-WssBackupVolume
    
SYNOPSIS
    Gets backup volumes from a server, from a scheduled backup policy, or from existing backups.
    
SYNTAX
    Get-WssBackupVolume [-AllVolumes] [<CommonParameters>]
    
    Get-WssBackupVolume [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]
    
    Get-WssBackupVolume [-CriticalVolumes] [<CommonParameters>]
    
    Get-WssBackupVolume [-VolumeData] <ICollection<MountVhdData>> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBackupVolume cmdlet gets backup volumes from a server, from a scheduled backup policy, or from an
    existing backup.
    

PARAMETERS
    -AllVolumes [<SwitchParameter>]
        Indicates that the cmdlet gets all  backup volumes from a server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies a scheduled backup policy. The cmdlet gets all backup volumes from this scheduled backup policy.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -CriticalVolumes [<SwitchParameter>]
        Indicates that the cmdlet gets all critical volumes from a server. Critical volumes include the operating
        system volume and the Active Directory (AD) volume.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -VolumeData <ICollection<MountVhdData>>
        Specifies a virtual hard disk (VHD) from which to retrieve the volumes.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.string
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.ClientVolumeInfo
        
        
    
        This cmdlet returns backup volumes.
    
    
    Example 1: Get critical volumes from a backup
    
    PS C:\> Get-WssBackupVolume -CriticalVolumes
    
    
    This command gets critical volumes from the server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298292
    Add-WssBackupVolume
    Remove-WssBackupVolume

NAME
    Get-WssBpaScanResult
    
SYNOPSIS
    Gets the most recent BPA scan result.
    
SYNTAX
    Get-WssBpaScanResult [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBpaScanResult cmdlet gets the most recent Best Practices Analyzer (BPA) scan result. The BPA compares
    the server configuration with guidelines for the ideal way, under normal circumstances, to configure a server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.BPA.WssBpaIssue
        
        
    
        This cmdlet returns BPA issues.
    
    
    Example 1: Get a BPA scan result
    
    PS C:\> Get-WssBpaScanResult
    
    
    This command gets the most recent BPA scan result.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298296
    Invoke-WssBpaScan

NAME
    Get-WssBranchCacheStatus
    
SYNOPSIS
    Gets the current BranchCache status.
    
SYNTAX
    Get-WssBranchCacheStatus [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssBranchCacheStatus cmdlet gets the current BranchCache service status on the target computer, either
    enabled or disabled. BranchCache copies content from on-premise content servers or hosted cloud content servers
    and caches the content at branch office locations.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.BranchCache.BranchCacheStatus
        
        
    
     
    
    Example 1: Get BranchCache status
    
    PS C:\> Get-WssBranchCacheStatus
    
    
    This command gets the status of BranchCache on the server where you run the cmdlet.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298299

NAME
    Get-WssClientBackup
    
SYNOPSIS
    Gets information about client backup jobs.
    
SYNTAX
    Get-WssClientBackup [-ComputerName] <String> [<CommonParameters>]
    
    Get-WssClientBackup [-ComputerSid] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssClientBackup cmdlet gets information about client backup jobs for a computer. Specify a computer by
    name or security identifier (SID).
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.ClientJobInfo
        
        
    
        This cmdlet returns client job information.
    
    
    Example 1: Get client backup job information
    
    PS C:\> Get-WssClientBackup -ComputerName "Workstation073"
    
    
    This command gets information for client backup jobs for a computer named Workstation073.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298303
    Disable-WssClientBackup
    Enable-WssClientBackup
    Set-WssClientBackup
    Start-WssClientBackup
    Stop-WssClientBackup

NAME
    Get-WssClientBackupClient
    
SYNOPSIS
    Gets a list of clients that the server can back up.
    
SYNTAX
    Get-WssClientBackupClient [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssClientBackupClient cmdlet gets a list of the clients that the server can back up. You can use the
    Enable-WssClientBackup cmdlet to enable client backup for a specific computer.
    
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.ObjectModel.PCBackupClient
        
        
    
        This cmdlet returns PC backup clients.
    
    
    Example 1: Get the clients that the server can back up
    
    PS C:\> Get-WssClientBackupClient
    
    
    This command gets the list of clients that the server can back up.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298307
    Enable-WssClientBackup

NAME
    Get-WssClientBackupOperationStatus
    
SYNOPSIS
    Gets the status of backup-related operations.
    
SYNTAX
    Get-WssClientBackupOperationStatus [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssClientBackupOperationStatus cmdlet gets the status of backup-related operations for the server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.OperationStatusResponse
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.OperationStatusResponse
        
        
    
        This cmdlet generates client backup operation status.
    
    
    Example 1: Get status for backup operations
    
    PS C:\> Get-WssClientBackupOperationStatus
    
    
    This command gets the status of backup-related operations for the current server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298308
    Disable-WssClientBackup
    Enable-WssClientBackup
    Get-WssClientBackup
    Set-WssClientBackup
    Start-WssClientBackup
    Stop-WssClientBackup

NAME
    Get-WssClientBackupVolume
    
SYNOPSIS
    Gets the volume configuration of a computer.
    
SYNTAX
    Get-WssClientBackupVolume [-ComputerName] <String> [<CommonParameters>]
    
    Get-WssClientBackupVolume [-ComputerSid] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssClientBackupVolume cmdlet gets the volume configuration of a previously backed up computer. Specify a
    computer by name or security identifier (SID).
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.ObjectModel.PCBackupClientVolume
        
        
    
        This cmdlet generates a backup volume.
    
    
    Example 1: Get volume configuration for a client computer
    
    PS C:\> Get-WssClientBackupVolume -ComputerName "Workstation073"
    
    
    This command gets the volume configuration for a computer named Workstation073.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298313
    Disable-WssClientBackupVolume
    Enable-WssClientBackupVolume
    Get-WssClientBackupVolumeJob

NAME
    Get-WssClientBackupVolumeJob
    
SYNOPSIS
    Gets backup information for a backup volume job.
    
SYNTAX
    Get-WssClientBackupVolumeJob [-ComputerName] <String> [-BackupIndex] <Int32> [<CommonParameters>]
    
    Get-WssClientBackupVolumeJob [-ComputerSid] <String> [-BackupIndex] <Int32> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssClientBackupVolumeJob cmdlet gets backup information for a backup volume job. Specify a computer by
    name or security identifier (SID). Specify a job by using its index.
    

PARAMETERS
    -BackupIndex <Int32>
        Specifies the index for a backup volume job.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.VolumeJobInfo
        
        
    
        This cmdlet generates volume job information.
    
    
    Example 1: Get backup volume job information
    
    PS C:\> Get-WssClientBackupVolumeJob -ComputerName "Workstation073" -BackupIndex 1
    
    
    This command gets information for a backup volume job for the computer named Workstation073. The command specifies
    the backup index of the job.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298315
    Disable-WssClientBackupVolume
    Enable-WssClientBackupVolume
    Get-WssClientBackupVolume

NAME
    Get-WssClientBmrMediaGenerationJob
    
SYNOPSIS
    Gets the client full system restore media generation job status for a full system restore.
    
SYNTAX
    Get-WssClientBmrMediaGenerationJob [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssClientBmrMediaGenerationJob cmdlet gets the client full system restore media generation job status. A
    full system restore recovers the operating system from a backup, and is also called bare metal recovery (BMR). The
    status includes:
    
    -- Status. The current status of the job.
    -- LastStage. The last status of the job.
    -- Result. The job run result.
    -- BootableMediaPath. The path to the bootable media.
    
    The status also checks if the Original Equipment Manufacturer (OEM) image exists, if the Assessment and Deployment
    Kit (ADK) is ready, if the restore image is ready, if the media is ready, and if the Windows Deployment Services
    (WDS) image is deployed.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.GenBmrJobExecutionInfo
        
        
    
     
    
    Example 1: Get the media generation job status
    
    PS C:\> Get-WssClientBmrMediaGenerationJob
    
    
    This command gets the media generation job status.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298218
    Start-WssClientBmrMediaGenerationJob
    Stop-WssClientBmrMediaGenerationJob

NAME
    Get-WssComputer
    
SYNOPSIS
    Gets device information objects for the computers in a network.
    
SYNTAX
    Get-WssComputer [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssComputer cmdlet gets the device information objects for the computers in a network. A DeviceInfo object
    contains the properties for a computer. The cmdlet gets DeviceInfo objects for servers, clients, and archived
    clients. An archived client is a backup of a computer that is no longer part of the network.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Common.Devices.DeviceInfo
        
        
    
        A DeviceInfo object contains all the properties for a computer in the network.
    
    
    Example 1: Get properties for computers in a network
    
    PS C:\> Get-WssComputer
    
    
    This command gets the DeviceInfo objects for the computers in the network.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298317
    Remove-WssComputer

NAME
    Get-WssConfigurationStatus
    
SYNOPSIS
    Gets the status of the configuration of Windows Server Essentials.
    
SYNTAX
    Get-WssConfigurationStatus [-ShowProgress] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssConfigurationStatus cmdlet gets the status of the configuration of Windows Server Essentials. Specify
    the ShowProgress parameter to view a progress indicator.
    

PARAMETERS
    -ShowProgress [<SwitchParameter>]
        Indicates that the cmdlet displays a progress indicator. If you do not specify this parameter, the cmdlet
        displays current status information.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Setup.ICCommon.StatusInfo
        
        
    
        This cmdlet gets an object that represents the configuration status.
    
    
    Example 1: Get configuration status
    
    PS C:\> Get-WssConfigurationStatus
    
    
    This command gets configuration status of Windows Server Essentials.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298323
    Remove-WssConfigurationData
    Start-WssConfigurationService
    Test-WssConfigurationOption
    Test-WssPrecheckResult

NAME
    Get-WssDisk
    
SYNOPSIS
    Gets an object that represents a disk.
    
SYNTAX
    Get-WssDisk [-ID <Guid>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssDisk cmdlet gets an object that represents a disk. Specify a GUID for a specific disk. If you do not
    specify a GUID, the cmdlet gets Disk objects for all the drives for the current server. You can use the
    Initialize-WssDisk cmdlet to initialize a disk for Windows Server® 2012 Essentials storage.
    

PARAMETERS
    -ID <Guid>
        Specifies the GUID for a disk.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Disk
        
        
    
        This cmdlet generates the server Disk object.
    
    
    Example 1: Get a Disk object
    
    PS C:\> Get-WssDisk -ID "26a21bda-a627-11d7-9931-806e6f6e6963"
    
    
    This command gets the Disk object that has the ID 26a21bda-a627-11d7-9931-806e6f6e6963.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298324
    Initialize-WssDisk

NAME
    Get-WssDomainNameConfiguration
    
SYNOPSIS
    Gets the domain name configuration of the Windows Server Essentials computer.
    
SYNTAX
    Get-WssDomainNameConfiguration [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssDomainNameConfiguration cmdlet gets the domain name configuration of the Windows Server Essentials
    computer. This cmdlet returns Windows Server Essentials domain configuration settings, the name of the domain
    provider, the certificate status, and the expiration date of the certificate.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.RemoteAccess.Domains.DomainNameConfiguration
        
        
    
        This cmdlet generates the currently active domain name configuration object.
    
    
    Example 1: Get the domain name configuration of the Windows Server
    
    PS C:\> Get-WssDomainNameConfiguration
    
    
    This command gets the domain name configuration of Windows Server Essentials.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298327
    Set-WssDomainNameConfiguration

NAME
    Get-WssDrive
    
SYNOPSIS
    Gets an object that represents a drive.
    
SYNTAX
    Get-WssDrive [-ID <Guid>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssDrive cmdlet gets an object that represents a drive. Specify a GUID for a specific drive. If you do not
    specify a GUID, the cmdlet gets Drive objects for all the drives for the current server.
    

PARAMETERS
    -ID <Guid>
        Specifies the GUID for a drive.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Drive
        
        
    
        This cmdlet generates the server Drive object.
    
    
    Example 1: Get all drives
    
    PS C:\> Get-WssDrive
    
    
    This command gets Drive objects for all the drives for the current server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298329
    Set-WssDrive
    Test-WssDrive

NAME
    Get-WssDriveInUse
    
SYNOPSIS
    Checks whether a drive is in use.
    
SYNTAX
    Get-WssDriveInUse [-Drive] <Drive> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssDriveInUse cmdlet checks whether a drive is in use. To obtain a Drive object to check, use the
    Get-WssDrive cmdlet.
    

PARAMETERS
    -Drive <Drive>
        Specifies a Drive object. To obtain a Drive object, use the Get-WssDrive cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.DriveInUseRequest
        
        
    
        This cmdlet generates a drive in use indicator.
    
    
    Example 1: Check whether a drive is in use
    
    PS C:\>$Drive = Get-WssDrive -ID b6b093a2-1860-4172-a4a5-07ce2aebfa13
    PS C:\> Get-WssDriveInUse -Drive $Drive
    
    
    This example checks whether a specified drive is in use. The first command uses the Get-WssDrive cmdlet to get a
    Drive object that has the specified GUID, and stores it in the $Drive variable.
    
    The second command checks whether the Drive object stored in the $Drive variable is in use.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298332
    Get-WssDrive

NAME
    Get-WssFileHistoryConfiguration
    
SYNOPSIS
    Gets the File History configurations settings for the server.
    
SYNTAX
    Get-WssFileHistoryConfiguration [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssFileHistoryConfiguration cmdlet gets the File History configuration settings for the server. You can
    use the Set-WssFileHistoryConfiguration cmdlet to change the File History configuration settings.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.FileBackup.ConfigurationSet
        
        
    
        This cmdlet generates file history configuration settings.
    
    
    Example 1: Get the File History configurations settings
    
    PS C:\> Get-WssFileHistoryConfiguration
    
    
    This command gets the File History configuration settings for the server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298333
    Set-WssFileHistoryConfiguration
    Get-WssFileHistoryManagementStatus

NAME
    Get-WssFileHistoryManagementStatus
    
SYNOPSIS
    Gets the File History managed status of a user.
    
SYNTAX
    Get-WssFileHistoryManagementStatus [-UserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssFileHistoryManagementStatus cmdlet gets the File History managed status of a user. The cmdlet returns
    $True if the File History setting of the user is managed by the server.
    

PARAMETERS
    -UserName <String>
        Specifies the user name of an account.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.Boolean
        
        
    
        This cmdlet generates the file history managed status for a user, which is $True if the user's file history
        setting is managed by the server.
    
    
    Example 1: Get the File History managed status of a user
    
    PS C:\> Get-WssFileHistoryManagementStatus -UserName "DaveB"
    
    
    This command gets the File History managed status of a user named DaveB.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298335
    Set-WssFileHistoryManagementStatus
    Get-WssFileHistoryConfiguration

NAME
    Get-WssFolder
    
SYNOPSIS
    Gets an object that represents a folder.
    
SYNTAX
    Get-WssFolder [-ID] <Guid> [<CommonParameters>]
    
    Get-WssFolder [-Name] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssFolder cmdlet gets an object that represents a folder. Specify a GUID for a specific folder. If you do
    not specify a GUID, the cmdlet gets Folder objects for all the folders on current server.
    

PARAMETERS
    -ID <Guid>
        Specifies the GUID for a folder.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies the name of a folder.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Folder
        
        
    
        This cmdlet generates the server Folder object.
    
    
    Example 1: Get a folder by using a name
    
    PS C:\> Get-WssFolder -Name "ProjectsWest"
    
    
    This command gets the folder named ProjectsWest.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298338
    Set-WssFolder
    Add-WssFolder
    Move-WssFolder
    Remove-WssFolder
    Measure-WssFolder

NAME
    Get-WssGlobalClientBackupPolicy
    
SYNOPSIS
    Gets the current global client backup policy.
    
SYNTAX
    Get-WssGlobalClientBackupPolicy [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssGlobalClientBackupPolicy cmdlet gets the current global client backup policy. This policy includes the
    following values:
    
    -- BackupStartTime. The beginning of the backup window. The default value is 18:00.
    -- BackupEndTime. The end of the backup window. The default value is 9:00.
    -- DailyRetainCount. The number of daily backups to keep. The default value is five.
    -- WeeklyRetainCount. The number of weekly backups to keep. The default value is four.
    -- MonthlyRetainCount. The number of monthly backups to keep. The default value is six.
    -- YearlyRetainCount. The number of yearly backups to keep. The default value is ten.
    
    You can use the Set-WssGlobalClientBackupPolicy cmdlet to change any of these settings, or to reset all settings
    to their default values.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.PCBackupConfiguration
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.PCBackupConfiguration
        
        
    
        This cmdlet generates the PC backup configuration.
    
    
    Example 1: Get the global client backup policy
    
    PS C:\> Get-WssGlobalClientBackupPolicy
    
    
    This command gets the global client backup policy.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298343
    Set-WssGlobalClientBackupPolicy

NAME
    Get-WssMediaLibraryName
    
SYNOPSIS
    Gets the name of the Media Library.
    
SYNTAX
    Get-WssMediaLibraryName [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMediaLibraryName cmdlet gets the name of the Media Library for the current server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.String
        
        
    
        This cmdlet generates the name of the Media Library shared by the server.
    
    
    Example 1: Get the name of the Media Library
    
    PS C:\> Get-WssMediaLibraryName
    
    
    This command gets the name of the Media Library.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298347
    Set-WssMediaLibraryName

NAME
    Get-WssMediaServerEnabled
    
SYNOPSIS
    Gets the status of media streaming for a server.
    
SYNTAX
    Get-WssMediaServerEnabled [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMediaServerEnabled cmdlet gets the status of media streaming for the current server. You can use the
    Set-WssMediaServerEnabled cmdlet to enable or disable media streaming.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.Boolean
        
        
    
        This cmdlet generates a Boolean value that indicates whether or not media streaming is enabled on the server.
    
    
    Example 1: Get media streaming status
    
    PS C:\> Get-WssMediaServerEnabled
    
    
    This command gets the media streaming status for the current server. Media streaming is either enabled or disabled.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298349
    Set-WssMediaServerEnabled

NAME
    Get-WssMediaSharedFolder
    
SYNOPSIS
    Gets the shared folders included in the Media Library.
    
SYNTAX
    Get-WssMediaSharedFolder [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMediaSharedFolder cmdlet gets the shared folders included in the Media Library.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.MediaStreaming.MediaStreamingSharedFolder
        
        
    
        This cmdlet generates a shared folder object with information specific to media.
    
    
    Example 1: Get shared folders
    
    PS C:\> Get-WssMediaSharedFolder
    
    
    This command gets the shared folders included in the Medial Library.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298351
    Set-WssMediaLibraryInclusion
    Get-WssMediaServerEnabled
    Get-WssMediaLibraryName

NAME
    Get-WssMediaStreamingVideoQuality
    
SYNOPSIS
    Gets the video streaming quality of the videos that are streamed from the server.
    
SYNTAX
    Get-WssMediaStreamingVideoQuality [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMediaStreamingVideoQuality cmdlet gets the video streaming quality of the videos that are streamed from
    the server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.MediaStreaming.VideoQuality
        
        
    
     
    
    Example 1: Get the video streaming quality
    
    PS C:\>Get-WssMediaStreamingVideoQuality
    
    
    This command gets the video streaming quality for the server on which you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298353
    Set-WssMediaStreamingVideoQuality

NAME
    Get-WssMountVhd
    
SYNOPSIS
    Gets a collection of VHDs from a backup set.
    
SYNTAX
    Get-WssMountVhd [-BackupSet] <BackupSet> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMountVhd cmdlet gets a collection of virtual hard drives (VHDs) from a backup set. Each VHD represents
    a backup volume in the set.
    

PARAMETERS
    -BackupSet <BackupSet>
        Specifies the backup set from which to get the collection of VHDs.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.MountVhdData
        
        
    
        This cmdlet generates the Mount Vhd data.
    
    
    Example 1: Get VHDs from a backup set
    
    PS C:\> $ContosoBUSet25VHD = Get-WssMountVhd -BackupSet $ContosoBUSet25
    
    
    This example gets the VHD collection from the backup set that is stored in the variable named $ContosoBUSet25 and
    stores the collection in the variable named $ContosoBUSet25VHD.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298362
    Select-WssMountVhd

NAME
    Get-WssMsoAssignedGroup
    
SYNOPSIS
    Gets a security group assigned to a user group.
    
SYNTAX
    Get-WssMsoAssignedGroup [[-WssGroupName] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoAssignedGroup cmdlet gets a Windows Azure Active Directory (Windows Azure AD) security group that is
    assigned to a Windows Server Essentials user group. If you do not specify a user group, the cmdlet gets all the
    Windows Azure AD security groups. To get security groups that are not assigned to a user group, use the
    Get-WssMsoGroup cmdlet.
    

PARAMETERS
    -WssGroupName <String>
        Specifies the name of a Windows Server Essentials user group. The cmdlet gets the security group that is
        assigned to the user group that you specify.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssGroupName
        Type: System.String
        Description: local network account name of group
    
    
OUTPUTS
    MSOSecurityGroup[]
        
        
    
     
    
    Example 1: Get all security groups
    
    PS C:\> Get-WssMsoAssignedGroup
    LocalGroupName : All Employee
    Description    :
    IdentityType   : SecurityGroup
    ObjectId       : d77e9419-2e1f-4080-ae7c-9b97c6caa681
    PrincipleName  :
    DisplayName    : All Employees
    
    LocalGroupName : Admins
    Description    :
    IdentityType   : SecurityGroup
    ObjectId       : 77378d14-80ab-48fe-a2d4-e610b2c7eef6
    PrincipleName  :
    DisplayName    : Administrators
    
    
    This command gets all the security groups.
    
    Example 2: Get a security group by name
    
    PS C:\> Get-WssMsoAssignedGroup -WssGroupName "Admins"
    LocalGroupName : Admins
    Description    :
    IdentityType   : SecurityGroup
    ObjectId       : 77378d14-80ab-48fe-a2d4-e610b2c7eef6
    PrincipleName  :
    DisplayName    : Administrators
    
    
    This command gets the security group assigned to the user group named named Admins.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298365
    Add-WssMsoGroup
    Add-WssUserGroup
    Get-WssMsoGroup

NAME
    Get-WssMsoAssignedUser
    
SYNOPSIS
    Gets the online service account for a user.
    
SYNTAX
    Get-WssMsoAssignedUser [[-WssUserName] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoAssignedUser cmdlet gets the online service account assigned to a local network user account from
    Windows Azure Active Directory (Windows Azure AD). If you do not specify a user, the cmdlet gets all online
    service accounts.
    

PARAMETERS
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet gets the online service account that corresponds to the user
        account that you specify.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Get a Microsoft account
    
    PS C:\> Get-WssMsoAssignedUser -WssUserName "DavidChew"
    
    
    This command gets the online service account for the user account named DavidChew.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298366
    Rename-WssMsoAssignedUser
    Get-WssMsoAssignedGroup

NAME
    Get-WssMsoDomainConfiguration
    
SYNOPSIS
    Gets domain configuration information for Online Services.
    
SYNTAX
    Get-WssMsoDomainConfiguration [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoDomainConfiguration cmdlet gets domain configuration information for Microsoft Online Services from
    Windows Azure Active Directory (Windows Azure AD). Configuration information includes the domain name and
    validation status.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Get configuration information
    
    PS C:\> Get-WssMsoDomainConfiguration
    
    
    This command gets configuration information for the domain configuration of online services.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298367

NAME
    Get-WssMsoGroup
    
SYNOPSIS
    Gets security groups.
    
SYNTAX
    Get-WssMsoGroup [[-MsoId] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoGroup cmdlet gets Windows Azure Active Directory (Windows Azure AD) security groups. Specify an ID
    to get a particular security group. The cmdlet gets security groups whether or not they have an assignment to a
    user group.
    

PARAMETERS
    -MsoId <String>
        Specifies an ID for a security group. The cmdlet gets the security group that has the ID that you specify.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssGroupName
        Type: System.String
        Description: local network account name of group
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Get all security groups
    
    PS C:\> Get-WssMSOGroup
    LocalGroupName : Admins
    
    Description    :
    
    IdentityType   : SecurityGroup
    
    ObjectId       : 70769c52-b6e2-4ef6-8369-3c2a0208da68
    
    PrincipleName  :
    
    DisplayName    : Administrators
    
    
    LocalGroupName : All Employees
    
    Description    :
    
    IdentityType   : SecurityGroup
    
    ObjectId       : d77e9419-2e1f-4080-ae7c-9b97c6caa681
    
    PrincipleName  :
    
    DisplayName    : All Employees
    
    
    LocalGroupName :
    
    Description    :
    
    IdentityType   : SecurityGroup
    
    ObjectId       : 77378d14-80ab-48fe-a2d4-e610b2c7eef6
    
    PrincipleName  :
    
    DisplayName    : Other Admins
    
    
    This command gets all the security groups.
    
    Example 2: Get a specific security group
    
    PS C:\> Get-WssMsoGroup -MsoId "70769c52-b6e2-4ef6-8369-3c2a0208da68"
    LocalGroupName :
    
    Description    :
    
    IdentityType   : SecurityGroup
    
    ObjectId       : 70769c52-b6e2-4ef6-8369-3c2a0208da68
    
    PrincipleName  :
    
    DisplayName    : Other Admins
    
    
    This command gets the security group that has the specified ID.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298369
    Add-WssMsoGroup
    Remove-WssMsoGroup

NAME
    Get-WssMsoSharePointLibrary
    
SYNOPSIS
    Retrieves a SharePoint Online library.
    
SYNTAX
    Get-WssMsoSharePointLibrary [[-Name] <String>] [[-Site] <SharePointSite>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoSharePointLibrary cmdlet retrieves a Microsoft® SharePoint® Online library. A Microsoft® Office 365
    site stores the SharePoint Online library.
    

PARAMETERS
    -Name <String>
        Specifies the name of a SharePoint Online library. The cmdlet gets the library for the name that you specify.
        If you do not specify the Name parameter, the cmdlet returns libraries in the default team site that match
        other parameters.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a Microsoft® SharePoint® 2013 Products site. The cmdlet gets the library for the site that you
        specify. If you do not specify the Site parameter, the cmdlet returns libraries in the default team site that
        match other parameters.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        Name
        
        Type: System.String
        
        Description: Name of the SharePoint library
    
    
OUTPUTS
    SharePointLibrary[]
        
        
    
     
    
    Example 1: Get a SharePoint library
    
    PS C:\> $Site = Get-WssMsoSharePointSite | Select-Object -First 1
    PS C:\> Get-WssMsoSharePointLibrary -Name "Documents" -Site $Site
    
    
    The first command uses the Get-WssMsoSharePointSite cmdlet to get a site, and stores the result in the $Site
    variable.
    
    The second command gets the SharePoint Online library for the site specified in the $Site variable.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298376
    New-WssMsoSharePointLibrary
    Remove-WssMsoSharePointLibrary
    Set-WssMsoSharePointLibrary

NAME
    Get-WssMsoSharePointPermission
    
SYNOPSIS
    Gets permission settings for a SharePoint Online securable object.
    
SYNTAX
    Get-WssMsoSharePointPermission [-Library] <SharePointLibrary> [[-User] <SharePointUser>] [<CommonParameters>]
    
    Get-WssMsoSharePointPermission [-Site] <SharePointSite> [[-User] <SharePointUser>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoSharePointPermission cmdlet gets permission settings for a SharePoint Online securable object. A
    Microsoft® Office 365 site stores the SharePoint Online library.
    

PARAMETERS
    -Library <SharePointLibrary>
        Specifies a SharePoint library. The cmdlet gets permission settings for the library that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a SharePoint site. The cmdlet gets permission settings for the site that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -User <SharePointUser>
        Specifies a SharePoint user. The cmdlet gets permission settings for the user that you specify.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary,Microsoft.WindowsServerSolutions.O365Integration
    .SharePointSite
        
        
    
        Library
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        Description: SharePoint library
        
        Site
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointSite
        
        Description: SharePoint site
    
    
OUTPUTS
    System.String
        
        
    
     
    
    Example 1: Get SharePoint permissions
    
    PS C:\> $Library= Get-WssMmoSharePointLibrary | Select-Object -First 1
    PS C:\> $Principal= Get-WssMsoSharePointPrincipal | Select-Object -First 1
    PS C:\> Get-WssMSOSharePointObjectPermission -SecurableObject $Library -Principal $Principal
    
    
    The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the
    $Library variable.
    
    The second command uses the Get-WssMsoSharePointPrincipal cmdlet to get a SharePoint principal, and stores the
    result in the $Principal variable.
    
    The last command gets the SharePoint permissions for the library named $Library and the principal named $Principal.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298379
    Remove-WssMsoSharePointPermission
    Set-WssMsoSharePointPermission

NAME
    Get-WssMsoSharePointPrincipal
    
SYNOPSIS
    Gets all SharePoint 2013 principal objects, including users and groups.
    
SYNTAX
    Get-WssMsoSharePointPrincipal [[-UserName] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoSharePointPrincipal cmdlet gets all Microsoft® SharePoint® 2013 Products principal objects,
    including SharePoint 2013 users and groups.
    

PARAMETERS
    -UserName <String>
        Specifies a name for a user account. The cmdlet gets all SharePoint 2013 principal objects for the user name
        that you specify.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    SharepointPrincipal[]
        
        
    
     
    
    Example 1: Get principal objects
    
    PS C:\> $Principals = Get-WssMsoSharePointPrincipal
    
    
    This command gets the SharePoint 2013 principal objects.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298383

NAME
    Get-WssMsoSharePointSite
    
SYNOPSIS
    Gets SharePoint Online site configuration.
    
SYNTAX
    Get-WssMsoSharePointSite [[-Name] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoSharePointSite cmdlet gets SharePoint Online site configuration. A Microsoft® Office 365 site stores
    the SharePoint Online site configuration.
    

PARAMETERS
    -Name <String>
        Specifies a SharePoint site name. The cmdlet gets the site configuration for a SharePoint site that you
        specify.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        Name
        
        Type: System.String
        
        Description: Name of the SharePoint site
    
    
OUTPUTS
    SharePointSite[]
        
        
    
     
    
    Example 1: Get site configuration details
    
    PS C:\> Get-WssMSOSharePointSite
    
    
    Id                       : 0a2d5783-cfff-4ec2-bf34-539121f5fbbc
    Title                    : Contoso Team Site
    Description              :
    Uri                      : https://contoso.sharepoint.com/
    SubSitesRelativeUri      : {}
    ParentSite               :
    Libraries                : {SharePointLibrary { Id=5d92ec0b-da7d-4855-a81b-69b78020011f, Title=Documents,
    RelativeUri=/Shared%20Documents }}
    HasUniqueRoleAssignments : True
    RoleAssignments          : {3, 4, 5, 6...}
    
    
    This command gets the SharePoint site configuration details.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298384

NAME
    Get-WssMsoSubscription
    
SYNOPSIS
    Gets subscription information for Online Services.
    
SYNTAX
    Get-WssMsoSubscription [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoSubscription cmdlet gets subscription information for Microsoft Online Services.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Get subscription information
    
    PS C:\> Get-WssMsoSubscription
    
    
    This command gets the subscription information for Online Services.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298385

NAME
    Get-WssMsoUser
    
SYNOPSIS
    Gets the online service account for a user.
    
SYNTAX
    Get-WssMsoUser [[-MsoUserName] <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssMsoUser cmdlet gets the online service account for a user principal name (UPN) from Windows Azure
    Active Directory (Windows Azure AD). If you do not specify a UPN, the cmdlet gets all online service accounts.
    

PARAMETERS
    -MsoUserName <String>
        Specifies a UPN. The cmdlet gets the online service account for the UPN that you specify.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Get an online service account
    
    PS C:\> Get-WssMsoUser -MsoUserName "DavidChew@TSQA.Contoso.com"
    
    
    This command gets the online service account for the specified UPN.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298389
    Add-WssMsoUser
    Disable-WssMsoUser
    Enable-WssMsoUser
    Remove-WssMsoUser

NAME
    Get-WssPasswordPolicy
    
SYNOPSIS
    Gets the current password policy for a server.
    
SYNTAX
    Get-WssPasswordPolicy [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssPasswordPolicy cmdlet gets the current password policy for a server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Identity.PasswordPolicy
        
        
    
        This cmdlet generates the password policy object for the server.
    
    
    Example 1: Get the password policy for a server
    
    PS C:\> Get-WssPasswordPolicy
    
    
    This command gets the password policy from the server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298394

NAME
    Get-WssPersonalFolder
    
SYNOPSIS
    Gets the personal folder for a user.
    
SYNTAX
    Get-WssPersonalFolder [-UserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssPersonalFolder cmdlet gets the personal folder for the specified user.
    

PARAMETERS
    -UserName <String>
        Specifies the name of a user account. The cmdlet gets the personal folder for the account that you specify on
        the current server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    System.IO.DirectoryInfo
        
        
    
     
    
    Example 1: Get a personal folder
    
    PS C:\> Get-WssPersonalFolder -UserName "PattiFuller"
    
    
    This command gets the personal folder for the account named PattiFuller.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298397
    New-WssPersonalFolder

NAME
    Get-WssPoolableDisk
    
SYNOPSIS
    Gets disks to use to create storage space.
    
SYNTAX
    Get-WssPoolableDisk [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssPoolableDisk cmdlet gets objects that represent the physical disks to use to create storage space.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Disk
        
        
    
     
    
    Example 1: Get poolable disks
    
    PS C:\>Get-WssPoolableDisk
    
    
    This command gets objects that represent all of the physical disks available for storage space.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298398
    New-WssStorageSpace
    Add-WssDisksToSpacesPool

NAME
    Get-WssRecoveryItem
    
SYNOPSIS
    Gets child recovery items from a parent recovery item.
    
SYNTAX
    Get-WssRecoveryItem [-Parent] <RecoveryItem> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRecoveryItem cmdlet gets child recovery items from a parent recovery item.  When you restore a file or
    folder, this cmdlet helps you locate the file or folder to restore by browsing from the root folder to the child
    folders, until you locate the missing folder.
    

PARAMETERS
    -Parent <RecoveryItem>
        Specifies the parent recovery item.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.RecoveryItem
        
        
    
        This cmdlet generates a recovery item.
    
    
    Example 1: Get child recovery items
    
    PS C:\> $ContosoRecOptions05Child = Get-WssRecoveryItem -Parent $ContosoRecOptions05Parent
    
    
    This command gets child recovery options from the parent node that is stored in the variable named
    $ContosoRecOptions05Parent and stores those options in the variable named $ContosoRecOptions05Child.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298400
    New-WssRecoveryOption

NAME
    Get-WssRemoteConnection
    
SYNOPSIS
    Retrieves a listing of remote connections from Remote Web Access clients, VPN clients, or Web API applications.
    
SYNTAX
    Get-WssRemoteConnection [-From <DateTime>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRemoteConnection cmdlet retrieves a listing of remote connections to the Windows Server 2012 Essentials
    server by Remote Web Access clients, VPN clients, or Web API applications.
    

PARAMETERS
    -From <DateTime>
        Specifies a starting time from which to return connections. If you do not specify this parameter, the cmdlet
        retrieves all active connections.
        
        Required?                    false
        Position?                    named
        Default value                System.DateTime.MaxValue
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.RemoteConnectionManager.RemoteConnectionInfo
        
        
    
        This cmdlet generates information of remote connections to the server from Remote Web Access, VPN, or Web API
        applications.
    
    
    Example 1: Retrieve a listing of remote connections
    
    PS C:\> Get-WssRemoteConnection
    
    
    This command retrieves a listing of all current remote connections to the server.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298402

NAME
    Get-WssRemoteWebAccessBackgroundImage
    
SYNOPSIS
    Retrieves the filename of the background image displayed on the Remote Web Access website.
    
SYNTAX
    Get-WssRemoteWebAccessBackgroundImage [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRemoteWebAccessBackgroundImage cmdlet retrieves the filename of the background image displayed on the
    logon page of the Remote Web Access website.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.String
        
        
    
        This cmdlet generates a string object that represents the filename of a customized background image. The
        cmdlet does not generate any output if Remote Web Access uses the default image.
    
    
    Example 1: Retrieve the filename of the background image
    
    PS C:\> Get-WssRemoteWebAccessLink
    
    
    This command retrieves the filename of the background image.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298406
    Set-WssRemoteWebAccessBackgroundImage
    

NAME
    Get-WssRemoteWebAccessLink
    
SYNOPSIS
    Retrieves the collection of links on the home page of a Remote Web Access website
    
SYNTAX
    Get-WssRemoteWebAccessLink [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRemoteWebAccessLink cmdlet retrieves the collection of links on the home page of a Remote Web Access
    website. The links are key-value pairs of IDs and link items.
    
    To remove a link from the home page of a Remote Web Access website, use the Remove-WssRemoteWebAccessLink cmdlet.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.Collections.Generic.Dictionary<System.String,
    Microsoft.WindowsServerSolutions.Web.Admin.RemoteAccessLinkItem>
        
        
    
        This cmdlet generates a dictionary object where each value represents a link in Eemote Web Access.
    
    
    Example 1: Retrieve a collection of links
    
    PS C:\> Get-WssRemoteWebAccessLink
    
    
    This command retrieves the collection of links on the home page of a Remote Web Access website.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298409
    Add-WssRemoteWebAccessLink
    Remove-WssRemoteWebAccessLink

NAME
    Get-WssRemoteWebAccessLogo
    
SYNOPSIS
    Retrieves the name of the file that contains the logo for the Remote Web Access website.
    
SYNTAX
    Get-WssRemoteWebAccessLogo [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRemoteWebAccessLogo cmdlet retrieves the name of the file that contains the logo for the Remote Web
    Access website in Windows Server 2012 Essentials. The logo image customizes the appearance of the Remote Web
    Access website.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.String
        
        
    
        This cmdlet generates a string object that represents the filename of customized logo. The cmdlet does not
        generate any output if Remote Web Access uses the default logo.
    
    
    Example 1: Retrieve the name of the logo file
    
    PS C:\> Get-WssRemoteWebAccessLogo
    
    
    This command retrieves the name of the file that contains the logo for the Remote Web Access website.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298411
    Set-WssRemoteWebAccessLogo

NAME
    Get-WssRemoteWebAccessStatus
    
SYNOPSIS
    Retrieves the status of a Remote Web Access website.
    
SYNTAX
    Get-WssRemoteWebAccessStatus [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRemoteWebAccessStatus cmdlet retrieves the status of a Remote Web Access website in Windows Server 2012
    Essentials. The status information includes the status of the website and the state of the router and the domain.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.Admin.RemoteAccess.RemoteAccessStatus
        
        
    
        This cmdlet generates a remote access status object that represents the status of Remote Web Access.
    
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Retrieve the status of the website
    
    PS C:\> Get-WssRemoteWebAccessStatus
    
    
    This command retrieves the status of the Remote Web Access website.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298413

NAME
    Get-WssRemoteWebAccessTitle
    
SYNOPSIS
    Retrieves the title string of a Remote Web Access website.
    
SYNTAX
    Get-WssRemoteWebAccessTitle [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRemoteWebAccessTitle cmdlet retrieves the title string of a Remote Web Access website.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.String
        
        
    
        This cmdlet generates a string object that represents the title of Remote Web Access website.
    
    
    Example 1: Retrieve the title for a Remote Web Access website
    
    PS C:\> Get-WssRemoteWebAccessTitle
    
    
    This command retrieves the title for a Remote Web Access website.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298414
    Set-WssRemoteWebAccessTitle

NAME
    Get-WssReport
    
SYNOPSIS
    Gets the full list of unexpired health reports.
    
SYNTAX
    Get-WssReport [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssReport cmdlet gets the full list of unexpired health reports, including manually-generated and
    auto-generated reports.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Administration.WssReport
        
        
    
     
    
    Example 1: Get all health reports
    
    PS C:\> Get-WssReport
    
    
    This command gets all health reports on the server where you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298419
    New-WssReport
    Remove-WssReport
    Send-WssReport

NAME
    Get-WssReportEmailSetting
    
SYNOPSIS
    Gets the email settings of a health report.
    
SYNTAX
    Get-WssReportEmailSetting [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssReportEmailSetting cmdlet gets the email settings of a health report.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Administration.EmailSettings
        
        
    
     
    
    Example 1: Get the report email settings
    
    PS C:\> Get-WssReportEmailSetting
    
    
    This command gets the report email settings on the server on which you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298421
    Set-WssReportEmailSetting

NAME
    Get-WssReportHtml
    
SYNOPSIS
    Gets the HTML string of a specific health report.
    
SYNTAX
    Get-WssReportHtml [-Id] <Guid> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssReportHtml cmdlet gets the HTML string of a specific health report.
    

PARAMETERS
    -Id <Guid>
        Specifies the ID of a report instance. The cmdlet gets the report instance for the ID that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.Guid
        
        
    
     
    
OUTPUTS
    System.String
        
        
    
     
    
    Example 1: Get the report HTML string
    
    PS C:\> Get-WssReportHtml | Out-File -Filepath C:\Test01\Report.html
    
    
    This command gets the report HTML string on the server on which you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298423

NAME
    Get-WssReportSchedule
    
SYNOPSIS
    Gets the schedule of an automated health report.
    
SYNTAX
    Get-WssReportSchedule [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssReportSchedule cmdlet gets the schedule of an automated health report.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.HealthReport.ObjectModel.Contracts.ReportSchedule
        
        
    
     
    
    Example 1: Get the report schedule
    
    PS C:\> Get-WssReportSchedule
    
    
    This command gets the report schedule on the server on which you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298425
    Set-WssReportSchedule

NAME
    Get-WssReportSection
    
SYNOPSIS
    Gets a listing of the sections to include in a health report.
    
SYNTAX
    Get-WssReportSection [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssReportSection cmdlet gets a listing of the sections to include in a health report. The sections
    include:
    
    -- Backups
    -- CriticalAlertsAndWarnings
    -- ErrorsInEventLog
    -- SecurityAndUpdates
    -- ServiceNotRunning
    -- Storage
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Administration.WssReportSection
        
        
    
     
    
    Example 1: Get the report sections
    
    PS C:\> Get-WssReportSection
    
    
    This command gets the report sections for a health report on the server on which you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=294411
    Set-WssReportSection

NAME
    Get-WssRouterInformation
    
SYNOPSIS
    Retrieves information about the router for the local network.
    
SYNTAX
    Get-WssRouterInformation [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssRouterInformation cmdlet retrieves information about the router, including the IP address, name, and
    model.
    
    If the router supports Universal Plug and Play (UPnP), Windows Server 2012 Essentials server may be able to
    configure the router for your local network. If the router does not support UPnP, you must manually configure the
    router.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Retrieve router information
    
    PS C:\> Get-WssRouterInformation
    
    
    This command retrieves the router information for the local network.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298430

NAME
    Get-WssServerConnectionOption
    
SYNOPSIS
    Retrieves the server connection option.
    
SYNTAX
    Get-WssServerConnectionOption [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssServerConnectionOption cmdlet retrieves the server connection option in Windows Server 2012 Essentials.
    WSS supports the use of a terminal session directly to the server (RemoteDesktop) or the use of the dashboard as a
    remote application (RemoteApp).
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.String
        
        
    
        This cmdlet generates a string object representing the server connection option, either RemoteDesktop or
        RemoteApp (Dashboard).
    
    
    Example 1: Get the server connection option
    
    PS C:\> Get-WssServerConnectionOption
    
    
    This command gets the server connection option.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298431
    Set-WssServerConnectionOption

NAME
    Get-WssSpacesPool
    
SYNOPSIS
    Retrieves a storage pool, or all storage pools in the system.
    
SYNTAX
    Get-WssSpacesPool [-ID <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssSpacesPool cmdlet retrieves a storage pool in Windows Server 2012 Essentials, or all storage pools in
    the system.
    

PARAMETERS
    -ID <String>
        Specifies the ID of a storage pool to retrieve. If you do not specify this parameter, the cmdlet returns a
        list of all storage pools. Each storage pool object includes a unique ID.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.SpacesPool
        
        
    
        This cmdlet generates the storage pool in the system.
    
    
    Example 1: Retrieve all storage pools
    
    PS C:\> Get-WssSpacesPool
    
    
    This command retrieves all storage pools in the system.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298435

NAME
    Get-WssUser
    
SYNOPSIS
    Retrieves a user account by name or security identifier.
    
SYNTAX
    Get-WssUser [-Name] <String> [<CommonParameters>]
    
    Get-WssUser [-Sid] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssUser cmdlet retrieves a Windows Server 2012 Essentials server user account. To retrieve a user account
    by name, specify the login name. To retrieve a user account by security identifier, specify the SID. To retrieve
    all user accounts, use the cmdlet without arguments.
    

PARAMETERS
    -Name <String>
        Specifies the logon name of a user.
        
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Sid <String>
        Specifies the security identifier of a user.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Users.User
        
        
    
        This cmdlet generates the server user object with the specified properties.
    
    
    Example 1: Retrieve a user account by name
    
    PS C:\> Get-WSSUser -Name "SarahJones"
    
    
    This command retrieves a user account by name.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298438
    Add-WssUser
    Import-WssUser
    Remove-WssUser
    Sync-WssUser

NAME
    Get-WssUserGroup
    
SYNOPSIS
    Gets user groups.
    
SYNTAX
    Get-WssUserGroup [-Name <String>] [<CommonParameters>]
    
    Get-WssUserGroup [-Sid <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssUserGroup cmdlet gets Windows Server Essentials user groups. If you do not specify the name or security
    identifier (SID) of a group, the cmdlet gets all user groups.
    

PARAMETERS
    -Name <String>
        Specifies a name. The cmdlet gets the user group that has the name that you specify.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Sid <String>
        Specifies a SID. The cmdlet gets the user group that has the SID that you specify.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Groups.Group
        
        
    
     
    
    Example 1: Get a user group by specifying a name
    
    PS C:\> Get-WssUserGroup -Name "Support"
    
    
    This command gets the user group named Support.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298444
    Add-WssUserGroup
    Remove-WssUserGroup
    Set-WssUserGroup

NAME
    Get-WssWinSatCpuScore
    
SYNOPSIS
    Retrieves the Windows Experience Index processor subscore.
    
SYNTAX
    Get-WssWinSatCpuScore [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssWinSatCpuScore cmdlet retrieves a Windows Experience Index (WinSAT) processor subscore.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Retrieve the processor subscore
    
    PS C:\> Get-WssWinSatCpuScore
    
    
    This command retrieves the WinSAT processor subscore.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298451
    Set-WssWinSatCpuScore

NAME
    Get-WssWinSatCpuScoreUserConfigurable
    
SYNOPSIS
    Retrieves a setting that determines if a user can configure the CPU assessment.
    
SYNTAX
    Get-WssWinSatCpuScoreUserConfigurable [<CommonParameters>]
    
    
DESCRIPTION
    The Get-WssWinSatCpuScoreUserConfigurable cmdlet retrieves a setting that determines if a user can configure the
    CPU assessment.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Retrieve the user-configurable setting
    
    PS C:\> Get-WssWinSatCpuScoreUserConfigurable
    
    
    This command retrieves a setting that determines if the CPU assessment is user-configurable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298453
    Get-WssWinSatCpuScore
    Set-WssWinSatCpuScore

NAME
    Initialize-WssBackupDisk
    
SYNOPSIS
    Prepares a disk for, or removes a disk from, a Windows Server® 2012 Essentials backup.
    
SYNTAX
    Initialize-WssBackupDisk [-Disk] <Disk> [-Name] <String> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Initialize-WssBackupDisk [-Disk] <Disk> [-Remove] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Initialize-WssBackupDisk cmdlet prepares a disk to use as storage for a Windows Server® 2012 Essentials backup
    or removes a disk from a Windows Server 2012 Essentials backup. When the cmdlet prepares a disk for backup
    storage, it automatically formats the disk.
    

PARAMETERS
    -Disk <Disk>
        Specifies the disk to add to or remove from a Windows Server 2012 Essentials backup.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies the name of the backup disk.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Remove [<SwitchParameter>]
        Indicates that the cmdlet removes the disk from  a Windows Server 2012 Essentials backup.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Disk
        
        
    
     
    
    Example 1: Initialize a backup disk
    
    PS C:\>$ContosoBUDisk515 = Get-WssDisk
    PS C:\> Initialize-WssBackupDisk -Disk $ContosoDisk515[0] -Name "ContosoWSEBackup40"
    
    
    This example initializes a Windows Server 2012 Essentials backup disk.
    
    The first command gets a list of available disks and stores it in the variable named $ContosoBUDisk515.
    
    The second command initializes the first backup disk (located in position 0) in the array in $ContosoDisk515 and
    gives the new backup disk the name ContosoWSEBackup40.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298272
    Get-WssBackupDisk

NAME
    Initialize-WssDisk
    
SYNOPSIS
    Initializes a disk for Windows Server 2012 Essentials storage.
    
SYNTAX
    Initialize-WssDisk [-Disk] <Disk> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Initialize-WssDisk cmdlet initializes a disk that you can use for the Windows Server® 2012 Essentials storage
    system. The cmdlet formats and creates volumes for Windows Server 2012 Essentials on the disk that you specify.
    

PARAMETERS
    -Disk <Disk>
        Specifies a Disk object. To obtain a Disk object, use the Get-WssDisk cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Disk
        
        
    
        This cmdlet generates the disk for use in the Windows Server Essentials storage system to format and create
        volumes.
    
    
    Example 1: Initialize a disk for Windows Server 2012 Essentials storage
    
    PS C:\>$Disks = Get-WssDisk -ID "26a21bda-a627-11d7-9931-806e6f6e6963"
    PS C:\> Initialize-WssDisk -Disk $Disks
    
    
    The first command gets the Disk object that has the ID 26a21bda-a627-11d7-9931-806e6f6e6963, and stores it in the
    $Disks variable.
    
    The second command initializes the disk stored in the $Disks variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298325
    Get-WssDisk
    Add-WssDisksToSpacesPool

NAME
    Install-WssAddIn
    
SYNOPSIS
    Installs or redeploys an add-in package.
    
SYNTAX
    Install-WssAddIn [-PackagePath] <String> [-Force] [-InstallOnClients] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Install-WssAddIn [-Redeploy] [-Id] <Guid> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Install-WssAddIn cmdlet installs a new add-in or redeploys an installed add-in. To install an add-in, specify
    the path of a package file. To redeploy an add-in, specify the Id of the alert.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Id <Guid>
        Specifies the GUID for an installed package. The cmdlet redeploys the add-ins for this package.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -InstallOnClients [<SwitchParameter>]
        Indicates that cmdlet deploys the add-in to clients.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -PackagePath <String>
        Specifies the absolute path of the add-in package file (.wssx).
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  true
        
    -Redeploy [<SwitchParameter>]
        Indicates that the cmdlet redeploys an add-in. If you specify this parameter, specify the PackagePath
        parameter.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.AddinInfrastructure.PackageInfo
        
        
    
        This cmdlet generates package information about the installed add-in.
    
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Install an add-in package
    
    PS C:\> Install-WssAddIn -PackagePath "c:\TSQAaddin.wssx"
    
    
    This command installs the add-in from the add-in package named TSQAaddin.wssx.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298265
    Get-WssAddIn
    Uninstall-WssAddIn

NAME
    Install-WssVpnServer
    
SYNOPSIS
    Installs a VPN server.
    
SYNTAX
    Install-WssVpnServer [-ApplyToExistingUsers] [-AutoDetect] [-DenyAccessByDefault] [-NoSkip] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    Install-WssVpnServer [[-IPv4AddressRange] <IPAddress[]>] [[-IPv6AddressPrefix] <IPAddress>]
    [-ApplyToExistingUsers] [-DenyAccessByDefault] [-NoSkip] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Install-WssVpnServer [-ApplyToExistingUsers] [-DenyAccessByDefault] [-NoSkip] [-UseDhcp] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Install-WssVpnServer cmdlet installs a VPN server on Windows Server 2012 Essentials.
    
    

PARAMETERS
    -ApplyToExistingUsers [<SwitchParameter>]
        Indicates that access is granted to existing users.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -AutoDetect [<SwitchParameter>]
        Indicates that the VPN server automatically detect best-fit settings, regardless of previous settings.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -DenyAccessByDefault [<SwitchParameter>]
        Indicates that the VPN server deny access by default.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -IPv4AddressRange <IPAddress[]>
        Specifies an array of IPv4 addresses for the static IP address pool.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -IPv6AddressPrefix <IPAddress>
        Specifies the prefix of IPv6 addresses for the static IP address pool.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NoSkip [<SwitchParameter>]
        Indicates that the VPN server installation runs, even if there are no changes to the previous installation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UseDhcp [<SwitchParameter>]
        Indicates that DHCP assigns IP addresses to VPN clients.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Install a VPN server
    
    PS C:\> Install-WssVpnServer -AutoDetect
    
    
    This command installs a VPN server.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298448
    Test-WssVpnServerInstallation
    Uninstall-WssVpnServer

NAME
    Invoke-WssBpaScan
    
SYNOPSIS
    Starts a BPA scan.
    
SYNTAX
    Invoke-WssBpaScan [<CommonParameters>]
    
    
DESCRIPTION
    The Invoke-WssBpaScan cmdlet starts a Best Practices Analyzer (BPA) scan that raises BPA error or warning alerts.
    The BPA compares the server configuration with guidelines for the ideal way, under normal circumstances, to
    configure a server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Start a BPA scan
    
    PS C:\> Invoke-WssBpaScan
    
    
    This command starts a BPA scan.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298295
    Get-WssBpaScanResult

NAME
    Measure-WssFolder
    
SYNOPSIS
    Calculates the size of a given server folder.
    
SYNTAX
    Measure-WssFolder [-Folder] <Folder> [<CommonParameters>]
    
    
DESCRIPTION
    The Measure-WssFolder cmdlet calculates the size of a given server folder.
    

PARAMETERS
    -Folder <Folder>
        Specifies the folder to calculate the size of.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.CalculateFolderSizeRequest
        
        
    
        This cmdlet generates the CalculateFolderSizeRequest object which can be used to calculate the size of a
        server folder.
    
    
    Example 1: Calculate the size of a server folder
    
    PS C:\> $Pfolder = Get-WssFolder -Name "Projects01"
    Measure-WssFolder -Folder $Pfolder
    
    
    The first command gets the folder named Projects01, and stores the folder in the $Pfolder variable. The second
    command calculates the size of the server folder stored in $Pfolder.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298339
    Get-WssFolder
    Add-WssFolder
    Set-WssFolder
    Remove-WssFolder

NAME
    Move-WssFolder
    
SYNOPSIS
    Moves a server folder to a different drive.
    
SYNTAX
    Move-WssFolder [-Folder] <Folder> [-NewDrive] <String> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Move-WssFolder [-Folder] <Folder> [-Cancel] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Move-WssFolder cmdlet moves a server folder to a different drive.
    

PARAMETERS
    -Cancel [<SwitchParameter>]
        Indicates that the cmdlet attempts to cancel a move that is in progress.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Folder <Folder>
        Specifies the name of a folder.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NewDrive <String>
        Specifies the destination path for the folder on the new drive.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Folder
        
        
    
     
    
    Example 1: Move a folder to a different drive
    
    PS C:\> $Folder = Get-WssFolder -Name "ProjectsWest"
    PS C:\> Move-WssFolder -Folder $Folder -NewDrive "E:\"
    
    
    The first command gets the folder named ProjectsWest and stores it in the $Folder variable.
    
    The second command moves the folder stored it in the $Folder variable from the current drive to the root directory
    on the drive E.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298340
    Add-WssFolder
    Get-WssFolder
    Set-WssFolder
    Remove-WssFolder
    Measure-WssFolder

NAME
    New-WssBackupConfiguration
    
SYNOPSIS
    Creates a file specification that specifies the files and folders to include in or exclude from a backup.
    
SYNTAX
    New-WssBackupConfiguration [-FilePath] <String> [-FileName] <String> [-IsDirectory] [-IsExcludeSpec]
    [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssBackupConfiguration cmdlet creates a file specification for a backup of a volume. The file
    specification lists the files and folders to include in or exclude from the backup.
    

PARAMETERS
    -FileName <String>
        Specifies the name of a file to back up. Use * for this parameter to back up all files in the path that the
        FilePath parameter specifies.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -FilePath <String>
        Specifies the path that contains the files to back up.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -IsDirectory [<SwitchParameter>]
        Indicates that the file specification refers to a folder.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -IsExcludeSpec [<SwitchParameter>]
        Indicates that the cmdlet excludes the files in the specification from the backup
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupFileSpec
        
        
    
        This cmdlet generates the object that specifies whether files or folders are included or excluded in the
        server backup.
    
    
    Example 1: Create a backup file specification
    
    PS C:\> $Spec = New-WssBackupConfiguration -FilePath "c:\users\" -FileName * -IsDirectory -IsExcludeSpec
    
    
    This command creates a backup file specification that excludes folders in the c:\users path from the backup. It
    then stores the backup specification in the variable named $Spec.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298269
    Add-WssBackupConfiguration
    Get-WssBackupConfiguration
    Remove-WssBackupConfiguration

NAME
    New-WssBackupTarget
    
SYNOPSIS
    Creates a backup target from a backup disk.
    
SYNTAX
    New-WssBackupTarget [-Disk] <BackupDisk> -Label] <String>] [[-PreserveExistingBackups [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssBackupTarget cmdlet creates a backup target from a backup disk. A backup target defines storage
    locations for backups.
    

PARAMETERS
    -Disk <BackupDisk>
        Specifies the backup disk that stores backups.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Label <String>
        Specifies the label for the backup storage location.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -PreserveExistingBackups [<SwitchParameter>]
        Indicates that the cmdlet keeps existing backups on the disk in the BackupDisk parameter when the cmdlet adds
        a new backup to the disk.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupTarget
        
        
    
        This cmdlet generates the backup target.
    
    
    Example 1: Create a backup target from a backup disk
    
    PS C:\> New-WssBackupTarget -Disk $disks[1] -Label "Backup Disk 1" -PreserveExistingBackups
    
    
    This command creates a backup target labeled Backup Disk 1 from the second item, located in position 1, of the
    array that is stored in the $disks variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298290
    Add-WssBackupTarget
    Get-WssBackupTarget
    Remove-WssBackupTarget

NAME
    New-WssMsoSharePointLibrary
    
SYNOPSIS
    Creates a SharePoint Online library.
    
SYNTAX
    New-WssMsoSharePointLibrary [-Name] <String> [[-Description] <String>] [[-LibraryType] {InvalidType |
    NoListTemplate | DocumentLibrary | PictureLibrary | WebPageLibrary}] [[-Site] <SharePointSite>]
    -EnableVersioning -ForceCheckout [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssMsoSharePointLibrary cmdlet creates a Microsoft® SharePoint® Online library. A Microsoft® Office 365
    site stores the SharePoint Online library.
    

PARAMETERS
    -Description <String>
        Specifies a description of a SharePoint Online library. The cmdlet creates the library with the description
        that you specify.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -EnableVersioning [<SwitchParameter>]
        Indicates that versioning is enabled for this library.
        
        Required?                    false
        Position?                    5
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -ForceCheckout [<SwitchParameter>]
        Indicates that force checkout is enabled for this library.
        
        Required?                    false
        Position?                    6
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -LibraryType <SharePointLibraryType>
        Specifies the type of a SharePoint Online library. The cmdlet creates the library with the type that you
        specify.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies the name of a library. The cmdlet creates the SharePoint Online library with the name that you
        specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a SharePoint Online site. The cmdlet creates the library in the site that you specify. If you do not
        specify this parameter, the cmdlet creates the library under the default site.
        
        Required?                    false
        Position?                    4
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        Name
        
        Type: System.String
        
        Description: Name of the SharePoint library
    
    
OUTPUTS
    SharePointLibrary
        
        
    
     
    
    Example 1: Create a SharePoint library
    
    PS C:\> $Site = Get-WssMSOSharePointSite | Select-Object -First 1
    PS C:\> New-WssMsoSharePointLibrary -Name "Documents" -Description "SharePoint library used to share documents."
    -LibraryType "DocumentLibrary" -Site $Site -EnableVersioning
    SharePointLibraryType: DocumentLibrary = 101, PictureLibrary = 109, WebPageLibrary = 119
    
    
    The first command uses the Get-WssMsoSharePointSite cmdlet to get a site, and saves the result in the $Site
    variable.
    
    The second command creates a SharePoint Online library in the site specified in the $Site variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298375
    Get-WssMsoSharePointLibrary
    Remove-WssMsoSharePointLibrary
    Set-WssMsoSharePointLibrary

NAME
    New-WssPersonalFolder
    
SYNOPSIS
    Adds a personal folder to the current server.
    
SYNTAX
    New-WssPersonalFolder [-UserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssPersonalFolder cmdlet adds a personal folder to the current server for a user.
    

PARAMETERS
    -UserName <String>
        Specifies the name of a user account. The cmdlet adds a personal folder for the account that you specify to
        the current server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Add a personal folder
    
    PS C:\> New-WssPersonalFolder -UserName "PattiFuller"
    
    
    This command adds a personal folder for the user account named PattiFuller to the current server.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298396
    Get-WssPersonalFolder

NAME
    New-WssRecoveryOption
    
SYNOPSIS
    Creates a recovery configuration for a file restore operation.
    
SYNTAX
    New-WssRecoveryOption [-OverwriteExisting] [-RestoreAcl] [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssRecoveryOption cmdlet creates a recovery configuration that a later file restore operation can use to
    determine which files to restore.
    

PARAMETERS
    -OverwriteExisting [<SwitchParameter>]
        Indicates that the restore operation overwrites existing files.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -RestoreAcl [<SwitchParameter>]
        Indicates that the cmdlet restores an access control list (ACL) along with files. An ACL is a list of the
        users and groups that have permission to view or change a file.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.RecoveryOptions
        
        
    
        This cmdlet generates recovery options.
    
    
    Example 1: Create a recovery configuration
    
    PS C:\> $RecoverOpt15 = New-WssRecoveryOption -RestoreAcl
    
    
    This command creates a configuration for a file restore operation that includes the ACL along with files and
    stores the configuration in the variable named $RecoverOpt15.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298401
    Get-WssRecoveryItem

NAME
    New-WssReport
    
SYNOPSIS
    Creates a health report instance.
    
SYNTAX
    New-WssReport [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssReport cmdlet creates a health report instance.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Create a health report
    
    PS C:\> $InstanceId = New-WssReport
    
    
    This command creates a health report instance, and stores the ID in the variable $InstanceId.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298416
    Get-WssReport
    Remove-WssReport
    Send-WssReport

NAME
    New-WssStorageSpace
    
SYNOPSIS
    Creates a two-way mirrored storage space.
    
SYNTAX
    New-WssStorageSpace [-Disk] <ICollection<Disk>> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The New-WssStorageSpace cmdlet creates a two-way mirrored storage space on physical disks that you specify.
    

PARAMETERS
    -Disk <ICollection<Disk>>
        Specifies a collection of Disk objects. The cmdlet creates a storage space on the disks that you specify. To
        obtain Disk objects, use the Get-WssPoolableDisk cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Drive
        
        
    
     
    
    Example 1: Create a storage space
    
    PS C:\> $Disks = Get-WssPoolableDisk
    PS C:\> New-WssStorageSpace -Disk $Disks
    
    
    The first command uses the Get-WssPoolableDisk cmdlet to get the available poolable disks, and stores them in the
    $Disks variable.
    
    The second command creates a two-way mirrored storage space on the collection of disks stored in the $Disks
    variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298436
    Get-WssPoolableDisk
    Get-WssDisk
    Add-WssDisksToSpacesPool

NAME
    Remove-WssBackupConfiguration
    
SYNOPSIS
    Removes a file specification from a backup volume.
    
SYNTAX
    Remove-WssBackupConfiguration [-Volume] <BackupVolume> [-Configuration] <BackupFileSpec> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssBackupConfiguration cmdlet removes a file specification from a backup volume. When you remove a file
    specification from a backup volume, the files and folders in the file specification are no longer backed up with
    the backup volume.
    

PARAMETERS
    -Configuration <BackupFileSpec>
        Specifies the backup file specification to remove from the volume.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Volume <BackupVolume>
        Specifies the volume from which to remove the file specification.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupVolume
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupFileSpec
        
        
    
        This cmdlet generates an object that indicates whether to include or exclude files or folders in the server
        backup.
    
    
    Example 1: Remove a file specification from a backup volume
    
    PS C:\>$ContosoBUVolume110 = Get-WssBackupVolume -AllVolumes
    PS C:\> $ContosoBUFilespec05 = Get-WssBackupConfiguration –Volume $ContosoBUVolume110[0]
    PS C:\> Remove-WssBackupConfiguration -Configuration $ContosoBUFilespec05[1]
    
    
    This command removes the backup file specification from a backup volume.
    
    The first command gets the backup volumes from the server and stores them in the $ContosoBUVolume110 variable.
    
    The second command gets the backup file specification from the first item (located in position 0) in
    $ContosoBUVolume110 and stores the backup file specification in the $ContosoBUFilespec05 variable.
    
    The third command removes the backup file specification from the second item (located in position 1) in
    $ContosoBUFilespec05.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298270
    Add-WssBackupConfiguration
    Get-WssBackupConfiguration
    New-WssBackupConfiguration

NAME
    Remove-WssBackupSchedule
    
SYNOPSIS
    Removes a backup schedule from a scheduled backup policy.
    
SYNTAX
    Remove-WssBackupSchedule [-BackupPolicy] <ScheduledBackupPolicy> [-BackupTime] <DateTime> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssBackupSchedule cmdlet removes a date and time from a scheduled backup policy. This action removes
    the backup that is scheduled for that date and time from the policy.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to edit.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -BackupTime <DateTime>
        Specifies the date and time of the backup to remove from the schedule.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet generates the BackupPolicy parameter value.
    
    
    Example 1: Remove a scheduled backup from a policy
    
    PS C:\> Remove-WssBackupSchedule -BackupPolicy $ContosoBUPolicy25 -Schedule 5:00
    
    
    This command removes the scheduled backup at 5:00 A.M. daily from the policy that is stored in the variable named
    $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298283
    Get-WssBackupSchedule
    Add-WssBackupSchedule

NAME
    Remove-WssBackupSystemRecovery
    
SYNOPSIS
    Removes a bare metal recovery option from a scheduled backup policy.
    
SYNTAX
    Remove-WssBackupSystemRecovery [-BackupPolicy] <ScheduledBackupPolicy> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssBackupSystemRecovery cmdlet removes a bare metal recovery option from a scheduled backup policy. If
    you remove bare metal recovery from a scheduled backup policy, disaster recovery may not be possible.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy from which to remove the system recovery option.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet generates the BackupPolicy parameter value.
    
    
    Example 1: Remove a bare metal recovery option from a backup policy
    
    PS C:\> Remove-WssBackupSystemRecovery -BackupPolicy $ContosoBUPolicy25
    
    
    This command removes a bare metal recovery option from the backup policy that is stored in the variable named
    $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298287
    Add-WssBackupSystemRecovery
    Get-WssBackupSystemRecovery

NAME
    Remove-WssBackupTarget
    
SYNOPSIS
    Removes a backup target from a scheduled backup policy.
    
SYNTAX
    Remove-WssBackupTarget [-BackupPolicy] <ScheduledBackupPolicy> [-BackupTarget] <BackupTarget> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssBackupTarget cmdlet removes a backup target from a scheduled backup policy. A scheduled backup
    policy is a backup file specification that has a backup schedule associated with it. If you remove a backup target
    from a scheduled backup policy, backups that use the policy no longer back up the files and volumes that the
    target specifies.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy from which to remove the backup target.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -BackupTarget <BackupTarget>
        Specifies the name of the backup target to remove.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupTarget
        
        
    
        This cmldet generates backup targets.
    
    
    Example 1: Remove a backup target from a policy
    
    PS C:\>$ContosoBUPolicies10 = Get-WSSBackupPolicy
    PS C:\> $ContosoBUTarget = Get-WssBackupTarget -BackupPolicy $ContosoBUPolicies10[9]
    PS C:\> Remove-WssBackupTarget -BackupPolicy $ContosoBUPolicy10[9] -BackupTarget $ContosoBUTarget
    
    
    This example removes a backup target from a backup policy.
    
    The first command gets the current backup policies and stores them in the $ContosoBUPolicies10 variable.
    
    The second command gets the backup target for the tenth policy in the $ContosoBUPolicies10 array, and then stores
    the backup target in the $ContosoBUTarget variable.
    
    The third command removes the backup target that is stored in $ContosoBUTarget from the policy stored in
    $ContosoBUPolicies10[9].
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298291
    Add-WssBackupTarget
    Get-WssBackupTarget
    New-WssBackupTarget

NAME
    Remove-WssBackupVolume
    
SYNOPSIS
    Removes a backup volume from a scheduled backup policy.
    
SYNTAX
    Remove-WssBackupVolume [-BackupPolicy] <ScheduledBackupPolicy> [-BackupVolume] <BackupVolume> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssBackupVolume cmdlet removes a backup volume from a scheduled backup policy. When you remove a backup
    volume from a scheduled backup policy, backups that use the policy no longer back up the volume.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy from which to remove the backup volume.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -BackupVolume <BackupVolume>
        Specifies the backup volume to remove from the scheduled backup policy.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.BackupVolume
        
        
    
        This cmdlet generates a backup volume.
    
    
    Example 1: Remove a backup volume from a scheduled backup policy
    
    PS C:\> Remove-WssBackupVolume -BackupPolicy $ContosoBUPolicy215 -BackupVolume $ContosoBUVol50
    
    
    This command removes the backup volume that is stored in the variable named $ContosoBUVol50 from the scheduled
    backup policy that is stored in the variable named $ContosoBUPolicy215.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298294
    Add-WssBackupVolume
    Get-WssBackupVolume

NAME
    Remove-WssComputer
    
SYNOPSIS
    Removes a client computer identity, backup, and properties from the network.
    
SYNTAX
    Remove-WssComputer [-Computer] <DeviceInfo> [-RemoveBackup] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssComputer cmdlet removes a client computer identity, backup, and properties from the network. For
    active clients, the cmdlet removes the computer identity, but does not remove backups, unless you use the
    RemoveBackup parameter to remove associated backups.
    
    An archived client exists only as a backup of a computer that is no longer part of the network. This cmdlet
    removes the identity, backup, and properties for an archived client without the RemoveBackup parameter.
    

PARAMETERS
    -Computer <DeviceInfo>
        Specifies the DeviceInfo object for computer. To obtain DeviceInfo objects, use the Get-WssComputer cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -RemoveBackup [<SwitchParameter>]
        Indicates that the cmdlet removes any backups for the specified computer.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Remove a computer and backups
    
    PS C:\>$DeviceList = Get-WssComputer
    PS C:\> Remove-WssComputer -Computer $DeviceList[0] -RemoveBackup
    
    
    This example removes a computer identity and any backups from the network.
    
    The first command uses the Get-WssComputer cmdlet to get all DeviceInfo objects, and then stores them in the
    $DeviceList variable.
    
    The second command removes a DeviceInfo object. The command uses standard array notation to specify the first
    element of the $DeviceList array as the computer to be removed. The command includes the RemoveBackup parameter.
    Therefore, the command removes any backups.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298318
    Get-WssComputer

NAME
    Remove-WssComputerAccess
    
SYNOPSIS
    Removes a relationship between a user and a computer for Remote Web Access.
    
SYNTAX
    Remove-WssComputerAccess [-GroupName <String>] [-UserName <String>] -ComputerName <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssComputerAccess cmdlet removes a relationship between a user account and a computer used for Remote
    Web Access. After you remove the relationship, a user cannot access a computer by means of Remote Web Access. You
    can use the Add-WssComputerAccess cmdlet to create a relationship for use with Remote Web Access.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -GroupName <String>
        Specifies the name of a group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserName <String>
        Specifies the user name of an account.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Remove computer access for a user
    
    PS C:\> Remove-WssComputerAccess -ComputerName "Workstation033" -UserName "SarahJones"
    
    
    This command deletes a relationship between the user SarahJones and the computer named Workstation033. The user
    can no longer use Remote Web Access to connect to this computer.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298320
    Add-WssComputerAccess

NAME
    Remove-WssConfigurationData
    
SYNOPSIS
    Removes data, scheduled tasks, and log files and disables the Windows Server Essential Experience role.
    
SYNTAX
    Remove-WssConfigurationData [-Force] [-ValidateOnly] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssConfigurationData cmdlet removes data, scheduled tasks, and log files that the Windows Server
    Essential Experience role uses. After you run this cmdlet, you can then remove the Windows Server Essential
    Experience role.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ValidateOnly [<SwitchParameter>]
        Indicates that the cmdlet validates that the Windows Server Essential Experience role is configured on the
        target server. Use this parameter to determine if you must remove the configuration data before you can remove
        the Windows Server Essential Experience role.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.Boolean, Microsoft.WindowsServerSolutions.Setup.ICCommon.StatusInfo
        
        
    
        This cmdlet generates either a Boolean value or a StatusInfo object. If you specify the ValidateOnly
        parameter, the cmdlet responds with whether the target server qualifies to run cleanup. If you do not specify
        the ValidateOnly parameter, the cmdlet provides the service configuration status.
    
    
    Example 1: Remove configuration data
    
    PS C:\> Remove-WssConfigurationData
    
    
    This command removes the configuration data and disables the Windows Server Essential Experience role.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkId=298247
    Get-WssConfigurationStatus
    Start-WssConfigurationService
    Test-WssConfigurationOption
    Test-WssPrecheckResult

NAME
    Remove-WssFolder
    
SYNOPSIS
    Removes a server folder.
    
SYNTAX
    Remove-WssFolder [-DeleteContents] [-Force] -Name <String> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Remove-WssFolder [-DeleteContents] [-Force] -Folder <Folder> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Remove-WssFolder [-DeleteContents] [-Force] -ID <Guid> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssFolder cmdlet removes a server folder. If you specify the DeleteContents parameter, the cmdlet
    deletes the contents of the server folder that you specify. If you do not specify the DeleteContents parameter,
    the cmdlet stops sharing the contents of the server folder.
    

PARAMETERS
    -DeleteContents [<SwitchParameter>]
        Indicates that the cmdlet deletes the contents of the server folder.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Folder <Folder>
        Specifies the name of a folder.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ID <Guid>
        Specifies the GUID for a folder.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies the name of a folder.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.Storage.Folder
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Folder
        
        
    
        This cmdlet generates an object that represents the removed folder.
    
    
    Example 1: Remove a server folder
    
    PS C:\> Remove-WssFolder -Name "ProjectsNorth" -DeleteContents
    
    
    This command removes the server folder named ProjectsNorth and deletes all the contents of the folder.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298341
    Add-WssFolder
    Get-WssFolder
    Set-WssFolder
    Move-WssFolder
    Measure-WssFolder

NAME
    Remove-WssMsoGroup
    
SYNOPSIS
    Removes a security group that is assigned to a user group.
    
SYNTAX
    Remove-WssMsoGroup [-WssGroupName] <String> -Force [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssMsoGroup cmdlet removes a Windows Windows Azure Active Directory (Windows Azure AD) security group
    that is assigned to a Windows Server Essentials user group. This cmdlet removes both the assignment and the
    security group itself from Windows Azure AD. To remove just the assignment, use the Remove-WssMsoGroupAssignment
    cmdlet. If the group that is specified is not assigned to a Windows Server Essentials user group, no error is
    generated, but nothing is done to the group.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WssGroupName <String>
        Specifies the name of a Windows Server 2012 R2 Essentials user group. The cmdlet removes the security group
        assigned to the user group that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssGroupName
        Type: System.String
        Description: local network account name of group
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove a security group
    
    PS C:\> Remove-WssMSOGroup -WssGroupName "Admins"
    
    
    This command removes the security group assigned to the user group named Admins.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298370
    Add-WssMsoGroup
    Get-WssMsoGroup
    Remove-WssMsoGroupAssignment

NAME
    Remove-WssMsoGroupAssignment
    
SYNOPSIS
    Removes the assignment of a security group to a user group.
    
SYNTAX
    Remove-WssMsoGroupAssignment [-WssGroupName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssMsoGroupAssignment cmdlet removes the assignment of a Windows Azure Active Directory (Windows Azure
    AD) security group to a Windows Server Essentials user group. This cmdlet does not remove the user group or the
    Windows Azure AD security group. After this cmdlet runs, the local group no longer syncs with the Windows Azure AD
    group. To remove a security group, use the Remove-WssMsoGroup cmdlet.
    

PARAMETERS
    -WssGroupName <String>
        Specifies the name of a Windows Server 2012 R2 Essentials user group. The cmdlet removes the assignment of a
        security group for the user group that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssGroupName
        Type: System.String
        Description: local network account name of group
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove an assigned security group
    
    PS C:\> Clear-WssMSOAssignedGroup -WssGroupName "AllEmployee"
    
    
    This command removes the assignment to a security group for the user group named AllEmployee.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298371
    Set-WssMsoGroupAssignment
    Remove-WssMsoUserAssignment

NAME
    Remove-WssMsoSharePointLibrary
    
SYNOPSIS
    Removes a SharePoint Online library.
    
SYNTAX
    Remove-WssMsoSharePointLibrary [-Library] <SharePointLibrary> -Force [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssMsoSharePointLibrary cmdlet removes a Microsoft® SharePoint® Online library. A Microsoft® Office 365
    site stores the SharePoint Online library.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Library <SharePointLibrary>
        Specifies a SharePoint Online library object. The cmdlet removes the library that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        
    
        Library
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        Description: SharePoint library
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove a SharePoint library
    
    PS C:\> $Library = Get-WssMsoSharePointLibrary | Select-Object -First 1
    PS C:\> Remove-WssMsoSharePointLibrary -Library $Library
    
    
    The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the
    $Library variable.
    
    The second command removes the library named $Library.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298377
    Get-WssMsoSharePointLibrary
    New-WssMsoSharePointLibrary
    Set-WssMsoSharePointLibrary

NAME
    Remove-WssMsoSharePointPermission
    
SYNOPSIS
    Removes a permission relationship between a SharePoint 2013 user or group and a library or site.
    
SYNTAX
    Remove-WssMsoSharePointPermission [-Library] <SharePointLibrary> [[-User] <SharePointUser>] [<CommonParameters>]
    
    Remove-WssMsoSharePointPermission [-Site] <SharePointSite> [[-User] <SharePointUser>] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssMsoSharePointPermission cmdlet removes a permission relationship between a Microsoft® SharePoint®
    2013 Products user or group and a  SharePoint 2013 library or site. A Microsoft® Office 365 site stores the  
    Microsoft® SharePoint® Online library.
    

PARAMETERS
    -Library <SharePointLibrary>
        Specifies a  SharePoint 2013 library. The cmdlet removes a permission relationship for the library that you
        specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a  SharePoint 2013 site. The cmdlet removes a permission relationship for the site that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -User <SharePointUser>
        Specifies a SharePoint 2013 user. The cmdlet removes a permission relationship for the user that you specify.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary,Microsoft.WindowsServerSolutions.O365Integration
    .SharePointSite
        
        
    
        Library
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        Description: SharePoint library
        
        Site
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointSite
        
        Description: SharePoint site
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove a SharePoint permission relationship
    
    PS C:\>Remove-WssMsoSharePointPermission -User "Admin01"
    
    
    This command removes SharePoint 2013 permissions for the user.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298357
    Get-WssMsoSharePointPermission
    Set-WssMsoSharePointPermission

NAME
    Remove-WssMsoUser
    
SYNOPSIS
    Removes an online service account.
    
SYNTAX
    Remove-WssMsoUser [-WssUserName] <String> -Force [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssMsoUser cmdlet removes an online service account from Windows Azure Active Directory (Windows Azure
    AD). Specify the name of the local network user account that the account is assigned to.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet removes the online service account that is assigned to the
        account that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove an online service account
    
    PS C:\> Remove-WssMsoUser -WssUserName "EvanNarvaez"
    
    
    This command removes the online service account that is assigned to the local network account named EvanNarvaez.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298390
    Add-WssMsoUser
    Disable-WssMsoUser
    Enable-WssMsoUser
    Get-WssMsoUser

NAME
    Remove-WssMsoUserAssignment
    
SYNOPSIS
    Removes the assignment between an online service account and an account.
    
SYNTAX
    Remove-WssMsoUserAssignment [-WssUserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssMsoUserAssignment cmdlet removes the online service account (the Microsoft account) from its
    assignment to a local network user account. This cmdlet does not otherwise modify or delete either account.
    

PARAMETERS
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet removes the assignment to the online service account for the
        user account that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
NOTES
    
    
        Note: If you run this command against a local network user account that does not have a Microsoft account it
        generates an error.
    
    Example 1: Remove an assignment
    
    PS C:\> Remove-WssMsoUserAssignment -WssUserName "PattiFuller"
    
    
    This command removes the assignment between the user account named PattiFuller and an online service account.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298391
    Set-WssMsoUserAssignment
    Get-WssMsoAssignedUser
    Remove-WssMsoGroupAssignment

NAME
    Remove-WssRemoteWebAccessLink
    
SYNOPSIS
    Removes a link from the home page of a Remote Web Access website.
    
SYNTAX
    Remove-WssRemoteWebAccessLink -ID <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssRemoteWebAccessLink cmdlet removes a link from the home page of a Remote Web Access website.
    
    To add a link to the home page of a Remote Web Access website, use the Add-WssRemoteWebAccessLink cmdlet.
    

PARAMETERS
    -ID <String>
        Specifies the key for the link you want to remove. To obtain a list of IDs, use the Get-RemoteWebAccessLink
        cmdlet.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Remove a link from a home page
    
    PS C:\> Remove-WssRemoteWebAccessLink -ID "23456789-ACAC-0330-9975-A246890654BC"
    
    
    This command removes a link from a home page in Remote Web Access.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298410
    Add-WssRemoteWebAccessLink
    Get-WssRemoteWebAccessLink

NAME
    Remove-WssReport
    
SYNOPSIS
    Removes a health report instance.
    
SYNTAX
    Remove-WssReport [-Id] <Guid> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssReport cmdlet removes a single health report instance identified by its ID.
    

PARAMETERS
    -Id <Guid>
        Specifies the ID of a health report instance. The cmdlet removes the health report instance that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.Guid
        
        
    
        Report
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove an instance of a health report
    
    PS C:\> $Reports = Get-WssReport
    PS C:\> Remove-WssReport $Reports[0].Id
    
    
    The first command uses the Get-WssReport cmdlet to get all instances of reports, and saves the results in the
    $Reports variable.
    
    The second command removes an instance of a health report by using the ID of the first instance in the $Reports
    variable.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298417
    Get-WssReport
    New-WssReport
    Send-WssReport

NAME
    Remove-WssUser
    
SYNOPSIS
    Deletes a user.
    
SYNTAX
    Remove-WssUser -Name <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssUser cmdlet deletes a user from a Windows Server 2012 Essentials server.
    
    

PARAMETERS
    -Name <String>
        Specifies the logon name of a user.
        
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Delete a user
    
    PS C:\> Remove-WssUser -Name "SarahJones"
    
    
    This command deletes a user from WSS by using the logon name.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298439
    Add-WssUser
    Get-WssUser
    Import-WssUser
    Sync-WssUser

NAME
    Remove-WssUserGroup
    
SYNOPSIS
    Removes a user group.
    
SYNTAX
    Remove-WssUserGroup -Name <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssUserGroup cmdlet removes a user group. If you previously assigned a Windows Azure Active Directory
    (Windows Azure AD) security group to the group to remove, this cmdlet removes the assignment, but does not remove
    the security group.
    

PARAMETERS
    -Name <String>
        Specifies a name. The cmdlet removes the user group that you specify by name.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove a user group
    
    PS C:\> Remove-WssUserGroup -Name "Support"
    
    
    This command removes a user group named support, as well as the assignment to a security group, if one exists.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298445
    Add-WssUserGroup
    Get-WssUserGroup
    Set-WssUserGroup

NAME
    Remove-WssUserGroupMembership
    
SYNOPSIS
    Removes a user from a user group.
    
SYNTAX
    Remove-WssUserGroupMembership -GroupName <String> -UserName <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Remove-WssUserGroupMembership cmdlet removes a user account from a user group.
    

PARAMETERS
    -GroupName <String>
        Specifies the name of a user group. The cmdlet removes a user account from the group that you specify.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserName <String>
        Specifies the name of a user account. The cmdlet removes the account that you specify from a group.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Remove a user from a group
    
    PS C:\> Remove-WssUserGroupMembership -GroupName "HRGroup" -UserName "EvanNarvaez"
    
    
    This command removes the account named EvanNarvaez from the user group named HRGroup.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298245
    Add-WssUserGroupMembership

NAME
    Rename-WssMsoAssignedUser
    
SYNOPSIS
    Modifies the online service account for a user.
    
SYNTAX
    Rename-WssMsoAssignedUser [-WssUserName] <String> [-NewMsoUserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Rename-WssMsoAssignedUser cmdlet modifies the online service account assigned to a local network user account
    in Windows Azure Active Directory (Windows Azure AD).
    

PARAMETERS
    -NewMsoUserName <String>
        Specifies an online service account, as a user principal name (UPN). The cmdlet assigns the UPN that you
        specify to the user that the WssUserName parameter specifies.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet updates the online service account for the user account that
        you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Modify a Microsoft account
    
    PS C:\> Update-WssMSOAccountName -WssUserName "DavidChew" -NewMsoUserName "DavidChew@TSQA.Contoso.com"
    
    
    This command modifies the online service account for the user account named DavidChew.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=313378
    Get-WssMsoAssignedUser

NAME
    Repair-WssAlert
    
SYNOPSIS
    Repairs an alert.
    
SYNTAX
    Repair-WssAlert [-FeatureName] <String> [-HealthDefinitionName] <String> [[-MachineName] <String>]
    [<CommonParameters>]
    
    Repair-WssAlert [-Alert] <Alert> [<CommonParameters>]
    
    
DESCRIPTION
    The Repair-WssAlert cmdlet runs the repair task for an alert. Specify an alert object or specify the feature and
    health definition file associated with the alert.
    

PARAMETERS
    -Alert <Alert>
        Specifies a WssAlert object. To obtain a WssAlert object, use the Get-WssAlert cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -FeatureName <String>
        Specifies the name of the feature associated with the alert.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -HealthDefinitionName <String>
        Specifies the name of the health definition associated with the alert.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -MachineName <String>
        Specifies the name of the computer on which the server generated the alert.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.NetworkHealth.AlertFramework.Alert
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Repair an alert
    
    PS C:\> Repair-WssAlert -FeatureName "MicrosoftServicing" -HealthDefinitionName "MUOptIn"
    
    
    This command runs the repair task for the alert associated with the feature named MicrosoftServicing and the
    health definition named MUOptIn.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298223
    Get-WssAlert
    Enable-WssAlert
    Disable-WssAlert
    Clear-WssAlert

NAME
    Repair-WssMediaStreamingMetadata
    
SYNOPSIS
    Repairs the database that stores information for media streaming.
    
SYNTAX
    Repair-WssMediaStreamingMetadata [<CommonParameters>]
    
    
DESCRIPTION
    The Repair-WssMediaStreamingMetadata cmdlet repairs the database that stores information for media streaming. Use
    this cmdlet only when you see symptoms of data corruption.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Repair media streaming metadata
    
    PS C:\>Repair-WssMediaStreamingMetadata
    
    
    This command repairs the database that contains media streaming metadata.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298352
    Get-WssMediaLibraryName
    Set-WssMediaLibraryName

NAME
    Repair-WssRemoteWebAccess
    
SYNOPSIS
    Repairs Remote Web Access.
    
SYNTAX
    Repair-WssRemoteWebAccess [-SkipRouter] [<CommonParameters>]
    
    
DESCRIPTION
    The Repair-WssRemoteWebAccess cmdlet repairs Remote Web Access in a Windows Server 2012 Essentials installation.
    The cmdlet initializes and starts the service.
    

PARAMETERS
    -SkipRouter [<SwitchParameter>]
        Indicates that the cmdlet skips the router configuration task. If you want to manually configure the router,
        set this parameter to $True
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Repair Remote Web Access
    
    PS C:\> Repair-WssRemoteWebAccess -SkipRouter
    
    
    This command repairs Remote Web Access but skips the router configuration task.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298405
    Disable-WssRemoteWebAccess
    Enable-WssRemoteWebAccess
    

NAME
    Repair-WssRouterConfiguration
    
SYNOPSIS
    Repairs the router configuration.
    
SYNTAX
    Repair-WssRouterConfiguration [<CommonParameters>]
    
    
DESCRIPTION
    The Repair-WssRouterConfiguration cmdlet repairs the router configuration for a Windows Server 2012 Essentials
    installation. This cmdlet also sets port forwarding for the router.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Repair the router configuration
    
    PS C:\> Repair-WssRouterConfiguration
    
    
    This command repairs the router configuration.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298429

NAME
    Resume-WssBackupPolicy
    
SYNOPSIS
    Resumes a scheduled task that runs a server backup in TaskScheduler.
    
SYNTAX
    Resume-WssBackupPolicy [-BackupPolicy] <ScheduledBackupPolicy> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Resume-WssBackupPolicy cmdlet resumes a scheduled task that runs a server backup in TaskScheduler.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to resume.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet generates the BackupPolicy parameter value.
    
    
    Example 1: Resume a server backup
    
    PS C:\>$ContosoBUPolicy25 = Get-WssBackupPolicy
    PS C:\> Resume-WssBackupPolicy -BackupPolicy $ContosoBUPolicy215
    
    
    This example resumes a scheduled task.
    
    The first command gets the backup policy for the computer and stores the result in the $ContosoBUPolicy25 variable
    
    The second command resumes the backup of the backup policy stored in $ContosoBUPolicy215.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298280
    Disable-WssBackupPolicy
    Get-WssBackupPolicy
    Set-WssBackupPolicy
    Suspend-WssBackupPolicy

NAME
    Select-WssMountVhd
    
SYNOPSIS
    Selects a VHD from a backup set to mount for a file restore operation.
    
SYNTAX
    Select-WssMountVhd [-BackupSet] <BackupSet> [-Vhd] <MountVhdData> [<CommonParameters>]
    
    
DESCRIPTION
    The Select-WssMountVhd cmdlet selects a virtual hard drive (VHD) from a backup set to mount for a file restore
    operation. Each VHD represents a backup volume in the set.
    

PARAMETERS
    -BackupSet <BackupSet>
        Specifies the backup set from which to restore files.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Vhd <MountVhdData>
        Specifies the VHD to mount.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.MountVhdData
        
        
    
        This cmdlet generates mount VHD data.
    
    
    Example 1: Select a VHD for a restore operation
    
    PS C:\> Select-WssMountVhd -BackupSet $ContosoBU122412 -Vhd $ContosoVHD122412
    
    
    This command selects the backup set that is stored in the variable named $ContosoBU122412 from the VHD that is
    stored in the variable named $ContosoVHD122412.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298363
    Get-WssMountVhd

NAME
    Send-WssReport
    
SYNOPSIS
    Sends out a health report instance.
    
SYNTAX
    Send-WssReport [-Id] <Guid> [<CommonParameters>]
    
    
DESCRIPTION
    The Send-WssReport cmdlet sends out a health report instance through email by using the ID of the report.
    

PARAMETERS
    -Id <Guid>
        Specifies the GUID of a health report instance.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.Guid
        
        
    
        Report Guid
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Send a health report
    
    PS C:\> $Reports = Get-WssReport
    PS C:\> Send-WssReport $Reports[0].Id
    
    
    The first command uses the Get-WssReport cmdlet to get all instances of reports, and saves the results in the
    $Reports variable.
    
    The second command sends an instance of a health report by using the ID of the first instance in the $Reports
    variable.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298418
    Get-WssReport
    New-WssReport
    Remove-WssReport

NAME
    Set-WindowsSearchSetting
    
SYNOPSIS
    Modifies values that control Windows Search.
    
SYNTAX
    Set-WindowsSearchSetting [-EnableMeteredWebResultsSetting <Boolean>] [-EnableWebResultsSetting <Boolean>]
    [-SafeSearchSetting <String>] [-SearchExperienceSetting <String>] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WindowsSearchSetting cmdlet modifies values that control Windows Search. You can specify whether Windows
    Search displays web results or suggestions, and you can specify whether to display web results and suggestions
    while using a metered network. You can specify whether Windows Search personalizes results, including whether
    Windows Search employs the specific location of the user. You can also specify SafeSearch settings.
    

PARAMETERS
    -EnableMeteredWebResultsSetting <Boolean>
        Indicates whether Windows Search displays web results and suggestions while using metered connections. Specify
        a value of $True to display web results and suggestions over metered connections or a value of $False to
        exclude web results and suggestions.
        
        Do not specify a value for this parameter if the value of the EnableWebResultsSetting parameter is $False.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -EnableWebResultsSetting <Boolean>
        Indicates whether Windows Search displays web results and suggestions. Specify a value of $True to display web
        results and suggestions or a value of $False to exclude web results and suggestions.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -SafeSearchSetting <String>
        Specifies a SafeSearch setting for Window Search. The acceptable values for this parameter are:
        
        -- Off. Windows Search does not remove adult content from results.
        -- Moderate. Windows Search excludes adult images and videos, but not text, from results.
        -- Strict. Windows Search excludes adult images, videos, and text from results.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -SearchExperienceSetting <String>
        Specifies a Windows Search experience setting. The acceptable values for this parameter are:
        
        -- PersonlizedAndLocation. Personalize Windows Search and other Microsoft experiences by using search history,
        some Microsoft account information, and specific location of the user.
        -- Personalized. Personalize Windows Search and other Microsoft experiences by using search history and some
        Microsoft account information, but do not use specific location of the user.
        -- NotPersonalized. Do not personalize Windows Search and other Microsoft experiences or use specific location
        of the user.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Personalize Windows Search
    
    PS C:\> Set-WindowsSearchSetting -SearchExperienceSetting "Personalized"
    
    
    This command allows Windows Search to use search history, but not specific location of the user, to personalize
    results.
    
    Example 2: Modify Windows Search settings
    
    PS C:\>Set-WindowsSearchSetting -EnableWebResultsSetting $True -SafeSearchSetting "Strict"
    -SearchExperienceSetting "PersonlizedAndLocation"
    
    
    This command modifies Windows Search settings. The command enables the use of search history and specific location
    of the user by specifying a value of PersonlizedAndLocation for the SearchExperienceSetting parameter. The command
    enables web results and sets SafeSearch to a value of Strict.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=294364
    Get-WindowsSearchSetting

NAME
    Set-WssBackupPolicy
    
SYNOPSIS
    Creates or changes a scheduled backup policy.
    
SYNTAX
    Set-WssBackupPolicy [-BackupPolicy] <ScheduledBackupPolicy> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssBackupPolicy cmdlet creates or changes a scheduled backup policy.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to create or change.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet generates a server backup policy object that specifies backup options such as backup targets,
        backup volume, and schedule time.
    
    
    Example 1: Specify a scheduled backup policy
    
    PS C:\>$ContosoBUPolicy25 = Get-WssBackupPolicy
    PS C:\> Add-WssBackupSchedule -BackupPolicy $ContosoBUPolicy25 -BackupTime 5:00
    PS C:\> Set-WssBackupPolicy -BackupPolicy $ContosoBUPolicy25
    
    
    This example sets a scheduled backup policy as the current scheduled backup policy.
    
    The first command gets the current backup policy for the computer and stores it in the $ContosoBUPolicy25 variable.
    
    The second command adds 5:00 A.M. daily as a backup schedule for the backup policy stored in $ContosoBUPolicy25.
    
    The third command sets the scheduled backup policy stored in $ContosoBUPolicy25 (including the new schedule) as
    the current scheduled backup policy.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298277
    Disable-WssBackupPolicy
    Get-WssBackupPolicy
    Resume-WssBackupPolicy
    Suspend-WssBackupPolicy

NAME
    Set-WssClientBackup
    
SYNOPSIS
    Changes job retention policy and description for a client backup.
    
SYNTAX
    Set-WssClientBackup [-ComputerName] <String> [-BackupIndex] <Int32> [-Description <String>] [-Retention {Automatic
    | Delete | Invalid | Keep}] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Set-WssClientBackup [-ComputerSid] <String> [-BackupIndex] <Int32> [-Description <String>] [-Retention {Automatic
    | Delete | Invalid | Keep}] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssClientBackup cmdlet changes job retention policy and description for a client backup for a computer.
    Specify a computer by name or security identifier (SID). Specify which backup to change by using its backup index.
    

PARAMETERS
    -BackupIndex <Int32>
        Specifies the index for a backup job. To obtain a backup index, use the Get-WssClientBackup cmdlet.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Description <String>
        Specifies a description for the backup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Retention <BackupJobRetention>
        Specifies a retention policy for the backup. The acceptable values for this parameter are:
        
        -- Automatic
        -- Delete
        -- Keep
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Change a description for a client backup
    
    PS C:\> Set-WssClientBackup -ComputerName "Workstation073" -BackupIndex 1 -Description "January backup"
    
    
    This command changes the description for a backup of the computer named Workstation073. The command specifies the
    backup by using its index. The description is January backup.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298304
    Disable-WssClientBackup
    Enable-WssClientBackup
    Get-WssClientBackup
    Start-WssClientBackup
    Stop-WssClientBackup

NAME
    Set-WssClientBackupVolumeExcludedFolder
    
SYNOPSIS
    Specifies folders to exclude from client backup on a computer.
    
SYNTAX
    Set-WssClientBackupVolumeExcludedFolder [-ComputerName] <String> [-VolumeGuid] <Guid> [[-ExcludedFolders]
    <ICollection<String>>] [-Clear] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Set-WssClientBackupVolumeExcludedFolder [-ComputerSid] <String> [-VolumeGuid] <Guid> [[-ExcludedFolders]
    <ICollection<String>>] [-Clear] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssClientBackupVolumeExcludedFolder cmdlet specifies folders to exclude from client backup on a computer.
    Specify a computer by name or security identifier (SID). Specify a volume by using its GUID.
    
    If you use the Clear parameter, the cmdlet clears the list of excluded folders, so future backups do not exclude
    any folders.
    

PARAMETERS
    -Clear [<SwitchParameter>]
        Indicates that the cmdlet clears the list of excluded folders.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ExcludedFolders <ICollection<String>>
        Specifies a collection of folder paths.
        
        Required?                    false
        Position?                    5
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -VolumeGuid <Guid>
        Specifies the GUID of a volume. To obtain a GUID, use the Get-WssClientBackupVolume cmdlet.
        
        Required?                    true
        Position?                    4
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Exclude folders from backup for a volume
    
    PS C:\> Set-WssClientBackupVolumeExcludedFolder -ComputerName "Workstation073" -VolumeGuid
    b6b093a2-1860-4172-a4a5-07ce2aebfa13 -ExcludedFolders (@("C:\Temp","C:\Downloads") -as [string[]])
    
    
    This command excludes folders for the specified volume for the computer named Workstation073. The command accepts
    a collection of folders to exclude from backup.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298314
    Disable-WssClientBackupVolume
    Enable-WssClientBackupVolume
    Get-WssClientBackupVolume

NAME
    Set-WssDomainNameConfiguration
    
SYNOPSIS
    Changes the domain name configuration of the server.
    
SYNTAX
    Set-WssDomainNameConfiguration [-DomainName] <String> [-CertificatePath] <String> [[-CertificateFilePassword]
    <SecureString>] [-NoCertificateVerification] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssDomainNameConfiguration cmdlet changes the domain name configuration settings of the server. You can
    use this cmdlet to change the domain name of the server and configure the Secure Sockets Layer (SSL) certificate
    binding to the Web Server, terminal server, and virtual private network (VPN) server.
    

PARAMETERS
    -CertificateFilePassword <SecureString>
        Specifies the password, as a secure string, for the SSL certificate file.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -CertificatePath <String>
        Specifies the path of the SSL certificate file. If the cmdlet cannot find the certificate file in this path,
        the cmdlet searches in the root of each hard drive on the computer.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -DomainName <String>
        Specifies the domain name for the server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NoCertificateVerification [<SwitchParameter>]
        Indicates that the server skips verification of the SSL certificate.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Change the domain name configuration of the server
    
    PS C:\> $SecureString_pwd = convertto-securestring "P@ssW0rD!" -Asplaintext -Force
    PS C:\> Set-WssDomainNameConfiguration -CertificateFilePassword $SecureString_pwd -CertificatePath "c:\cert.pfx"
    -DomainName "Contoso.com" -NoCertificateVerification
    
    
    The first command converts the plain text string "P@ssW0rD!" into a secure string and stores the result in the
    $SecureString_pwd variable.
    
    The second command specifies the domain name of the server, sets the password stored in the $SecureString_pwd
    variable, sets the path for the SSL certificate file, and specifies that the server skips verification of the SSL
    certificate.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298328
    Get-WssDomainNameConfiguration

NAME
    Set-WssDrive
    
SYNOPSIS
    Changes drive name or whether to enable snapshots.
    
SYNTAX
    Set-WssDrive [-Name] <String> [[-NewName] <String>] [[-SnapshotsEnabled] <Boolean>] [-Force] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    Set-WssDrive [-Drive] <Drive> [[-NewName] <String>] [[-SnapshotsEnabled] <Boolean>] [-Force] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    Set-WssDrive [-ID] <Guid> [[-NewName] <String>] [[-SnapshotsEnabled] <Boolean>] [-Force] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssDrive cmdlet changes the name of a drive or whether to enable snapshots for a drive. You can specify a
    drive by using its name or its GUID, or you can use the Get-WssDrive cmdlet to obtain a Drive object. To specify a
    new drive name, use the NewName parameter. To specify whether to enable snapshots, use the SnapShotsEnabled
    parameter.
    

PARAMETERS
    -Drive <Drive>
        Specifies a Drive object. To obtain a Drive object, use the Get-WssDrive cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ID <Guid>
        Specifies the GUID of a drive.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies the name of a drive.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NewName <String>
        Specifies a new name for the drive.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -SnapshotsEnabled <Boolean>
        Indicates whether to enable snapshots on the drive.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.Storage.Drive
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Drive
        
        
    
        This cmdlet generates an object that represents the modifies drive.
    
    
    Example 1: Change the name of a drive
    
    PS C:\>$Drive = Get-WssDrive -ID b6b093a2-1860-4172-a4a5-07ce2aebfa13
    PS C:\> Set-WssDrive -Drive $Drive -NewName "Sarah Jones Volume"
    
    
    This example renames a drive. The first command uses the Get-WssDrive cmdlet to get a Drive object that has the
    specified GUID, and stores it in the $Drive variable.
    
    The second command changes the name of the drive represented by the object stored in the $Drive variable to Sarah
    Jones Volume.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298330
    Get-WssDrive
    Test-WssDrive

NAME
    Set-WssFileHistoryConfiguration
    
SYNOPSIS
    Changes the File History configurations settings for the server.
    
SYNTAX
    Set-WssFileHistoryConfiguration [-Configuration] <ConfigurationSet> [-Force] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssFileHistoryConfiguration cmdlet changes the File History configuration settings for the server. File
    History is a backup application that continuously protects the personal files of users stored in Libraries,
    Desktop, Favorites, and Contacts folders. You can use the Get-WssFileHistoryConfiguration to get the File History
    configurations settings for the server.
    

PARAMETERS
    -Configuration <ConfigurationSet>
        Specifies the File History configuration settings for the server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.DataProtection.FileBackup.ConfigurationSet
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.FileBackup.ConfigurationSet
        
        
    
        This cmdlet generates the file history configuration settings stored on the server.
    
    
    Example 1: Change the File History configurations settings
    
    PS C:\> $fileHistoryConfig = Get-WssFileHistoryConfiguration
    PS C:\> $FileHistoryConfig.RetentionInMonths = 6
    PS C:\> Set-WssFileHistoryConfiguration -Configuration $fileHistoryConfig
    
    
    This example changes the File History configurations settings for the server.
    
    The first command gets the File History configurations settings for the server, and stores the result in the
    $fileHistoryConfig variable.
    
    The second command sets the RetentionInMonths property of the File History configurations object to six months.
    
    The third command sets the File History configuration settings stored in $fileHistoryConfig.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298334
    Get-WssFileHistoryManagementStatus

NAME
    Set-WssFileHistoryManagementStatus
    
SYNOPSIS
    Changes the File History managed status of a user account.
    
SYNTAX
    Set-WssFileHistoryManagementStatus [-UserName] <String> [-Delete] [-Force] [-UnManage] [-Confirm] [-WhatIf]
    [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssFileHistoryManagementStatus cmdlet changes the File History managed status of a user account. Specify
    the UnManage parameter if you do not want the server to manage the user account that you specify in the UserName
    parameter.
    

PARAMETERS
    -Delete [<SwitchParameter>]
        Indicates that the cmdlet also deletes the File History Backup folder for the user account when you specify
        the UnManage parameter.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UnManage [<SwitchParameter>]
        Indicates that the server no longer manages the File History of the user account.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserName <String>
        Specifies the user name whose File History you want to manage.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Change the File History managed status of a computer
    
    PS C:\> Set-WssFileHistoryManagementStatus -UserName "DaveB" -UnManage -Delete
    
    
    This command changes the File History managed status of a user named DaveB to unmanaged, and deletes the File
    History Backup folder for that account.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298336

NAME
    Set-WssFolder
    
SYNOPSIS
    Changes the settings of a server folder.
    
SYNTAX
    Set-WssFolder [-Folder] <Folder> [-Description <String>] [-Force] [-GroupName <String>]
    [-HideFolderFromRemoteAccess <Boolean>] [-NewName <String>] [-Permission {None | ReadOnly | Full | Other |
    ReadPermissions}] [-Quota <UInt64>] [-UserName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    Set-WssFolder [-Folder] <Folder> [-Description <String>] [-Force] [-GroupSid <String>]
    [-HideFolderFromRemoteAccess <Boolean>] [-NewName <String>] [-Permission {None | ReadOnly | Full | Other |
    ReadPermissions}] [-Quota <UInt64>] [-UserSid <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssFolder cmdlet changes the settings of a server folder.
    

PARAMETERS
    -Description <String>
        Specifies a description for the server folder.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Folder <Folder>
        Specifies the name of a folder.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -GroupName <String>
        Specifies the name of a group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -GroupSid <String>
        Specifies a security ID of a group.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -HideFolderFromRemoteAccess <Boolean>
        Specifies whether to hide the folder in Remote Desktop Web Access or Web service applications.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NewName <String>
        Specifies a new name for the folder.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Permission <Permission>
        Specifies the access to the shared folder that the server grants to the user that you specify in the UserName
        parameter. The acceptable values for this parameter are:
        -- None
        -- Readonly
        -- Full
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Quota <UInt64>
        Specifies a quota, in bytes, for the folder.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserName <String>
        Specifies the user name of an account. The server grants the user the permission to the shared folder that you
        specify the Permission parameter.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UserSid <String>
        Specifies the security identifier (SID) of the user that you specify in the UserName parameter.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.Storage.Folder
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.Folder
        
        
    
        This cmdlet generates an object that represents the modified folder.
    
    
    Example 1: Change the settings of a server folder
    
    PS C:\>$Folder = Get-WssFolder -Name "ProjectsWest"PS C:\> Set-WssFolder -Folder $Folder -NewName
    "ProjectsSoutwest01" -UserName "SarahJones" -Permission Full
    
    
    The first command gets the folder named ProjectsWest and stores it in the $Folder variable.
    
    The second command changes the name of the folder stored in the $Folder variable to ProjectsSoutwest01, and grants
    the user named SarahJones full access to ProjectsSoutwest01.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298342
    Add-WssFolder
    Get-WssFolder
    Move-WssFolder
    Remove-WssFolder
    Measure-WssFolder

NAME
    Set-WssGlobalClientBackupPolicy
    
SYNOPSIS
    Changes the global client backup policy.
    
SYNTAX
    Set-WssGlobalClientBackupPolicy [-BackupEndTime <TimeSpan>] [-BackupStartTime <TimeSpan>] [-DailyRetainCount
    <UInt32>] [-MonthlyRetainCount <UInt32>] [-WeeklyRetainCount <UInt32>] [-YearlyRetainCount <UInt32>] [-Confirm]
    [-WhatIf] [<CommonParameters>]
    
    Set-WssGlobalClientBackupPolicy [-Default] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssGlobalClientBackupPolicy cmdlet changes the global client backup policy. This policy includes the
    following values:
    
    -- BackupStartTime. The beginning of the backup window. The default value is 18:00.
    -- BackupEndTime. The end of the backup window. The default value is 9:00.
    -- DailyRetainCount. The number of daily backups to keep. The default value is five.
    -- WeeklyRetainCount. The number of weekly backups to keep. The default value is four.
    -- MonthlyRetainCount. The number of monthly backups to keep. The default value is six.
    -- YearlyRetainCount. The number of yearly backups to keep. The default value is ten.
    
    This cmdlet can change any of these values, or you can use the Default parameter to reset all the settings to the
    default values.
    

PARAMETERS
    -BackupEndTime <TimeSpan>
        Specifies the end of the backup window as a TimeSpan object.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -BackupStartTime <TimeSpan>
        Specifies the beginning of the backup window as a TimeSpan object.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -DailyRetainCount <UInt32>
        Specifies the number of daily backups to keep. The default value is five.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Default [<SwitchParameter>]
        Indicates that the cmdlet resets all the settings to their default values.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -MonthlyRetainCount <UInt32>
        Specifies the number of monthly backups to keep. The default value is six.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WeeklyRetainCount <UInt32>
        Specifies the number of weekly backups to keep. The default value is four.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -YearlyRetainCount <UInt32>
        Specifies the number of yearly backups to keep. The default value is ten.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Change the backup window for the global policy
    
    PS C:\> Set-WssGlobalClientBackupPolicy -BackupEndTime 8:00 -BackupStartTime 19:00
    
    
    This command changes the backup window for the global backup policy. The command specifies new start and end times
    for the policy.
    
    Example 2: Restore default settings for the backup policy
    
    PS C:\> Set-WssGlobalClientBackupPolicy -Default
    
    
    This command restores default settings for the global backup policy. The command includes the Default parameter.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298344
    Get-WssGlobalClientBackupPolicy
    Enable-WssClientBackup

NAME
    Set-WssMediaLibraryInclusion
    
SYNOPSIS
    Includes or excludes a shared folder from the Media Library.
    
SYNTAX
    Set-WssMediaLibraryInclusion [-Share] <MediaStreamingSharedFolder> [-Enable] <Boolean> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMediaLibraryInclusion cmdlet includes a shared folder in, or excludes a shared folder from, the Media
    Library for the current server.
    

PARAMETERS
    -Enable <Boolean>
        Indicates whether the cmdlet includes or excludes the specified folder from the Media Library. Specify a value
        of $True to include the folder in the Media Library. Specify a value of $False to exclude the folder.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Share <MediaStreamingSharedFolder>
        Specifies a shared folder on the server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Exclude a shared folder from the Media Library
    
    PS C:\> $MediaFolders = Get-WssMediaSharedFolder
    PS C:\> Set-WssMediaLibraryInclusion -Share $MediaFolders[0] -Enable $False
    
    
    This example excludes a shared folder from the Media Library. The first command uses the Get-WssMediaSharedFolder
    cmdlet to get the shared folders for the current server, and then stores them in the $MediaFolders variable. In
    this example, the server has more than one folder in the Media Library, so $MediaFolders contains an array.
    
    The second command excludes a folder from the Media Library. The command specifies a value of $False for the
    Enable parameter. The command uses standard array syntax to specify the first member of the array stored in the
    $MediaFolders variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298346
    Get-WssMediaSharedFolder
    Get-WssMediaServerEnabled
    Get-WssMediaLibraryName

NAME
    Set-WssMediaLibraryName
    
SYNOPSIS
    Changes the name of the Media Library.
    
SYNTAX
    Set-WssMediaLibraryName [-MediaLibraryName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMediaLibraryName cmdlet changes the name of the Media Library for the current server. You can use the
    Get-WssMediaLibraryName cmdlet to see the Media Library name.
    

PARAMETERS
    -MediaLibraryName <String>
        Specifies a new name for the Media Library shared by the server.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Rename a Media Library
    
    PS C:\> Set-WssMediaLibraryName -MediaLibraryName "Accounting Library"
    
    
    This command gives the Media Library the name Accounting Library.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298348
    Get-WssMediaLibraryName

NAME
    Set-WssMediaServerEnabled
    
SYNOPSIS
    Enables or disables media streaming on a server.
    
SYNTAX
    Set-WssMediaServerEnabled [-Enable] <Boolean> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMediaServerEnabled cmdlet enables or disables media streaming for the current server. You can use the
    Get-WssMediaServerEnabled cmdlet to see the status of media streaming.
    

PARAMETERS
    -Enable <Boolean>
        Indicates whether the cmdlet enables or disables media streaming. Use a value of $True to enable media
        streaming, or a value of $False to disable it.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Disable media streaming
    
    PS C:\> Set-WssMediaServerEnabled -Enable $False
    
    
    This command disables media streaming for the current server.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298350
    Get-WssMediaServerEnabled

NAME
    Set-WssMediaStreamingVideoQuality
    
SYNOPSIS
    Modifies the video streaming quality of videos that are streamed from the server.
    
SYNTAX
    Set-WssMediaStreamingVideoQuality [-Quality] {Low | Medium | High | Best} [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMediaStreamingVideoQuality cmdlet modifies the video streaming quality of videos that are streamed from
    the server.
    

PARAMETERS
    -Quality <VideoQuality>
        Specifies the video quality. The cmdlet sets the video quality value that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.MediaStreaming.VideoQuality
        
        
    
     
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Set the video streaming quality
    
    PS C:\>Set-WssMediaStreamingVideoQuality
    
    
    This command sets the video streaming quality on the server on which you run the cmdlet.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298354
    Get-WssMediaStreamingVideoQuality

NAME
    Set-WssMsoGroupAssignment
    
SYNOPSIS
    Assigns a security group to a user group.
    
SYNTAX
    Set-WssMsoGroupAssignment [-WssGroupName] <String> [-MsoId] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMsoGroupAssignment cmdlet assigns a Windows Azure Active Directory (Windows Azure AD) security group to
    a Windows Server Essentials user group.
    

PARAMETERS
    -MsoId <String>
        Specifies an ID for a security group. The cmdlet assign the security group that you specify to a Windows
        Server Essentials user group.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -WssGroupName <String>
        Specifies the name of a Windows Server Essentials user group. The cmdlet assigns a security group to the gets
        the user group that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssGroupName
        Type: System.String
        Description: local network account name of group
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Assign a security group
    
    PS C:\> Set-WssMSOAssignedGroup -WssGroupName "Admins" -MsoId "d77e9419-2e1f-4080-ae7c-9b97c6caa681"
    
    
    This command assigns the specified security group to the user group named Admins.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298372
    Remove-WssMsoGroupAssignment
    Set-WssMsoUserAssignment

NAME
    Set-WssMsoSharePointLibrary
    
SYNOPSIS
    Sets the properties of a SharePoint Online library.
    
SYNTAX
    Set-WssMsoSharePointLibrary [-Library] <SharePointLibrary> [[-Name] <String>] [[-Description] <String>]
    -EnableVersioning -ForceCheckout [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMsoSharePointLibrary cmdlet sets the properties of a Microsoft® SharePoint® Online library. A
    Microsoft® Office 365 site stores the SharePoint Online library.
    

PARAMETERS
    -Description <String>
        Specifies a description of a SharePoint Online library. The cmdlet modifies the properties of a library with
        the description you specify.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -EnableVersioning [<SwitchParameter>]
        Indicates that versioning is enabled for this library.
        
        Required?                    false
        Position?                    4
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -ForceCheckout [<SwitchParameter>]
        Indicates that force checkout is enabled for this library.
        
        Required?                    false
        Position?                    5
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Library <SharePointLibrary>
        Specifies a  SharePoint Online library object. The cmdlet modifies the library that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies the name of a library. The cmdlet modifies the name of a SharePoint Online library with the name
        that you specify.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        
    
        Library
        
        Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary
        
        Description: SharePoint library
        
    
    
OUTPUTS
    SharePointLibrary
        
        
    
     
    
    Example 1: Set properties of a SharePoint library
    
    PS C:\> $Library = Get-WssMsoSharePointLibrary | Select-Object -First 1
    PS C:\> Set-WssMSOSharePointLibrary -Library $Library -Name "New Name" -Description "New Description"
    -ForceCheckout -EnableVersioning
    
    
    The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the
    $Library variable.
    
    The second command sets the properties of a library by using the $Library variable. The command also sets the
    ForceCheckout and EnableVersioning parameters.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298378
    Get-WssMsoSharePointLibrary
    New-WssMsoSharePointLibrary
    Remove-WssMsoSharePointLibrary

NAME
    Set-WssMsoSharePointPermission
    
SYNOPSIS
    Sets permission settings for a SharePoint Online securable object.
    
SYNTAX
    Set-WssMsoSharePointPermission [-Library] <SharePointLibrary> [-User] <SharePointUser> [-Permission] {Edit |
    FullControl | NoAccess | Read} [<CommonParameters>]
    
    Set-WssMsoSharePointPermission [-Site] <SharePointSite> [-User] <SharePointUser> [-Permission] {Edit | FullControl
    | NoAccess | Read} [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMsoSharePointPermission cmdlet sets permission settings for a Microsoft® SharePoint® Online securable
    object, such as a library or a site. An Microsoft® Office 365 site stores the  SharePoint Onlinelibrary.
    

PARAMETERS
    -Library <SharePointLibrary>
        Specifies a Microsoft® SharePoint® 2013 Products library. The cmdlet sets permissions for the library that you
        specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -Permission <WssMsoSharePointPermissionType>
        Specifies the permission for a SharePoint 2013 principal to modify.  The acceptable values for this parameter
        are:
        
        
             -- NoAccess
        
             -- Read
        
             -- Edit
        
             -- FullControl
        
        Required?                    true
        Position?                    3
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Site <SharePointSite>
        Specifies a SharePoint 2013 site. The cmdlet sets permissions for the site that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -User <SharePointUser>
        Specifies a name for a user account. The cmdlet sets permissions for the SharePoint 2013 name that you specify.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary,Microsoft.WindowsServerSolutions.O365Integration
    .SharePointSite
        
        
    
        Library -- Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointLibrary -- Description: SharePoint
        library
        
        Site -- Type: Microsoft.WindowsServerSolutions.O365Integration.SharePointSite -- Description: SharePoint site
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Set SharePoint permissions
    
    PS C:\> $Library= Get-WssMSOSharePointLibrary | Select-Object -First 1
    PS C:\> $Principal= Get-WssMSOSharePointPrincipal | Select-Object -First 1
    PS C:\> Set-WssMSOSharePointObjectPermission -Object $Library -Principal $Principal -Permission FullControl
    
    
    The first command uses the Get-WssMsoSharePointLibrary cmdlet to get a library, and stores the result in the
    $Library variable.
    
    The second command uses the Get-WssMsoSharePointPrincipal cmdlet to get a SharePoint principal, and stores the
    result in the $Principal variable.
    
    The last command sets the SharePoint permissions for the library named $Library and the principal named $Principal.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298380
    Get-WssMsoSharePointPermission
    Remove-WssMsoSharePointPermission

NAME
    Set-WssMsoUserAssignment
    
SYNOPSIS
    Assigns an online service account to a user account.
    
SYNTAX
    Set-WssMsoUserAssignment [-WssUserName] <String> [-MsoUserName] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMsoUserAssignment cmdlet assigns an online service account to a local network user account.
    

PARAMETERS
    -MsoUserName <String>
        Specifies a user principal name (UPN). The cmdlet assigns the online service account for the UPN that you
        specify to a user account.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -WssUserName <String>
        Specifies the name of a user account. The cmdlet assigns the online service account to the user account that
        you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Assign an online service account
    
    PS C:\> Set-WssMSOAssignedUser -WssUserName "Admin" -MsoUserName "DavidChew@TSQA.Contoso.com"
    
    
    This command assigns the online service account DavidChew@TSQA.Contoso.com to the local network user account named
    Admin.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298392
    Remove-WssMsoUserAssignment
    Get-WssMsoAssignedUser
    Rename-WssMsoAssignedUser
    Set-WssMsoGroupAssignment

NAME
    Set-WssMsoUserLicense
    
SYNOPSIS
    Assigns licenses to an account in Windows Azure AD.
    
SYNTAX
    Set-WssMsoUserLicense [-WssUserName] <String> [[-License] <MSOLicense[]>] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssMsoUserLicense cmdlet assigns licenses to an online service account in Windows Azure Active Directory
    (Windows Azure AD).
    

PARAMETERS
    -License <MSOLicense[]>
        Specifies an array of licenses as MSOLicense objects. The cmdlet assigns the licenses that you specify to a
        user account. To obtain MSOLicense objects, use the Get-WssMsoSubscription cmdlet to get subscription
        information. Subscription information contains the MSOLicenseSuite array that refers to MSOLicense objects.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -WssUserName <String>
        Specifies the name of the user account to which you want the licenses assigned.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.String
        
        
    
        WssUserName
        Type: System.String
        Description: local network account name of user
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Store a license for a user
    
    PS C:\> $Subscribe = Get-WssMsoSubscription
    PS C:\> Set-WssMSOUserLicense -WssUserName "EvanNarvaez" -License $Subscribe.MSOLicenseSuite[0].MSOLicense
    
    
    The first command uses the Get-WssMsoSubscription cmdlet to get subscription information, and then stores it in
    the $Subscribe variable.
    
    The second command assigns a license, contained in the object stored in the $Subscribe variable, to the account
    named EvanNarvaez. The command uses standard array notation to access the first member of the MSOLicenseSuite
    array, and refer to the associated MSOLicense object.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298393
    Get-WssMsoSubscription

NAME
    Set-WssPasswordPolicy
    
SYNOPSIS
    Modifies password policy requirements for the server.
    
SYNTAX
    Set-WssPasswordPolicy [-Strength] {Medium | MediumStrong | Strong | Weak} -PasswordNeverExpire
    [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssPasswordPolicy cmdlet modifies password policy requirements for the server.
    

PARAMETERS
    -PasswordNeverExpire [<SwitchParameter>]
        Indicates that passwords never expire. If you do not specify this parameter, passwords expire after 180 days.
        
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Strength <WssPasswordPolicy>
        Specifies the password strength for the server. The acceptable values for this parameter are:
        
        -- Weak. Passwords are not blank.
        -- Medium. Passwords must contain at least five characters.
        -- MediumStrong. Passwords must contain at least five characters, and must contain at least three of the
        following categories: uppercase letters, lowercase letters, numbers, and symbols.
        -- Strong. Passwords must contain at least seven characters, and must contain at least three of the following
        categories: uppercase letters, lowercase letters, numbers, and symbols.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Modify the password policy
    
    PS C:\> Set-WssPasswordPolicy -Strength Strong -PasswordNeverExpire
    
    
    This command changes the password policy to require Strong passwords. Passwords never expire.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298395
    Get-WssPasswordPolicy

NAME
    Set-WssRemoteWebAccessBackgroundImage
    
SYNOPSIS
    Sets the background image for a Remote Web Access website.
    
SYNTAX
    Set-WssRemoteWebAccessBackgroundImage -ImagePath <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssRemoteWebAccessBackgroundImage cmdlet sets a background image on the logon page of a Remote Web Access
    website.
    

PARAMETERS
    -ImagePath <String>
        Specifies the path to an image file. Use any of the following image types:
        -- Bitmap (*.bmp, *.dib, *.rle)
        -- GIF (*.gif)
        -- PNG (*.png)
        -- JPG (*.jpg)
        
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Set the background image
    
    PS C:\> Set-WssRemoteWebAccessBackgroundImage -ImagePath "D:\Contoso-image.png"
    
    
    This command sets the background image of the logon page.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298407
    Get-WssRemoteWebAccessBackgroundImage

NAME
    Set-WssRemoteWebAccessLogo
    
SYNOPSIS
    Sets the path and filename of the logo image for the Remote Web Access website.
    
SYNTAX
    Set-WssRemoteWebAccessLogo -ImagePath <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssRemoteWebAccessLogo cmdlet sets the path and filename of the logo for the Remote Web Access website in
    Windows Server 2012 Essentials. The logo image customizes the appearance of the Remote Web Access website.
    
    

PARAMETERS
    -ImagePath <String>
        Specifies the file path of the logo image. To obtain the best results, use an image that is 32x32 pixels.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Set the name of the logo file
    
    PS C:\> Set-WssRemoteWebAccessLogon -ImagePath "D:\Contoso-Logo.png"
    
    
    This command sets the filename for the logo image displayed on the Remote Web Access website.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298412
    Get-WssRemoteWebAccessLogo

NAME
    Set-WssRemoteWebAccessTitle
    
SYNOPSIS
    Modifies the title string of a Remote Web Access website.
    
SYNTAX
    Set-WssRemoteWebAccessTitle -Title <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssRemoteWebAccessTitle cmdlet modifies the title string of a Remote Web Access website in Windows Server
    2012 Essentials. The title string appears in the middle of the logon page.
    

PARAMETERS
    -Title <String>
        Specifies a title string for the Remote Web Access website.
        
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Modify the title for Remote Web Access
    
    PS C:\> Set-WssRemoteWebAccessTitle -Title "Contoso Remote Web Access"
    
    
    This command modifies the title for a Remote Access Web website.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298415
    Get-WssRemoteWebAccessTitle

NAME
    Set-WssReportEmailSetting
    
SYNOPSIS
    Configures the email settings of health report.
    
SYNTAX
    Set-WssReportEmailSetting [-Credential <PSCredential>] [-UseAuthentication] [-UseSsl] -Enable -From <String> -Port
    <Int32> -SmtpServer <String> -To <String> [<CommonParameters>]
    
    Set-WssReportEmailSetting -Disable [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssReportEmailSetting cmdlet configures the email settings of a health report.
    

PARAMETERS
    -Credential <PSCredential>
        Specifies a credential for SMTP authentication. To obtain a credential object, use the Get-Credential cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Disable [<SwitchParameter>]
        Indicates that the email setting is disabled.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Enable [<SwitchParameter>]
        Indicates that the email setting is enabled.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -From <String>
        Specifies the sender address of the health report. The sender of the email is the email address that you
        specify.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Port <Int32>
        Specifies the TCP port number of SMTP service. The SMTP service listens on the port you specify.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -SmtpServer <String>
        Specifies the SMTP server name.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -To <String>
        Specifies the email addresses of recipients, separated by a semicolon (;). The recipients of the email are the
        email addresses that you specify.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UseAuthentication [<SwitchParameter>]
        Indicates that the SMTP server requires authentication.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UseSsl [<SwitchParameter>]
        Use this when SSL is required.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    System.Management.Automation.PSCredential,System.Management.Automation.SwitchParameter,System.Management.Automation
    .SwitchParameter,System.String,System.Int32,System.String,System.String,System.Management.Automation.SwitchParamete
    r,System.Management.Automation.SwitchParameter
        
        
    
        Email settings
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Set report email settings
    
    PS C:\> $UserName = "ContosoUser"
    PS C:\> $Password = ConvertTo-SecureString "passw0rd" -AsPlainText -Force
    PS C:\> $Cred = New-Object System.Management.Automation.PSCredential($UserName, $Password)
    PS C:\> Set-WssReportEmailSetting -Enable -From "Contoso-Admin@contoso.com" -SMTPServer "smtphost" -Port 25
    -UseAuthentication -Credential $Cred
    
    
    The first command creates a $UserName variable.
    
    The second command creates a password for the user by using a secure string conversion cmdlet.
    
    The third command creates a credential for the user by using the New-Object cmdlet.
    
    The last command sets the report email settings.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298422
    Get-WssReportEmailSetting

NAME
    Set-WssReportSchedule
    
SYNOPSIS
    Sets the health report schedule.
    
SYNTAX
    Set-WssReportSchedule -At <DateTimeOffset> -Daily -Enable [<CommonParameters>]
    
    Set-WssReportSchedule -Disable [<CommonParameters>]
    
    Set-WssReportSchedule -Enable -Hourly [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssReportSchedule cmdlet sets the health report schedule. Schedule the report to run daily, hourly, or
    never.
    

PARAMETERS
    -At <DateTimeOffset>
        Specifies the time of day to run the daily health report.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Daily [<SwitchParameter>]
        Indicates that the schedule runs the health report daily.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Disable [<SwitchParameter>]
        Indicates that the automated health report generation is disabled.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Enable [<SwitchParameter>]
        Indicates that the automated health report generation is enabled.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Hourly [<SwitchParameter>]
        Indicates that the schedule runs the health report hourly.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Set the report schedule
    
    PS C:\> $Time = [System.DateTimeOffset]::Now
    PS C:\> Set-WssReportSchedule -Enable -Daily -At $Time
    
    
    The first command gets the current time and stores the result in the $Time variable.
    
    The second command sets the report schedule to run daily at the time specified by the $Time variable.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298426
    Get-WssReportSchedule

NAME
    Set-WssReportSection
    
SYNOPSIS
    Sets the sections to include in a health report.
    
SYNTAX
    Set-WssReportSection [-Section] {All | None | ShowBackups | ShowCriticalAlertsAndWarnings | ShowErrorsInEventLog |
    ShowSecurityAndUpdates | ShowServiceNotRunning | ShowStorage} [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssReportSection cmdlet sets the sections to include in a health report.
    

PARAMETERS
    -Section <WssReportSection>
        Specifies the sections to include in a health report.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Set the report sections for a health report
    
    PS C:\> Set-WssReportSection ShowCriticalAlertsAndWarnings,ShowBackups
    
    
    This command sets the report sections for a health report on a server where you run the cmdlet.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298322
    Get-WssReportSection

NAME
    Set-WssServerConnectionOption
    
SYNOPSIS
    Modifies the server connection option.
    
SYNTAX
    Set-WssServerConnectionOption -Option <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssServerConnectionOption cmdlet modifies the server connection option in Windows Server 2012 Essentials.
    WSS supports the use of a terminal session directly to the server (RemoteDesktop) or the use of the dashboard as a
    remote application (RemoteApp).
    

PARAMETERS
    -Option <String>
        Specifies the server connection option. Valid values for this parameter are: RemoteDesktop or RemoteApp.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Set the connection option
    
    PS C:\> Set-WssServerConnectionOption -Option RemoteDesktop
    
    
    This command sets the connection option for the WSS server to RemoteDesktop.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298432
    Get-WssServerConnectionOption

NAME
    Set-WssUserAccess
    
SYNOPSIS
    Modifies the user access setting.
    
SYNTAX
    Set-WssUserAccess [-User] <User> [-GrantAccess {ComputerAccess | DashboardAccess | HomePageLinks | MediaAccess |
    NetworkAlertAccess | RemoteAccess | ShareAccess | VpnAccess}] [-RevokeAccess {ComputerAccess | DashboardAccess |
    HomePageLinks | MediaAccess | NetworkAlertAccess | RemoteAccess | ShareAccess | VpnAccess}] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssUserAccess cmdlet modifies the user access setting in Windows Server 2012 Essentials.
    
    

PARAMETERS
    -GrantAccess <UserAccess>
        Specifies the access to grant to a user. To set more than one access, you must call the cmdlet for each
        access. Valid values for this parameter are:
        -- 1 RemoteAccess
        -- 2 ShareAccess
        -- 3 ComputerAccess
        -- 4 MediaAccess
        -- 5 AddInAccess
        -- 6 DashboardAccess
        -- 7 HomePageLinks
        -- 8 NetworkAlertAccess
        -- 9 VpnAccess
        
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -RevokeAccess <UserAccess>
        Specifies the access to revoke from a user. Valid values for this parameter are:
        -- 1 RemoteAccess
        -- 2 ShareAccess
        -- 3 ComputerAccess
        -- 4 MediaAccess
        -- 5 AddInAccess
        -- 6 DashboardAccess
        -- 7 HomePageLinks
        -- 8 NetworkAlertAccess
        -- 9 VpnAccess
        
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -User <User>
        Specifies a user object.
        
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Modify user access
    
    PS C:\> Set-WSSUserAccess -User $WSSUser -GrantAccess 2
    
    
    This command modifies user access by granting ShareAccess to the user in the variable named WSSUser.
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298442

NAME
    Set-WssUserDashboardVisibility
    
SYNOPSIS
    Modifies whether to make a user account visible in the dashboard.
    
SYNTAX
    Set-WssUserDashboardVisibility [-Name] <String> [-Hidden] [<CommonParameters>]
    
    Set-WssUserDashboardVisibility [-Name] <String> [-Visible] [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssUserDashboardVisibility cmdlet modifies whether to make a user account visible in the Windows Server
    Essentials dashboard.
    

PARAMETERS
    -Hidden [<SwitchParameter>]
        Indicates that the cmdlet hides the user account in the dashboard.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies a name. The cmdlet modifies the visibility for the user account that has the name that you specify.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Visible [<SwitchParameter>]
        Indicates that the cmdlet shows the user account in the dashboard.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Show a user in the dashboard
    
    PS C:\> Set-WssUserDashboardVisibility -Name "PattiFuller" -Visible
    
    
    This command shows the specified user account in the dashboard by specifying the Visible parameter.
    
    Example 2: Hide a user in the dashboard
    
    PS C:\> Set-WssUserDashboardVisibility -Name "PattiFuller" -Hidden
    
    
    This command hides the specified user account in the dashboard by specifying the Hidden parameter.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298361
    Get-WssUser

NAME
    Set-WssUserGroup
    
SYNOPSIS
    Modifies properties of a user group.
    
SYNTAX
    Set-WssUserGroup [-Description <String>] -GroupName <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssUserGroup cmdlet modifies properties of a Windows Server Essentials user group.
    

PARAMETERS
    -Description <String>
        Specifies a description. The cmdlet modifies the user group to have the description that you specify.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -GroupName <String>
        Specifies the name of a user group. The cmdlet modifies the user group that you specify.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Modify a description for a group
    
    PS C:\> Set-WssUserGroup -GroupName "HRGroup" -Description "User group for the HR"
    
    
    This command modifies the description for the group named HRGroup.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298356
    Add-WssUserGroup
    Get-WssUserGroup
    Remove-WssUserGroup

NAME
    Set-WssUserGroupAccess
    
SYNOPSIS
    Modifies access for user groups.
    
SYNTAX
    Set-WssUserGroupAccess [-GrantAccess {RemoteAccess | ShareAccess | ComputerAccess | MediaAccess | DashboardAccess
    | HomePageLinks | VpnAccess}] [-RevokeAccess {RemoteAccess | ShareAccess | ComputerAccess | MediaAccess |
    DashboardAccess | HomePageLinks | VpnAccess}] -Name <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssUserGroupAccess cmdlet modifies access for user groups.
    

PARAMETERS
    -GrantAccess <WSSGroupType>
        Specifies the access to grant. The cmdlet grants the access that you specify to users in the user group. To
        grant more than one type of access, run the cmdlet for each type to grant. The acceptable values for this
        parameter are:
        
        
        -- 1 RemoteAccess
        
        -- 2 ShareAccess
        
        -- 3 ComputerAccess
        
        -- 4 MediaAccess
        
        -- 6 DashboardAccess
        
        -- 7 HomePageLinks
        
        -- 9 VpnAccess
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Name <String>
        Specifies a name. The cmdlet modifies access for the group that you specify by name.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -RevokeAccess <WSSGroupType>
        Specifies the access to revoke. The cmdlet revokes the access that you specify to users in the user group. To
        revoke more than one type of access, use the cmdlet for each type to revoke. The acceptable values for this
        parameter are:
        
        
        -- 1 RemoteAccess
        
        -- 2 ShareAccess
        
        -- 3 ComputerAccess
        
        -- 4 MediaAccess
        
        -- 6 DashboardAccess
        
        -- 7 HomePageLinks
        
        -- 9 VpnAccess
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Grant ShareAccess to a group
    
    PS C:\> Set-WssUserGroupAccess -Name "HRGroup" -GrantAccess 2
    
    
    This command grants ShareAccess to the group named HRGroup. The GrantAccess parameter specifies a value of 2,
    which corresponds to ShareAccess.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298446
    Set-WssUserAccess

NAME
    Set-WssWinSatCpuScore
    
SYNOPSIS
    Modifies the Windows Experience Index processor subscore.
    
SYNTAX
    Set-WssWinSatCpuScore [-WinSatCpuScore] <Double> [<CommonParameters>]
    
    
DESCRIPTION
    The Set-WssWinSatCpuScore cmdlet modifies the Windows Experience Index (WinSAT) processor subscore.
    

PARAMETERS
    -WinSatCpuScore <Double>
        Specifies a WinSAT CPU score.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Modify the WinSAT score
    
    PS C:\> Set-WssWinSatCpuScore -WinSatCpuScore 1
    
    
    This command modifies the WinSAT score.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298452
    Get-WssWinSatCpuScore

NAME
    Start-WssBackupJob
    
SYNOPSIS
    Starts a manual server backup.
    
SYNTAX
    Start-WssBackupJob [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssBackupJob cmdlet starts a manual backup of a server. This is an asynchronous operation.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Start a manual server backup
    
    PS C:\> Start-WssBackupJob
    
    
    This command starts a manual server backup.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298274
    Get-WssBackupJob
    Stop-WssBackupJob

NAME
    Start-WssClientBackup
    
SYNOPSIS
    Starts a client backup for a computer.
    
SYNTAX
    Start-WssClientBackup [-ComputerName] <String> [-Description] <String> [<CommonParameters>]
    
    Start-WssClientBackup [-ComputerSid] <String> [-Description] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssClientBackup cmdlet starts a client backup for a computer. Specify a computer by name or security
    identifier (SID). Include a description for the backup job.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Description <String>
        Specifies a description for the backup job.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Start a client backup
    
    PS C:\> Start-WssClientBackup -ComputerName "Workstation073" -Description "End of month backup"
    
    
    This command starts a client backup for a computer named Workstation073. The command specifies a description.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298305
    Disable-WssClientBackup
    Enable-WssClientBackup
    Get-WssClientBackup
    Set-WssClientBackup
    Stop-WssClientBackup

NAME
    Start-WssClientBackupRepair
    
SYNOPSIS
    Starts an attempt to repair the database of client computer backups.
    
SYNTAX
    Start-WssClientBackupRepair [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssClientBackupRepair cmdlet starts an attempt to repair the database of client computer backups. You
    can use this cmdlet in the event that the database becomes corrupt or unusable.
    

PARAMETERS
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Start client backup database repair
    
    PS C:\> Start-WssClientBackupRepair
    
    
    This command starts an attempt to repair the client backup database.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298309
    Stop-WssClientBackupRepair
    Enable-WssClientBackup

NAME
    Start-WssClientBmrMediaGenerationJob
    
SYNOPSIS
    Starts the client full system restore media generation job.
    
SYNTAX
    Start-WssClientBmrMediaGenerationJob [-UsbDriveGuid <Guid>] -JobType {Wds | ServerUsb} [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssClientBmrMediaGenerationJob cmdlet starts the client full system restore media generation job. A full
    system restore recovers the operating system from backup, and is also called bare metal recovery (BMR).
    

PARAMETERS
    -JobType <GenBmrJobType>
        Specifies the job type. The acceptable values for this parameter are:
        
        -- 0  Client Restore Service
        -- 1  USB
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -UsbDriveGuid <Guid>
        Specifies the job type. The acceptable values for this parameter are:
        
        -- 0  Client Restore Service
        -- 1  USB
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Start a media generation job for bare metal recovery
    
    PS C:\> Start-ClientBmrMediaGenerationJob -JobType 1 -UsbDriveGuid "{77FC2704-25CC-48CC-B32F-25F9EBB19338}"
    
    
    This command starts a bare metal recovery media generation job by using a USB drive.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298216
    Get-WssClientBmrMediaGenerationJob
    Stop-WssClientBmrMediaGenerationJob

NAME
    Start-WssConfigurationService
    
SYNOPSIS
    Starts initial configuration of Windows Server Essentials.
    
SYNTAX
    Start-WssConfigurationService [-CompanyName [<String>]] [-ComputerName [<String>]] [-Credential [<psCredential>]]
    [-DnsName [<String>]] [-Force] [-Hosted] [-NetBiosName [<String>]] [-NewAdminCredential [<psCredential>]]
    [-Setting {All | Update | None}] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssConfigurationService cmdlet starts initial configuration of Windows Server Essentials.
    

PARAMETERS
    -CompanyName [<String>]
        Specifies the name of the company for the server configuration. This dynamic parameter becomes available only
        if the server belongs to a workgroup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -ComputerName [<String>]
        Specifies the name of a computer with which to work. The cmdlet renames the server with the name that you
        specify. This dynamic parameter becomes available only if the server belongs to a workgroup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Credential [<psCredential>]
        Specifies the credentials for the administrator account used to create the domain. This is required if you are
        not currently signed in as a user with the required permissions.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -DnsName [<String>]
        Specifies the Domain Name System (DNS) name for the Active Directory® Domain Services domain to create. This
        dynamic parameter becomes available only if the server belongs to a workgroup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Hosted [<SwitchParameter>]
        Indicates that the server is hosted in the cloud. This dynamic parameter becomes available only if the server
        belongs to a workgroup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NetBiosName [<String>]
        Specifies the NetBIOS name for the Active Directory Domain Services domain to create. This dynamic parameter
        becomes available only if the server belongs to a workgroup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NewAdminCredential [<psCredential>]
        Specifies the credentials for the administrator account that is created during the setup process.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Setting [<String>]
        Specifies how to configure Windows Update on the server. The acceptable values for this parameter are:
        
        
           -- All. Automatically download and install all updates for the Windows operating system.
        
        -- Updates. Automatically download and install only critical and security updates for the Windows operating
        system.
        
           -- None. Opt out of Windows Update.
        
        
        This dynamic parameter becomes available only if the server belongs to a workgroup.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Setup.ICCommon.StatusInfo
        
        
    
        The cmdlet generates an object that represents the configuration status.
    
    
    Example 1: Start initial configuration
    
    PS C:\> $cred = Get-Credential –UserName LocalAdmin –Message "Please specify the password for your new
    administrator account."
    PS C:\> Start-WssConfigurationService -CompanyName "Contoso.Inc" -NetBiosName "contosodomain" -NewAdminCredential
    $cred
    
    
    This command starts initial configuration of Windows Server Essentials.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298447
    Get-WssConfigurationStatus
    Remove-WssConfigurationData
    Test-WssConfigurationOption
    Test-WssPrecheckResult

NAME
    Start-WssRouterConfiguration
    
SYNOPSIS
    Configures port forwarding for routers.
    
SYNTAX
    Start-WssRouterConfiguration [-Manual] [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssRouterConfiguration cmdlet configures port forwarding for UPnP-enabled routers.
    

PARAMETERS
    -Manual [<SwitchParameter>]
        Indicates to Windows Server® 2012 R2 Essentials that router configuration was intentionally skipped. If you
        plan to manually configure the router, specify this parameter.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Start router configuration
    
    PS C:\> Start-WssRouterConfiguration
    
    
    This command starts automatic router configuration.
    
    Example 2: Specify manual router configuration
    
    PS C:\> Start-WssRouterConfiguration -Manual
    
    
    This command skips automatic router configuration. The command specifies the Manual parameter to inform Windows
    Server 2012 R2 Essentials that the router is manually configured.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298428
    Repair-WssRouterConfiguration

NAME
    Start-WssServerFileRestore
    
SYNOPSIS
    Starts a file restore operation.
    
SYNTAX
    Start-WssServerFileRestore [-BackupSet] <BackupSet> [-RecoveryItems] <IList<RecoveryItem>> [[-RecoveryLocation]
    <String>] [-RecoveryOption] <RecoveryOptions> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssServerFileRestore cmdlet starts a file restore operation on a Windows Server 2012 Essentials server.
    

PARAMETERS
    -BackupSet <BackupSet>
        Specifies a backup set from which to restore the recovery items.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -RecoveryItems <IList<RecoveryItem>>
        Specifies a list of items to restore.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -RecoveryLocation <String>
        Specifies the location to which to restore the items.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -RecoveryOption <RecoveryOptions>
        Specifies the restore options, such as whether to overwrite existing files or to restore file permissions.
        
        Required?                    true
        Position?                    4
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Restore files on a server
    
    PS C:\> $Items = Get-WssRecoveryItem
    PS C:\> $Option = New-WssRecoveryOption
    PS C:\> $Backupsets = Get-WssBackupSet
    PS C:\> Start-WssServerFileRestore -BackupSet $Backupsets[1] -RecoveryItems $Items -RecoveryOption $Option
    
    
    This example restores files on a Windows Server 2012 Essentials server.
    
    The first command uses the Get-WssRecoveryItem cmdlet to retrieve the recovery items, and stores the result in the
    variable named Items.
    
    The second command uses New-WssRecoveryOption to create a recovery configuration for a file restore operation, and
    stores the result in the variable named Option.
    
    The third command uses Get-WssBackupSet to retrieve a collection of backup sets, and stores the collection in a
    variable named Backupsets.
    
    The fourth command uses Start-WssServerFileRestore to start a file restore operation on the server using the
    second backup set.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298433

NAME
    Start-WssServerVolumeRestore
    
SYNOPSIS
    Starts a volume restore operation.
    
SYNTAX
    Start-WssServerVolumeRestore [-BackupSet] <BackupSet> [-VolumeToRestore] <BackupVolume> [-DestinationVolume]
    <BackupVolume> [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Start-WssServerVolumeRestore cmdlet starts a volume restore operation on a Windows Server 2012 Essentials
    server.
    

PARAMETERS
    -BackupSet <BackupSet>
        Specifies a backup set from which to restore a volume.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -DestinationVolume <BackupVolume>
        Specifies a destination volume to which to restore a source volume.
        
        Required?                    true
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -VolumeToRestore <BackupVolume>
        Specifies a source volume to restore.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Restore a volume
    
    PS C:\> $Policy = Get-WssBackupPolicy
    PS C:\> $Source = Get-WssBackupVolume -BackupPolicy $Policy
    PS C:\> $Destination = Get-WssBackupVolume -AllVolumes
    PS C:\> $Backupset = Get-WssBackupSet
    PS C:\> Start-WssServerVolumeRestore -BackupSet $Backupset[0] -VolumeToRestore $Source[2] -DestinationVolume
    $Destination[2]
    
    
    This example restores a volume from a backup set.
    
    The first command uses the Get-WssBackupPolicy cmdlet to get the current backup policy, and stores the results in
    the variable $Policy.
    
    The second command uses the Get-WssBackupVolume cmdlet to get the backup volumes that are backed up with this
    policy, and stores the result in the variable named $Source.
    
    The third command uses the Get-WssBackupVolume cmdlet to get the volumes on the system, and stores the result in
    the variable named $Destination.
    
    The fourth command uses the Get-WssBackupSet cmdlet to retrieve the backup sets, and stores the result in the
    variable named $Backupset.
    
    The fifth command uses the Get-WssServerVolumeRestore cmdlet to restore the volume.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298434

NAME
    Stop-WssBackupJob
    
SYNOPSIS
    Cancels the currently running backup job.
    
SYNTAX
    Stop-WssBackupJob [<CommonParameters>]
    
    
DESCRIPTION
    The Stop-WssBackupJob cmdlet cancels the currently running backup job.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Stop a backup job
    
    PS C:\> Stop-WssBackupJob
    
    
    This command cancels the current backup job.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298275
    Get-WssBackupJob
    Start-WssBackupJob

NAME
    Stop-WssClientBackup
    
SYNOPSIS
    Cancels a client backup for a computer.
    
SYNTAX
    Stop-WssClientBackup [-ComputerName] <String> [<CommonParameters>]
    
    Stop-WssClientBackup [-ComputerSid] <String> [<CommonParameters>]
    
    
DESCRIPTION
    The Stop-WssClientBackup cmdlet cancels any currently running client backup for a computer. Specify a computer by
    name or security identifier (SID). Canceling a backup creates a partial backup, but does not cause the previous
    backup to be deleted.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -ComputerSid <String>
        Specifies the SID of a computer.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Cancel a client backup
    
    PS C:\> Stop-WssClientBackup -ComputerName "Workstation073"
    
    
    This command cancels any currently running client backup on the computer named Workstation073.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298306
    Disable-WssClientBackup
    Enable-WssClientBackup
    Get-WssClientBackup
    Set-WssClientBackup
    Start-WssClientBackup

NAME
    Stop-WssClientBackupRepair
    
SYNOPSIS
    Stops the attempt to repair a database of client computer backups.
    
SYNTAX
    Stop-WssClientBackupRepair [<CommonParameters>]
    
    
DESCRIPTION
    The Stop-WssClientBackupRepair cmdlet stops the attempt to repair the database of client computer backups. You can
    use the Start-WssClientBackupRepair cmdlet to start an attempt to repair a database that is corrupt or unusable.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Stop a client backup database repair
    
    PS C:\> Stop-WssClientBackupRepair
    
    
    This command stops the attempt to repair the client backup database.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298310
    Start-WssClientBackupRepair
    Enable-WssClientBackup

NAME
    Stop-WssClientBmrMediaGenerationJob
    
SYNOPSIS
    Stops a client full system restore media generation job.
    
SYNTAX
    Stop-WssClientBmrMediaGenerationJob [<CommonParameters>]
    
    
DESCRIPTION
    The Stop-WssClientBmrMediaGenerationJob cmdlet stops a client full system restore media generation job. A full
    system restore recovers the operating system from a backup, and is also called bare metal recovery (BMR).
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Stop a media generation job for bare metal recovery
    
    PS C:\> Stop-WssClientBmrMediaGenerationJob
    
    
    This command stops a bare metal recovery media generation job.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298217
    Get-WssClientBmrMediaGenerationJob
    Start-WssClientBmrMediaGenerationJob

NAME
    Suspend-WssBackupPolicy
    
SYNOPSIS
    Stops a scheduled task from running the next scheduled backup.
    
SYNTAX
    Suspend-WssBackupPolicy [-BackupPolicy] <ScheduledBackupPolicy> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Suspend-WssBackupPolicy cmdlet stops a scheduled task from running the next scheduled backup.
    

PARAMETERS
    -BackupPolicy <ScheduledBackupPolicy>
        Specifies the scheduled backup policy to suspend.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.DataProtection.ServerBackup.ObjectModel.ScheduledBackupPolicy
        
        
    
        This cmdlet generates the BackupPolicy parameter value.
    
    
    Example 1: Suspend a backup policy
    
    PS C:\>$ContosoBUPolicy25 = Get-WBPolicy
    PS C:\> Suspend-WssBackupPolicy -BackupPolicy $ContosoBUPolicy25
    
    
    This example suspends a backup policy.
    
    The first command gets the backup policy for the computer and stores it in the variable named $ContosoBUPolicy25.
    
    The second command suspends the backup policy that is stored in $ContosoBUPolicy25.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298279
    Disable-WssBackupPolicy
    Get-WssBackupPolicy
    Resume-WssBackupPolicy
    Set-WssBackupPolicy

NAME
    Sync-WssAccount
    
SYNOPSIS
    Updates user and user group account information from the domain controller.
    
SYNTAX
    Sync-WssAccount [<CommonParameters>]
    
    
DESCRIPTION
    The Sync-WssAccount cmdlet updates user and user group account information from the domain controller on demand.
    By default, Microsoft® Office 365 updates user and user group account information from the domain controller every
    five minutes.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
        
    
    
OUTPUTS
    
        
        
    
        
    
    
    Example 1: Update user and user group account information
    
    PS C:\> Sync-WssAccount
    
    
    This command updates user and user group account information from the domain controller.
    
    
    
    PS C:\>
    
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkId=298440
    

NAME
    Test-WssConfigurationOption
    
SYNOPSIS
    Validates server name, domain name and domain administrator credentials.
    
SYNTAX
    Test-WssConfigurationOption [-Credential <PSCredential>] [<CommonParameters>]
    
    Test-WssConfigurationOption [-ComputerName <String>] [-Credential <PSCredential>] -NetbiosName <String>
    [<CommonParameters>]
    
    Test-WssConfigurationOption [-ComputerName <String>] [-Credential <PSCredential>] -NetbiosName <String>
    -NewAdminCredential <PSCredential> [<CommonParameters>]
    
    
DESCRIPTION
    The Test-WssConfigurationOption cmdlet validates server name, domain name and domain administrator credentials in
    Windows Server Essential Experience.
    

PARAMETERS
    -ComputerName <String>
        Specifies the name of the computer with which to work.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Credential <PSCredential>
        Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential cmdlet. The cmdlet
        uses the credential supplied by this parameter to connect to the server to test.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NetbiosName <String>
        Specifies the NetBIOS name of the domain to which the computer being tested belongs.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -NewAdminCredential <PSCredential>
        Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential cmdlet. The cmdlet
        validates the user name and password in the credential you supply, and then creates a new user account by
        using these credentials.
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    System.Boolean
        
        
    
        This cmdlet generates a value of $True or $False to represent whether you can configure Windows Server
        Essential Experience on the target server by using the parameter values that you specify.
    
    
    Example 1: Validate a server configuration
    
    PS C:\> $PsCredential = Get-Credential
    PS C:\> Test-WssConfigurationOption -NetbiosName "Contoso-dom" -ComputerName "Contoso-01" -Credential $PsCredential
    
    
    The first command obtains a credential and stores the result in the $PsCredential variable.
    
    The second command validates the configuration for a server named Contoso-01 in the NetBIOS domain named
    Contoso-dom.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkId=313381
    Get-WssConfigurationStatus
    Remove-WssConfigurationData
    Start-WssConfigurationService
    Test-WssPrecheckResult

NAME
    Test-WssDrive
    
SYNOPSIS
    Checks a drive for file system errors, and optionally repairs errors.
    
SYNTAX
    Test-WssDrive [-Drive] <Drive> [-Repair] [<CommonParameters>]
    
    Test-WssDrive [-Drive] <Drive> [-Cancel] [<CommonParameters>]
    
    
DESCRIPTION
    The Test-WssDrive cmdlet checks a drive for file system errors. You can use this cmdlet to attempt to repair file
    system errors. You can also use this cmdlet to stop a current check for errors. To obtain a Drive object to check,
    use the Get-WssDrive cmdlet.
    

PARAMETERS
    -Cancel [<SwitchParameter>]
        Indicates that the cmdlet cancels an in-progress Test-WssDrive check.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Drive <Drive>
        Specifies a Drive object. To obtain a Drive object, use the Get-WssDrive cmdlet.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false
        
    -Repair [<SwitchParameter>]
        Indicates that the cmdlet attempts to repair file system errors that it finds.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    Microsoft.WindowsServerSolutions.Storage.Drive
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Storage.CheckDiskRequest
        
        
    
        This cmdlet generates a request to check or repair a disk.
    
    
    Example 1: Check and repair a drive
    
    PS C:\>$Drive = Get-WssDrive -ID b6b093a2-1860-4172-a4a5-07ce2aebfa13
    PS C:\> Test-WssDrive -Drive $Drive -Repair
    
    
    This example runs a check on a drive, and attempts to repair any file system errors. The first command uses the
    Get-WssDrive cmdlet to get a Drive object that has the specified GUID, and stores it in the $Drive variable.
    
    The second command runs a check on the Drive object stored in the $Drive variable. The command includes the Repair
    parameter, therefore the command attempts to repair any file system errors it finds.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298331
    Get-WssDrive
    Set-WssDrive

NAME
    Test-WssHealth
    
SYNOPSIS
    Performs an evaluation of all health checks.
    
SYNTAX
    Test-WssHealth [<CommonParameters>]
    
    
DESCRIPTION
    The Test-WssHealth cmdlet performs an evaluation of all health checks. If the cmdlet finds no outstanding health
    alerts, it returns a value of $True. If it finds outstanding health alerts, it returns a value of $False.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Boolean
        
        
    
     
    
    Example 1: Perform a health check evaluation
    
    PS C:\> Test-WssHealth
    
    
    This command performs evaluation of all health checks. The command returns a value of $True or $False, depending
    on whether it finds outstanding alerts.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298224

NAME
    Test-WssPrecheckResult
    
SYNOPSIS
    Verifies prerequisites for configuration of Windows Server Essentials.
    
SYNTAX
    Test-WssPrecheckResult [<CommonParameters>]
    
    
DESCRIPTION
    The Test-WssPrecheckResult cmdlet verifies prerequisites for configuration of Windows Server Essentials. For
    example, if a certification authority (CA) is already installed on the server, it fails verification.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    Microsoft.WindowsServerSolutions.Setup.ICCommon.PrecheckInfo
        
        
    
        This cmdlet generates an object that represents the result of the prerequisite check.
    
    
    Example 1: Verify prerequisites for the product
    
    PS C:\> Test-WssPrecheckResult
    
    
    This command verifies prerequisites for configuration of Windows Server Essentials.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkId=313382
    Test-WssConfigurationOption
    Start-WssConfigurationService
    Get-WssConfigurationStatus

NAME
    Test-WssVpnServerInstallation
    
SYNOPSIS
    Checks for an installation of VPN server.
    
SYNTAX
    Test-WssVpnServerInstallation [<CommonParameters>]
    
    
DESCRIPTION
    The Test-WssVpnServerInstallation cmdlet checks for an installation of VPN server on the Windows Server 2012
    Essentials server.
    

PARAMETERS
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Test VPN server installation
    
    PS C:\> Test-WssVpnServerInstallation
    
    
    This command tests the VPN server installation.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298450
    Install-WssVpnServer
    Uninstall-WssVpnServer

NAME
    Uninstall-WssAddIn
    
SYNOPSIS
    Uninstalls an add-in.
    
SYNTAX
    Uninstall-WssAddIn [-Id] <Guid> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Uninstall-WssAddIn cmdlet uninstalls an add-in from the server. When you uninstall an add-in, the
    functionality provided by add-in is no longer available on the server.
    

PARAMETERS
    -Force [<SwitchParameter>]
        Forces the command to run without asking for user confirmation.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Id <Guid>
        Specifies the GUID of an installed package.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       True (ByPropertyName)
        Accept wildcard characters?  false
        
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Uninstall an add-in
    
    PS C:\> Uninstall-WssAddIn -Id {6617708D-0F98-4898-8D05-9E882C23DCB2}
    
    
    This command uninstalls the add-in that has the package Id 6617708D-0F98-4898-8D05-9E882C23DCB2.
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298266
    Get-WssAddIn
    Install-WssAddIn

NAME
    Uninstall-WssVpnServer
    
SYNOPSIS
    Uninstalls a VPN server.
    
SYNTAX
    Uninstall-WssVpnServer [-Confirm] [-WhatIf] [<CommonParameters>]
    
    
DESCRIPTION
    The Uninstall-WssVpnServer cmdlet uninstalls a VPN server on Windows Server 2012 Essentials server.
    

PARAMETERS
    -Confirm [<SwitchParameter>]
        Prompts you for confirmation before running the cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -WhatIf [<SwitchParameter>]
        Shows what would happen if the cmdlet runs. The cmdlet is not run.
        
        Required?                    false
        Position?                    named
        Default value                false
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
    
INPUTS
    
        
        
    
     
    
OUTPUTS
    
        
        
    
     
    
    Example 1: Uninstall a VPN server
    
    PS C:\> Uninstall-WssVpnServer
    
    
    This command uninstalls a VPN server.
    
    
    
    
RELATED LINKS
    Online Version: http://go.microsoft.com/fwlink/?LinkID=298449
    Install-WssVpnServer
    Test-WssVpnServerInstallation