DSCResources/DSC_RemoteDesktopAdmin/en-US/about_RemoteDesktopAdmin.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.NAME
    RemoteDesktopAdmin
 
.DESCRIPTION
    This resource will manage the remote desktop administration settings on a computer.
    This includes whether remote desktop connections are allowed or denied and whether
    network level authentication is required.
 
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'
 
.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Determines whether or not the computer should accept remote desktop connections. Present sets the value to Enabled and Absent sets the value to Disabled.
 
.PARAMETER UserAuthentication
    Write - String
    Allowed values: Secure, NonSecure
    Setting this value to Secure configures the machine to require Network Level Authentication (NLA) for remote desktop connections.
 
.EXAMPLE 1
 
This configuration will enable Remote Desktop for Administration and set
the User Authentication to secure, i.e. to require Network Level Authentication
 
Configuration RemoteDesktopAdmin_SetSecureRemoteDesktopAdmin_Config
{
    Import-DscResource -Module ComputerManagementDsc
 
    Node ('localhost')
    {
        RemoteDesktopAdmin RemoteDesktopSettings
        {
            IsSingleInstance = 'yes'
            Ensure = 'Present'
            UserAuthentication = 'Secure'
        }
    }
}