https://github.com/dsccommunity/xremotedesktopadmin
https://github.com/dsccommunity/xremotedesktopadmin
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/dsccommunity/xremotedesktopadmin
- Owner: dsccommunity
- License: mit
- Created: 2015-04-15T22:43:04.000Z (over 11 years ago)
- Default Branch: dev
- Last Pushed: 2019-09-19T08:13:23.000Z (almost 7 years ago)
- Last Synced: 2025-03-24T00:16:45.131Z (over 1 year ago)
- Language: PowerShell
- Size: 51.8 KB
- Stars: 17
- Watchers: 24
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **THIS MODULE HAS BEEN DEPRECATED**
It will no longer be released.
Please use the 'RemoteDesktopAdmin' resource in [ComputerManagementDsc](https://github.com/PowerShell/ComputerManagementDsc)
instead.
[](https://ci.appveyor.com/project/PowerShell/xremotedesktopadmin/branch/master)
# xRemoteDesktopAdmin
The **xRemoteDesktopAdmin** module contains the **xRemoteDesktopAdmin** DSC resource for configuring remote desktop settings and the Windows firewall on a local or remote machine.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Contributing
Please check out common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).
## Description
The **xRemoteDesktopAdmin** module contains the **xRemoteDesktopAdmin** DSC Resource.
This DSC Resource allows you to configure remote desktop settings to either allow or prevent users to setup a remote desktop connection to a specific machine.
In addition, it can optionally leverage the xPSDesiredStateConfiguration resources **xFirewall** and **xGroup**.
This allows you to configure remote desktop settings and create the necessary firewall rules to allow a remote session and add a domain user to the local Remote Desktop Users group.
## Resources
### xRemoteDesktopAdmin
* **Ensure**: Ensures that �remote connections to this computer� are allowed or disallowed: { Absent | Present }
* **UserAuthentication**: Enables or disables �Network Level Authentication�. Valid values are:
* Secure
* NonSecure
## Versions
### Unreleased
* THIS MODULE HAS BEEN DEPRECATED. It will no longer be released.
Please use the 'RemoteDesktopAdmin' resource in ComputerManagementDsc instead.
* Update appveyor.yml to use the default template.
* Added default template files .codecov.yml, .gitattributes, and .gitignore, and
.vscode folder.
### 1.1.0.0
* Updated OutputType to System.Boolean for Test-TargetResource and removed for Set-TargetResource.
xRemoteDesktopSessionHost
### 1.0.3.0
* Updated examples
### 1.0.2.0
* Update to correct issue in Set-TargetResource when checking Ensure
### 1.0.0.0
* Initial release with the following resource:
* xRemoteDesktopAdmin
## Examples
### [ExampleConfiguration-RemoteDesktopAdmin.ps1](Examples/ExampleConfiguration-RemoteDesktopAdmin.ps1)
This configuration configures the target system to allow for remote connections (i.e. allows an RDP session to be setup), enables Network Level Authentication and creates a Windows firewall rule to allow incoming RDP traffic.
### [ExampleConfiguration-RemoteDesktopAdminWithUnEncryptedPassword.ps1](Examples/ExampleConfiguration-RemoteDesktopAdminWithUnEncryptedPassword.ps1)
This configuration extends the previous configuration by adding a domain user to the local Remote Desktop Users group using a credential stored in clear text (for testing purposes only).
Note: this Example requires the built-in **Group** resource.
### [ExampleConfiguration-RemoteDesktopAdminWithEncryptedPassword.ps1](Examples/ExampleConfiguration-RemoteDesktopAdminWithEncryptedPassword.ps1)
This configuration extends the previous configuration by adding a domain user to the local Remote Desktop Users group using certificates to encrypt credentials. Please refer to [this blog post](please refer to http://blogs.msdn.com/b/powershell/archive/2014/01/31/want-to-secure-credentials-in-windows-powershell-desired-state-configuration.aspx) for more info on how to use certificates to encrypt passwords.