RemoteDesktopManager.dll-Help.xml
|
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubEntry</command:name> <gl:group>HubEntry</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubEntry</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PSDecryptedEntry</maml:name> <command:parameterValue required="true">PSDecryptedEntry</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSDecryptedEntry</maml:name> <maml:description> <maml:para>Hub entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDecryptedEntry</command:parameterValue> <dev:type> <maml:name>PSDecryptedEntry</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault you want to create the entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubEntry -detailed". For technical information, type "Get-Help New-HubEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubEntry</command:name> <gl:group>HubEntry</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubEntry</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub entry you want to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault you want to remove the entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubEntry -detailed". For technical information, type "Get-Help Remove-HubEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubEntry</command:name> <gl:group>HubEntry</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubEntry</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub entry</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubEntry -detailed". For technical information, type "Get-Help Get-HubEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubEntry</command:name> <gl:group>HubEntry</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubEntry</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PSDecryptedEntry</maml:name> <command:parameterValue required="true">PSDecryptedEntry</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSDecryptedEntry</maml:name> <maml:description> <maml:para>Hub connection</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDecryptedEntry</command:parameterValue> <dev:type> <maml:name>PSDecryptedEntry</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault you want to set the entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubEntry -detailed". For technical information, type "Get-Help Set-HubEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubEntryPermission</command:name> <gl:group>HubEntryPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubEntryPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub Entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryPermission</maml:name> <maml:description> <maml:para>Set custom entry permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntryPermission</command:parameterValue> <dev:type> <maml:name>EntryPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Entry Roles</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntryRole</command:parameterValue> <dev:type> <maml:name>EntryRole</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub Vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubEntryPermission -detailed". For technical information, type "Get-Help New-HubEntryPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubEntryPermission</command:name> <gl:group>HubEntryPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubEntryPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub entry you want to remove all user permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubEntryPermission -detailed". For technical information, type "Get-Help Remove-HubEntryPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubEntryPermission</command:name> <gl:group>HubEntryPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubEntryPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub Entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Group Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubEntryPermission -detailed". For technical information, type "Get-Help Get-HubEntryPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubEntryPermission</command:name> <gl:group>HubEntryPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubEntryPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubEntryPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the Hub Entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryPermission</maml:name> <maml:description> <maml:para>Set custom entry permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntryPermission</command:parameterValue> <dev:type> <maml:name>EntryPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Entry Roles</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntryRole</command:parameterValue> <dev:type> <maml:name>EntryRole</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubEntryPermission -detailed". For technical information, type "Get-Help Set-HubEntryPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubEntriesForExport</command:name> <gl:group>HubEntriesForExport</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubEntriesForExport</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubEntriesForExport</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault you want to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubEntriesForExport -detailed". For technical information, type "Get-Help Get-HubEntriesForExport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubGateway</command:name> <gl:group>HubGateway</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubGateway</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubGateway</maml:name> <command:parameter required="true" position="1"> <maml:name>PsDecryptedGateway</maml:name> <command:parameterValue required="true">PSDecryptedGateway</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PsDecryptedGateway</maml:name> <maml:description> <maml:para>Gateway object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDecryptedGateway</command:parameterValue> <dev:type> <maml:name>PSDecryptedGateway</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubGateway -detailed". For technical information, type "Get-Help New-HubGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubGateway</command:name> <gl:group>HubGateway</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubGateway</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubGateway</maml:name> <command:parameter required="true" position="1"> <maml:name>GatewayId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GatewayId</maml:name> <maml:description> <maml:para>Id of the gateway you want to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubGateway -detailed". For technical information, type "Get-Help Remove-HubGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubGateway</command:name> <gl:group>HubGateway</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubGateway</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubGateway</maml:name> <command:parameter required="true" position="1"> <maml:name>PsDecryptedGateway</maml:name> <command:parameterValue required="true">PSDecryptedGateway</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PsDecryptedGateway</maml:name> <maml:description> <maml:para>Gateway object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDecryptedGateway</command:parameterValue> <dev:type> <maml:name>PSDecryptedGateway</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubGateway -detailed". For technical information, type "Get-Help Set-HubGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubGateway</command:name> <gl:group>HubGateway</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubGateway</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubGateway</maml:name> <command:parameter required="false" position="1"> <maml:name>GatewayId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GatewayId</maml:name> <maml:description> <maml:para>Gateway Id</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubGateway -detailed". For technical information, type "Get-Help Get-HubGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubGatewaySettings</command:name> <gl:group>HubGatewaySettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubGatewaySettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubGatewaySettings</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubGatewaySettings -detailed". For technical information, type "Get-Help New-HubGatewaySettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubGatewaySettings</command:name> <gl:group>HubGatewaySettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubGatewaySettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubGatewaySettings</maml:name> <command:parameter required="true" position="1"> <maml:name>PsDecryptedGatewaySettings</maml:name> <command:parameterValue required="true">PSDecryptedGatewaySettings</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PsDecryptedGatewaySettings</maml:name> <maml:description> <maml:para>Global gateway settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDecryptedGatewaySettings</command:parameterValue> <dev:type> <maml:name>PSDecryptedGatewaySettings</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubGatewaySettings -detailed". For technical information, type "Get-Help Set-HubGatewaySettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubGatewaySettings</command:name> <gl:group>HubGatewaySettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubGatewaySettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubGatewaySettings</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubGatewaySettings -detailed". For technical information, type "Get-Help Get-HubGatewaySettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubGroup</command:name> <gl:group>HubGroup</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>GroupUserIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupUserIds</maml:name> <maml:description> <maml:para>List of Hub user ids to insert in group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubGroup -detailed". For technical information, type "Get-Help New-HubGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubGroup</command:name> <gl:group>HubGroup</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub group you want to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubGroup -detailed". For technical information, type "Get-Help Remove-HubGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubGroup</command:name> <gl:group>HubGroup</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubGroup</maml:name> <command:parameter required="false" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PSGroup</maml:name> <command:parameterValue required="true">PSGroup</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSGroup</maml:name> <maml:description> <maml:para>Hub group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSGroup</command:parameterValue> <dev:type> <maml:name>PSGroup</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubGroup -detailed". For technical information, type "Get-Help Set-HubGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubGroup</command:name> <gl:group>HubGroup</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubGroup</maml:name> <command:parameter required="false" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubGroup -detailed". For technical information, type "Get-Help Get-HubGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Add-HubGroupUser</command:name> <gl:group>HubGroupUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HubGroupUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HubGroupUser</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>UserIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>Id or List of ids of Hub user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Add-HubGroupUser -detailed". For technical information, type "Get-Help Add-HubGroupUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubGroupUser</command:name> <gl:group>HubGroupUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubGroupUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubGroupUser</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>UserIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>Id or List of ids of Hub user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubGroupUser -detailed". For technical information, type "Get-Help Remove-HubGroupUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Connect-HubAccount</command:name> <gl:group>HubAccount</gl:group> <maml:description> <maml:para>Connect to Hub.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>HubAccount</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>If PSHubContext is provided, try to connect to Hub with it. If PSHubContext is not provided, create a PSHubContext with informations received and try to connect to Hub afterward.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-HubAccount</maml:name> <command:parameter required="true" position="1"> <maml:name>PSHubContext</maml:name> <command:parameterValue required="true">PSHubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-HubAccount</maml:name> <command:parameter required="true" position="1"> <maml:name>Url</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ApplicationKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ApplicationSecret</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ApplicationKey</maml:name> <maml:description> <maml:para>Hub Application Key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ApplicationSecret</maml:name> <maml:description> <maml:para>Hub Application Secret</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSHubContext</maml:name> <maml:description> <maml:para>Hub Context</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSHubContext</command:parameterValue> <dev:type> <maml:name>PSHubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Url</maml:name> <maml:description> <maml:para>Hub Url</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Connect-HubAccount -detailed". For technical information, type "Get-Help Connect-HubAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $PSHubContext = [Devolutions.Hub.PowerShell.Entities.PowerShell.PSHubContext]@{ApplicationKey="24526a88-7f18-4356-95bd-11690f7bc59b;468ce2d5-ea4b-42ff-bc02-d93c71b4e554"; ApplicationSecret="U4nmdOjqPAcL0GfbvNC2u8e0FCZjhEJFTnn6YHpIZDY="; Url="https://stagingv3.devolutions.xyz"}; Connect-HubAccount -PSHubContext $PSHubContext</dev:code> <dev:remarks> <maml:para>The user creates the context with information he knows and uses it to connect to Hub.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Connect-HubAccount -Url https://stagingv3.devolutions.xyz -ApplicationKey "24526a88-7f18-4356-95bd-11690f7bc59b;468ce2d5-ea4b-42ff-bc02-d93c71b4e554" -ApplicationSecret U4nmdOjqPAcL0GfbvNC2u8e0FCZjhEJFTnn6YHpIZDY=</dev:code> <dev:remarks> <maml:para>The user etablishes a connection to Hub by passing the context's information directly to the cmdlet. The associated context is created at the same time.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Disconnect-HubAccount</command:name> <gl:group>HubAccount</gl:group> <maml:description> <maml:para>Disconnect to Hub</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>HubAccount</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>If ApplicationKey is provided, disconnect and remove PSHubContext from PowerShell session. If All is provided, disconnect and remove all PSHubContext from PowerShell session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-HubAccount</maml:name> <command:parameter required="false" position="1"> <maml:name>ApplicationKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>All</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <maml:description> <maml:para>Disconnect all Hub context</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ApplicationKey</maml:name> <maml:description> <maml:para>Disconnect a particular connected Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Disconnect-HubAccount -detailed". For technical information, type "Get-Help Disconnect-HubAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Disconnect-HubAccount -All</dev:code> <dev:remarks> <maml:para>Disconnect all Hub Accounts and remove all PSHubContext.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Disconnect-HubAccount -ApplicationKey "24526a88-7f18-4356-95bd-11690f7bc59b;468ce2d5-ea4b-42ff-bc02-d93c71b4e554"</dev:code> <dev:remarks> <maml:para>Disconnect the Hub account associated with the application key. The PSHubContext will also be removed.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubContext</command:name> <gl:group>HubContext</gl:group> <maml:description> <maml:para>Get the current context or all available contexts</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubContext</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>If ListAvailable provided, list all PSHubContext set in PowerShell session. If ListAvailable not provided, get the current PSHubContext who will be used for all other Hub commands.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubContext</maml:name> <command:parameter required="false" position="1"> <maml:name>ListAvailable</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>List all Hub context</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Devolutions.Hub.PowerShell.Entities.PowerShell.PSHubContext</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the current context</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Devolutions.Hub.PowerShell.Entities.PowerShell.PSHubContext, RemoteDesktopManager, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>List of objects representing available contexts</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubContext -detailed". For technical information, type "Get-Help Get-HubContext -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-HubContext</dev:code> <dev:remarks> <maml:para>Obtain the current context</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-HubContext -ListAvailable</dev:code> <dev:remarks> <maml:para>Obtain the available contexts</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubContext</command:name> <gl:group>HubContext</gl:group> <maml:description> <maml:para>Set the current PSHubContext</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubContext</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the current PSHubContext to the one provided</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubContext</maml:name> <command:parameter required="true" position="1"> <maml:name>PSHubContext</maml:name> <command:parameterValue required="true">PSHubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSHubContext</maml:name> <maml:description> <maml:para>Set Hub context to current session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSHubContext</command:parameterValue> <dev:type> <maml:name>PSHubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubContext -detailed". For technical information, type "Get-Help Set-HubContext -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $availCtxs = Get-HubContext; Set-HubContext -PSHubContext $availCtxs[2]</dev:code> <dev:remarks> <maml:para>The user fetches all available contexts and set the third one as the new current context.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Select-HubContext</command:name> <gl:group>HubContext</gl:group> <maml:description> <maml:para>Select another PSHubContext to change the current PSHubContext</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Select</command:verb> <command:noun>HubContext</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Select another PSHubContext to change the current PSHubContext who will be used for all Hub commands.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-HubContext</maml:name> <command:parameter required="true" position="1"> <maml:name>ApplicationKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ApplicationKey</maml:name> <maml:description> <maml:para>Select a connected Hub context to current session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Select-HubContext -detailed". For technical information, type "Get-Help Select-HubContext -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $availCtxs = Get-HubContext; Select-HubContext -ApplicationKey $availCtxs[2].ApplicationKey</dev:code> <dev:remarks> <maml:para>The user fetches all available contexts and set the third one as the new current context.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Save-HubContext</command:name> <gl:group>HubContext</gl:group> <maml:description> <maml:para>Save the current PSHubContext to a .json file at the path received</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>HubContext</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save the current PSHubContext to a .json file at the path received. If PSHubContext is provided, save this one to a .sjon file. If Force is provided, overwrite file if the path already exist. If SecurePassword is provided, prompt to user to enter a password to encrypt the .json file. If Password provided, encrypt the .json file with the password received.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-HubContext</maml:name> <command:parameter required="true" position="1"> <maml:name>SecurePassword</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PSHubContext</maml:name> <command:parameterValue required="true">PSHubContext</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Save-HubContext</maml:name> <command:parameter required="false" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PSHubContext</maml:name> <command:parameterValue required="true">PSHubContext</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite the file if exist</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Will encrypt the file with the clear password</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path of the file to save Hub context.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSHubContext</maml:name> <maml:description> <maml:para>Save Hub context to file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSHubContext</command:parameterValue> <dev:type> <maml:name>PSHubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SecurePassword</maml:name> <maml:description> <maml:para>Will prompt the password to encrypt the file with</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Save-HubContext -detailed". For technical information, type "Get-Help Save-HubContext -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Save-HubContext -Path "C:\PATH\TO\YOUR\FILE\file.json"</dev:code> <dev:remarks> <maml:para>Save the current PSHubContext.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Save-HubContext -Path "C:\PATH\TO\YOUR\FILE\file.json" -Password "password"</dev:code> <dev:remarks> <maml:para>Save the current PSHubContext in a file protected by a password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $availCtxs = Get-HubContext; Save-HubContext -Path "C:\PATH\TO\YOUR\FILEile.json" -PSHubContext $availCtxs[2] -SecurePassword</dev:code> <dev:remarks> <maml:para>Fetch all available contexts. Save the third PSHubContext in a file protected by a password who will be filled be a prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Import-HubContext</command:name> <gl:group>HubContext</gl:group> <maml:description> <maml:para>Import a PSHubContext from a .json file at the path received.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>HubContext</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Import a PSHubContext from a .json file at the path received. If SecurePassword is provided, prompt to enter a password to decrypt the .json file. If Password provided, decrypt the .json file with the password received.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-HubContext</maml:name> <command:parameter required="true" position="1"> <maml:name>SecurePassword</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-HubContext</maml:name> <command:parameter required="false" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Will decrypt the file with the clear password</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file path of Hub context to import.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SecurePassword</maml:name> <maml:description> <maml:para>Will prompt the password to decrypt the file with</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Import-HubContext -detailed". For technical information, type "Get-Help Import-HubContext -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Import-HubContext -Path "C:\PATH\TO\YOUR\FILE\file.json"</dev:code> <dev:remarks> <maml:para>Import a standard PSHubContext.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Import-HubContext -Path "C:\PATH\TO\YOUR\FILEile.json" -Password "password"</dev:code> <dev:remarks> <maml:para>Import the PSHubContext from a file protected by a password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Import-HubContext -Path "C:\PATH\TO\YOUR\FILEile.json" -SecurePassword</dev:code> <dev:remarks> <maml:para>Import the PSHubContext from a file protected by a password. The user will be prompted for the password.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSiemLogs</command:name> <gl:group>HubSiemLogs</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSiemLogs</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSiemLogs</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSiemLogs -detailed". For technical information, type "Get-Help Get-HubSiemLogs -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSiemLogsDaily</command:name> <gl:group>HubSiemLogsDaily</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSiemLogsDaily</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSiemLogsDaily</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSiemLogsDaily -detailed". For technical information, type "Get-Help Get-HubSiemLogsDaily -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSiemLogsWeekly</command:name> <gl:group>HubSiemLogsWeekly</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSiemLogsWeekly</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSiemLogsWeekly</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSiemLogsWeekly -detailed". For technical information, type "Get-Help Get-HubSiemLogsWeekly -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSiemLogsMonthly</command:name> <gl:group>HubSiemLogsMonthly</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSiemLogsMonthly</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSiemLogsMonthly</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSiemLogsMonthly -detailed". For technical information, type "Get-Help Get-HubSiemLogsMonthly -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSystemSettings</command:name> <gl:group>HubSystemSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSystemSettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSystemSettings</maml:name> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSystemSettings -detailed". For technical information, type "Get-Help Get-HubSystemSettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubSystemSettings</command:name> <gl:group>HubSystemSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubSystemSettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubSystemSettings</maml:name> <command:parameter required="true" position="1"> <maml:name>PSSystemSettings</maml:name> <command:parameterValue required="true">PSSystemSettings</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSSystemSettings</maml:name> <maml:description> <maml:para>Set system settings object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSystemSettings</command:parameterValue> <dev:type> <maml:name>PSSystemSettings</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubSystemSettings -detailed". For technical information, type "Get-Help Set-HubSystemSettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubSystemVaultPermission</command:name> <gl:group>HubSystemVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubSystemVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultRole</command:parameterValue> <dev:type> <maml:name>VaultRole</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SystemVaultPermission</maml:name> <maml:description> <maml:para>Set custom system vault permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultPermission</command:parameterValue> <dev:type> <maml:name>VaultPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubSystemVaultPermission -detailed". For technical information, type "Get-Help New-HubSystemVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubSystemVaultPermission</command:name> <gl:group>HubSystemVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubSystemVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubSystemVaultPermission -detailed". For technical information, type "Get-Help Remove-HubSystemVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSystemVaultPermission</command:name> <gl:group>HubSystemVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSystemVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Group Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSystemVaultPermission -detailed". For technical information, type "Get-Help Get-HubSystemVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubSystemVaultPermission</command:name> <gl:group>HubSystemVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubSystemVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubSystemVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultRole</command:parameterValue> <dev:type> <maml:name>VaultRole</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SystemVaultPermission</maml:name> <maml:description> <maml:para>Set custom system vault permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultPermission</command:parameterValue> <dev:type> <maml:name>VaultPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubSystemVaultPermission -detailed". For technical information, type "Get-Help Set-HubSystemVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubSystemPermission</command:name> <gl:group>HubSystemPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubSystemPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SystemPermission</maml:name> <maml:description> <maml:para>Set system permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemPermission</command:parameterValue> <dev:type> <maml:name>SystemPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubSystemPermission -detailed". For technical information, type "Get-Help New-HubSystemPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubSystemPermission</command:name> <gl:group>HubSystemPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubSystemPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubSystemPermission -detailed". For technical information, type "Get-Help Remove-HubSystemPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubSystemPermission</command:name> <gl:group>HubSystemPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubSystemPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Group Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubSystemPermission -detailed". For technical information, type "Get-Help Get-HubSystemPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubSystemPermission</command:name> <gl:group>HubSystemPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubSystemPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubSystemPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Group Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SystemPermission</maml:name> <maml:description> <maml:para>Set system permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemPermission</command:parameterValue> <dev:type> <maml:name>SystemPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubSystemPermission -detailed". For technical information, type "Get-Help Set-HubSystemPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubUser</command:name> <gl:group>HubUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubUser</maml:name> <command:parameter required="true" position="1"> <maml:name>UserEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UserLocale</maml:name> <command:parameterValue required="true">en_US | fr | de | es | hu | it | nl | pl | ru | sv | uk | zh_CHS | zh_TW | cs</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IsTemporaryPasswordSendByEmail</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IsTemporaryPasswordSendByEmail</maml:name> <maml:description> <maml:para>If new Devolutions user and this is set to true, his temporary password will be send by email. If not, the temporary password will be display at the end of the user creation</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>Email of Devolutions user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserLocale</maml:name> <maml:description> <maml:para>If new Devolutions user, set his account locale</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Language</command:parameterValue> <dev:type> <maml:name>Language</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubUser -detailed". For technical information, type "Get-Help New-HubUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubOrganizationUser</command:name> <gl:group>HubOrganizationUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubOrganizationUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubOrganizationUser</maml:name> <command:parameter required="true" position="1"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AllowOfflineInRDM</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UserSendMessageConfiguration</maml:name> <command:parameterValue required="true">MessagesWithEntries | MessagesWithoutEntries | NoMessages</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubOrganizationUser</maml:name> <command:parameter required="true" position="1"> <maml:name>PSInvitation</maml:name> <command:parameterValue required="true">PSInvitation</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AllowOfflineInRDM</maml:name> <maml:description> <maml:para>Allow offline mode in RDM</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email of organization user you want to invite</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSInvitation</maml:name> <maml:description> <maml:para>Invite organization user by PSInvitation object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSInvitation</command:parameterValue> <dev:type> <maml:name>PSInvitation</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserSendMessageConfiguration</maml:name> <maml:description> <maml:para>Configuration that allow/disallow to send messages with/without entries</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UserSendMessagePermission</command:parameterValue> <dev:type> <maml:name>UserSendMessagePermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubOrganizationUser -detailed". For technical information, type "Get-Help New-HubOrganizationUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubUser</command:name> <gl:group>HubUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubUser</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub user you want to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubUser -detailed". For technical information, type "Get-Help Remove-HubUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubUser</command:name> <gl:group>HubUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubUser</maml:name> <command:parameter required="false" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub user</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubUser -detailed". For technical information, type "Get-Help Get-HubUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubUser</command:name> <gl:group>HubUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubUser</maml:name> <command:parameter required="false" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PSUser</maml:name> <command:parameterValue required="true">PSUser</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSUser</maml:name> <maml:description> <maml:para>Hub User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSUser</command:parameterValue> <dev:type> <maml:name>PSUser</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub user</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubUser -detailed". For technical information, type "Get-Help Set-HubUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>ConvertTo-HubFlatObject</command:name> <gl:group>HubFlatObject</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>ConvertTo</command:verb> <command:noun>HubFlatObject</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-HubFlatObject</maml:name> <command:parameter required="true" position="1"> <maml:name>PsObject</maml:name> <command:parameterValue required="true">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>PsObject</maml:name> <maml:description> <maml:para>Object(s) to flatten</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help ConvertTo-HubFlatObject -detailed". For technical information, type "Get-Help ConvertTo-HubFlatObject -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubVault</command:name> <gl:group>HubVault</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubVault</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubVault</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>VaultDescription</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultDescription</maml:name> <maml:description> <maml:para>Description of the Hub Vault</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultName</maml:name> <maml:description> <maml:para>Name of the Hub Vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubVault -detailed". For technical information, type "Get-Help New-HubVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubVault</command:name> <gl:group>HubVault</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubVault</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubVault</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault you want to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubVault -detailed". For technical information, type "Get-Help Remove-HubVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubVault</command:name> <gl:group>HubVault</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubVault</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubVault</maml:name> <command:parameter required="false" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubVault -detailed". For technical information, type "Get-Help Get-HubVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubVault</command:name> <gl:group>HubVault</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubVault</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubVault</maml:name> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PSVault</maml:name> <command:parameterValue required="true">PSVault</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSVault</maml:name> <maml:description> <maml:para>Hub vault</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSVault</command:parameterValue> <dev:type> <maml:name>PSVault</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubVault -detailed". For technical information, type "Get-Help Set-HubVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-HubVaultPermission</command:name> <gl:group>HubVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HubVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultRole</command:parameterValue> <dev:type> <maml:name>VaultRole</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub Vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultPermission</maml:name> <maml:description> <maml:para>Set custom vault permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultPermission</command:parameterValue> <dev:type> <maml:name>VaultPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-HubVaultPermission -detailed". For technical information, type "Get-Help New-HubVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-HubVaultPermission</command:name> <gl:group>HubVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HubVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of user you want to remove all permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault you want to remove all user permissions from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-HubVaultPermission -detailed". For technical information, type "Get-Help Remove-HubVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-HubVaultPermission</command:name> <gl:group>HubVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Group Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-HubVaultPermission -detailed". For technical information, type "Get-Help Get-HubVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-HubVaultPermission</command:name> <gl:group>HubVaultPermission</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HubVaultPermission</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Readers | Operators | Contributors | Managers</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HubVaultPermission</maml:name> <command:parameter required="true" position="1"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HubContext</maml:name> <command:parameterValue required="true">HubContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Id of the Hub Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubContext</maml:name> <maml:description> <maml:para>Hub context</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">HubContext</command:parameterValue> <dev:type> <maml:name>HubContext</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultRole</command:parameterValue> <dev:type> <maml:name>VaultRole</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Id of the Hub User</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the Hub vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultPermission</maml:name> <maml:description> <maml:para>Set custom vault permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultPermission</command:parameterValue> <dev:type> <maml:name>VaultPermission</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-HubVaultPermission -detailed". For technical information, type "Get-Help Set-HubVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMMessageAttachment</command:name> <gl:group>RDMMessageAttachment</gl:group> <maml:description> <maml:para>Create an attachment for a message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMMessageAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create an attachment for the command Send-RDMMessage. To attach a private entry, simply use the Get-RDMPrivateSession cmdlet instead of this one.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMMessageAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>Credentials</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMMessageAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>File</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>The credentials Username/Password are attached to the message with a title to identify them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>File</maml:name> <maml:description> <maml:para>The attachment is a file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password of the credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to attach to the message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username of the credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSMessageAttachment</maml:name> <maml:uri /> <maml:description> <maml:para>A object representing a single message received</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMMessageAttachment -detailed". For technical information, type "Get-Help New-RDMMessageAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $cred = New-RDMMessageAttachment -Credentials -Title 'ForSomething' -Username 'ABC' -Password (ConvertTo-SecureString -AsPlainText passw0rd); Send-RDMMessage -To 'First Last' -Subject 'Required credentials' -Attachment $cred</dev:code> <dev:remarks> <maml:para>Create a simple Username/Password attachment. That attachment is sent in a message to 'First Last'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $file = New-RDMMessageAttachment -File -Path C:\mypath\filename.extension; $file.Name = 'renamedFile.extension'; Send-RDMMessage -To 'First Last' -Subject 'A File' -Attachment $file</dev:code> <dev:remarks> <maml:para>Create an attachment from a file. The user rename the file from filename.extension to renamedFile.extension. That attachment is sent in a message to 'First Last'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Send-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMPort</command:name> <gl:group>RDMPort</gl:group> <maml:description> <maml:para>Generate port number(s) based on the specified parameters.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMPort</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Generate port number(s) based on the specified parameters.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMPort</maml:name> <command:parameter required="false" position="1"> <maml:name>Count</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExcludePort</maml:name> <command:parameterValue required="true">Int32[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeWellKnownPorts</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeRegisteredPorts</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludePortsUsedByOthersSessions</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Maximum</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Minimum</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of ports to be generated. Default value is 1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ExcludePort</maml:name> <maml:description> <maml:para>Those ports will not be generated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludePortsUsedByOthersSessions</maml:name> <maml:description> <maml:para>Allows ports used by others sessions to be generated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeRegisteredPorts</maml:name> <maml:description> <maml:para>Allows registered ports to be generated. For a list of registered ports, see: https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers#Registered_ports</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeWellKnownPorts</maml:name> <maml:description> <maml:para>Allows well known ports to be generated. For a list of well known ports, see: https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers#Well-known_ports</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Maximum</maml:name> <maml:description> <maml:para>Maximum port value generated. By default, the boundary is set at the absolute maximum 65 535.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Minimum</maml:name> <maml:description> <maml:para>Minimum port value generated. By default, the boundary is set at 0. A recommended value is 1024.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMPort -detailed". For technical information, type "Get-Help New-RDMPort -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $port = New-RDMPort -Minimum 50 -Maximum 2048 -IncludeWellKnownPorts -IncludeRegisteredPorts -IncludePortsUsedByOthersSessions</dev:code> <dev:remarks> <maml:para>Generate a port between 50 and 2048. The port can be already used by another session, or be a well known or registered port.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $port = New-RDMPort -Minimum 10 -Maximum 15 -IncludeWellKnownPorts -IncludeRegisteredPorts -ExcludePort 11,12,13</dev:code> <dev:remarks> <maml:para>The port will have a value of either 10, 14 or 15. If another session use one of the ports, that port will be excluded from the possibilities.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $ports = New-RDMPort -Count 10</dev:code> <dev:remarks> <maml:para>10 ports will be generated and stored in $ports.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $sess = Get-RDMSession -Name ARemotePwsh; $sess.PowerShell.Port = New-RDMPort -Minimum 1024; Set-RDMSession -Session $sess -Refresh</dev:code> <dev:remarks> <maml:para>The user fetch an existing remote powershell session called ARemotePwsh and change its port. The new port in at least 1024, not a well known port, not a registered port and unused by other sessions. The user save the modification.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Add-RDMPrivateSessionAttachment</command:name> <gl:group>RDMPrivateSessionAttachment</gl:group> <maml:description> <maml:para>Add a new attachment to a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMPrivateSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Add a new attachment to a session</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMPrivateSessionAttachment</maml:name> <command:parameter required="false" position="1"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SecurityGroup</maml:name> <command:parameterValue required="true">PSSecurityGroupInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Attachment description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Attachment filename.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Password</maml:name> <maml:description> <maml:para>Attachment password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Attachment security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSSecurityGroupInfo</command:parameterValue> <dev:type> <maml:name>PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Title</maml:name> <maml:description> <maml:para>Attachment title.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Add-RDMPrivateSessionAttachment -detailed". For technical information, type "Get-Help Add-RDMPrivateSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Add-RDMRoleRepositoryAccess</command:name> <gl:group>RDMRoleRepositoryAccess</gl:group> <maml:description> <maml:para>Add repository access to a role</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMRoleRepositoryAccess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Add repository access to a role</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMRoleRepositoryAccess</maml:name> <command:parameter required="true" position="2"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository the role will be granted access</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Role that will be granted access to a repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Role that will be granted access to a repository</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Repository the role will be granted access</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Add-RDMRoleRepositoryAccess -detailed". For technical information, type "Get-Help Add-RDMRoleRepositoryAccess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Add-RDMRoleRepositoryAccess -Role $role -Repository $repo;Set-RDMRole $role</dev:code> <dev:remarks> <maml:para>Add a repository access to a role.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Add-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Add a new attachment to a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Add a new attachment to a session</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMSessionAttachment</maml:name> <command:parameter required="false" position="1"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SecurityGroup</maml:name> <command:parameterValue required="true">PSSecurityGroupInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Attachment description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Attachment filename.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Password</maml:name> <maml:description> <maml:para>Attachment password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Attachment security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSSecurityGroupInfo</command:parameterValue> <dev:type> <maml:name>PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Title</maml:name> <maml:description> <maml:para>Attachment title.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Add-RDMSessionAttachment -detailed". For technical information, type "Get-Help Add-RDMSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Add-RDMUserRepositoryAccess</command:name> <gl:group>RDMUserRepositoryAccess</gl:group> <maml:description> <maml:para>Add repository access to an user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMUserRepositoryAccess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Add repository access to an user</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMUserRepositoryAccess</maml:name> <command:parameter required="true" position="2"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository the user will be granted access</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>User that will be granted access to a repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User that will be granted access to a repository</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Repository the user will be granted access</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Add-RDMUserRepositoryAccess -detailed". For technical information, type "Get-Help Add-RDMUserRepositoryAccess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Add-RDMUserRepositoryAccess -User $user -Repository $repo;Set-RDMUser $user</dev:code> <dev:remarks> <maml:para>Add repository access to an user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Add-RDMRoleToUser</command:name> <gl:group>RDMRoleToUser</gl:group> <maml:description> <maml:para>Add role to an user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMRoleToUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Add role to an user</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMRoleToUser</maml:name> <command:parameter required="true" position="2"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RDMRoleToUser</maml:name> <command:parameter required="true" position="2"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>UserObject</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RDMRoleToUser</maml:name> <command:parameter required="true" position="1"> <maml:name>RoleObject</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserObject</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-RDMRoleToUser</maml:name> <command:parameter required="true" position="1"> <maml:name>RoleObject</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Role name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleObject</maml:name> <maml:description> <maml:para>Role object, must be retrieved from Get-RDMRole or created via New-RDMRole.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserObject</maml:name> <maml:description> <maml:para>User object, must be retrieved from Get-RDMSecurityGroup or created via New-RDMUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the role and/or user</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Role to which the user will be assigned</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The user to which a role will be assigned</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Add-RDMRoleToUser -detailed". For technical information, type "Get-Help Add-RDMRoleToUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Add-RDMRoleToUser -RoleObject $role -UserObject $user;Set-RDMUser $user</dev:code> <dev:remarks> <maml:para>Add role to an user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Start-RDMInstance</command:name> <gl:group>RDMInstance</gl:group> <maml:description> <maml:para>Initialize a Remote Desktop Manager PowerShell module instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>RDMInstance</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Initialize a Remote Desktop Manager PowerShell module instance</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Start-RDMInstance -detailed". For technical information, type "Get-Help Start-RDMInstance -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Close-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Close a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Close</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Close a session</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Close-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces close of the Session without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to be closed.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Session ID to close</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Close-RDMSession -detailed". For technical information, type "Get-Help Close-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Close-RDMSession -ID 00000000-0000-0000-0000-000000000000</dev:code> <dev:remarks> <maml:para>Close a session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Copy-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Copy a session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Copy a session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DontChangeID</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>IncludePasswordHistory</maml:name> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IncludeSubConnections</maml:name> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ResolveVariables</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DontChangeID</maml:name> <maml:description> <maml:para>Copy the session without changing the ID</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>IncludePasswordHistory</maml:name> <maml:description> <maml:para>Include password history in the session copy</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeSubConnections</maml:name> <maml:description> <maml:para>Include sub connections in the session copy</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PSConnection</maml:name> <maml:description> <maml:para>Session to copy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ResolveVariables</maml:name> <maml:description> <maml:para>Resolve variables in the session copy</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Session to copy</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Session copied</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Copy-RDMSession -detailed". For technical information, type "Get-Help Copy-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Edit-RDMUserTemplate</command:name> <gl:group>RDMUserTemplate</gl:group> <maml:description> <maml:para>Add or default vaults in the User Template of the System Settings for a specific data source. New users created in that data source will gain or lose access to those vaults.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Edit</command:verb> <command:noun>RDMUserTemplate</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Add or default vaults in the User Template of the System Settings for a specific data source. New users created in that data source will gain or lose access to those vaults.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Edit-RDMUserTemplate</maml:name> <command:parameter required="true" position="2"> <maml:name>AddRepository</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Edit-RDMUserTemplate</maml:name> <command:parameter required="true" position="2"> <maml:name>RemoveRepository</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>AddRepository</maml:name> <maml:description> <maml:para>Add the default vaults in the User Template of the System Settings. Allows to find repositories by ID (Guid), by name (supports wildcards), and repositories (PSRepositoryInfo).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive when searching the data source or the repositories by name</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>DataSource whose settings will be modified. Allows to find the data source by ID (Guid), by name (supports wildcard), and data source (PSDataSource).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>RemoveRepository</maml:name> <maml:description> <maml:para>Remove the default vaults in the User Template of the System Settings. Allows to find repositories by ID (Guid), by name (supports wildcards), and repositories (PSRepositoryInfo). Removing all default vaults is possible.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The data source whose system settings will be modified. Allows to find the data source by ID (Guid), by name (supports wildcard), and data source (PSDataSource).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The repositories to add or remove to the User Template. Allows to find repositories by ID (Guid), by name (supports wildcards), and repositories (PSRepositoryInfo).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the data source and the repositories will be a case sensitive search is this switch is present.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Edit-RDMUserTemplate -detailed". For technical information, type "Get-Help Edit-RDMUserTemplate -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Edit-RDMUserTemplate -DataSource ADataSource -AddRepository ACommonVault;</dev:code> <dev:remarks> <maml:para>Add ACommonVault in the User Template in the System Settings of the data source "ADataSource".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Edit-RDMUserTemplate -DataSource ADataSource -RemoveRepository *;</dev:code> <dev:remarks> <maml:para>Remove all the repositories in the User Template in the System Settings of the data source ADataSource.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMDataSource -Name "ADataSource" | Edit-RDMUserTemplate -RemoveRepository CommonVault[ab] -CaseSensitive;</dev:code> <dev:remarks> <maml:para>Remove the repositories CommonVaulta and CommonVaultb in the User Template in the System Settings of the data source "ADataSource". The case sensitive switch is not impacting the term [ab], meaning a repository CommonVaultA would not be affected.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Edit-RDMUserTemplate -DataSource ADataSource -Repository UserVault? -CaseSensitive;</dev:code> <dev:remarks> <maml:para>Add all repositories UserVault? such as UserVaultA and UserVault1 in the User Template in the System Settings of the data source "ADataSource". The search for the data source and the repositories wll be case sensitive.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMCurrentDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMCurrentRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMRepository</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Export-RDMActivityLogsReport</command:name> <gl:group>RDMActivityLogsReport</gl:group> <maml:description> <maml:para>Export the activity logs for the current data source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>RDMActivityLogsReport</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Export the activity logs for the current data source. The content can be filtered with parameters. If a file exists at the specified path, it will be overwritten. To use this cmdlet, the user must have the rights to access reports.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-RDMActivityLogsReport</maml:name> <command:parameter required="false" position="1"> <maml:name>Theme</maml:name> <command:parameterValue required="true">Light | Dark</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DateFilter</maml:name> <command:parameterValue required="true">LastWeek | Today | Yesterday | Custom | LastMonth | CurrentMonth | Last7Days | Last30Days | Last31Days | Last60Days | Last90Days</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Descending</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EntryName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Folder</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MachineName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>OnCloseComment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>OnOpenComment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SortField</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Type</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UTC</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>After</maml:name> <maml:description> <maml:para>Set the inclusive custom lower limit date for the logs included in the report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Before</maml:name> <maml:description> <maml:para>Set the inclusive custom upper limit date for the logs included in the report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DateFilter</maml:name> <maml:description> <maml:para>Filter the logs based on predefined value for the date, such as Today. If not specified, it will be custom, allowing the use of the parameters Before and After.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateFilter</command:parameterValue> <dev:type> <maml:name>DateFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Descending</maml:name> <maml:description> <maml:para>Sort in the descending order.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryName</maml:name> <maml:description> <maml:para>Filter the logs for a specific entry.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Filter the logs for a specific folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Filter the logs by the machine name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>Filter the logs by the message.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OnCloseComment</maml:name> <maml:description> <maml:para>Filter the logs by the close prompt comment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OnOpenComment</maml:name> <maml:description> <maml:para>Filter the logs by the open prompt comment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file will be the saved. Must end with:</maml:para> <maml:para /> <maml:para>"CSV: .csv", "HTML: .html", "XML: .xml"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SortField</maml:name> <maml:description> <maml:para>Field on which the sort will be applied</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Theme</maml:name> <maml:description> <maml:para>Specify the theme of the report. If not specified, the RDM theme will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Theme</command:parameterValue> <dev:type> <maml:name>Theme</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TicketID</maml:name> <maml:description> <maml:para>Filter the logs by the ticket number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the file type of the export. CSV, HTML and XLM are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Filter the logs by the user name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UTC</maml:name> <maml:description> <maml:para>Use UTC time for the parameters 'After' and 'Before'.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Filter the logs by the vault ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Export-RDMActivityLogsReport -detailed". For technical information, type "Get-Help Export-RDMActivityLogsReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Export-RDMActivityLogsReport Html C:\my\path\name.html -DateFilter Last30Days</dev:code> <dev:remarks> <maml:para>Generate an html report at the location C:\my\path\name.html for all activities that occured in the last 30 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Export-RDMActivityLogsReport Csv C:\my\path\name.csv -EntryName VIPEntry -Theme Dark</dev:code> <dev:remarks> <maml:para>Generate an csv report at the location C:\my\path\name.csv for all activities that occured on the entry VIPEntry. The report will have a dark background.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Export-RDMOptionFile</command:name> <gl:group>RDMOptionFile</gl:group> <maml:description> <maml:para>Export a RemoteDesktopManager configuration file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>RDMOptionFile</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Export a RemoteDesktopManager configuration file</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-RDMOptionFile</maml:name> <command:parameter required="false" position="1"> <maml:name>ClearApplicationLockInformation</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CloudCredentials</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Datasources</maml:name> <command:parameterValue required="true">PSDataSource[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ForceAlwaysRetrieveNewRegistration</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DataSourceCredentials</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ProxySettings</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>RegistrationEmail</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>RegistrationKey</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>RegistrationName</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SavedInstallationPaths</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SavedTemplates</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ClearApplicationLockInformation</maml:name> <maml:description> <maml:para>Clear the application lock information in the configuration file. </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CloudCredentials</maml:name> <maml:description> <maml:para>Include the Devolutions Account credentials in the configuration file. </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DataSourceCredentials</maml:name> <maml:description> <maml:para>Include your data source credentials.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Datasources</maml:name> <maml:description> <maml:para>PSDataSource objects, must be retrieved from Get-RDMCurrentDataSource or Get-RDMDatasource, or created via New-RDMDataSource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PSDataSource[]</command:parameterValue> <dev:type> <maml:name>PSDataSource[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ForceAlwaysRetrieveNewRegistration</maml:name> <maml:description> <maml:para>Include the force always new registration in the configuration file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file will be the saved. Must be different from the current configuaration file and end with .cfg</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProxySettings</maml:name> <maml:description> <maml:para>Includes your proxy settings.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RegistrationEmail</maml:name> <maml:description> <maml:para>Include the registration email in the configuration file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RegistrationKey</maml:name> <maml:description> <maml:para>Include the registration key in the configuration file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RegistrationName</maml:name> <maml:description> <maml:para>Include the registration name in the configuration file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SavedInstallationPaths</maml:name> <maml:description> <maml:para>Preserve your installation paths configured for the external application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SavedTemplates</maml:name> <maml:description> <maml:para>Include the local templates in the configuration file.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>File path</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Export-RDMOptionFile -detailed". For technical information, type "Get-Help Export-RDMOptionFile -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Export-RDMOptionFile -Path C:\MyPath\Filename.cfg</dev:code> <dev:remarks> <maml:para>Retrieve the current configuration and export it to a cfg file at C:\MyPath\Filename.cfg</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Export-RDMOptionFile -Path C:\MyPath\Filename.cfg -DataSources (Get-RDMDataSource | Where-Object {$_.Name -like "Test*"})</dev:code> <dev:remarks> <maml:para>Retrieve the current configuration with only the datasources whose name beginning with Test and export it to a cfg file at C:\MyPath\Filename.cfg</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Export-RDMOptionFile -Path C:\MyPath\Filename.cfg -ProxySettings -RegistrationName -RegistrationEmail -RegistrationKey -DataSources @()</dev:code> <dev:remarks> <maml:para>Retrieve the current configuration file including the proxy settings and the registration information and without datasources and export it to a cfg file at C:\MyPath\Filename.cfg</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Export-RDMPasswordAnalyzerReport</command:name> <gl:group>RDMPasswordAnalyzerReport</gl:group> <maml:description> <maml:para>Export an entry security analyzer report of the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>RDMPasswordAnalyzerReport</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Export an entry security analyzer report of the current data source to the specfied path. The user must have access to the reports to use the command.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-RDMPasswordAnalyzerReport</maml:name> <command:parameter required="false" position="1"> <maml:name>ShowAllEntries</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ShowPwnedPassword</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ShowVPNAnalysis</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Theme</maml:name> <command:parameterValue required="true">Light | Dark</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ExportType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Private</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ReportType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Status</maml:name> <command:parameterValue required="true">ShowAll | Default | Locked | Disabled | Warning | Expired</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportType</maml:name> <maml:description> <maml:para>Specify the file type of the export. CSV, HTML and XLM are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file will be the saved. Must end with:</maml:para> <maml:para /> <maml:para>"CSV: .csv", "HTML: .html", "XML: .xml"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Private</maml:name> <maml:description> <maml:para>The report will cover the list of available sessions from the user private vault.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ReportType</maml:name> <maml:description> <maml:para>Specify the report type to export. Only PasswordAnalyzer (Entry Security Analyzer) is supported for now.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ShowAllEntries</maml:name> <maml:description> <maml:para>Show also the entries without a password</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ShowPwnedPassword</maml:name> <maml:description> <maml:para>Show the compromised (pwned) passwords</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ShowVPNAnalysis</maml:name> <maml:description> <maml:para>Show the VPN analysis</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter the connections based on their status. The filter "Default" keeps the connections whose status is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ConnectionStatusFilter</command:parameterValue> <dev:type> <maml:name>ConnectionStatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Theme</maml:name> <maml:description> <maml:para>Specify the theme of the report. If not specified, the RDM theme will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Theme</command:parameterValue> <dev:type> <maml:name>Theme</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Export-RDMPasswordAnalyzerReport -detailed". For technical information, type "Get-Help Export-RDMPasswordAnalyzerReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Export-RDMPasswordAnalyzerReport -ExportType Html -Path C:\mypath\filename.html -Status Expired -Verbose</dev:code> <dev:remarks> <maml:para>Export the Password Analyzer report in a html format at the location C:\mypath\filename.html. Only the connections with expired password will be include in the report. If the report does not contain an entry, a verbose message will indicates that the report is empty. In that case, the report will not be generated.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMDataSource -Name ADataSource | Set-RDMCurrentDataSource; Export-RDMPasswordAnalyzerReport -ExportType Html -Path C:\mypath\filename.html -ShowAllEntries -ShowVPNAnalysis -ShowPwnedPassword -Private</dev:code> <dev:remarks> <maml:para>Change the current data source to ADataSource and export the Password Analyzer report in a html format at the location C:\mypath\filenmae.html. The report will contain all connections, even those without a password, the VPN analysis, and will identified the compromised passwords.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $original = Get-RDMCurrentDataSource; $ds = Get-RDMDataSource; $ds.ForEach({Set-RDMCurrentDataSource -DataSource $_; Export-RDMPasswordAnalyzerReport -ExportType Html -Path C:\mypath\$($_.Name).html -ShowPwnedPassword -Private}); Set-RDMCurrentDataSource -DataSource $original</dev:code> <dev:remarks> <maml:para>For all the data sources, export the Password Analyzer report of the private vault in a html format in the directory C:\mypath\ where the file name will be the same as the data source name. The initial current data source will be set again as the current one.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Export-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Export a list of sessions to a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Export a list of sessions to a file. The user must have the right to export. The sessions must come from the current data source or they will be ignored. If user vault export is disabled, the sessions from the private vault will be ignored.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>CSV</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Sessions</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>HTML</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Sessions</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExcludeSessionPassword</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>XML</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Sessions</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeCredentials</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeAttachements</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeSecurityGroups</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CSV</maml:name> <maml:description> <maml:para>Export the sessions into a CSV file</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExcludeSessionPassword</maml:name> <maml:description> <maml:para>Don't export the password in the connections exported</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HTML</maml:name> <maml:description> <maml:para>Export the sessions into a HTML file</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeAttachements</maml:name> <maml:description> <maml:para>Include attachements in the export (Only available for the XML type).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeCredentials</maml:name> <maml:description> <maml:para>Include credentials in the export (Only available for the XML type).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeSecurityGroups</maml:name> <maml:description> <maml:para>Include Security Groups in the export (Only available for the XML type).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file will be the saved. Must end with:</maml:para> <maml:para /> <maml:para>"CSV: .zip", "HTML: .html", "XML: .xml", "RDM: .rdm"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Sessions</maml:name> <maml:description> <maml:para>Sessions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>XML</maml:name> <maml:description> <maml:para>Export the sessions into a XML file</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>File path</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Password used to protect the file</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Sessions to export into the file</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Export-RDMSession -detailed". For technical information, type "Get-Help Export-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $sessions = get-rdmsession; $password = read-host -assecurestring "Password"; Export-RDMSession -XML -Path C:\MyPath\MyFilename.xml -Sessions $sessions -Password $password</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and export them to a xml file at C:\MyPath\Filename.xml.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMCommand</command:name> <gl:group>RDMCommand</gl:group> <maml:description> <maml:para>Retrieve the Remote Desktop Manager executable path</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMCommand</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the Remote Desktop Manager executable path</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMCommand</maml:name> <command:parameter required="false" position="1"> <maml:name>Edition</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Edition</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Remote Desktop Manager executable path</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMCommand -detailed". For technical information, type "Get-Help Get-RDMCommand -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $execPath = Get-RDMCommand</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMCurrentDataSource</command:name> <gl:group>RDMCurrentDataSource</gl:group> <maml:description> <maml:para>Retrieve the active data source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMCurrentDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the active data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para>Data source object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMCurrentDataSource -detailed". For technical information, type "Get-Help Get-RDMCurrentDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMCurrentDataSource</dev:code> <dev:remarks> <maml:para>The current active data sources.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMCurrentRepository</command:name> <gl:group>RDMCurrentRepository</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMCurrentRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMCurrentRepository -detailed". For technical information, type "Get-Help Get-RDMCurrentRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $repository = Get-RDMCurrentRepository</dev:code> <dev:remarks> <maml:para>Get the current repository.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMDataSource</command:name> <gl:group>RDMDataSource</gl:group> <maml:description> <maml:para>Retrieve the list of available data sources.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available data sources.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMDataSource</maml:name> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Data source name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMDataSource -detailed". For technical information, type "Get-Help Get-RDMDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMDataSource</dev:code> <dev:remarks> <maml:para>Retrieves the list of available data sources.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMDataSource; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available data sources and displays the first item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMDataSource; Set-RDMDataSource $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available data sources and sets the current data source the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMDatasourceProperty</command:name> <gl:group>RDMDatasourceProperty</gl:group> <maml:description> <maml:para>Get the value of property given for a dataSource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMDatasourceProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Protected values will always return null.</maml:para> <maml:para>Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMDatasourceProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the datasource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Data source object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Property name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> <maml:description> <maml:para>Property value</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMDatasourceProperty -detailed". For technical information, type "Get-Help Get-RDMDatasourceProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMDiagnostic</command:name> <gl:group>RDMDiagnostic</gl:group> <maml:description> <maml:para>Retrieve the latest version download url</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMDiagnostic</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the latest version download url</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> <maml:description> <maml:para>Remote Desktop Manager download url and version</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMDiagnostic -detailed". For technical information, type "Get-Help Get-RDMDiagnostic -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $package = Get-RDMPackage</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMInstance</command:name> <gl:group>RDMInstance</gl:group> <maml:description> <maml:para>Get the instance info</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMInstance</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the instance info</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRDMInstanceInfo</maml:name> <maml:uri /> <maml:description> <maml:para>Instance infos</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMInstance -detailed". For technical information, type "Get-Help Get-RDMInstance -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMLicense</command:name> <gl:group>RDMLicense</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMLicense</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMLicense</maml:name> <command:parameter required="false" position="1"> <maml:name>Serial</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Serial</maml:name> <maml:description> <maml:para>License serial</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>License serial</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>License array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMLicense -detailed". For technical information, type "Get-Help Get-RDMLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMOffline</command:name> <gl:group>RDMOffline</gl:group> <maml:description> <maml:para>Get the current data source offline</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMOffline</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the current data source offline</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMOffline -detailed". For technical information, type "Get-Help Get-RDMOffline -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMOnline</command:name> <gl:group>RDMOnline</gl:group> <maml:description> <maml:para>Get the current data source online</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMOnline</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the current data source online</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMOnline -detailed". For technical information, type "Get-Help Get-RDMOnline -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMOpenedSession</command:name> <gl:group>RDMOpenedSession</gl:group> <maml:description> <maml:para>Retrieve the list of opened sessions of the current data source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMOpenedSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of opened sessions. of the current data source</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Data source object</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Session object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMOpenedSession -detailed". For technical information, type "Get-Help Get-RDMOpenedSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMOpenedSession</dev:code> <dev:remarks> <maml:para>Retrieves the list of available data sources of the current data source.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMOpenedSession; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of the opened sessions and displays the first item.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPackage</command:name> <gl:group>RDMPackage</gl:group> <maml:description> <maml:para>Retrieve the latest or specified version download url</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPackage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the latest or specified version download url</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPackage</maml:name> <command:parameter required="false" position="1"> <maml:name>Edition</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Platform</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RequiredVersion</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Edition</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Platform</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> <maml:description> <maml:para>Remote Desktop Manager download url and version</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPackage -detailed". For technical information, type "Get-Help Get-RDMPackage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $package = Get-RDMPackage</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPersonalCredentials</command:name> <gl:group>RDMPersonalCredentials</gl:group> <maml:description> <maml:para>Get the connection representing 'MyPersonalCredentials'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPersonalCredentials</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the connection representing 'MyPersonalCredentials'. All the pertinent informations are in the property Credentials. On Windows, the policy DisableMyPersonalCredentials prevent using this cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>The connection representing 'MyPersonalCredentials'. All the pertinent informations are in the property Credentials.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPersonalCredentials -detailed". For technical information, type "Get-Help Get-RDMPersonalCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $persoCreds = Get-RDMPersonalCredentials</dev:code> <dev:remarks> <maml:para>Store the personal credentials in the variable $persoCreds. Access the desired values in $persoCreds.Credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $perso = Get-RDMPersonalCredentials; $perso.Credentials.SecretServerPassword = (ConvertTo-SecureString -AsPlainText 'aPassword'); $perso.Credentials.SecretServerUsername = 'aPassword'; $perso.Credentials.SecretServerDomain = 'aDomain'; Set-RDMPersonalCredentials -Session $perso</dev:code> <dev:remarks> <maml:para>Fetch the personal credentials. Modify the Secret Server's domain, password and username value. Save the modificatons. The password modification can be seen in the value change of the field SafeSecretServerPassword.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMPersonalCredentials</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPlaylistLocal</command:name> <gl:group>RDMPlaylistLocal</gl:group> <maml:description> <maml:para>Get the local playlists of the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPlaylistLocal</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the local playlists of the current data source</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPlaylistLocal</maml:name> <command:parameter required="false" position="1"> <maml:name>ExportConnection</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ExportConnection</maml:name> <maml:description> <maml:para>Export the playlist connections.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSPlaylistLocal[]</maml:name> <maml:uri /> <maml:description> <maml:para>Local playlists array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPlaylistLocal -detailed". For technical information, type "Get-Help Get-RDMPlaylistLocal -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $playlists = Get-RDMPlaylistLocal</dev:code> <dev:remarks> <maml:para>Get the local playlists of the current data source.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPlaylistShared</command:name> <gl:group>RDMPlaylistShared</gl:group> <maml:description> <maml:para>Get the shared playlists of the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPlaylistShared</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the shared playlists of the current data source</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPlaylistShared</maml:name> <command:parameter required="false" position="1"> <maml:name>ExportConnections</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ExportConnections</maml:name> <maml:description> <maml:para>Export the playlist connections.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSPlaylistShared[]</maml:name> <maml:uri /> <maml:description> <maml:para>Shared playlists array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPlaylistShared -detailed". For technical information, type "Get-Help Get-RDMPlaylistShared -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $playlists = Get-RDMPlaylistShared</dev:code> <dev:remarks> <maml:para>Get the shared playlists of the current data source.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPowerShellOverride</command:name> <gl:group>RDMPowerShellOverride</gl:group> <maml:description> <maml:para>Retrieve the module override values</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPowerShellOverride</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the module override values</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSPowerShellOverride</maml:name> <maml:uri /> <maml:description> <maml:para>PowerShell Override object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPowerShellOverride -detailed". For technical information, type "Get-Help Get-RDMPowerShellOverride -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $override = Get-RDMPowerShellOverride</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionAttachment</command:name> <gl:group>RDMPrivateSessionAttachment</gl:group> <maml:description> <maml:para>Get session attachments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get session attachments</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the connection to get the attachments from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionAttachment -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSession</command:name> <gl:group>RDMPrivateSession</gl:group> <maml:description> <maml:para>Retrieve the list of available sessions from the user private vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available sessions from the user private vault for the current selected data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSession</maml:name> <command:parameter required="false" position="1"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>GroupName</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>ID of the desired session</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> <maml:description> <maml:para>Include attachment from documents</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeLocalPlaylists</maml:name> <maml:description> <maml:para>Include dependable connections and local playlists from playlist connection</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>Include subfolders from the group name</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeUserSpecificSettings</maml:name> <maml:description> <maml:para>Include user specific settings</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Session name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Session from the private vault</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSession -detailed". For technical information, type "Get-Help Get-RDMPrivateSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionCredentials</command:name> <gl:group>RDMPrivateSessionCredentials</gl:group> <maml:description> <maml:para>Returns the session credentials</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionCredentials</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Returns the session credentials</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>GetID</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GetID</maml:name> <maml:description> <maml:para>Get the credential ID.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSConnection</maml:name> <maml:description> <maml:para>Specifies the connection to get credentials from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Session type or ID</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionCredentials -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionDocumentStoredInDatabase</command:name> <gl:group>RDMPrivateSessionDocumentStoredInDatabase</gl:group> <maml:description> <maml:para>Get documents stored in database</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionDocumentStoredInDatabase</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get documents stored in database</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionDocument</maml:name> <maml:uri /> <maml:description> <maml:para>Document session</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionDocumentStoredInDatabase -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionDocumentStoredInDatabase -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionDomain</command:name> <gl:group>RDMPrivateSessionDomain</gl:group> <maml:description> <maml:para>Get the domain from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionDomain</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the domain from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the domain from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the domain to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionDomain -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionDomain "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the domain from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionDomain $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the domain from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionOTP</command:name> <gl:group>RDMPrivateSessionOTP</gl:group> <maml:description> <maml:para>Get the One Time Password from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionOTP</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the One Time Password from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment for the credential viewed log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the OTP from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to get the OTP from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TicketID</maml:name> <maml:description> <maml:para>Ticket number for the credential viewed log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ID of the OTP entry</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>OTP entry obtained from Get-RDMPrivateSession</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> <maml:description> <maml:para>OTP object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionOTP -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionOTP -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionOTP "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the OTP from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionOTP $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the OTP from the the second element in the list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMPrivateSession -Name AnOTPCred | Get-RDMPrivateSessionOTP -TicketID 123 -Comment "It is a comment."</dev:code> <dev:remarks> <maml:para>Get the OTP from the session AnOTPCred while filling the credential viewed log, avoiding the prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionOTP</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionPassword</command:name> <gl:group>RDMPrivateSessionPassword</gl:group> <maml:description> <maml:para>Get the password from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionPassword</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the password from the specified session. Session must be marked as "Allow show credentials" if not null is returned.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns the password as plain text.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment for the credential viewed log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to get the password from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TicketID</maml:name> <maml:description> <maml:para>Ticket number for the credential viewed log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionPassword -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionPassword "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the password from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionPassword $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionProperty</command:name> <gl:group>RDMPrivateSessionProperty</gl:group> <maml:description> <maml:para>Get the value of property given a session ID and path.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Protected values will always return null.</maml:para> <maml:para>Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the property being read (refernce RDM export xml). If top level property do not sepcify parameter or pass empty string [""] or $null</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to read(get).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionProperty -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group"</dev:code> <dev:remarks> <maml:para>Get the Group value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionProperty "{00000000-0000-0000-0000-000000000000}" "MetaInformation" "OS"</dev:code> <dev:remarks> <maml:para>Get the MetaInformation.OS value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionProperty -ID $list[1].ID -Path "MetaInformation" -Property "OS"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and then returns MetaInformation.OS value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionProperty</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionStatus</command:name> <gl:group>RDMPrivateSessionStatus</gl:group> <maml:description> <maml:para>Get the status from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionStatus</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the status from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the status from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the status to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionStatus -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionStatus "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the status from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionStatus $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the status from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionStatus</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivateSessionUserName</command:name> <gl:group>RDMPrivateSessionUserName</gl:group> <maml:description> <maml:para>Get the username from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionUserName</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the username from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionUserName</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionUserName</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the username from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the username to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivateSessionUserName -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionUserName -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSessionUserName "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the username from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionUserName $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMPrivilegedAccount</command:name> <gl:group>RDMPrivilegedAccount</gl:group> <maml:description> <maml:para>Get the connection representing 'My Privileged Account'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivilegedAccount</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the connection representing 'My Privileged Account'. All the pertinent informations are in the property Credentials. On Windows, the policy DisableMyPrivilegedAccount prevent using this cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>The connection representing 'My Privileged Account'. All the pertinent informations are in the property Credentials.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMPrivilegedAccount -detailed". For technical information, type "Get-Help Get-RDMPrivilegedAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $privAcc = Get-RDMPrivilegedAccount</dev:code> <dev:remarks> <maml:para>Store the privileged account in the variable $privAcc. Access the desired values in $privAcc.Credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $privAcc = Get-RDMPrivilegedAccount; $privAcc.Credentials.SecretServerPassword = (ConvertTo-SecureString -AsPlainText 'aPassword'); $privAcc.Credentials.SecretServerUsername = 'aPassword'; $privAcc.Credentials.SecretServerDomain = 'aDomain'; Set-RDMPrivilegedAccount -Session $privAcc</dev:code> <dev:remarks> <maml:para>Fetch the privileged account. Modify the Secret Server's domain, password and username value. Save the modificatons. The password modification can be seen in the value change of the field SafeSecretServerPassword.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMPrivilegedAccount</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMProcess</command:name> <gl:group>RDMProcess</gl:group> <maml:description> <maml:para>Get RemoteDesktopManager process</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMProcess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get RemoteDesktopManager process</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMProcess -detailed". For technical information, type "Get-Help Get-RDMProcess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Retrieve the list of available repositories.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available repositories for the current selected data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMRepository</maml:name> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Repository name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Repository name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>Repository array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMRepository -detailed". For technical information, type "Get-Help Get-RDMRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMRepository</dev:code> <dev:remarks> <maml:para>Retrieves the list of available repository.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRepository; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available repositories and displays the first item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRepository; $list[1].Name = "New Name";Set-RDMRepository $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available respositories, modify the name of the second role, update the repository.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMRole</command:name> <gl:group>RDMRole</gl:group> <maml:description> <maml:para>Retrieve the list of available roles.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMRole</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available roles for the current selected data source..</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMRole</maml:name> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Role name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Role name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>Roles array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMRole -detailed". For technical information, type "Get-Help Get-RDMRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMRole</dev:code> <dev:remarks> <maml:para>Retrieves the list of available role.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRole; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available roles and displays the first item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRole; $list[1].Name = "New Name";Set-RDMRole $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available roles, modify the name of the second role, update the role.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRoleProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMRootSession</command:name> <gl:group>RDMRootSession</gl:group> <maml:description> <maml:para>Retrieve the root session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMRootSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMRootSession -detailed". For technical information, type "Get-Help Get-RDMRootSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRootSession</dev:code> <dev:remarks> <maml:para>Retrieve the root session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSecurityGroup</command:name> <gl:group>RDMSecurityGroup</gl:group> <maml:description> <maml:para>Retrieve the list of available security groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSecurityGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available security groups for the current selected data source. Security group list contains a column "Session" that can be directly manipulated then updated. (see Set-RDMSessionCommand for more detail).</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSecurityGroup</maml:name> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Security group name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Security group name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSSecurityGroupInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>Security groups array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSecurityGroup -detailed". For technical information, type "Get-Help Get-RDMSecurityGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSecurityGroup</dev:code> <dev:remarks> <maml:para>Retrieves the list of available security groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSecurityGroup; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available security groups and displays the first item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSecurityGroup; $list[1].Name = "New Name";Set-RDMSecurityGroup $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available security groups, modify the name of the second security group, update the security group.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroupProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Get session attachments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get session attachments</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the connection to get the attachments from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionAttachment -detailed". For technical information, type "Get-Help Get-RDMSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Retrieve the list of available sessions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available sessions for the current selected data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSession</maml:name> <command:parameter required="false" position="1"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>GroupName</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>ID of the desired session</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> <maml:description> <maml:para>Include attachment from documents</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeLocalPlaylists</maml:name> <maml:description> <maml:para>Include dependable connections and local playlists from playlist connection</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>Include subfolders from the group name</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeUserSpecificSettings</maml:name> <maml:description> <maml:para>Include user specific settings</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Session name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Session object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSession -detailed". For technical information, type "Get-Help Get-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and displays the first item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; $list[1].Name = "New Name";Set-RDMSession $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, modify the name of the second session, update the session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionCredentials</command:name> <gl:group>RDMSessionCredentials</gl:group> <maml:description> <maml:para>Returns the session credentials</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionCredentials</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Returns the session credentials</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>GetID</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GetID</maml:name> <maml:description> <maml:para>Get the credential ID.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSConnection</maml:name> <maml:description> <maml:para>Specifies the connection to get credentials from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Session type or ID</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionCredentials -detailed". For technical information, type "Get-Help Get-RDMSessionCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionDocumentation</command:name> <gl:group>RDMSessionDocumentation</gl:group> <maml:description> <maml:para>Get documentation from a session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionDocumentation</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Must have the right to export. All information of the documentation pages are accessible.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Page</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Filter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Page</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Filter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Page</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Filter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the pages by looking for the value in the page's name and content. The value of the filter is case insensitive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Current data source session`s ID from which to extract the documentation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Current data source session`s name from which to extract the documentation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Page</maml:name> <maml:description> <maml:para>Filter the handbook pages by the name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session from which to extract the documentation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbook</maml:name> <maml:uri /> <maml:description> <maml:para>Documentation object containing the property Pages</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionDocumentation -detailed". For technical information, type "Get-Help Get-RDMSessionDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMRootSession | Get-RDMSessionDocumentation</dev:code> <dev:remarks> <maml:para>Get the documentation of the root session in the current data source.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession -Name "ASession" | Get-RDMSessionDocumentation -Name "APage"</dev:code> <dev:remarks> <maml:para>Get the documentation page "APage" of the session ASession.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionDocumentation -ID "{00000000-0000-0000-0000-000000000000}" -Name "APage"</dev:code> <dev:remarks> <maml:para>Get the documentation page "APage" of the session with ID = "{00000000-0000-0000-0000-000000000000}" of the current data source.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRootSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionDocumentStoredInDatabase</command:name> <gl:group>RDMSessionDocumentStoredInDatabase</gl:group> <maml:description> <maml:para>Get documents stored in database</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionDocumentStoredInDatabase</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get documents stored in database</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionDocument</maml:name> <maml:uri /> <maml:description> <maml:para>Document session</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionDocumentStoredInDatabase -detailed". For technical information, type "Get-Help Get-RDMSessionDocumentStoredInDatabase -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionDomain</command:name> <gl:group>RDMSessionDomain</gl:group> <maml:description> <maml:para>Get the domain from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionDomain</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the domain from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the domain from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the domain to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionDomain -detailed". For technical information, type "Get-Help Get-RDMSessionDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionDomain "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the domain from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionDomain $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the domain from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionOTP</command:name> <gl:group>RDMSessionOTP</gl:group> <maml:description> <maml:para>Get the One Time Password from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionOTP</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the One Time Password from the specified session. If a required log field is not provided (ticket number or comment) with the corresponding parameter, a prompt will occur to obtain both fields.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment for the credential viewed log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the OTP from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to get the OTP from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TicketID</maml:name> <maml:description> <maml:para>Ticket number for the credential viewed log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ID of the OTP entry</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>OTP entry obtained from Get-RDMSession</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> <maml:description> <maml:para>OTP object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionOTP -detailed". For technical information, type "Get-Help Get-RDMSessionOTP -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionOTP "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the OTP from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionOTP $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the OTP from the the second element in the list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession -Name AnOTPCred | Get-RDMSessionOTP -TicketID 123 -Comment "It is a comment."</dev:code> <dev:remarks> <maml:para>Get the OTP from the session AnOTPCred while filling the credential viewed log, avoiding the prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionOTP</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionPassword</command:name> <gl:group>RDMSessionPassword</gl:group> <maml:description> <maml:para>Get the password from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionPassword</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the password from the specified session. Session must be marked as "Allow show credentials" if not null is returned.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>MyPersonalCredentials</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>MyPrivilegedAccount</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns the password as plain text.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment for the credential viewed log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MyPersonalCredentials</maml:name> <maml:description> <maml:para>Obtain the password from 'My Personal Credentials'.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MyPrivilegedAccount</maml:name> <maml:description> <maml:para>Obtain the password from 'My Privileged Account'.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to get the password from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TicketID</maml:name> <maml:description> <maml:para>Ticket number for the credential viewed log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionPassword -detailed". For technical information, type "Get-Help Get-RDMSessionPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionPassword "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the password from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionPassword $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $pwd = Get-RDMSessionPassword -MyPersonalCredentials -AsPlainText</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionProperty</command:name> <gl:group>RDMSessionProperty</gl:group> <maml:description> <maml:para>Get the value of property given a session ID and path.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Protected values will always return null.</maml:para> <maml:para>Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the property being read (refernce RDM export xml). If top level property do not sepcify parameter or pass empty string [""] or $null</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to read(get).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionProperty -detailed". For technical information, type "Get-Help Get-RDMSessionProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group"</dev:code> <dev:remarks> <maml:para>Get the Group value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionProperty "{00000000-0000-0000-0000-000000000000}" "MetaInformation" "OS"</dev:code> <dev:remarks> <maml:para>Get the MetaInformation.OS value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionProperty -ID $list[1].ID -Path "MetaInformation" -Property "OS"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and then returns MetaInformation.OS value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionProperty</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionStatus</command:name> <gl:group>RDMSessionStatus</gl:group> <maml:description> <maml:para>Get the status from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionStatus</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the status from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the status from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the status to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionStatus -detailed". For technical information, type "Get-Help Get-RDMSessionStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionStatus "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the status from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionStatus $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the status from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionStatus</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMSessionUserName</command:name> <gl:group>RDMSessionUserName</gl:group> <maml:description> <maml:para>Get the username from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionUserName</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the username from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionUserName</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionUserName</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the username from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the username to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMSessionUserName -detailed". For technical information, type "Get-Help Get-RDMSessionUserName -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSessionUserName "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Get the username from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionUserName $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMTask</command:name> <gl:group>RDMTask</gl:group> <maml:description> <maml:para>Retrieve the list of tasks of the current data source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMTask</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Allows to search tasks with differents parameters on the user's main and private vaults. This feature is only available for the following data sources: Devolutions Server, Azure SQL, SQL Server, and SQLite. If the data source does not support users, the parameter User will be simply ignored. If a virtual folder is involved, the user must have the add and edit rights to obtain the tasks.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMTask</maml:name> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CreationDateEnd</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CreationDateStart</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Due</maml:name> <command:parameterValue required="true">LastWeek | Today | Yesterday | Custom | LastMonth | CurrentMonth | Last7Days | Last30Days | Last31Days | Last60Days | Last90Days</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DueDateEnd</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DueDateStart</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Entry</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">TodoStatus[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive search when searching the name of the entry, task or user.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CreationDateEnd</maml:name> <maml:description> <maml:para>The upper bound for the task's creation date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CreationDateStart</maml:name> <maml:description> <maml:para>The lower bound for the task's creation date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Due</maml:name> <maml:description> <maml:para>Filter the tasks based on their due date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateFilter</command:parameterValue> <dev:type> <maml:name>DateFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DueDateEnd</maml:name> <maml:description> <maml:para>The upper bound for a custom due date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DueDateStart</maml:name> <maml:description> <maml:para>The lower bound for a custom due date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Entry</maml:name> <maml:description> <maml:para>Entry the task is assigned to. It can be specified by ID, by name or by PSConnection. Entries in the private vault are accessible. For virtual folders, the add and edit rights are required to get the tasks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter the tasks based on the specified status. Multiple status are equivalent to an OR condition.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TodoStatus[]</command:parameterValue> <dev:type> <maml:name>TodoStatus[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>Task assigned to those user. The users can be specified with their name, their email address, their ID or their PSUserInfo.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask</maml:name> <maml:uri /> <maml:description> <maml:para>An object representing the task and its attributes.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask[]</maml:name> <maml:uri /> <maml:description> <maml:para>An array of objects where each one represents a task and its attributes.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMTask -detailed". For technical information, type "Get-Help Get-RDMTask -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $tasks = Get-RDMTask -Entry AnEntry -CaseSensitive</dev:code> <dev:remarks> <maml:para>Retrieves the tasks of the current data source associated with the entry AnEntry (case sensitive) and stores it in the variable $tasks.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMTask -Name Task* -Due Today -Status Open, Assigned, InProgress, Default</dev:code> <dev:remarks> <maml:para>Obtain all the tasks of the current data source that are due Today and are still active.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMTask -CreationDateStart 2022/1/1 -CreationDateEnd 2022/2/1 -DueDateStart 2022/2/1 -DueDateEnd 2022/3/1</dev:code> <dev:remarks> <maml:para>Obtain all the tasks of the current data source that are due Today and are still active.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $user = Get-RDMUser -Name AUser; Get-RDMTask -Status Assigned -User $user | Set-RDMTask -UnassignUser</dev:code> <dev:remarks> <maml:para>Unassign all the tasks assigned the user AUser.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMTemplate</command:name> <gl:group>RDMTemplate</gl:group> <maml:description> <maml:para>Retrieve the list of available templates.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMTemplate</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available templates. The current selected template is marked with an "X".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMTemplate</maml:name> <command:parameter required="false" position="3"> <maml:name>Type</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of templates</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMTemplate -detailed". For technical information, type "Get-Help Get-RDMTemplate -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMTemplate</dev:code> <dev:remarks> <maml:para>Retrieves the list of available templates.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMTemplate; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available templates and displays the first item.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMUser</command:name> <gl:group>RDMUser</gl:group> <maml:description> <maml:para>Retrieve the list of available users.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available users for the current selected data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMUser</maml:name> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>User name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>Users array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMUser -detailed". For technical information, type "Get-Help Get-RDMUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUser</dev:code> <dev:remarks> <maml:para>Retrieves the list of available user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUser; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available users and displays the first item.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUser; $list[1].Description = "New Description";Set-RDMUser $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available users, modify the name of the second user, update the user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMUserProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMUserRepositoryAccess</command:name> <gl:group>RDMUserRepositoryAccess</gl:group> <maml:description> <maml:para>Retrieve the list of available user vaults.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMUserRepositoryAccess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the list of available vaults for the provided user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMUserRepositoryAccess</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMUserRepositoryAccess</maml:name> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the user to user.</maml:para> <maml:para /> <maml:para>The value must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Vault's name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>User object, must be retrieved from Get-RDMUser or created via New-RDMUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>Vaults array</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMUserRepositoryAccess -detailed". For technical information, type "Get-Help Get-RDMUserRepositoryAccess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultAccess</dev:code> <dev:remarks> <maml:para>Retrieves the list of available user vaults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultAccess $user; $list[0]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available user vaults and displays the first item. $user must be retrieved from Get-RDMUser or New-RDMUser.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultAccess $user -Name Default</dev:code> <dev:remarks> <maml:para>Retrieves the Default vault information if associated to $user. $user must be retrieved from Get-RDMUser or New-RDMUser.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMUserProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMUserSpecificSettings</command:name> <gl:group>RDMUserSpecificSettings</gl:group> <maml:description> <maml:para>Get the session user specific settings</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMUserSpecificSettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get the session user specific settings</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMUserSpecificSettings</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSConnection object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.BaseConnectionOverride</maml:name> <maml:uri /> <maml:description> <maml:para>User Specific settings object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMUserSpecificSettings -detailed". For technical information, type "Get-Help Get-RDMUserSpecificSettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Get-RDMVersion</command:name> <gl:group>RDMVersion</gl:group> <maml:description> <maml:para>Retrieve the installed Remote Desktop Manager for Windows version</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMVersion</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Retrieve the installed Remote Desktop Manager for Windows version</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMVersion</maml:name> <command:parameter required="false" position="1"> <maml:name>Edition</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Edition</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Remote Desktop Manager version</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Get-RDMVersion -detailed". For technical information, type "Get-Help Get-RDMVersion -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $version = Get-RDMVersion</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Import-RDMDataSource</command:name> <gl:group>RDMDataSource</gl:group> <maml:description> <maml:para>Import RDM DataSource from a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>RDMDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Import RDM DataSource from a file</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file is loaded. Must end with .rdd</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Import-RDMDataSource -detailed". For technical information, type "Get-Help Import-RDMDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Import-RDMDataSource -Path "C:\MyFile.rdd" | Set-RDMDataSource</dev:code> <dev:remarks> <maml:para>Import the data source from a configuration and save it</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $ds = Import-RDMDataSource -Path "C:\MyFile.rdd"; $ds.Name = "ANewName"; Set-RDMDataSource -DataSource $ds</dev:code> <dev:remarks> <maml:para>Import the data source from a configuration file, rename it "ANewName" and save it</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Import-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Import RDM sessions from a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Import RDM sessions from a file. This cmdlet does not save the sessions in the data source. To do so, the result must be passed to Set-RDMSession.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DuplicateAction</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DuplicateAction</maml:name> <maml:description> <maml:para>Action when a duplicate is found. Must be one of the following:</maml:para> <maml:para /> <maml:para>"Add", "Overwrite", "Ignore"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group where the sessions will be saved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to access a password protected file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file is loaded. Must be finish:</maml:para> <maml:para /> <maml:para>"RDM: .rdm", "XML: .xml"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Array of all sessions imported.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Import-RDMSession -detailed". For technical information, type "Get-Help Import-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $sessions = Import-RDMSession -Path "C:\MyFile.rdm" -Group "DestinationGroup" -DuplicateAction "Add"</dev:code> <dev:remarks> <maml:para>Obtain all sessions in the file "MyFile.rdm" and prepend their group with DestinationGroup. In case a session already existed, a new ID will be assigned to it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $pwd = ConvertTo-SecureString "myPassword" -AsPlainText; $sessions = Import-RDMSession -Path "C:\MyFile.rdm" -Password $pwd | Set-RDMSession</dev:code> <dev:remarks> <maml:para>Obtain all sessions in the password protected file "MyFile.rdm". In case a session already existed, it will be ignored. All sessions are saved in the current data source.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Install-RDMPackage</command:name> <gl:group>RDMPackage</gl:group> <maml:description> <maml:para>Install the latest or specified version of Remote Desktop Manager</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>RDMPackage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Install the latest or specified version of Remote Desktop Manager</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-RDMPackage</maml:name> <command:parameter required="false" position="1"> <maml:name>Edition</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RequiredVersion</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NoDesktopShortcut</maml:name> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NoStartMenuShortcut</maml:name> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Quiet</maml:name> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Force</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Edition</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NoDesktopShortcut</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoStartMenuShortcut</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Quiet</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RequiredVersion</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Install-RDMPackage -detailed". For technical information, type "Get-Help Install-RDMPackage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Install-RDMPackage</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Invoke-RDMCreateDataSourceDatabase</command:name> <gl:group>RDMCreateDataSourceDatabase</gl:group> <maml:description> <maml:para>Create a new Database</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RDMCreateDataSourceDatabase</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RDMCreateDataSourceDatabase</maml:name> <command:parameter required="false" position="2"> <maml:name>AzureDatabaseEdition</maml:name> <command:parameterValue required="true">Basic | Standard | Premium</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AzureDatabaseMaxSize</maml:name> <command:parameterValue required="true">Size100MB | Size500MB | Size1GB | Size2GB | Size5GB | Size10GB | Size20GB | Size30GB | Size40GB | Size50GB | Size100GB | Size150GB | Size200GB | Size250GB | Size300GB | Size400GB | Size500GB</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AzureDatabaseServiceObjective</maml:name> <command:parameterValue required="true">Basic | S0 | S1 | S2 | S3 | P1 | P2 | P3</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>AzureDatabaseEdition</maml:name> <maml:description> <maml:para>Azure database edition.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureDatabaseEdition</command:parameterValue> <dev:type> <maml:name>AzureDatabaseEdition</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>AzureDatabaseMaxSize</maml:name> <maml:description> <maml:para>Azure database maximum size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureDatabaseMaxSize</command:parameterValue> <dev:type> <maml:name>AzureDatabaseMaxSize</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>AzureDatabaseServiceObjective</maml:name> <maml:description> <maml:para>Azure database service objective.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureDatabaseServiceObjective</command:parameterValue> <dev:type> <maml:name>AzureDatabaseServiceObjective</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession that you want to unparented.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Invoke-RDMCreateDataSourceDatabase -detailed". For technical information, type "Get-Help Invoke-RDMCreateDataSourceDatabase -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $ds = New-RDMDataSource -SQLServer -Database 'PSTestCreation5' -Name 'PSSQLServerCreation' -Server 'localhost' -Username 'sa' -Password (ConvertTo-SecureString 'masterkey' �asplaintext �force); Invoke-RDMCreateDataSourceDatabase -DataSource $ds </dev:code> <dev:remarks> <maml:para>Create a SQL Server data source and create the database</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Invoke-RDMLoadFromInventorySession</command:name> <gl:group>RDMLoadFromInventorySession</gl:group> <maml:description> <maml:para>Invoke a Load from inventory action.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RDMLoadFromInventorySession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RDMLoadFromInventorySession</maml:name> <command:parameter required="false" position="2"> <maml:name>Credential</maml:name> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Credential</maml:name> <maml:description> <maml:para>PSCredential object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSConnection object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Invoke-RDMLoadFromInventorySession -detailed". For technical information, type "Get-Help Invoke-RDMLoadFromInventorySession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Invoke-RDMLoadFromInventorySession -Session $list[0]; Set-RDMSession -Session $list[0] -Refresh</dev:code> <dev:remarks> <maml:para>Invoke a Load from inventory on the first session in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RDMUnparentSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Invoke-RDMParentSession</command:name> <gl:group>RDMParentSession</gl:group> <maml:description> <maml:para>Invoke a refactoring action to move a connection under a parent connection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RDMParentSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Move a session under a parent session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RDMParentSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ParentSession</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UseParentCredentials</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UseInheritedVPN</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ParentSession</maml:name> <maml:description> <maml:para>PSConnection object, must be retrieved from Get-RDMSession or created via New-RDMSession that you will become the parent of the sessions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSConnection object, must be retrieved from Get-RDMSession or created via New-RDMSession that will become a subconnection of the parent session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UseInheritedVPN</maml:name> <maml:description> <maml:para>Use inherited VPN.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UseParentCredentials</maml:name> <maml:description> <maml:para>Use parent credentials.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Invoke-RDMParentSession -detailed". For technical information, type "Get-Help Invoke-RDMParentSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; $parent = $list[0]; $child = $list[1]; Invoke-RDMParentSession -ParentSession $parent -Session $child -Refresh</dev:code> <dev:remarks> <maml:para>Session in the variable $child becomes a subconnection of the session in the variable $parent and refresh the sessions.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RDMUnparentSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Invoke-RDMUnparentSession</command:name> <gl:group>RDMUnparentSession</gl:group> <maml:description> <maml:para>Invoke a refactoring action to move out a connection under a parent connection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RDMUnparentSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Move out a session under a parent session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RDMUnparentSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession that you want to unparented.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Invoke-RDMUnparentSession -detailed". For technical information, type "Get-Help Invoke-RDMUnparentSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; $parent = $list[0]; Invoke-RDMUnparentSession -Session $parent.SubConnections -Refresh</dev:code> <dev:remarks> <maml:para>The subconnections in the session in the variable $parent are unparented.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RDMUnparentSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Invoke-RDMUpdateDataSourceDatabase</command:name> <gl:group>RDMUpdateDataSourceDatabase</gl:group> <maml:description> <maml:para>Upgrade a Database</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>RDMUpdateDataSourceDatabase</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RDMUpdateDataSourceDatabase</maml:name> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>PSDataSource object, must be retrieved from Get-RDMDataSource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Invoke-RDMUpdateDataSourceDatabase -detailed". For technical information, type "Get-Help Invoke-RDMUpdateDataSourceDatabase -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $ds = Get-RDMDataSource -Name SQLServerDataSourceName; Invoke-RDMUpdateDataSourceDatabase -DataSource $ds </dev:code> <dev:remarks> <maml:para>Get a SQL Server data source and upgrade the database</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMDataSource</command:name> <gl:group>RDMDataSource</gl:group> <maml:description> <maml:para>Create a new datasource instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new datasource instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMDatasource $s" to save the datasource.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>SQLite</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>SQLServer</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>SQLServer</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IntegratedSecurity</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>SQLServer</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DontSavePassword</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UserEditable</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>DOD</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ScriptingApplicationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ScriptingTenantID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>Dropbox</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>DVLS</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ScriptingApplicationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ScriptingTenantID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>DVLS</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IntegratedSecurity</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>XML</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>MySQL</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Hostname</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Schema</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>HubBusiness</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ScriptingApplicationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ScriptingTenantID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>HubPersonal</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetDatasource</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Database</maml:name> <maml:description> <maml:para>Indicates the filename of the SQLite database (.db).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DOD</maml:name> <maml:description> <maml:para>Create a Devolutions Online Drive data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DontSavePassword</maml:name> <maml:description> <maml:para>Don't save the password in the SQL Server data source settings</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Dropbox</maml:name> <maml:description> <maml:para>Create a Dropbox data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DVLS</maml:name> <maml:description> <maml:para>Create a DVLS data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Filename</maml:name> <maml:description> <maml:para>XML Filename</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Name of the server where the data source will be store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubBusiness</maml:name> <maml:description> <maml:para>Create a Hub Business data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HubPersonal</maml:name> <maml:description> <maml:para>Create a Hub Personal data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IntegratedSecurity</maml:name> <maml:description> <maml:para>Specify to use Windows Integrated Authentication for authenticating to the data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MySQL</maml:name> <maml:description> <maml:para>Create a MySQL data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the data source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password used to encrypt the SQLite database (.db).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>Name of the schema on the MySQL server for the utilization of Remote Desktop Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ScriptingApplicationPassword</maml:name> <maml:description> <maml:para>Application password used to access the Devolutions Password Server instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ScriptingTenantID</maml:name> <maml:description> <maml:para>Application ID used to access the Devolutions Password Server instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Name of Devolutions Password Server instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetDatasource</maml:name> <maml:description> <maml:para>Save the data source.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLite</maml:name> <maml:description> <maml:para>Create a SQLite data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLServer</maml:name> <maml:description> <maml:para>Create a SQL Server data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserEditable</maml:name> <maml:description> <maml:para>Editable username</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to access the Devolutions Password Server instance</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>XML</maml:name> <maml:description> <maml:para>Create a XML data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para>New Data source created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMDataSource -detailed". For technical information, type "Get-Help New-RDMDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMLicense</command:name> <gl:group>RDMLicense</gl:group> <maml:description> <maml:para>Create a new license instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMLicense</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a license instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMLicense $s" to save the license.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMLicense</maml:name> <command:parameter required="true" position="1"> <maml:name>Serial</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>SetLicense</maml:name> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AutoAssign</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Auto assign new users to automatically provide the Remote Desktop Manager serial to all newly created users. For others serials, it will be ignored.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Serial</maml:name> <maml:description> <maml:para>New license serial.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SetLicense</maml:name> <maml:description> <maml:para>Save the new license.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseInfo</maml:name> <maml:uri /> <maml:description> <maml:para>New license created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMLicense -detailed". For technical information, type "Get-Help New-RDMLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-RDMLicense -Serial "a-valid-serial-123" -AutoAssign -SetLicense</dev:code> <dev:remarks> <maml:para>Create & save a new license that will be automatically assigned to new users.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMLogComment</command:name> <gl:group>RDMLogComment</gl:group> <maml:description> <maml:para>Create a log comment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMLogComment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create and insert a new log comment.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMLogComment</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Notes</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>StartDateTime</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EndDateTime</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Log comment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>End date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Log notes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Start date.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMLogComment -detailed". For technical information, type "Get-Help New-RDMLogComment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $sessions = Get-RDMSession;$date = Get-Date;New-RDMLogComment -Comment "MyComment" -Notes "MyNotes" -Session $sessions[2] -StartDateTime $date -EndDateTime $date.AddDays(3)</dev:code> <dev:remarks> <maml:para>Create & save a new log comment.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMPlaylistLocal</command:name> <gl:group>RDMPlaylistLocal</gl:group> <maml:description> <maml:para>Create a new local playlist</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMPlaylistLocal</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new local playlist</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMPlaylistLocal</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Connections</maml:name> <command:parameterValue required="true">Connection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ExportConnection</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Connections</maml:name> <maml:description> <maml:para>Connections in the new playlist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>New local playlist description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>ExportConnection</maml:name> <maml:description> <maml:para>Export the playlist connections.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New local playlist name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>WaitTime</maml:name> <maml:description> <maml:para>New local playlist wait time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMPlaylistLocal -detailed". For technical information, type "Get-Help New-RDMPlaylistLocal -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMPlaylistShared</command:name> <gl:group>RDMPlaylistShared</gl:group> <maml:description> <maml:para>Create a new shared playlist</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMPlaylistShared</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new shared playlist</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMPlaylistShared</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ConnectionPlayList</maml:name> <command:parameterValue required="true">ConnectionPlayList</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ExportConnections</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectionPlayList</maml:name> <maml:description> <maml:para>Connections in the new playlist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectionPlayList</command:parameterValue> <dev:type> <maml:name>ConnectionPlayList</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ExportConnections</maml:name> <maml:description> <maml:para>Export the playlist connections.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New shared playlist name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMPlaylistShared -detailed". For technical information, type "Get-Help New-RDMPlaylistShared -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMRandomPassword</command:name> <gl:group>RDMRandomPassword</gl:group> <maml:description> <maml:para>Create a new random password</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMRandomPassword</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new random password</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMRandomPassword</maml:name> <command:parameter required="false" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMRandomPassword</maml:name> <command:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMRandomPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Default | SpecifiedSettings | HumanReadable | Pattern | Pronounceable | Strong | Passphrase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Mode</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">PasswordGeneratorMode</command:parameterValue> <dev:type> <maml:name>PasswordGeneratorMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Generate a random password with the password complexity of that session</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>Generate a random password with the template settings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMRandomPassword -detailed". For technical information, type "Get-Help New-RDMRandomPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $randomPassword = New-RDMRandomPassword</dev:code> <dev:remarks> <maml:para>Generate a random password with the default settings</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $randomPassword = New-RDMRandomPassword -TemplateName $templateName</dev:code> <dev:remarks> <maml:para>Generate a random password with the template settings</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $session = Get-RDMSession -Name MySession; $randomPassword = New-RDMRandomPassword -Session $session</dev:code> <dev:remarks> <maml:para>Generate a random password with the password complexity of the session</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $pwd = New-RandomPassword -Mode Default -MinimumDigit 10 -MinimumLength 1</dev:code> <dev:remarks> <maml:para>Generate a random password composed of 10 digits.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 5-----------------------</maml:title> <dev:code>PS C:\> $pwd = New-RandomPassword -Mode SpecifiedSettings -Digit 1 -Bracket 0 -Underline 1 -Lowercase 0 -Special 0 -Uppercase 0</dev:code> <dev:remarks> <maml:para>Generate a random password composed of at least 1 digit and 1 underline. The other characters are either a digit, a lowercase, an uppercase, a special symbol, a bracket , or an underline. High ANSI, minus and space characters are not present in the password. There is not guarantuee the password is XML Compliant.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Create a new repository instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a repository instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMRepository $s" to save the repository.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>IsAllowedOffline</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>SetRepository</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Repository description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IsAllowedOffline</maml:name> <maml:description> <maml:para>Is repository allowed offline. Default value: True</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New repository name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SetRepository</maml:name> <maml:description> <maml:para>Save the new repository.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para>New repository created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMRepository -detailed". For technical information, type "Get-Help New-RDMRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $role = New-RDMRepository -Name "New Repository" ;Set-RDMRepository $role</dev:code> <dev:remarks> <maml:para>Create & save new repository.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMRole</command:name> <gl:group>RDMRole</gl:group> <maml:description> <maml:para>Create a new role instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMRole</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a role instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMRole $s" to save the role.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMRole</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>SetRole</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Role description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New role name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SetRole</maml:name> <maml:description> <maml:para>Save the new role.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para>New role created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMRole -detailed". For technical information, type "Get-Help New-RDMRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $role = New-RDMRole -Name "New Role" ;Set-RDMRole $role</dev:code> <dev:remarks> <maml:para>Create & save new role.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRoleProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMSecurityGroup</command:name> <gl:group>RDMSecurityGroup</gl:group> <maml:description> <maml:para>Create a new security group instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMSecurityGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a security group instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMSecurityGroup $s" to save the security group.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMSecurityGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetSecurityGroup</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Security group description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New security group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetSecurityGroup</maml:name> <maml:description> <maml:para>Save the new security group.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para>New security group created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMSecurityGroup -detailed". For technical information, type "Get-Help New-RDMSecurityGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $securityGroup = New-RDMSecurityGroup -Name "New SecurityGroup" ;Set-RDMSecurityGroup $securityGroup</dev:code> <dev:remarks> <maml:para>Create & save new security group.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroupProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Create a new session instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new session instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMSession $s" to save the session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMSession</maml:name> <command:parameter required="false" position="3"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Type</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Host</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DocumentAttachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DocumentFileName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>TemplateID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>SetSession</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>DocumentAttachment</maml:name> <maml:description> <maml:para>New document attachement.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSConnectionAttachment</command:parameterValue> <dev:type> <maml:name>PSConnectionAttachment</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>DocumentFileName</maml:name> <maml:description> <maml:para>New document file name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Session group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Host</maml:name> <maml:description> <maml:para>New Session host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>New PSSession name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SetSession</maml:name> <maml:description> <maml:para>Save the session in the current data source.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>TemplateID</maml:name> <maml:description> <maml:para>Create PSSession from template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Type</maml:name> <maml:description> <maml:para>New session kind. Must be on of the following:</maml:para> <maml:para /> <maml:para> "ADConsole", "AddOn", "AppleRemoteDesktop", "ApplicationTool", "Aws", "Azure", "AzureQueueStorage", "AzureStorage", "BeyondTrustPasswordSafeConsole", "ChromeRemoteDesktop"CitrixWeb", "CommandLine", "Computer", "Contact", "ControlUp", "Credential", "Customer", "CyberArkJump", "CyberArkPSM", "Dameware", "Database", "DataEntry", "DataReport", "DataSource", "DeskRoll", "Desktone", "DevolutionsProxy", "Document", "DropBox", "FileExplorer", "Ftp", "FtpNative", "Gateway", "Group", "Host", "HpRgs", "HyperV", "ICA", "IDrac", "Ilo", "IntelAMT", "InventoryReport", "Iterm", "LogMeIn", "PCAnywhere", "PlayList", "PortForward", "PowerShell", "PowerShellRemoteConsole", "ProxyTunnel", "PSExec", "Putty", "Radmin", "RDCommander", "RDPConfigured", "RDPFilename", "ResetPassword", "S3", "Scp","ScreenConnect", "ScreenHero", "SecureCRT", "Serial", "SessionTool" , "Sftp" , "Sheet" , "SkyDrive", "SNMPReport"),"Spiceworks", "Splunk", "SSHShell", "SSHTunnel", "Sync", "TeamViewer", "TeamViewerConsole", "Telnet",""TemplateGroup", "TerminalConsole", "TFtp","VirtualBox", "VirtualPC", "VMRC", "VMWare", "VMWareConsole", "VNC", "VPN", "Wayk", "WaykDenConsole", "WebBrowser", , "WebDav", "WindowsAdminCenter", "WindowsVirtualPC", "XenServer", "XWindow"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>New session created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMSession -detailed". For technical information, type "Get-Help New-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $session = New-RDMSession -Name "New Session" -Host "myServer" -Type "RDPConfigured";Set-RDMSession $session</dev:code> <dev:remarks> <maml:para>Create & save new session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMSSHKey</command:name> <gl:group>RDMSSHKey</gl:group> <maml:description> <maml:para>Create an SSH key.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMSSHKey</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create an SSH key. The public key will be returned. There is also the possiblity the save a public or private key file. A passphrase can be used to protect the private key file. In both cases, an existing file will be overwritten.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMSSHKey</maml:name> <command:parameter required="true" position="1"> <maml:name>Format</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Algorithm</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Size</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMSSHKey</maml:name> <command:parameter required="true" position="1"> <maml:name>Format</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Algorithm</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Size</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMSSHKey</maml:name> <command:parameter required="false" position="1"> <maml:name>SavePublicKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Algorithm</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Size</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Algorithm</maml:name> <maml:description> <maml:para>The algorithm used to generate the SSH key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The comment at the end of a public key. No space allowed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Format</maml:name> <maml:description> <maml:para>The format used to store the private key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protected the private key file. An empty SecureString is accepted, meaning no encryption will occur.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SavePrivateKey</maml:name> <maml:description> <maml:para>Save the private key in a file at the specified path. The supported extensions are: PKCS#1/OpenSSL (*.key), PKCS#8 (*.pri) and PuTTY (*ppk)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SavePublicKey</maml:name> <maml:description> <maml:para>Save the public key in a file at the specified path. The supported extension is (*.pub).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Size</maml:name> <maml:description> <maml:para>The number of bits in the key for RSA and ECDSA algorithms. For RSA, the default value is 2048 and the valid values are: 1024, 2048, 3072, 4096, 6144 and 8192. For ECDSA, the default value is 256 and the valid values are: 256, 384 and 521.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSSSHKey</maml:name> <maml:uri /> <maml:description> <maml:para>PSSSHKey contains the public key, and MD5 and SHA1 fingerprints.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMSSHKey -detailed". For technical information, type "Get-Help New-RDMSSHKey -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $pubKey = New-RDMSSHkey -Algorithm RSA -Comment username@hostname -Size 2048</dev:code> <dev:remarks> <maml:para>Create an SSH public key of 2048 bits using RSA and of format is Putty. The resulting key ends with the comment (username@hostname).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $pubKey = New-RDMSSHkey ECDSA -Comment username@hostname -Size 256 -SavePublicKey C:\mypath\sshPublicKey.pub</dev:code> <dev:remarks> <maml:para>Create an SSH public key of 256 bits using ECDSA with the comment username@hostname. The key is saved in the file C:\mypath\sshPublicKey.pub. If the file exists, it will be overwritten.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $passwd = Read-Host -AsSecureString; $pubKey = New-RDMSSHkey -Algorithm ECDSA -Format PKCS8 -Encryption SHA1_RC4_128 -Size 521 -Round 64 -SavePrivateKey C:\mypath\sshPrivateKey.pri -Passphrase $passwd</dev:code> <dev:remarks> <maml:para>First, the password used to encrypt the file is generated from the input of the user. Create an SSH private key of 521 bits using ECDSA with an empty comment. The key is saved in the file C:\mypath\sshPrivateKey.pri. The format used is PKCS8 with encryption SHA1_RC4_128 and 64 rounds. If the passphrase used is empty, no encryption will occur.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $pubKey = New-RDMSSHkey -Algorithm ECDSA -Comment username@hostname -Format PKCS8 -Size 521 -Round 64 -SavePrivateKey C:\mypath\sshPrivateKey.pri</dev:code> <dev:remarks> <maml:para>Create an SSH private key of 521 bits using ECDSA with the comment username@hostname. The key is saved in the file C:\mypath\sshPrivateKey.pri and is not encrypted.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMTask</command:name> <gl:group>RDMTask</gl:group> <maml:description> <maml:para>Create a new task.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMTask</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new task. It must have a name and be associated to an entry. This feature is only available for the following data sources: Devolutions Server, Azure SQL, SQL Server, and SQLite. If the data source does not support users, the parameter User will be simply ignored. If a virtual folder is involved, the user must have the add and edit rights to save the task.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMTask</maml:name> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Entry</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DueDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Priority</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetTask</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">TodoStatus</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Add a comment to the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>Add the description to the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DueDate</maml:name> <maml:description> <maml:para>Add a deadline to accomplish the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Entry</maml:name> <maml:description> <maml:para>Entry the task is assigned to. It can be specified by ID, by name or by PSConnection. Entries in the private vault are accessible.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Set the priority of the task. The default value is 1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetTask</maml:name> <maml:description> <maml:para>Save the task.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Set the status of the task. By default, the status is Open.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TodoStatus</command:parameterValue> <dev:type> <maml:name>TodoStatus</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>Assign this user to the task. The user can be specified with his name, his email address, his ID or a PSUserInfo. The data source must support users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entry obtained from Get-RDMSession or Get-RDMPrivateSession can be piped to the parameter Entry.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask</maml:name> <maml:uri /> <maml:description> <maml:para>An object representing the task and its attributes.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMTask -detailed". For technical information, type "Get-Help New-RDMTask -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $task = New-RDMTask TaskName EntryName</dev:code> <dev:remarks> <maml:para>Create a task named TaskName and associated with the entry EntryName. This task is not saved yet, so it is stored in $task.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> New-RDMTask -Name ATask -Entry AnEntry -Description 'What To Do' -Priority 10 -User AUsername -Status Assigned -SetTask</dev:code> <dev:remarks> <maml:para>Create a task named ATask associated with the entry AnEntry. The task is assigned to AUsername and its status reflects it. It has a priority of 10 and a desciption of the task. This task is created in the data source.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $task = (Get-RDMPrivateSession -Name APrivateEntry | New-RDMTask -Name ATask -Comment 'For me only' -DueDate 2022/1/1)</dev:code> <dev:remarks> <maml:para>Create a task named ATask associated with the private entry APrivateEntry. The task is not assigned and its status is the default value 'Open'. Its due date is the fist day of the year 2022. This task is not saved yet, so it is stored in $task.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> New-RDMTask -Name ATask -Entry AnEntry | Set-RDMTask -Force</dev:code> <dev:remarks> <maml:para>Save a newly created task named ATask and associated with AnEntry without any confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 5-----------------------</maml:title> <dev:code>PS C:\> $user = Get-RDMUser -Name Username; New-RDMTask -Name ATask -Entry AnEntry -User $user.Name -Status Assigned -SetTask</dev:code> <dev:remarks> <maml:para>Save a newly created task named ATask and associated with AnEntry. The task is assigned to Username and its status reflects it.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMTemplate</command:name> <gl:group>RDMTemplate</gl:group> <maml:description> <maml:para>Create a new template instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMTemplate</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a new template instance. The instance has not yet been saved. Assign the result to a variable then call "Set-RDMTemplate $s" to save the template.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMTemplate</maml:name> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Type</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SetTemplate</maml:name> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Template destination</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New PSSession name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SetTemplate</maml:name> <maml:description> <maml:para>Save the session in the current data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Type</maml:name> <maml:description> <maml:para>New session kind. Must be on of the following:</maml:para> <maml:para /> <maml:para> "ADConsole", "AddOn", "AppleRemoteDesktop", "ApplicationTool", "Aws", "Azure", "AzureQueueStorage", "AzureStorage", "BeyondTrustPasswordSafeConsole", "ChromeRemoteDesktop"CitrixWeb", "CommandLine", "Computer", "Contact", "ControlUp", "Credential", "Customer", "Dameware", "Database", "DataEntry", "DataReport", "DataSource", "DeskRoll", "Desktone", "DevolutionsProxy", "Document", "DropBox", "Ftp", "Gateway", "Group", "Host", "HpRgs", "HyperV", "ICA", "IDrac", "Ilo", "IntelAMT", "InventoryReport", "Iterm", "LogMeIn", "PCAnywhere", "PlayList", "PortForward", "PowerShell", "PowerShellRemoteConsole", "ProxyTunnel", "PSExec", "Putty", "Radmin", "RDCommander", "RDPConfigured", "RDPFilename", "ResetPassword", "S3", "ScreenConnect", "ScreenHero", "SecureCRT", "Serial", "SessionTool" , "Sheet" , "SkyDrive", "SNMPReport"),"Spiceworks", "Splunk", "SSHShell", "SSHTunnel", "Sync", "TeamViewer", "TeamViewerConsole", "Telnet",""TemplateGroup", "TerminalConsole", "VirtualBox", "VirtualPC", "VMRC", "VMWare", "VMWareConsole", "VNC", "VPN", "Wayk", "WebBrowser", , "WebDav", "WindowsVirtualPC", "XenServer", "XWindow"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTemplate</maml:name> <maml:uri /> <maml:description> <maml:para>New template created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMTemplate -detailed". For technical information, type "Get-Help New-RDMTemplate -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $session = New-RDMTemplate -Destination Database -Name "New Template"-Type "RDPConfigured";Set-RDMTemplate $template</dev:code> <dev:remarks> <maml:para>Create & save new session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>New-RDMUser</command:name> <gl:group>RDMUser</gl:group> <maml:description> <maml:para>Create a new user instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Create a user instance. The instance has not yet been saved. Use the SetUser parameter or assign the result to a variable then call "Set-RDMUser $s" to save the user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMUser</maml:name> <command:parameter required="false" position="1"> <maml:name>IntegratedSecurity</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Login</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Administrator</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Disable</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>LoginEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SkipCreateSQLServerLogin</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AuthentificationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AuthenticationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>BypassAzureADValidationEvenIfUnsupported</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetUser</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMUser</maml:name> <command:parameter required="false" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Login</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Administrator</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Disable</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>LoginEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SkipCreateSQLServerLogin</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AuthentificationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AuthenticationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>BypassAzureADValidationEvenIfUnsupported</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetUser</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Gives the user administrator rights</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Authentication type. Available in some data sources</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AuthentificationType</maml:name> <maml:description> <maml:para>Authentification type. Available in some data sources (Backward compatibility)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>BypassAzureADValidationEvenIfUnsupported</maml:name> <maml:description> <maml:para>Bypass validation preventing creation of AzureAD user when connected with a database user. Do so at your own risk.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Disables the user. Available in some data sources</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Email</maml:name> <maml:description> <maml:para>User email. Available when using a all data source except DODB</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IntegratedSecurity</maml:name> <maml:description> <maml:para>Integrated security. Only available in SQL Server and DVLS data sources</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Login</maml:name> <maml:description> <maml:para>Login.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LoginEmail</maml:name> <maml:description> <maml:para>Login email. Available in some data sources</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>User password. Available when using a SQL Server data source and integrated security is not used</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetUser</maml:name> <maml:description> <maml:para>Set the user in the data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SkipCreateSQLServerLogin</maml:name> <maml:description> <maml:para>Skip to create the SQL Server login. The administrator will add the database login/user manually. Available in SQL Server data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para>New user created object</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help New-RDMUser -detailed". For technical information, type "Get-Help New-RDMUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $user = New-RDMUser -AuthenticationType SqlServer -Login 'PSTest' -Password (ConvertTo-SecureString -String 'password' -AsPlainText -Force) -SetUser</dev:code> <dev:remarks> <maml:para>Create & save new user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $user = New-RDMUser -Login 'domain\username' -IntegratedSecurity -SkipCreateSQLServerLogin; $user.UserType = 'User'; Set-RDMUser $user</dev:code> <dev:remarks> <maml:para>Before everything, the administrator add the login/user to the database. Create the user domain\username with integrated security. The SkipCreateSQLServerLogin switch indicates the administrator will manually add the information in the database. Change the user type from read-only to user and save the user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMUserProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Open-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Open the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Open</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Open the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Silent</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ForceExternal</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment for the opening log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ForceExternal</maml:name> <maml:description> <maml:para>Open the session external</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to open.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Silent</maml:name> <maml:description> <maml:para>Silent</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TicketID</maml:name> <maml:description> <maml:para>Ticket ID for the opening log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Open-RDMSession -detailed". For technical information, type "Get-Help Open-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Open-RDMSession -ID "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Open the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Open-RDMSession -ID $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and opens the second element in the list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Open-RDMSession -ID $list[1].ID -TicketID 123 -Comment "A comment" </dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and opens the second element in the list while filling the prompt, if required, with the the ticket id and a comment.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Open-RDMQuickConnect</command:name> <gl:group>RDMQuickConnect</gl:group> <maml:description> <maml:para>Open an session by specifying the host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Open</command:verb> <command:noun>RDMQuickConnect</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Open an ad-hoc session by specifying the host.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RDMQuickConnect</maml:name> <command:parameter required="true" position="1"> <maml:name>Host</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Connection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TemplateID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a connection template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the domain of the host to open.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>Specifies the host of the host to open.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the host to open</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TemplateID</maml:name> <maml:description> <maml:para>Specifies a template ID</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the username of the host to open.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Open-RDMQuickConnect -detailed". For technical information, type "Get-Help Open-RDMQuickConnect -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Open-RDMQuickConnect -Host "MyHost" -Connection connection"</dev:code> <dev:remarks> <maml:para>Open the host MyHost.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Open-RDMSyncSession</command:name> <gl:group>RDMSyncSession</gl:group> <maml:description> <maml:para>Open the the specified sync session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Open</command:verb> <command:noun>RDMSyncSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Open the the specified sync session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RDMSyncSession</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DontSetSessions</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-RDMSyncSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DontSetSessions</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DontSetSessions</maml:name> <maml:description> <maml:para>Don't save the new sessions into the data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to open.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the PSConnection to open</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Open-RDMSyncSession -detailed". For technical information, type "Get-Help Open-RDMSyncSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $result = Open-RDMSyncSession -ID "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Open the sync session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Open-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Read-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Read RDM session from a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Read</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Read RDM session from a file</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Read-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DuplicateAction</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DuplicateAction</maml:name> <maml:description> <maml:para>Action when a duplicate is found. Must be one of the following:</maml:para> <maml:para /> <maml:para>"Add", "Overwrite", "Ignore"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group where the sessions will be saved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file is loaded. Must be finish:</maml:para> <maml:para /> <maml:para>"RDM: .rdm", "XML: .xml"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Read-RDMSession -detailed". For technical information, type "Get-Help Read-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $session = Read-RDMSession -Filename "C:\MyFile.rdm" -DuplicateAction "Add"; Set-RDMSession $session[0]</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Receive-RDMMessage</command:name> <gl:group>RDMMessage</gl:group> <maml:description> <maml:para>Get messages associated with the current data source for the actual user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Receive</command:verb> <command:noun>RDMMessage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Get messages associated with the current data sourcefor the actual user. By default, the fetched messages won't be marked as read. The data source must be a Devolutions Server or a Devolutions Hub Server. Devolutions Hub Server allows to download only entries in the desired repository. Devolutions Server supports credentials, file and private entries. However, all entries will be saved in the user vault.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Receive-RDMMessage</maml:name> <command:parameter required="false" position="1"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Download</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExcludeRead</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExpiresOn</maml:name> <command:parameterValue required="true">LastWeek | Today | Yesterday | Custom | LastMonth | CurrentMonth | Last7Days | Last30Days | Last31Days | Last60Days | Last90Days</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Folder</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>From</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MarkAsRead</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SentOn</maml:name> <command:parameterValue required="true">LastWeek | Today | Yesterday | Custom | LastMonth | CurrentMonth | Last7Days | Last30Days | Last31Days | Last60Days | Last90Days</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Subject</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Vault</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>After</maml:name> <maml:description> <maml:para>Set the inclusive custom lower limit date for the ExpiresOn or SentOn parameter that is set to Custom. It will be set at the beginning of the day. If both ExpiresOn and SentOn are set to Custom, it will apply for both of them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Before</maml:name> <maml:description> <maml:para>Set the inclusive custom upper limit date for the ExpiresOn or SentOn parameter that is set to Custom. It will be set at the end of the day. If both ExpiresOn and SentOn are set to Custom, it will apply for both of them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Parameters used will be case sensitive.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Download</maml:name> <maml:description> <maml:para>Download the connections and attachments in the message.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExcludeRead</maml:name> <maml:description> <maml:para>Keep only the unread messages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExpiresOn</maml:name> <maml:description> <maml:para>Keep the messages that expire after the specified date. If set to Custom, After and Before parameters allows to define a specific interval.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateFilter</command:parameterValue> <dev:type> <maml:name>DateFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Folder</maml:name> <maml:description> <maml:para>For Devolutions Server only. Specify the directory where the files will be downloaded. If not specied, it will be in 'MyDocuments'. In the event a file attachment shares a name with an existing file in the folder, the existing one will be overwritten.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Bypass the confirmation to proceed. If the DownloadAttachment switch is present, the attachments of all returned message will be downloaded.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>From</maml:name> <maml:description> <maml:para>Filter the messages based on the senders.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>For Devolutions Server only. Specify the group where the connections will be downloaded. If not specified, it will be in the root.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MarkAsRead</maml:name> <maml:description> <maml:para>All fetched messages will be marked as read.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SentOn</maml:name> <maml:description> <maml:para>Keep the messages that expire after the specified date. If set to Custom, After and Before parameters allows to define a specific interval.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateFilter</command:parameterValue> <dev:type> <maml:name>DateFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Filter the messages based on the subjects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Vault</maml:name> <maml:description> <maml:para>For Devolution Hub Server only. Specify the vault where the entry will be saved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.Messages.DataSourceMessage</maml:name> <maml:uri /> <maml:description> <maml:para>A object representing a single message received</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.Messages.DataSourceMessage[]</maml:name> <maml:uri /> <maml:description> <maml:para>An array of objects representing all the messages received. If piped, it will be an enumerated collection.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Receive-RDMMessage -detailed". For technical information, type "Get-Help Receive-RDMMessage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $messages = Receive-RDMMessage -ExcludeRead; Receive-RDMMessage -From 'First Last' -ExcludeRead -MarkAsRead</dev:code> <dev:remarks> <maml:para>Obtain all the unread messages. All of them will still be marked as unread upon reception. After reading them, the user mark as read the messages from First Last.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $messages = Receive-RDMMessage -SentOn Today -From Joe* -MarkAsRead</dev:code> <dev:remarks> <maml:para>Obtain all the messages received today from every user whose name start with Joe (Joey LastName, Joelle LastName, Joe Blow, etc.). All of them will be marked as read upon reception.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $messages = Receive-RDMMessage -SentOn Today -Subject 'Required connections' -From 'FirstName LastName' -Download -Force -MarkAsRead</dev:code> <dev:remarks> <maml:para>Obtain the message(s) sent today by 'FirstName LastName' whose subject is 'Requiered Connections'. The message(s) will be marked as read upon reception and all connections/attachments will be downloaded without a confirmation prompt in the user vault. The files will be stored in 'MyDocuments' and the entries will be in the root.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $messages = Receive-RDMMessage -SentOn Custom -ExpiresOn Custom -After 2000/01/01 -Before 2001/12/31</dev:code> <dev:remarks> <maml:para>Obtain the messages that were sent and expired in 2000.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 5-----------------------</maml:title> <dev:code>PS C:\> $messages = Receive-RDMMessage -From *LastName -Subject Subject? -CaseSensitive</dev:code> <dev:remarks> <maml:para>Obtain all the messages from people whose name end with LastName and the subject is Subject followed by an another character (SubjectA, Subject1).</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMDataSource</command:name> <gl:group>RDMDataSource</gl:group> <maml:description> <maml:para>Remove data source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the data source to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMDataSource -detailed". For technical information, type "Get-Help Remove-RDMDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMLicense</command:name> <gl:group>RDMLicense</gl:group> <maml:description> <maml:para>Delete an existing license.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMLicense</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMLicense</maml:name> <command:parameter required="false" position="2"> <maml:name>License</maml:name> <command:parameterValue required="true">PSLicenseInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the license without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>License</maml:name> <maml:description> <maml:para>Specifies the license to delete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSLicenseInfo</command:parameterValue> <dev:type> <maml:name>PSLicenseInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMLicense -detailed". For technical information, type "Get-Help Remove-RDMLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMMessage</command:name> <gl:group>RDMMessage</gl:group> <maml:description> <maml:para>Remove a secure message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMMessage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove a secure message. The data source must be a Devolutions Server or a Devolutions Hub Server.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMMessage</maml:name> <command:parameter required="true" position="2"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMMessage</maml:name> <command:parameter required="true" position="2"> <maml:name>Message</maml:name> <command:parameterValue required="true">DataSourceMessage</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Bypass the confirmation to proceed. If the DownloadAttachment switch is present, the attachments of all returned message will be downloaded.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ID</maml:name> <maml:description> <maml:para>Id of the message to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Message</maml:name> <maml:description> <maml:para>Messages to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DataSourceMessage</command:parameterValue> <dev:type> <maml:name>DataSourceMessage</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.Messages.DataSourceMessage</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The message obtained from the Receive-RDMMessage can be piped to the parameter Message.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMMessage -detailed". For technical information, type "Get-Help Remove-RDMMessage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Receive-RDMMessage -SentOn -Custom -Before 2021/12/31 | Remove-RDMMessage -Force</dev:code> <dev:remarks> <maml:para>Delete all messages sent before 2022/01/01 (Before value is inclusive). No confirmation prompt will occur.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $messages = Receive-RDMMessage -SentOn Today; $messages | Where-Object -Property FromName -ne 'First Last' | Remove-RDMMessage -Force</dev:code> <dev:remarks> <maml:para>The user fetch all message received today. He read all of them. He decides to only keep those sent by 'First Last' and delete the rest wiithout any confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Receive-RDMMessage | Remove-RDMMessage -Confirm</dev:code> <dev:remarks> <maml:para>The user will be prompted to delete each message one by one.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Receive-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMPrivateSession</command:name> <gl:group>RDMPrivateSession</gl:group> <maml:description> <maml:para>Delete an existing session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMPrivateSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMPrivateSession</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMPrivateSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the session without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to be deleted.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the sessions to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMPrivateSession -detailed". For technical information, type "Get-Help Remove-RDMPrivateSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Remove-RDMUserVaultSession $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, deletes session at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMUserVaultSession "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMUserVaultSession -ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete of the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $sessions = Get-RDMUserVaultSession -Name 'My Session'; Remove-RDMUserVaultSession -Session $session -Force</dev:code> <dev:remarks> <maml:para>Force delete of the session MySession</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Delete an existing repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RepositoryDestination</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the repository without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the repository to be deleted from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>RepositoryDestination</maml:name> <maml:description> <maml:para>Specifies the new repository to move the sessions from the deleted repository to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMRepository -detailed". For technical information, type "Get-Help Remove-RDMRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRepository; Remove-RDMRepository $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available repositories, deletes repository at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMRepository "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete repository with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMRepository-ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete of the repository with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMRepository</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMRole</command:name> <gl:group>RDMRole</gl:group> <maml:description> <maml:para>Delete an existing role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMRole</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMRole</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the role without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the role to be deleted from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMRole -detailed". For technical information, type "Get-Help Remove-RDMRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRole; Remove-RDMRole $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, deletes role at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMRole "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMRole -ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete of the role with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRoleProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMRoleRepositoryAccess</command:name> <gl:group>RDMRoleRepositoryAccess</gl:group> <maml:description> <maml:para>Remove repository access to a role</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMRoleRepositoryAccess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove repository access to a role</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMRoleRepositoryAccess</maml:name> <command:parameter required="true" position="2"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository the role will be denied access</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Role that will be denied access to a repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Role that will be denied access to a repository</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Repository the role will be denied access</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMRoleRepositoryAccess -detailed". For technical information, type "Get-Help Remove-RDMRoleRepositoryAccess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Remove-RDMRoleRepositoryAccess -Role $role -Repository $repo;Set-RDMRole $role</dev:code> <dev:remarks> <maml:para>Remove repository access to a role.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMSecurityGroup</command:name> <gl:group>RDMSecurityGroup</gl:group> <maml:description> <maml:para>Delete an existing security group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMSecurityGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMSecurityGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the security group without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the security group to be deleted from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMSecurityGroup -detailed". For technical information, type "Get-Help Remove-RDMSecurityGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSecurityGroup; Remove-RDMSecurityGroup $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available security groups, deletes security group at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMSecurityGroup "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete security group with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMSecurityGroup -ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete of the security group with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroupProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Remove session attachment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove session attachment.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMSessionAttachment</maml:name> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>Connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnectionAttachment</command:parameterValue> <dev:type> <maml:name>PSConnectionAttachment</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the attachment without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMSessionAttachment -detailed". For technical information, type "Get-Help Remove-RDMSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $session = Get-RDMSession -Name MySession; $attachments = Get-RDMSessionAttachment -Session $session; Update-RDMSessionAttachment -Attachment $attachments[0]</dev:code> <dev:remarks> <maml:para>Remove the first attachment in the session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Delete an existing session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the session without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to be deleted.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the sessions to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMSession -detailed". For technical information, type "Get-Help Remove-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Remove-RDMSession $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, deletes session at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMSession "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMSession -ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete of the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $sessions = Get-RDMSession -Name 'My Session'; Remove-RDMSession -Session $session -Force</dev:code> <dev:remarks> <maml:para>Force delete of the session MySession</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMSessionDocumentation</command:name> <gl:group>RDMSessionDocumentation</gl:group> <maml:description> <maml:para>Remove the documentation of a session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMSessionDocumentation</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Must have the right to delete. Three possiblities exist to remove the documentation of a session.The All switch is used to remove all documentation. The Handbook parameter uses documentation fetched via the Get-RDMDocumentation cmdlet. The Name parameter allows to delete all pages named the value entered. The user will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Page</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Page</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Page</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <maml:description> <maml:para>Delete all existing documentation of the session.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Delete the documentation without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Handbook</maml:name> <maml:description> <maml:para>Specifies the documentation to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSHandbook</command:parameterValue> <dev:type> <maml:name>PSHandbook</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Current data source session`s ID from which to delete the documentation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Current data source session`s name from which to extract the documentation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Page</maml:name> <maml:description> <maml:para>Specifies the documentation page to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session where the documentation will be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMSessionDocumentation -detailed". For technical information, type "Get-Help Remove-RDMSessionDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMRootSession | Remove-RDMSessionDocumentation -All</dev:code> <dev:remarks> <maml:para>Remove all documentation in the root session of the current data source. The user will be prompted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMSessionDocumentation -Name "ASession" -Page "APage" -Force</dev:code> <dev:remarks> <maml:para>Remove documentation page "APage" from the session "ASession" without prompting the user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\ $id = [Guid]"00000000-0000-0000-0000-000000000000"; $doc = Get-RDMSessionDocumentation -ID $id; $doc.Pages = ($doc.Pages | Where-Object { $_.Default -ne $true }); Remove-RDMSessionDocumentation -ID $id -Handbook $doc -Refresh</dev:code> <dev:remarks> <maml:para>Remove all documentation pages except the default one from the session with ID = 00000000-0000-0000-0000-000000000000 of the current data source. The user will be prompted before deleting a page.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRootSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMTask</command:name> <gl:group>RDMTask</gl:group> <maml:description> <maml:para>Delete a task</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMTask</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Delete a task of the current data source. The deletion consists of setting the status to Deleted. The confirm impact level is low. This feature is only available for the following data sources: Devolutions Server, Azure SQL, SQL Server, and SQLite.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMTask</maml:name> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Task</maml:name> <command:parameterValue required="true">PSTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>The task will be saved or created without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Task</maml:name> <maml:description> <maml:para>Task to add or modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSTask</command:parameterValue> <dev:type> <maml:name>PSTask</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The task obtained from Get-RDMTask can be piped to the parameter Task.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMTask -detailed". For technical information, type "Get-Help Remove-RDMTask -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>Get-RDMTask | Remove-RDMTask -Force</dev:code> <dev:remarks> <maml:para>Set the all tasks' status to Deleted without confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>Get-RDMTask -Due LastMonth | Where-Object AssignedToUserID -eq 00000000-0000-0000-0000-000000000000 | Remove-RDMTask -Force</dev:code> <dev:remarks> <maml:para>Remove all the tasks that were due last month and are still unassigned without a confirmation prompt. The empty guid means it is unassigned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>Get-RDMTask -Status Done, Closed | Remove-RDMTask -Force</dev:code> <dev:remarks> <maml:para>Remove all tasks that are done or closed without a confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMTemplate</command:name> <gl:group>RDMTemplate</gl:group> <maml:description> <maml:para>Delete an existing template.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMTemplate</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMTemplate</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMTemplate</maml:name> <command:parameter required="true" position="1"> <maml:name>Template</maml:name> <command:parameterValue required="true">PSTemplate[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the templates without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the template to be deleted.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the templates to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSTemplate[]</command:parameterValue> <dev:type> <maml:name>PSTemplate[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMTemplate -detailed". For technical information, type "Get-Help Remove-RDMTemplate -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Remove-RDMSession $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available template, deletes template at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMTemplate "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete the template with the ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMTemplate -ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete the template with the ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $templates = Get-RDMTemplate; Remove-RDMTemplate -Template $templates[0] -Force</dev:code> <dev:remarks> <maml:para>Force delete the first template</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMUser</command:name> <gl:group>RDMUser</gl:group> <maml:description> <maml:para>Delete an existing user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>You will be prompted to confirm the delete.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMUser</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeleteSQLLogin</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RDMUser</maml:name> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeleteSQLLogin</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DeleteSQLLogin</maml:name> <maml:description> <maml:para>Forces removal of the SQL Login without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces removal of the user without confirmation by the user. Optional.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the user to be deleted from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the array of users to be deleted.</maml:para> <maml:para /> <maml:para>Users must be retrieved by Get-RDMUser</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSUserInfo[]</command:parameterValue> <dev:type> <maml:name>PSUserInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMUser -detailed". For technical information, type "Get-Help Remove-RDMUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-User; Remove-RDMUser $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available users, deletes user at index 0 and from 1 from a list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-User; $users = @($list[0], $list[1]); $Remove-RDMUser $users</dev:code> <dev:remarks> <maml:para>Retrieves the list of available users, deletes user at index 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMUser "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Delete security group with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Remove-RDMUser -ID "{00000000-0000-0000-0000-000000000000}" -Force</dev:code> <dev:remarks> <maml:para>Force delete of the user with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMUserRepositoryAccess</command:name> <gl:group>RDMUserRepositoryAccess</gl:group> <maml:description> <maml:para>Remove repository access to an user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMUserRepositoryAccess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove repository access to an user</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMUserRepositoryAccess</maml:name> <command:parameter required="true" position="2"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository the user will be denied access</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>User that will be denied access to a repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User that will be granted access to a repository</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRepositoryInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Repository the user will be granted access</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMUserRepositoryAccess -detailed". For technical information, type "Get-Help Remove-RDMUserRepositoryAccess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Remove-RDMUserRepositoryAccess -User $user -Repository $repo;Set-RDMUser $user</dev:code> <dev:remarks> <maml:para>Add repository access to an user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMRoleToUser</command:name> <gl:group>RDMRoleToUser</gl:group> <maml:description> <maml:para>Remove a role to an user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMRoleToUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove a role to an user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMRoleToUser</maml:name> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Role object, must be retrieved from Get-RDMRole or created via New-RDMRole.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>User</maml:name> <maml:description> <maml:para>User object, must be retrieved from Get-RDMUser or created via New-RDMUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMRoleToUser -detailed". For technical information, type "Get-Help Remove-RDMRoleToUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Remove-RDMRoleToUser -Role $role -User $user</dev:code> <dev:remarks> <maml:para>Remove role to an user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMRoleToUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Remove-RDMUserSpecificSettings</command:name> <gl:group>RDMUserSpecificSettings</gl:group> <maml:description> <maml:para>Remove the session user specific settings</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMUserSpecificSettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Remove the session user specific settings</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMUserSpecificSettings</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Remove-RDMUserSpecificSettings -detailed". For technical information, type "Get-Help Remove-RDMUserSpecificSettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Rename-RDMGroup</command:name> <gl:group>RDMGroup</gl:group> <maml:description> <maml:para>Rename the group in a connection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>RDMGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Rename the group in a connection</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-RDMGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>NewGroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Rename-RDMGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>NewGroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to be deleted.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewGroupName</maml:name> <maml:description> <maml:para>New group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session object to modifiy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Rename-RDMGroup -detailed". For technical information, type "Get-Help Rename-RDMGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Restart-RDMProcess</command:name> <gl:group>RDMProcess</gl:group> <maml:description> <maml:para>Initialize a Remote Desktop Manager PowerShell module instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>RDMProcess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Initialize a Remote Desktop Manager PowerShell module instance</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Restart-RDMProcess -detailed". For technical information, type "Get-Help Restart-RDMProcess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Send-RDMMessage</command:name> <gl:group>RDMMessage</gl:group> <maml:description> <maml:para>Write a new secure message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Send</command:verb> <command:noun>RDMMessage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Write a message. The data source must be a Devolutions Server or Devolutions Hub Server.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-RDMMessage</maml:name> <command:parameter required="true" position="1"> <maml:name>To</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Body</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExpiresIn</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExpiresOn</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-RDMMessage</maml:name> <command:parameter required="false" position="1"> <maml:name>Body</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Subject</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ReplyTo</maml:name> <command:parameterValue required="true">DataSourceMessage</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExpiresIn</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExpiresOn</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>Attachments to add to the message. The supported types are PSMessageAttachment and PSConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Body</maml:name> <maml:description> <maml:para>Body text of the message.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>The value passed for the user will be case sensitive.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExpiresIn</maml:name> <maml:description> <maml:para>Number of days before the message expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExpiresOn</maml:name> <maml:description> <maml:para>Date when the message will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplyTo</maml:name> <maml:description> <maml:para>The subject and a recipient will be added based on the message. The subject can be modified with the Subject parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DataSourceMessage</command:parameterValue> <dev:type> <maml:name>DataSourceMessage</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of the message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>To</maml:name> <maml:description> <maml:para>The recepients of the message. They can be identified by ID, name, email, or by their PSUserInfo.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.Messages.DataSourceMessage</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The message obtained from the Receive-RDMMessage can be piped to the parameter ReplyTo.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Send-RDMMessage -detailed". For technical information, type "Get-Help Send-RDMMessage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Send-RDMMessage 'FirstName LastName' 'ASubject' 'AMessage'</dev:code> <dev:remarks> <maml:para>Send a secure message to 'FirstName LastName' about 'ASubject'. The detail of the message is 'AMessage'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entryA = Get-RDMPrivateSession -Name 'entryA'; $file = New-RDMMessageAttachment -File -Path "C:\mypath\filename.extension"; Send-RDMMessage -To 'Person A', 'Person B' -Subject 'Why' -Body 'AMessage' -Attachment $entryA, $file</dev:code> <dev:remarks> <maml:para>Fetch a private entry and create a file attachment. Send a secure message to Person A and Person B about 'Why'. The detail of the message is 'AMessage' and two attachments, 'entryA' and the file, are attached.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Receive-RDMMessage -From 'First Last' -SentOn Today -Subject 'Required Connection'| Send-RDMMessage -Body 'Thank you'</dev:code> <dev:remarks> <maml:para>Send a reply to the message 'First Last' sent today about 'Required Connection' to thank him. The subject will be 'Re: Required Connection' and the body, 'Thank you'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Send-RDMMessage -To 'person A' -Subject 'ASubject' -Attachment 'anEntry' -CaseSensitive</dev:code> <dev:remarks> <maml:para>Send a message to 'person A' with the attachment 'anEntry'. The user Person A won't be found.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 5-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMPrivateSession -Name AnEntry; Send-RDMMessage -To 'Person A' -Subject 'ASubject' -Attachment $entry</dev:code> <dev:remarks> <maml:para>Fetch a private entry with the cmdlet Get-RDMPrivateSession. It is pointless to modify the stored entry because it will be fetched by its ID. After that, a message will be sent to Person A with the attachment AnEntry.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMMessageAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Receive-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMMessage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMCurrentDataSource</command:name> <gl:group>RDMCurrentDataSource</gl:group> <maml:description> <maml:para>Set current active data source.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMCurrentDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set current active data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMCurrentDataSource</maml:name> <command:parameter required="false" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMCurrentDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the datasource to set current</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the data source to set as the current.</maml:para> <maml:para /> <maml:para>The value must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Password</maml:name> <maml:description> <maml:para>Data source password</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Username</maml:name> <maml:description> <maml:para>Data source username</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMCurrentDataSource -detailed". For technical information, type "Get-Help Set-RDMCurrentDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMCurrentDataSource "{00000000-0000-0000-0000-000000000000}"</dev:code> <dev:remarks> <maml:para>Set active data source to the data source with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMDataSource; Set-RDMCurrentDataSource $list[1].ID</dev:code> <dev:remarks> <maml:para>Retrieves the list of available data sources and sets the current data source the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMCurrentRepository</command:name> <gl:group>RDMCurrentRepository</gl:group> <maml:description> <maml:para>Set the current repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMCurrentRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the current repository. Repository must be first fetch via repository property of the Get-RDMRepository cmdlet or via the New-RDMRepository result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMCurrentRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMCurrentRepository</maml:name> <command:parameter required="false" position="1"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the GUID of the data source to set as the current.</maml:para> <maml:para /> <maml:para>The value must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository object, must be retrieved from Get-RDMRepository or created via New-RDMRepository.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMCurrentRepository -detailed". For technical information, type "Get-Help Set-RDMCurrentRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $repository = Get-RDMRepository -Name "MyRepo" ;Set-RDMCurrentRepository repository</dev:code> <dev:remarks> <maml:para>Get the repository named MyRepo and set it as the current repository.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMDataSource</command:name> <gl:group>RDMDataSource</gl:group> <maml:description> <maml:para>Save/set the datasource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMDataSource</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the datasource. Datasource must be first fetch via Data source property of the Get-RDMDataSource cmdlet or via the New-RDMDataSource result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the data source to set/save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMDataSource -detailed". For technical information, type "Get-Help Set-RDMDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMDataSource; Set-RDMDataSourceProperty -DataSource $list[0] -Property "Name" -Value "MyNewDataSourceName"; Set-RDMDataSource $list[0]</dev:code> <dev:remarks> <maml:para>Change the name of the first data source</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMDatasourceMasterKey</command:name> <gl:group>RDMDatasourceMasterKey</gl:group> <maml:description> <maml:para>Modify or clear your data source master key</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMDatasourceMasterKey</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMDatasourceMasterKey</maml:name> <command:parameter required="true" position="2"> <maml:name>NewMasterKey</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMDatasourceMasterKey</maml:name> <command:parameter required="true" position="2"> <maml:name>NoMasterKey</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the data source to change the master key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewMasterKey</maml:name> <maml:description> <maml:para>New data source master key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NoMasterKey</maml:name> <maml:description> <maml:para>Set no master key.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMDatasourceMasterKey -detailed". For technical information, type "Get-Help Set-RDMDatasourceMasterKey -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $dataSource = Get-RDMDataSource -Name MyDataSource; Set-RDMDatasourceMasterKey -DataSource $dataSource -NewMaster (ConvertTo-SecureString -AsPlainText "MyMasterKey" -Force)</dev:code> <dev:remarks> <maml:para>Modify the master key of the data source named MyDataSource to MyMasterKey</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMDatasourceProperty</command:name> <gl:group>RDMDatasourceProperty</gl:group> <maml:description> <maml:para>Save/set the datasource.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMDatasourceProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the datasource. Datasource must be first fetch via Data source property of the Get-RDMDataSource cmdlet or via the New-RDMDataSource result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMDatasourceProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the datasouce</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Value</maml:name> <maml:description> <maml:para>New value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMDatasourceProperty -detailed". For technical information, type "Get-Help Set-RDMDatasourceProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMDataSource; Set-RDMDataSourceProperty -DataSource $list[0] -Property "Name" -Value "MyNewDataSourceName"; Set-RDMDataSource $list[0]</dev:code> <dev:remarks> <maml:para>Change the name of the first data source</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMDatasourceRepository</command:name> <gl:group>RDMDatasourceRepository</gl:group> <maml:description> <maml:para>Modify data source repository</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMDatasourceRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMDatasourceRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the data source to change the current repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Repository</maml:name> <maml:description> <maml:para>New data source current repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMDatasourceRepository -detailed". For technical information, type "Get-Help Set-RDMDatasourceRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $dataSource = Get-RDMDataSource -Name MyDataSource; $repository = Get-RDMRepository -Name MyRepository ;Set-RDMDatasourceRepository -DataSource $dataSource -Repository $repository</dev:code> <dev:remarks> <maml:para>Modifiy the data source repository to </maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMLicense</command:name> <gl:group>RDMLicense</gl:group> <maml:description> <maml:para>Save/set the license.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMLicense</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the license. License must be first fetch via license property of the Get-RDMLicense cmdlet or via the New-RDMLicense result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMLicense</maml:name> <command:parameter required="false" position="2"> <maml:name>AutoAssign</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>License</maml:name> <command:parameterValue required="true">PSLicenseInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Auto assign new users to automatically provide the Remote Desktop Manager serial to all newly created users. For others serials, it will be ignored.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>License</maml:name> <maml:description> <maml:para>License object, must be retrieved from Get-RDMLicense or created via New-RDMLicense.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSLicenseInfo</command:parameterValue> <dev:type> <maml:name>PSLicenseInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMLicense -detailed". For technical information, type "Get-Help Set-RDMLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $license = New-RDMLicense -Name "New License" ;Set-License $license</dev:code> <dev:remarks> <maml:para>Create & save new license.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPersonalCredentials</command:name> <gl:group>RDMPersonalCredentials</gl:group> <maml:description> <maml:para>Set RDM personal credentials.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPersonalCredentials</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set RDM personal credentials. Set Username/Password type directly or modify the result of Get-RDMPersonalCredentials.To modify member starting with Safe, set the property without the Safe. On Windows, the policy DisableMyPersonalCredentials prevent using this cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPersonalCredentials</maml:name> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AlwaysAskPassword</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPersonalCredentials</maml:name> <command:parameter required="false" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AlwaysAskPassword</maml:name> <maml:description> <maml:para>Set Always ask password option in personal credentials</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Set domain in personal credentials</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Password</maml:name> <maml:description> <maml:para>Set password in personal credentials</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>The credentials obtained from Get-RDMPersonalCredentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Set username in personal credentials</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPersonalCredentials -detailed". For technical information, type "Get-Help Set-RDMPersonalCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $pwd = Read-Host -AsSecureString; Set-RDMPersonalCredentials username domain $pwd</dev:code> <dev:remarks> <maml:para>Set RDM personal credentials of the type Username/Password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $perso = Get-RDMPersonalCredentials; $perso.Credentials.SecretServerPassword = (ConvertTo-SecureString -AsPlainText 'aPassword'); $perso.Credentials.SecretServerUsername = 'aPassword'; $perso.Credentials.SecretServerDomain = 'aDomain'; Set-RDMPersonalCredentials -Session $perso</dev:code> <dev:remarks> <maml:para>Fetch the personal credentials. Modify the Secret Server's domain, password and username value. Save the modificatons. The password modification can be seen in the value change of the field SafeSecretServerPassword.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPersonalCredentials</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPlaylistLocal</command:name> <gl:group>RDMPlaylistLocal</gl:group> <maml:description> <maml:para>Save a local playlist</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPlaylistLocal</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save a local playlist</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPlaylistLocal</maml:name> <command:parameter required="true" position="1"> <maml:name>Playlist</maml:name> <command:parameterValue required="true">PSPlaylistLocal</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ImportConnection</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ImportConnection</maml:name> <maml:description> <maml:para>Import the playlist connections to the data source.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Playlist</maml:name> <maml:description> <maml:para>Specifies the the local playlist to set/save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSPlaylistLocal</command:parameterValue> <dev:type> <maml:name>PSPlaylistLocal</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPlaylistLocal -detailed". For technical information, type "Get-Help Set-RDMPlaylistLocal -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPlaylistShared</command:name> <gl:group>RDMPlaylistShared</gl:group> <maml:description> <maml:para>Save a shared playlist in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPlaylistShared</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save a shared playlist in the current data source</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPlaylistShared</maml:name> <command:parameter required="true" position="1"> <maml:name>Playlist</maml:name> <command:parameterValue required="true">PSPlaylistShared</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ImportConnection</maml:name> </command:parameter> <command:parameter required="false" position="3"> <maml:name>PrivateVault</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ImportConnection</maml:name> <maml:description> <maml:para>Import the playlist connections to the data source.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Playlist</maml:name> <maml:description> <maml:para>Specifies the the shared playlist to set/save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSPlaylistShared</command:parameterValue> <dev:type> <maml:name>PSPlaylistShared</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>PrivateVault</maml:name> <maml:description> <maml:para>Save the shared playlist in the private vault.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPlaylistShared -detailed". For technical information, type "Get-Help Set-RDMPlaylistShared -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPowerShellOverride</command:name> <gl:group>RDMPowerShellOverride</gl:group> <maml:description> <maml:para>Save the module override values</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPowerShellOverride</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save the module override values. Override must be first fetch via the Get-RDMPowerShellOverride cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPowerShellOverride -detailed". For technical information, type "Get-Help Set-RDMPowerShellOverride -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $override = Get-RDMPowerShellOverride; $override.OptionFilePath = NewPathValue; Set-RDMPowerShellOverride $override</dev:code> <dev:remarks> <maml:para>Change the option file path</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionAttachment</command:name> <gl:group>RDMPrivateSessionAttachment</gl:group> <maml:description> <maml:para>Save/set the session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the session. Session must be first fetch via Session property of the Get-RDM-Session cmdlet or via the New-RDMSession result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnectionAttachment[]</command:parameterValue> <dev:type> <maml:name>PSConnectionAttachment[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionAttachment -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; $list[1].Name = "New Name";Set-RDMUserVaultSession $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, modify the name of the second session, update the session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSession</command:name> <gl:group>RDMPrivateSession</gl:group> <maml:description> <maml:para>Save the session in the user private vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save the session in the user private vault</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or Get-RDMPrivateSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSession -detailed". For technical information, type "Get-Help Set-RDMPrivateSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionCredentials</command:name> <gl:group>RDMPrivateSessionCredentials</gl:group> <maml:description> <maml:para>Save credentials in a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionCredentials</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save credentials in a session</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>CredentialEntryID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetSession</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>CredentialsType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetSession</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CredentialEntryID</maml:name> <maml:description> <maml:para>Specifies the credentials type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CredentialsType</maml:name> <maml:description> <maml:para>Specifies the credentials type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSConnection</maml:name> <maml:description> <maml:para>Specifies the connection to set credentials to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetSession</maml:name> <maml:description> <maml:para>Specifies the credentials type.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionCredentials -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionDocument</command:name> <gl:group>RDMPrivateSessionDocument</gl:group> <maml:description> <maml:para>Save a document in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionDocument</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save a document in the current data source</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionDocument</maml:name> <command:parameter required="true" position="1"> <maml:name>Document</maml:name> <command:parameterValue required="true">PSConnectionDocument</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Document</maml:name> <maml:description> <maml:para>Specifies the the document to set/save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnectionDocument</command:parameterValue> <dev:type> <maml:name>PSConnectionDocument</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionDocument -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionDocument -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionDomain</command:name> <gl:group>RDMPrivateSessionDomain</gl:group> <maml:description> <maml:para>Set the domain from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionDomain</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the domain from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>New domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the domain from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the Domain to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionDomain -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMUserVaultSessionDomain "{00000000-0000-0000-0000-000000000000}" "MyOtherDomain.com"</dev:code> <dev:remarks> <maml:para>Set the domain from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Set-RDMSessionDomain -ID $list[1].ID -Domain "MyOtherDomain.com" -Refresh</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and sets the domain from the the second element in the list with UI refresh.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionPassword</command:name> <gl:group>RDMPrivateSessionPassword</gl:group> <maml:description> <maml:para>Set the password from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionPassword</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the password from the specified session. Session must be marked as "Allow show credentials" if not null is returned.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password as SecureString.</maml:para> <maml:para>Use either "Read-Host -AsSecureString" or "ConvertTo-SecureString"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PasswordAge</maml:name> <maml:description> <maml:para>Specifies password age in days. PasswordAge takes presedence over PasswordSinceDate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PasswordSinceDate</maml:name> <maml:description> <maml:para>Specifies date/time (UTC) at which the password was first created. PasswordAge takes presedence over PasswordSinceDate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the password to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionPassword -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMUserVaultSessionPassword -ID "{00000000-0000-0000-0000-000000000000}" -Password (Read-Host -AsSecureString "Password")</dev:code> <dev:remarks> <maml:para>Set the password from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Set-RDMUserVaultSessionPassword -ID $list[1].ID -Password (Read-Host -AsSecureString "Password")</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and sets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionProperty</command:name> <gl:group>RDMPrivateSessionProperty</gl:group> <maml:description> <maml:para>Set the value of property given a session ID and path.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Protected values will always return null.</maml:para> <maml:para>Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the property being read (reference RDM export xml). In the case of top level property do not specify parameter or pass empty string [""] or $null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Value</maml:name> <maml:description> <maml:para>New value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionProperty -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMUserVaultSessionProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group" -Value "My New Group Name"</dev:code> <dev:remarks> <maml:para>Set the Group value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Set-RDMUserVaultSessionProperty "{00000000-0000-0000-0000-000000000000}" "MetaInformation" "OS" "Windows Server 2008 R2"</dev:code> <dev:remarks> <maml:para>Set the MetaInformation.OS value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Set-RDMUserVaultSessionProperty -ID $list[1].ID -Path "MetaInformation" -Property "OS" -Value "Windows Server 2008 R2"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and then sets the MetaInformation.OS value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionProperty</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionStatus</command:name> <gl:group>RDMPrivateSessionStatus</gl:group> <maml:description> <maml:para>Set a status to a given session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionStatus</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set a status to a given session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to set the status to.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>Status message</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the status to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Status type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionStatus -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Set-RDMUserVaultSessionStatus -Session $list[1] -Status Locked -Message 'Locked Message' </dev:code> <dev:remarks> <maml:para>Set the status locked to the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionStatus</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivateSessionUsername</command:name> <gl:group>RDMPrivateSessionUsername</gl:group> <maml:description> <maml:para>Set the username on the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionUsername</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the username on the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionUsername</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionUsername</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to set the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the username to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivateSessionUsername -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionUsername -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMUserVaultSessionUsername "{00000000-0000-0000-0000-000000000000}" "localadmin"</dev:code> <dev:remarks> <maml:para>Set the username from the user vault session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUserVaultSession; Get-RDMUserVaultSessionPassword -ID $list[1].ID -Username </dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMPrivilegedAccount</command:name> <gl:group>RDMPrivilegedAccount</gl:group> <maml:description> <maml:para>Set RDM privileged account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivilegedAccount</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set RDM privileged account. Set Username/Password type directly or modify the result of Get-RDMPrivilegedAccount.To modify member starting with Safe, set the property without the Safe. On Windows, the policy DisableMyPrivilegedAccount prevent using this cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPrivilegedAccount</maml:name> <command:parameter required="false" position="1"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AlwaysAskPassword</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivilegedAccount</maml:name> <command:parameter required="false" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AlwaysAskPassword</maml:name> <maml:description> <maml:para>Set Always ask password option in privileged account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Set domain in privileged account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Password</maml:name> <maml:description> <maml:para>Set password in privileged account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>The credentials obtained from Get-RDMPrivilegedAccount.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Set username in privileged account</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMPrivilegedAccount -detailed". For technical information, type "Get-Help Set-RDMPrivilegedAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $pwd = Read-Host -AsSecureString; Set-RDMPrivilegedAccount username domain $pwd</dev:code> <dev:remarks> <maml:para>Set RDM privileged account of the type Username/Password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $privAcc = Get-RDMPrivilegedAccount; $privAcc.Credentials.SecretServerPassword = (ConvertTo-SecureString -AsPlainText 'aPassword'); $privAcc.Credentials.SecretServerUsername = 'aPassword'; $privAcc.Credentials.SecretServerDomain = 'aDomain'; Set-RDMPrivilegedAccount -Session $privAcc</dev:code> <dev:remarks> <maml:para>Fetch the privileged account. Modify the Secret Server's domain, password and username value. Save the modificatons. The password modification can be seen in the value change of the field SafeSecretServerPassword.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPrivilegedAccount</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Save/set the repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the repository. Repository must be first fetch via repository property of the Get-RDMRepository cmdlet or via the New-RDMRepository result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Repository</maml:name> <maml:description> <maml:para>repository object, must be retrieved from Get-RDMRepository or created via New-RDMRepository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRepositoryInfo</command:parameterValue> <dev:type> <maml:name>PSRepositoryInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMRepository -detailed". For technical information, type "Get-Help Set-RDMRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $repository = New-RDMRepository -Name "New Repository" ;Set-RDMRepository repository</dev:code> <dev:remarks> <maml:para>Create & save new repository.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMRole</command:name> <gl:group>RDMRole</gl:group> <maml:description> <maml:para>Save/set the role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMRole</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the role. Role must be first fetch via role property of the Get-RDMRole cmdlet or via the New-RDMRole result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMRole</maml:name> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Role object, must be retrieved from Get-RDMRoleSecurityGroup or created via New-RDMRole.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMRole -detailed". For technical information, type "Get-Help Set-RDMRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $role = New-RDMRole -Name "New Role" ;Set-RDMRole $role</dev:code> <dev:remarks> <maml:para>Create & save new role.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMRoleProperty</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMRoleGroupRights</command:name> <gl:group>RDMRoleGroupRights</gl:group> <maml:description> <maml:para>Assign/set role permissions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMRoleGroupRights</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Assign/set role permissions.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMRoleGroupRights</maml:name> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>SecurityGroup</maml:name> <command:parameterValue required="true">PSSecurityGroupInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Add</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Delete</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Edit</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Add</maml:name> <maml:description> <maml:para>Allows the role to add entries in groups/folders for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Delete</maml:name> <maml:description> <maml:para>Allows the role to Delete the entries for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Edit</maml:name> <maml:description> <maml:para>Allows the role to Edit the entries for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>role object, must be retrieved from Get-RDMRole or created via New-RDMRole.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Security group object, must be retrieved from Get-RDMSecurityGroup or created via New-RDMSecurityGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSecurityGroupInfo</command:parameterValue> <dev:type> <maml:name>PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Allows the role to View AND USE the entries for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMRoleGroupRights -detailed". For technical information, type "Get-Help Set-RDMRoleGroupRights -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $roles = Get-RDMRole; $groups = Get-RDMSecurityGroup; Set-RDMRoleGroupRights -role $roles[1] -SecurityGroup $groups[0] -Add $true -Delete $true</dev:code> <dev:remarks> <maml:para>Retrieves the list of available roles and groups. Set permission add and delete to the second role of the list on the first group of the list</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMRoleProperty</command:name> <gl:group>RDMRoleProperty</gl:group> <maml:description> <maml:para>Set the value of property given to a role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMRoleProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the value of property given to a role.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMRoleProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">PSRoleInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRoleInfo</command:parameterValue> <dev:type> <maml:name>PSRoleInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Value</maml:name> <maml:description> <maml:para>New value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMRoleProperty -detailed". For technical information, type "Get-Help Set-RDMRoleProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMRoleProperty -Role "$role"-Property "Description" -Value "My New Description"</dev:code> <dev:remarks> <maml:para>Set the description value for the role given.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMRole; Set-RDMRoleProperty -Role $list[1] -Property "Description" -Value "My description"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available role and then sets the description value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMRootSession</command:name> <gl:group>RDMRootSession</gl:group> <maml:description> <maml:para>Save the root session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMRootSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save the root session. Root session must be first fetch via the Get-RDMRootSession cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMRootSession</maml:name> <command:parameter required="true" position="1"> <maml:name>RootSession</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>RootSession</maml:name> <maml:description> <maml:para>PSConnection object, must be retrieved from Get-RDMRootSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMRootSession -detailed". For technical information, type "Get-Help Set-RDMRootSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $rootSession = Get-RDMRootSession; $rootSession.Name = "New Name";Set-RDMRootSession -RootSession $rootSession</dev:code> <dev:remarks> <maml:para>Retrieves the root session, modify the root session name, save the root session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRootSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSecurityGroup</command:name> <gl:group>RDMSecurityGroup</gl:group> <maml:description> <maml:para>Save/set the security group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSecurityGroup</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the SecurityGroup. SecurityGroup must be first fetch via SecurityGroup property of the Get-RDMSecurityGroup cmdlet or via the New-RDMSecurityGroup result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSecurityGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>SecurityGroup</maml:name> <command:parameterValue required="true">PSSecurityGroupInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Security group object, must be retrieved from Get-RDMSecurityGroup or created via New-RDMSecurityGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSecurityGroupInfo</command:parameterValue> <dev:type> <maml:name>PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSecurityGroup -detailed". For technical information, type "Get-Help Set-RDMSecurityGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $securityGroup = New-RDMSecurityGroup -Name "New SecurityGroup" ;Set-RDMSecurityGroup $securityGroup</dev:code> <dev:remarks> <maml:para>Create & save new security group.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSecurityGroupProperty</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSecurityGroup</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSecurityGroupProperty</command:name> <gl:group>RDMSecurityGroupProperty</gl:group> <maml:description> <maml:para>Set the value of property given to a security group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSecurityGroupProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Protected values will always return null.</maml:para> <maml:para>Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSecurityGroupProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>SecurityGroup</maml:name> <command:parameterValue required="true">PSSecurityGroupInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Specifies the security group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSecurityGroupInfo</command:parameterValue> <dev:type> <maml:name>PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Value</maml:name> <maml:description> <maml:para>New value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSecurityGroupProperty -detailed". For technical information, type "Get-Help Set-RDMSecurityGroupProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSecurityGroupProperty -SecurityGroup "$securityGroup" -Property "Description" -Value "My New Description"</dev:code> <dev:remarks> <maml:para>Set the description value for the security group given.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSecurityGroup; Set-RDMSecurityGroupProperty -Group $list[1] -Property "Description" -Value "My description"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available security groups and then sets the description value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Save/set the session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the session. Session must be first fetch via Session property of the Get-RDM-Session cmdlet or via the New-RDMSession result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnectionAttachment[]</command:parameterValue> <dev:type> <maml:name>PSConnectionAttachment[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionAttachment -detailed". For technical information, type "Get-Help Set-RDMSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; $list[1].Name = "New Name";Set-RDMSession $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, modify the name of the second session, update the session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Save/set the session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save/set the session. Session must be first fetch via Session property of the Get-RDM-Session cmdlet or via the New-RDMSession result.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSession -detailed". For technical information, type "Get-Help Set-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; $list[1].Name = "New Name";Set-RDMSession $list[1]</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions, modify the name of the second session, update the session.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $session = New-RDMSession -Name "New Session" -Host "myServer" -Kind "RDPConfigured";Set-RDMSession $session</dev:code> <dev:remarks> <maml:para>Create & save new session.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> [Devolutions.Generated.Models.Connection].DeclaredFields | Where-Object -Property Name -like "*ConnectionID" | Select-Object -Property Name; $session = Get-RDMSession -Name ARDP"; $session.CredentialConnectionID = [Devolutions.Generated.Models.Connection]::MyDefaultCredentialConnectionID; Set-RDMSession $session</dev:code> <dev:remarks> <maml:para>The user looks at the options for the type of credentials for entries. After finding the desired one, he gets the session ARDP. He sets the credentials to 'My Personal Credentials' and save the modification.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMDataSource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionCredentials</command:name> <gl:group>RDMSessionCredentials</gl:group> <maml:description> <maml:para>Save credentials in a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionCredentials</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save credentials in a session</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>CredentialEntryID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetSession</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>CredentialsType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetSession</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CredentialEntryID</maml:name> <maml:description> <maml:para>Specifies the credentials type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CredentialsType</maml:name> <maml:description> <maml:para>Specifies the credentials type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PSConnection</maml:name> <maml:description> <maml:para>Specifies the connection to set credentials to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetSession</maml:name> <maml:description> <maml:para>Specifies the credentials type.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionCredentials -detailed". For technical information, type "Get-Help Set-RDMSessionCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionDocumentation</command:name> <gl:group>RDMSessionDocumentation</gl:group> <maml:description> <maml:para>Set the documentation on a session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionDocumentation</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Must have the right to add and edit. Documentation must be first fetch via the Get-RDMSessionDocumentation cmdlet. If the documentation comes from another session, all pages will be created. Only before updating pages will the user be prompted to confirm.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AsLastPage</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AsLastPage</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AsLastPage</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DefaultPage</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DefaultPage</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="false" position="1"> <maml:name>DefaultPage</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AsLastPage</maml:name> <maml:description> <maml:para>Append the created pages to the end.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultPage</maml:name> <maml:description> <maml:para>Define a new default page in the documentation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Update the documentation without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Handbook</maml:name> <maml:description> <maml:para>Specifies the documentation to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSHandbook</command:parameterValue> <dev:type> <maml:name>PSHandbook</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Current data source session`s ID where the documentation will be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Current data source session`s name where the documentation will be set.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session where the documentation will be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionDocumentation -detailed". For technical information, type "Get-Help Set-RDMSessionDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMRootSession | Get-RDMSessionDocumentation | Set-RDMSessionDocumentation -Session (Get-RDMSession -Name "ASession")</dev:code> <dev:remarks> <maml:para>Copy the documentation from the current data source's root to the session "ASession".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $sess = Get-RDMSession -Name "ASession"; Get-RDMDataSource -Name "AnotherDataSource" | Set-RDMCurrentDataSource; Get-RDMRootSession | Get-RDMSessionDocumentation | Set-RDMSessionDocumentation -Session $sess)</dev:code> <dev:remarks> <maml:para>Copy the documentation from the root session of "AnotherDataSource" to the session "ASession" of the previous data source.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSessionDocumentation -Name ASession -DefaultPage NewDefaultPage -Force)</dev:code> <dev:remarks> <maml:para>Change the default documentation page of the session ASession to NewDefaultPage.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMRootSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionDocument</command:name> <gl:group>RDMSessionDocument</gl:group> <maml:description> <maml:para>Save a document in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionDocument</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save a document in the current data source</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionDocument</maml:name> <command:parameter required="true" position="1"> <maml:name>Document</maml:name> <command:parameterValue required="true">PSConnectionDocument</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Document</maml:name> <maml:description> <maml:para>Specifies the the document to set/save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnectionDocument</command:parameterValue> <dev:type> <maml:name>PSConnectionDocument</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionDocument -detailed". For technical information, type "Get-Help Set-RDMSessionDocument -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionDomain</command:name> <gl:group>RDMSessionDomain</gl:group> <maml:description> <maml:para>Set the domain from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionDomain</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the domain from the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>New domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the domain from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the Domain to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionDomain -detailed". For technical information, type "Get-Help Set-RDMSessionDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSessionDomain "{00000000-0000-0000-0000-000000000000}" "MyOtherDomain.com"</dev:code> <dev:remarks> <maml:para>Set the domain from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Set-RDMSessionDomain -ID $list[1].ID -Domain "MyOtherDomain.com" -Refresh</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and sets the domain from the the second element in the list with UI refresh.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionPassword</command:name> <gl:group>RDMSessionPassword</gl:group> <maml:description> <maml:para>Set the password from the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionPassword</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the password from the specified session. Session must be marked as "Allow show credentials" if not null is returned.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password as SecureString.</maml:para> <maml:para>Use either "Read-Host -AsSecureString" or "ConvertTo-SecureString"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PasswordAge</maml:name> <maml:description> <maml:para>Specifies password age in days. PasswordAge takes presedence over PasswordSinceDate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PasswordSinceDate</maml:name> <maml:description> <maml:para>Specifies date/time (UTC) at which the password was first created. PasswordAge takes presedence over PasswordSinceDate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the password to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionPassword -detailed". For technical information, type "Get-Help Set-RDMSessionPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSessionPassword -ID "{00000000-0000-0000-0000-000000000000}" -Password (Read-Host -AsSecureString "Password")</dev:code> <dev:remarks> <maml:para>Set the password from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Set-RDMSessionPassword -ID $list[1].ID -Password (Read-Host -AsSecureString "Password")</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and sets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionProperty</command:name> <gl:group>RDMSessionProperty</gl:group> <maml:description> <maml:para>Set the value of property given a session ID and path.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Protected values will always return null.</maml:para> <maml:para>Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the property being read (reference RDM export xml). In the case of top level property do not specify parameter or pass empty string [""] or $null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Value</maml:name> <maml:description> <maml:para>New value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionProperty -detailed". For technical information, type "Get-Help Set-RDMSessionProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSessionProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group" -Value "My New Group Name"</dev:code> <dev:remarks> <maml:para>Set the Group value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSessionProperty "{00000000-0000-0000-0000-000000000000}" "MetaInformation" "OS" "Windows Server 2008 R2"</dev:code> <dev:remarks> <maml:para>Set the MetaInformation.OS value from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Set-RDMSessionProperty -ID $list[1].ID -Path "MetaInformation" -Property "OS" -Value "Windows Server 2008 R2"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and then sets the MetaInformation.OS value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionProperty</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionStatus</command:name> <gl:group>RDMSessionStatus</gl:group> <maml:description> <maml:para>Set a status to a given session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionStatus</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set a status to a given session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to set the status to.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>Status message</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the status to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnection[]</command:parameterValue> <dev:type> <maml:name>PSConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Status type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionStatus -detailed". For technical information, type "Get-Help Set-RDMSessionStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Set-RDMSessionStatus -Session $list[1] -Status Locked -Message 'Locked Message' </dev:code> <dev:remarks> <maml:para>Set the status locked to the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionUsername</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionStatus</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSessionUsername</command:name> <gl:group>RDMSessionUsername</gl:group> <maml:description> <maml:para>Set the username on the specified session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionUsername</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the username on the specified session.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSessionUsername</maml:name> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionUsername</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to set the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Specifies the session to set the username to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSessionUsername -detailed". For technical information, type "Get-Help Set-RDMSessionUsername -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMSessionUsername "{00000000-0000-0000-0000-000000000000}" "localadmin"</dev:code> <dev:remarks> <maml:para>Set the username from the session with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMSession; Get-RDMSessionPassword -ID $list[1].ID -Username </dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and gets the password from the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionDomain</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionUserName</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionPassword</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMSQLiteDatasourcePassword</command:name> <gl:group>RDMSQLiteDatasourcePassword</gl:group> <maml:description> <maml:para>Modify or clear your data source password</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSQLiteDatasourcePassword</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMSQLiteDatasourcePassword</maml:name> <command:parameter required="true" position="4"> <maml:name>NewPassword</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSQLiteDatasourcePassword</maml:name> <command:parameter required="true" position="4"> <maml:name>NoPassword</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DataSource</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the SQLite data source</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataSource</command:parameterValue> <dev:type> <maml:name>PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>New data source password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoPassword</maml:name> <maml:description> <maml:para>Set no password.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMSQLiteDatasourcePassword -detailed". For technical information, type "Get-Help Set-RDMSQLiteDatasourcePassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $dataSource = Get-RDMDataSource -Name MySqliteDataSource; Set-RDMSQLiteDatasourcePassword -DataSource $dataSource -NewPassword (ConvertTo-SecureString -AsPlainText "MyPassword" -Force)</dev:code> <dev:remarks> <maml:para>Modify the password of the data source named MySqliteDataSource to MyPassword</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMTask</command:name> <gl:group>RDMTask</gl:group> <maml:description> <maml:para>Save or update a task.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMTask</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save or update a task of the current data source. This feature is only available for the following data sources: Devolutions Server, Azure SQL, SQL Server, and SQLite. If the data source does not support users, the parameter User will be simply ignored. If a virtual folder is involved, the user must have the add and edit rights to save the tasks. To modify fields, this cmdlet parameters can be used or the PSTask can be modified directly. The confirmation impact (ConfirmImpact) is low.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMTask</maml:name> <command:parameter required="false" position="1"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DueDate</maml:name> <command:parameterValue required="true">DateFilter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Priority</maml:name> <command:parameterValue required="true">DateFilter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Status</maml:name> <command:parameterValue required="true">TodoStatus</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Task</maml:name> <command:parameterValue required="true">PSTask</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UnassignUser</maml:name> </command:parameter> <command:parameter required="false" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Modify the comment of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>Modify the description of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DueDate</maml:name> <maml:description> <maml:para>Specify the deadline to accomplish the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateFilter</command:parameterValue> <dev:type> <maml:name>DateFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>The task will be saved or created without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name for the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Modify the priority of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateFilter</command:parameterValue> <dev:type> <maml:name>DateFilter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Modify the status of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TodoStatus</command:parameterValue> <dev:type> <maml:name>TodoStatus</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Task</maml:name> <maml:description> <maml:para>Task to add or modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSTask</command:parameterValue> <dev:type> <maml:name>PSTask</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UnassignUser</maml:name> <maml:description> <maml:para>Remove the user assigned to the task.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>Assign this user to the task. The user can be specified with his name, his email address, his ID or a PSUserInfo.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTask</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The task obtained from Get-RDMTask can be piped to the parameter Task.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMTask -detailed". For technical information, type "Get-Help Set-RDMTask -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMTask -Name ATask | Set-RDMTask -Comment "Task completed" -Status Closed</dev:code> <dev:remarks> <maml:para>Add the comment "Task completed" to task ATask and close it. If the name is not unique, all tasks named ATask will have the modifications.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> New-RDMTask -Name ATask -Entry AnEntry | Set-RDMTask -Force</dev:code> <dev:remarks> <maml:para>Save a newly created task named ATask and associated with AnEntry without any confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $user = Get-RDMUser -Name AUser; Get-RDMTask -Status Assigned -User $user | Set-RDMTask -UnassignUser</dev:code> <dev:remarks> <maml:para>Unassign all the tasks assigned the user AUser.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $task = Get-RDMTask -Name ATask; $task.Task.CustomField1 = "Whatever"; Set-RDMTask $task</dev:code> <dev:remarks> <maml:para>Store the uniquely named task ATask in $task. Add a value to the CustomField1 and save the modification using the only positional parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 5-----------------------</maml:title> <dev:code>PS C:\> Get-RDMTask -Name ATask | Set-RDMTask $task -WhatIf -Verbose -Description 'NewDesc' -DueDate 2023/1/1 -Priority 3</dev:code> <dev:remarks> <maml:para>Using the WhatIf and Verbose parameters, it will allow to determine if the task is created or updated and where exactly (data source name > entry name > task name). No modification will happen.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMTask</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMTemplate</command:name> <gl:group>RDMTemplate</gl:group> <maml:description> <maml:para>Save templates in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMTemplate</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save templates in the current data source. All local templates will be ignored.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMTemplate</maml:name> <command:parameter required="true" position="1"> <maml:name>Template</maml:name> <command:parameterValue required="true">PSTemplate[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Template</maml:name> <maml:description> <maml:para>Template must be retrieved from Get-RDMTemplate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSTemplate[]</command:parameterValue> <dev:type> <maml:name>PSTemplate[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSTemplate</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An object PSTemplate can be piped to the parameter Template</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMTemplate -detailed". For technical information, type "Get-Help Set-RDMTemplate -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $grTemplates = Get-RDMTemplate | Where-Object -Property Type -eq TemplateGroup; $sess = Get-RDMSession -Name "ASession"; $grTemplates[0].GroupEntries += $sess; Set-RDMTemplate $grTemplates[0]</dev:code> <dev:remarks> <maml:para>Retrieves all group templates. Fetches the entry 'ASession' and add it to the first group template. Save the template with the new added entry.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMUser</command:name> <gl:group>RDMUser</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMUser</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMUser</maml:name> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>User object, must be retrieved from Get-RDMUser or created via New-RDMUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMUser -detailed". For technical information, type "Get-Help Set-RDMUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMUserGroupRights</command:name> <gl:group>RDMUserGroupRights</gl:group> <maml:description> <maml:para>Assign/set user permissions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMUserGroupRights</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Assign/set user permissions.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMUserGroupRights</maml:name> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>SecurityGroup</maml:name> <command:parameterValue required="true">PSSecurityGroupInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Add</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Delete</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Edit</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetUser</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Add</maml:name> <maml:description> <maml:para>Allows the user to add entries in groups/folders for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Delete</maml:name> <maml:description> <maml:para>Allows the user to Delete the entries for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Edit</maml:name> <maml:description> <maml:para>Allows the user to Edit the entries for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityGroup</maml:name> <maml:description> <maml:para>Security group object, must be retrieved from Get-RDMSecurityGroup or created via New-RDMSecurityGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSecurityGroupInfo</command:parameterValue> <dev:type> <maml:name>PSSecurityGroupInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetUser</maml:name> <maml:description> <maml:para>Set the user in the data source</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>User object, must be retrieved from Get-RDMUser or created via New-RDMUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Allows the user to View AND USE the entries for that security group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMUserGroupRights -detailed". For technical information, type "Get-Help Set-RDMUserGroupRights -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $users = Get-RDMUser; $groups = Get-RDMGroup; Set-RDMUserGroupRights -user $users[1] -SecurityGroup $groups[0] -Add -Delete</dev:code> <dev:remarks> <maml:para>Retrieves the list of available users and groups. Set permission add and delete to the second user of the list on the first group of the list</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMUserProperty</command:name> <gl:group>RDMUserProperty</gl:group> <maml:description> <maml:para>Set the value of property given to a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMUserProperty</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Set the value of property given to a user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMUserProperty</maml:name> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the GUID of the user to get the password from.</maml:para> <maml:para /> <maml:para>Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Value</maml:name> <maml:description> <maml:para>New value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMUserProperty -detailed". For technical information, type "Get-Help Set-RDMUserProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMuserProperty -User "$user" -Property "Description" -Value "My New Description"</dev:code> <dev:remarks> <maml:para>Set the description value for the user given.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $list = Get-RDMUser; Set-RDMUserProperty -User $list[1] -Property "Description" -Value "My description"</dev:code> <dev:remarks> <maml:para>Retrieves the list of available users and then sets the description value of the the second element in the list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMUserSecurity</command:name> <gl:group>RDMUserSecurity</gl:group> <maml:description> <maml:para>Assign/set user security settings.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMUserSecurity</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Assign/set user security settings.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMUserSecurity</maml:name> <command:parameter required="true" position="1"> <maml:name>User</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AllowDragAndDrop</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CanExport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CanImport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CanViewDetails</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CanViewGlobalLogs</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CanViewInformations</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DenyAddInRoot</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OfflineMode</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>SetUser</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AllowDragAndDrop</maml:name> <maml:description> <maml:para>Allows the user to move the sessions using drag-and-drop from other applications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CanExport</maml:name> <maml:description> <maml:para>Allows the user to Export sessions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CanImport</maml:name> <maml:description> <maml:para>Allows the user to Import sessions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>CanViewDetails</maml:name> <maml:description> <maml:para>Allows the user to see the content of the Details tab for all sessions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CanViewGlobalLogs</maml:name> <maml:description> <maml:para>Allows the user to see the content of the Logs that apply to a session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>CanViewInformations</maml:name> <maml:description> <maml:para>Allows the user to see the content of the Information tab for all sessions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10"> <maml:name>DenyAddInRoot</maml:name> <maml:description> <maml:para>Denies the user the rights to add in the root.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OfflineMode</maml:name> <maml:description> <maml:para>Allows the user to enable the Offline Mode on the data sources. Choose between: Disabled : no offline cache allowed for that user Cache : cache allowed for that user ReadOnly : a read-only cache is allowed for Advanced Data Sources. ReadWrite : an advanced cache, with change synchronization, is allowed for Advanced Data Sources.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetUser</maml:name> <maml:description> <maml:para>Set user</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>User</maml:name> <maml:description> <maml:para>User object, must be retrieved from Get-RDMUser or created via New-RDMUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSUserInfo</command:parameterValue> <dev:type> <maml:name>PSUserInfo</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMUserSecurity -detailed". For technical information, type "Get-Help Set-RDMUserSecurity -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Set-RDMUserSecurity -user $user -CanImport $true -CanExport $true -AllowRevealPassword $false -OfflineMode "Read/Write"</dev:code> <dev:remarks> <maml:para>Set user to allow it to import, export, not allow to reveal password and set offline mode to read/write and</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMUser</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Set-RDMUserSpecificSettings</command:name> <gl:group>RDMUserSpecificSettings</gl:group> <maml:description> <maml:para>Save user specific settings in a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMUserSpecificSettings</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Save user specific settings in a session</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMUserSpecificSettings</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserSpecificSettings</maml:name> <command:parameterValue required="true">BaseConnectionOverride</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>PSConnection object, must be retrieved from Get-RDMSession or created via New-RDMSession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserSpecificSettings</maml:name> <maml:description> <maml:para>User specific settings, must be retrieved from Get-RDMUserSpecificSettings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaseConnectionOverride</command:parameterValue> <dev:type> <maml:name>BaseConnectionOverride</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Set-RDMUserSpecificSettings -detailed". For technical information, type "Get-Help Set-RDMUserSpecificSettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Start-RDMInstance</command:name> <gl:group>RDMInstance</gl:group> <maml:description> <maml:para>Initialize a Remote Desktop Manager PowerShell module instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>RDMInstance</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Initialize a Remote Desktop Manager PowerShell module instance</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Start-RDMInstance -detailed". For technical information, type "Get-Help Start-RDMInstance -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Start-RDMProcess</command:name> <gl:group>RDMProcess</gl:group> <maml:description> <maml:para>Start a Remote Desktop Manager process</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>RDMProcess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Start a Remote Desktop Manager process</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Start-RDMProcess -detailed". For technical information, type "Get-Help Start-RDMProcess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Stop-RDMProcess</command:name> <gl:group>RDMProcess</gl:group> <maml:description> <maml:para>Stop the running Remote Desktop Manager process</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>RDMProcess</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Stop the running Remote Desktop Manager process</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Stop-RDMProcess -detailed". For technical information, type "Get-Help Stop-RDMProcess -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Uninstall-RDMPackage</command:name> <gl:group>RDMPackage</gl:group> <maml:description> <maml:para>Uninstall the installed version of Remote Desktop Manager</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>RDMPackage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Uninstall the installed version of Remote Desktop Manager</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-RDMPackage</maml:name> <command:parameter required="false" position="1"> <maml:name>Edition</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Quiet</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Edition</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Quiet</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Uninstall-RDMPackage -detailed". For technical information, type "Get-Help Uninstall-RDMPackage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Uninstall-RDMPackage</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Update-RDMPackage</command:name> <gl:group>RDMPackage</gl:group> <maml:description> <maml:para>Update the installed version of Remote Desktop Manager</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMPackage</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Update the installed version of Remote Desktop Manager</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMPackage</maml:name> <command:parameter required="false" position="1"> <maml:name>Edition</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Quiet</maml:name> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Force</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Edition</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Quiet</maml:name> <maml:description> <maml:para /> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Update-RDMPackage -detailed". For technical information, type "Get-Help Update-RDMPackage -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-RDMPackage</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Update-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Update RDM repository list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Update RDM repository list.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Update-RDMRepository -detailed". For technical information, type "Get-Help Update-RDMRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-RDMRepository</dev:code> <dev:remarks> <maml:para>Update RDM repository list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Update-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Update attachment document.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Update attachment document.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMSessionAttachment</maml:name> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>Attachment to update the document to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnectionAttachment</command:parameterValue> <dev:type> <maml:name>PSConnectionAttachment</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Filename</maml:name> <maml:description> <maml:para>New document filename</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Update-RDMSessionAttachment -detailed". For technical information, type "Get-Help Update-RDMSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $session = Get-RDMSession -Name MySession; $attachments = Get-RDMSessionAttachment -Session $session; Update-RDMSessionAttachment -Attachment $attachments[0] -Filename 'C:\Mytestfile.txt'</dev:code> <dev:remarks> <maml:para>Update the first attachment to the document at 'C:\Mytestfile.txt'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Update-RDMSessionDocument</command:name> <gl:group>RDMSessionDocument</gl:group> <maml:description> <maml:para>Update attachment document.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMSessionDocument</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Update attachment document.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMSessionDocument</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-RDMSessionDocument</maml:name> <command:parameter required="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Refresh</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>Attachment to update the document to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnectionAttachment</command:parameterValue> <dev:type> <maml:name>PSConnectionAttachment</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Filename</maml:name> <maml:description> <maml:para>New document filename</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session to update the document to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSConnection</command:parameterValue> <dev:type> <maml:name>PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Update-RDMSessionDocument -detailed". For technical information, type "Get-Help Update-RDMSessionDocument -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $session = Get-RDMSession -Name MySession; $attachments = Get-RDMSessionAttachment -Session $session; Update-RDMSessionAttachment -Attachment $attachments[0] -Filename 'C:\Mytestfile.txt'</dev:code> <dev:remarks> <maml:para>Update the first attachment to the document at 'C:\Mytestfile.txt'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:gl="http://schemas.falchionconsulting.com/maml/gl/2013/02" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <command:details> <command:name>Update-RDMUI</command:name> <gl:group>RDMUI</gl:group> <maml:description> <maml:para>Update RDM user interface.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMUI</command:noun> <dev:version>2022.3.1.8</dev:version> </command:details> <maml:description> <maml:para>Update RDM user interface.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>For more information, type "Get-Help Update-RDMUI -detailed". For technical information, type "Get-Help Update-RDMUI -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-RDMUI</dev:code> <dev:remarks> <maml:para>Update RDM user interface.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks /> </command:command> </helpItems> |