salt.modules.rdp
Manage RDP Service on Windows servers
-
Disable RDP the service on the server
CLI Example:
salt '*' rdp.disable
salt.modules.rdp.disable()
-
Disconnect a session.
New in version 2016.11.0.
- Parameters
-
session_id -- The numeric Id of the session.
- Returns
-
A boolean representing whether the disconnect succeeded.
CLI Example:
salt '*' rdp.disconnect_session session_id salt '*' rdp.disconnect_session 99
salt.modules.rdp.disconnect_session(session_id)
-
Enable RDP the service on the server
CLI Example:
salt '*' rdp.enable
salt.modules.rdp.enable()
-
Get information about a session.
New in version 2016.11.0.
- Parameters
-
session_id -- The numeric Id of the session.
- Returns
-
A dictionary of session information.
CLI Example:
salt '*' rdp.get_session session_id salt '*' rdp.get_session 99
salt.modules.rdp.get_session(session_id)
-
List information about the sessions.
New in version 2016.11.0.
- Parameters
-
logged_in_users_only -- If True, only return sessions with users logged in.
- Returns
-
A list containing dictionaries of session information.
CLI Example:
salt '*' rdp.list_sessions
salt.modules.rdp.list_sessions(logged_in_users_only=False)
-
Initiate the logoff of a session.
New in version 2016.11.0.
- Parameters
-
session_id -- The numeric Id of the session.
- Returns
-
A boolean representing whether the logoff succeeded.
CLI Example:
salt '*' rdp.logoff_session session_id salt '*' rdp.logoff_session 99
salt.modules.rdp.logoff_session(session_id)
-
Show if rdp is enabled on the server
CLI Example:
salt '*' rdp.status
salt.modules.rdp.status()
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.rdp.html