Module RDS Information
Installs and sets configuration for client- and server-side. Allow support team to connect (shadow), disconnect/logoff/reset sessions (future).
Requirements
Product
|
Version
|
Windows Server
|
2012R2, RDS Role Installed
|
Windows Client
|
Windows 8.1+
|
Powershell
|
4.0+
|
Installation
Link to
Powershell Gallery
You have to start powershell as Administrator.
Before you start working with Sintez module you have to install two server-/client-side components. It can be simply make with two cmdlets: Install-RDSServer and Install-RDSClient. Please check commands syntax.
Update
You have to start powershell as Administrator.
Syntax
Add/Remove user/group to RDP-Tcp administrator group settings on server side (ONLY RDSH servers). By default only users from Administrators group are able to make changes on RDP-Tcp connections. If you want to grant access to another group you have to create a new group in AD and add it to Security ACLs. This script will add it for you.
This script MUST be started as local Administrator.
Legend
|
Install-RDSServer [[-RDSH] <Array[]>] [[-Domain] <String[]>] [[-Group] <String[]>] [-View] [-Remove] [-Credential]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-RDSH
|
Execute commands on the specified computers. The default is the local computer.
Type the NetBIOS name, an IP address, or a fully qualified domain name (FQDN) of a remote computer. To specify the local computer, type the computer name, a dot (.), or localhost.
|
-SH
|
False
|
-Domain
|
NetBIOS domain name. For domain.com it should be just DOMAIN.
|
-D
|
False
|
-Group
|
Group of users who allow to connect (shadow) to the user session.
|
-G
|
False
|
-View
|
Show all groups from RDP-Tcp security settings tab.
|
-V
|
False
|
-Remove
|
Clear all custom groups in RDP-Tcp security ACLs (reset param).
|
-R
|
False
|
-Credential
|
Credentials switch. Enforce credential form.
|
-C
|
False
|
Example #1
|
Install-RDSServer -Domain DOMAIN -Group rds_support_team
|
Add RDS security group with administrator rights (Shadow, Logoff, Disconnect and etc.) to local RDSH server. If you add group you also have to set DOMAIN param. And vice versa.
|
Example #2
|
Install-RDSServer -SH RDSH1,RDSH2,RDSH3 -Domain DOMAIN -Group rds_support_team
|
As in example #1 we add RDS security group to remote RDSH servers.
|
Example #3
|
Install-RDSServer -R
|
Clear all custom groups in RDP security settings on local RDSH server.
|
Example #4
|
Install-RDSServer -View -SH RDSH1,RDSH2,RDSH3 -C
|
Show all groups in RDP-Tcp security settings on remote RDSH servers. Param "-C" tells cmdlet launch credential prompt window before script will continue.
|
Add/Remove registry tree "rdsmc" and .js file (WINDIR) for SINTEZ App RDS module on client PC.
This script MUST be started as local Administrator.
Legend
|
Install-RDSClient [-Remove]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-Remove
|
Uninstall changes.
|
-R
|
False
|
Example #1
|
Install-RDSClient
|
Install RDS module settings on support team PC.
|
Example #2
|
Install-RDSClient -R
|
Remove all RDS module client-side components.
|
Gets user list, starts RDP connection (shadow).
Legend
|
Start-RDSConnect [[-Broker] <String[]>] [-Credential]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-Broker
|
RDCB FQDN. Ex.: RDCB1.domain.com.
|
-B
|
True
|
-Credential
|
Credentials switch. Enforce credential form.
|
-C
|
False
|
Example #1
|
Start-RDSConnect -B RDCB1.domain.com
|
Start console.
|
Example #2
|
Start-RDSConnect -Broker RDCB1.domain.com -C
|
Start console with credentials prompt.
|
Initiate user session logoff or reset.
Legend
|
Stop-RDSSession [[-Broker] <String[]>] [-Credential] [-Force]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-Broker
|
RDCB FQDN. Ex.: RDCB1.domain.com.
|
-B
|
True
|
-Force
|
Force logoff (reset session). Use this option only if logoff does not work. It can corrupt user profile.
|
-C
|
False
|
-Credential
|
Credentials switch. Enforce credential form.
|
-C
|
False
|
Example #1
|
Stop-RDSSession -B RDCB1.domain.com
|
Starts console, initiates logoff.
|
Example #2
|
Stop-RDSSession -Broker RDCB1.domain.com -C -F
|
Starts console with credentials prompt, initiates session reset.
|
Gets and sets drain mode of RDSH servers. You MUST choose ONE of [-E | -D | -R].
Legend
|
Set-RDSDrainMode [[-Broker] <String[]>] [-Credential] [-Enable] [-Disable] [-Reboot]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-Broker
|
RDCB FQDN. Ex.: RDCB1.domain.com.
|
-B
|
True
|
-Credential
|
Credentials switch. Enforce credential form.
|
-C
|
False
|
-Enable
|
Enable permament drain mode: allow incoming reconnections but prohibit new connections.
|
-E
|
False
|
-Disable
|
Disable drain mode: allow all connections.
|
-D
|
False
|
-Reboot
|
Enable drain mode until reboot: allow incoming reconnections but until reboot prohibit new connections.
|
-R
|
False
|
Example #1
|
Set-RDSDrainMode -B RDCB1.domain.com -E
|
Enable drain mode for selected servers.
|
Sends private message to users.
Legend
|
Send-RDSPrivateMessage [[-Broker] <String[]>] [[-Message] <String[]>] [-Credential]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-Broker
|
RDCB FQDN. Ex.: RDCB1.domain.com.
|
-B
|
True
|
-Message
|
Message text.
|
-M
|
True
|
-Credential
|
Credentials switch. Enforce credential form.
|
-C
|
False
|
Example #1
|
Send-RDSPrivateMessage -B rdcb.domain.com -M "Hey! Big bro is watching you :)"
|
Send private message to selected users.
|
Sends massive message to ALL users on server.
Legend
|
Send-RDSMassiveMessage [[-Broker] <String[]>] [[-Message] <String[]>] [-Credential]
|
Parameter
|
Description
|
Alias
|
Mandatory
|
-Broker
|
RDCB FQDN. Ex.: RDCB1.domain.com.
|
-B
|
True
|
-Message
|
Message text.
|
-M
|
True
|
-Credential
|
Credentials switch. Enforce credential form.
|
-C
|
False
|
Example #1
|
Send-RDSMassiveMessage -B rdcb.domain.com -M "Hey! Big bro is watching you :)"
|
Send massive message to ALL users on selected servers.
|