Devolutions.PowerShell.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-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>2024.2.6</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="named"> <maml:name>Credentials</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMMessageAttachment</maml:name> <command:parameter required="true" position="named"> <maml:name>File</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>Count</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludePort</maml:name> <command:parameterValue required="true">Int32[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeWellKnownPorts</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeRegisteredPorts</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludePortsUsedByOthersSessions</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Maximum</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Minimum</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>Get-Secret</command:name> <gl:group>Secret</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Secret</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Secret</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalParameters</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</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="named"> <maml:name>VaultName</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 Get-Secret -detailed". For technical information, type "Get-Help Get-Secret -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-SecretInfo</command:name> <gl:group>SecretInfo</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SecretInfo</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SecretInfo</maml:name> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalParameters</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultName</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 Get-SecretInfo -detailed". For technical information, type "Get-Help Get-SecretInfo -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-Secret</command:name> <gl:group>Secret</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>Secret</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Secret</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalParameters</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</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="named"> <maml:name>VaultName</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 Remove-Secret -detailed". For technical information, type "Get-Help Remove-Secret -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-Secret</command:name> <gl:group>Secret</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>Secret</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Secret</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Secret</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalParameters</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</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="named"> <maml:name>Secret</maml:name> <maml:description> <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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultName</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 Set-Secret -detailed". For technical information, type "Get-Help Set-Secret -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-SecretInfo</command:name> <gl:group>SecretInfo</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SecretInfo</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SecretInfo</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalParameters</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</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="named"> <maml:name>VaultName</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 Set-SecretInfo -detailed". For technical information, type "Get-Help Set-SecretInfo -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>Test-SecretVault</command:name> <gl:group>SecretVault</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SecretVault</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-SecretVault</maml:name> <command:parameter required="false" position="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalParameters</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultName</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 Test-SecretVault -detailed". For technical information, type "Get-Help Test-SecretVault -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-DSSession</command:name> <gl:group>DSSession</gl:group> <maml:description> <maml:para>Terminate the connection with your Devolutions Server instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Close</command:verb> <command:noun>DSSession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Terminate the connection with your Devolutions Server by clearing global variables required to keep it up and running.</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 Close-DSSession -detailed". For technical information, type "Get-Help Close-DSSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\\> Close-DSSession</dev:code> <dev:remarks> <maml:para>Terminate the connection with your Devolutions Server instance.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSIsLogged</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSSession</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-DSIsLogged</command:name> <gl:group>DSIsLogged</gl:group> <maml:description> <maml:para>Verify if the session is etablished.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSIsLogged</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Verify if the session is etablished by a previous call to New-DSSession.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSIsLogged</maml:name> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>System.Boolean</maml:name> <maml:uri /> <maml:description> <maml:para>Boolean indicating if the user is logged</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the object representing the server response with a boolean in the data property.</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-DSIsLogged -detailed". For technical information, type "Get-Help Get-DSIsLogged -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSIsLogged</dev:code> <dev:remarks> <maml:para>Verify if the session is still established.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Close-DSSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSSession</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-DSSession</command:name> <gl:group>DSSession</gl:group> <maml:description> <maml:para>Establishes a connection with your Devolutions Server instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSSession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Establishes a connection with your Devolutions Server by retrieving server informations and setting global variables that are required for accessing the API.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSSession</maml:name> <command:parameter required="false" position="1"> <maml:name>Credential</maml:name> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>BaseUri</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainId</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsApplication</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseOAuth</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSSession</maml:name> <command:parameter required="true" position="named"> <maml:name>WindowsAuthentication</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>BaseUri</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainId</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsApplication</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseOAuth</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsApplication</maml:name> <maml:description> <maml:para>Required when using an application user to authenticate</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>BaseUri</maml:name> <maml:description> <maml:para>URL to your Devolutions 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>Credential</maml:name> <maml:description> <maml:para>PSCredential with your Devolutions Server username and password</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainId</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="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Polling delay in seconds. Default value is 15 seconds. The value must be between 3 and 600 seconds.</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="named"> <maml:name>UseOAuth</maml:name> <maml:description> <maml:para>Use OAuth in a web browser.</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="named"> <maml:name>WindowsAuthentication</maml:name> <maml:description> <maml:para>Use Windows Authentication. Must be on Windows.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSSession -detailed". For technical information, type "Get-Help New-DSSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $SecurePassword = ConvertTo-SecureString 'YourPassword' -AsPlainText -Force; $SessionData = @{ BaseURI = "Your/DVLS/Instance/URL" Credentials = New-Object System.Management.Automation.PSCredential ($YourUsername, $SecurePassword) }; New-DSSession @SessionData</dev:code> <dev:remarks> <maml:para>Authenticate with the splatting of the hash table containing the required parameters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $SecurePassword = ConvertTo-SecureString $YourPassword -AsPlainText -Force $Credentials = New-Object System.Management.Automation.PSCredential ($YourUsername, $SecurePassword) $BaseURI = "Your/DVLS/Instance/URL" New-DSSession -Credentials $Credentials -BaseURI $URI</dev:code> <dev:remarks> <maml:para>Authenticate by using the parameters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $SecurePassword = ConvertTo-SecureString $YourPassword -AsPlainText -Force $Credentials = New-Object System.Management.Automation.PSCredential ($YourUsername, $SecurePassword) $BaseURI = "Your/DVLS/Instance/URL" New-DSSession -Credentials $Credentials -BaseURI $URI</dev:code> <dev:remarks> <maml:para>Authenticate using an application user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> New-DSSession -BaseURI "Your/DVLS/Instance/URL" -WindowsAuthentication</dev:code> <dev:remarks> <maml:para>A Windows user authenticates himself with his logged account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 5-----------------------</maml:title> <dev:code>PS C:\> New-DSSession -BaseURI "Your/DVLS/Instance/URL" -UseOAuth</dev:code> <dev:remarks> <maml:para>Authenticate using OAuth in a web browser.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Close-DSSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSIsLogged</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>Add-RDMPrivateSessionAttachment</command:name> <gl:group>RDMPrivateSessionAttachment</gl:group> <maml:description> <maml:para>Add a new attachment to a session in the user vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMPrivateSessionAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Add a new attachment to a session in the user vault. Two parameters are required: Filename, path to the file to attach, and Session, where the file is attached. Additional information can be provided via the title and description. The attachment can be protected by a password. Only advanced data sources support attachment. The user must have the permission to add attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMPrivateSessionAttachment</maml:name> <command:parameter required="false" position="named"> <maml:name>Description</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="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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 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="named"> <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> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMPrivateSession -Name EntryA; Add-RDMPrivateSessionAttachment -Filename 'C:\my\path\filename.ext' -Session $entry</dev:code> <dev:remarks> <maml:para>Attach the file filename.ext, located in 'C:\my\path\', to the session named EntryA.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMPrivateSession -Name EntryA; $password = Read-Host -AsSecureString; Add-RDMPrivateSessionAttachment -Session $entry -Filename 'C:\my\path\filename.ext' -Description 'A description of the attachment' -Title 'Essential' -Password $password -Refresh</dev:code> <dev:remarks> <maml:para>Attach the file filename.ext, located in 'C:\my\path\', to the session named EntryA. The attachment will be protected by the password entered with Read-Host. Additional information is stored. The refresh parameter will update the RDM UI.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Add a new attachment to a session. Two parameters are required: Filename, path to the file to attach, and Session, where the file is attached. Additional information can be provided via the title and description. The attachment can be protected by a password. Only advanced data sources support attachment. The user must have the permission to add attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMSessionAttachment</maml:name> <command:parameter required="false" position="named"> <maml:name>Description</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="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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 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="named"> <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> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMSession -Name EntryA; Add-RDMSessionAttachment -Filename 'C:\my\path\filename.ext' -Session $entry</dev:code> <dev:remarks> <maml:para>Attach the file filename.ext, located in 'C:\my\path\', to the session named EntryA.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMSession -Name EntryA; $password = Read-Host -AsSecureString; Add-RDMSessionAttachment -Filename 'C:\my\path\filename.ext' -Session $entry -Description 'A description of the attachment' -Title 'Essential' -Password $password -Refresh</dev:code> <dev:remarks> <maml:para>Attach the file filename.ext, located in 'C:\my\path\', to the session named EntryA. The attachment will be protected by the password entered with Read-Host. Additional information is stored. The refresh parameter will update the RDM UI.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Start-RDMInstance</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</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="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="false" position="named"> <maml:name>DontChangeID</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludePasswordHistory</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubConnections</maml:name> </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="named"> <maml:name>ResolveVariables</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="false" position="named"> <maml:name>CaseSensitive</maml:name> </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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="false" position="named"> <maml:name>CaseSensitive</maml:name> </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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="named"> <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="named"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>Descending</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EntryName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MachineName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnCloseComment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnOpenComment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SortField</maml:name> <command:parameterValue required="true">Connection | User | Vault</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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">Html | Csv | Xml</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UTC</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>ClearApplicationLockInformation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloudCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Datasources</maml:name> <command:parameterValue required="true">PSDataSource[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceAlwaysRetrieveNewRegistration</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DataSourceCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxySettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationEmail</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationKey</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationName</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavedInstallationPaths</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavedTemplates</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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="named"> <maml:name>RegistrationKey</maml:name> <maml:description> <maml:para>Registration keys are now stored in the datasource. Avoid using this parameter. 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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>ShowAllEntries</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowPwnedPassword</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowVPNAnalysis</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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">Html | Csv | Xml</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Private</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ReportType</maml:name> <command:parameterValue required="true">PasswordAnalyzer</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>CSV</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Sessions</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-RDMSession</maml:name> <command:parameter required="true" position="named"> <maml:name>HTML</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Sessions</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeSessionPassword</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-RDMSession</maml:name> <command:parameter required="true" position="named"> <maml:name>XML</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Sessions</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Version</maml:name> <command:parameterValue required="true">v1 | v2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeShortcuts</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAttachements</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeFavorite</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveAllFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeShortcuts</maml:name> <maml:description> <maml:para>Exclude shortcuts 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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="named"> <maml:name>IncludeDocumentation</maml:name> <maml:description> <maml:para>Include entry documentation 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="named"> <maml:name>IncludeFavorite</maml:name> <maml:description> <maml:para>keep the favorite status.</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="named"> <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="true (ByValue)" position="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveAllFolders</maml:name> <maml:description> <maml:para>Remove all folders. All other entries will have their group set at the root level.</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="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Export file version for '.xml' and '.rdm' files. The default value is v2.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDMExportVersion</command:parameterValue> <dev:type> <maml:name>RDMExportVersion</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="named"> <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: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-RDMEntry; $password = Read-Host -AsSecureString "Password"; Export-RDMSession -XML -Path C:\MyPath\MyFilename.rdm -Sessions $sessions -Password $password</dev:code> <dev:remarks> <maml:para>Retrieves the list of available sessions and export them to a rdm file at C:\MyPath\Filename.rdm.</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 executable path of Remote Desktop Manager or the specified tool</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMCommand</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Retrieve the executable path of Remote Desktop Manager or the specified tool</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>Tool</maml:name> <command:parameterValue required="true">Jetsocat | SSH</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>Tool</maml:name> <maml:description> <maml:para>Define which tool is returned</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>Executable path of Remote Desktop Manager or specified tool</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 1-----------------------</maml:title> <dev:code>PS C:\> $execPath = Get-RDMCommand</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $execPath = Get-RDMCommand -Tool Jetsocat</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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Retrieve the active data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMCurrentDataSource</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMCurrentRepository</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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>2024.2.6</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>2024.2.6</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="2"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Retrieve the latest version download url</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMDiagnostic</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the instance info</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMInstance</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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.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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the current data source offline</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMOffline</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the current data source online</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMOnline</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Get-RDMOpenedSession</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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">Free | Enterprise</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Platform</maml:name> <command:parameterValue required="true">Linux | OSX | Windows</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Get-RDMPersonalCredentials</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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="named"> <maml:name>ExportConnection</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="named"> <maml:name>ExportConnections</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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 of a session in the user vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPrivateSessionAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get session attachments of a session in the user vault. Only advanced data sources support attachment.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionAttachment</maml:name> <command:parameter required="true" position="named"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]</maml:name> <maml:uri /> <maml:description> <maml:para>Array of PSConnectionAttachment associated with a 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-RDMPrivateSessionAttachment -detailed". For technical information, type "Get-Help Get-RDMPrivateSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMPrivateSession -Name EntryA; $attachments = Get-RDMPrivateSessionAttachment -Session $entry; $attachments[0].Description = 'New description'; Set-RDMPrivateSessionAttachment -Attachment $attachments[0]</dev:code> <dev:remarks> <maml:para>Get the attachments of the session EntryA in the user vault. Change the description of the desired attachment and save the modification.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMPrivateSession -Name EntryA; $attachments = Get-RDMPrivateSessionAttachment -Session $entry; Update-RDMSessionAttachment -Attachment $attachments[0] -Filename 'C:\another\path\filename.ext'</dev:code> <dev:remarks> <maml:para>Get the attachments of the session EntryA in the user vault. Update the document and save it.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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-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>2024.2.6</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="named"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Session name. No characters are interpreted as wildcards.</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="true" pipelineInput="false" position="named"> <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>2024.2.6</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="named"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GetID</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get documents stored in database</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivateSessionDocumentStoredInDatabase</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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.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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="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>2024.2.6</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="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Get-RDMPrivilegedAccount</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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>2024.2.6</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>2024.2.6</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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-RDMRoleRepositoryAccess</command:name> <gl:group>RDMRoleRepositoryAccess</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>RDMRoleRepositoryAccess</command:noun> <dev:version>2024.2.6</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-RDMRoleRepositoryAccess</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMRoleRepositoryAccess</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="false" position="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>Role</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">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>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-RDMRoleRepositoryAccess -detailed". For technical information, type "Get-Help Get-RDMRoleRepositoryAccess -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-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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMRootSession</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Get session attachments of a session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get session attachments of a session. Only advanced data sources support attachment.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionAttachment</maml:name> <command:parameter required="true" position="named"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]</maml:name> <maml:uri /> <maml:description> <maml:para>Array of PSConnectionAttachment associated with a 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-RDMSessionAttachment -detailed". For technical information, type "Get-Help Get-RDMSessionAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMSession -Name EntryA; $attachments = Get-RDMSessionAttachment -Session $entry; $attachments[0].Description = 'New description'; Set-RDMSessionAttachment -Attachment $attachments[0]</dev:code> <dev:remarks> <maml:para>Get the attachments of the session EntryA. Change the description of the desired attachment and save the modification.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMSession -Name EntryA; $attachments = Get-RDMSessionAttachment -Session $entry; Update-RDMSessionAttachment -Attachment $attachments[0] -Filename 'C:\another\path\filename.ext'</dev:code> <dev:remarks> <maml:para>Get the attachments of the session EntryA. Update the document and save it.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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-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>2024.2.6</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="named"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Session name. No characters are interpreted as wildcards.</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="true" pipelineInput="false" position="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the result by the connection type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ConnectionType</command:parameterValue> <dev:type> <maml:name>ConnectionType</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>2024.2.6</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="named"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GetID</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>Filter</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>Filter</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>Filter</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get documents stored in database</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSessionDocumentStoredInDatabase</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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.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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="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>2024.2.6</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="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionPassword</maml:name> <command:parameter required="true" position="named"> <maml:name>MyPersonalCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSessionPassword</maml:name> <command:parameter required="true" position="named"> <maml:name>MyPrivilegedAccount</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</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="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreationDateEnd</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreationDateStart</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>DueDateEnd</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DueDateStart</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Entry</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Status</maml:name> <command:parameterValue required="true">TodoStatus[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Name of the task. No characters are interpreted as wildcards.</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="true" pipelineInput="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="2"> <maml:name>Type</maml:name> <command:parameterValue required="true">Both | Local | Shared</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>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>2024.2.6</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>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>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:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $user = Get-RDMUser -Name MyUser; $user.UserInfo.UserProfile.Company = 'UsersCompany'; $user.UserInfo.UserProfile.Department = 'UsersDepartment'; $user.UserInfo.UserProfile.Address = '123 UsersAddress'; $user.UserInfo.UserProfile.Phone = '555-0100'; Set-RDMUser -User $user</dev:code> <dev:remarks> <maml:para>Update information about the user MyUser.</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>2024.2.6</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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">Free | Enterprise</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Import RDM sessions from a file. To save the sessions in the data source, the parameter SetSession must be used. The supported files are '.rdm' and '.json'.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-RDMSession</maml:name> <command:parameter required="false" position="4"> <maml:name>DuplicateAction</maml:name> <command:parameterValue required="true">Add | Overwrite | Ignore</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="true" position="1"> <maml:name>Path</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="named"> <maml:name>KeepID</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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="named"> <maml:name>KeepID</maml:name> <maml:description> <maml:para>Keep the entries' ID. Unwanted behaviors, such as moving an entry if imported in the same database, might occurs if this option is present.</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>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", "JSON: .json"</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="named"> <maml:name>SetSession</maml:name> <maml:description> <maml:para>Save all imported sessions. Required to import the documents and attachments included in sessions.</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.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>2024.2.6</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">Free | Enterprise</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="named"> <maml:name>NoDesktopShortcut</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoStartMenuShortcut</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Quiet</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="2"> <maml:name>ParentSession</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>UseInheritedVPN</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseParentCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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="named"> <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="named"> <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="named"> <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>2024.2.6</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="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>Move-RDMPrivateSession</command:name> <gl:group>RDMPrivateSession</gl:group> <maml:description> <maml:para>Move entries to the specified group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>RDMPrivateSession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Move entries to the specified group. If an entry is a group, all the entries it contains will be also moved. It is not allowed to move a parent group to one of its child group. It is not allowed to have a group with a duplicate name. In those two cases, the group will not be moved to the destination. To obtain the entries obtained from the user input that actually moved, use the PassThru parameter.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-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="true" position="2"> <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-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="true" position="2"> <maml:name>ToVaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMPrivateSession</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMPrivateSession</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ToVaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMPrivateSession</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>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMPrivateSession</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>ToVaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Destination</maml:name> <maml:description> <maml:para>New group value. It must be the complete path to the folder. It is corresponding to the Group attribute to the PSConnection object.</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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the entries to be moved.</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entries to be moved.</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="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the entries to be moved.</maml:para> </maml:description> <command:parameterValue required="true" 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the entries with the new group. Entries in a moved group will not be returned unless they were passed to the command. All unmodified entries are not returned.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh RDM UI. If RDM in not open, nothing happens.</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>ToVaultID</maml:name> <maml:description> <maml:para>ID of the vault where the entries will be moved. Cannot transfer entries from the user 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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of PSConnection to move.</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>With the PassThru parameter, all entries specified by the input parameters that actually moved will be returned as an 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 Move-RDMPrivateSession -detailed". For technical information, type "Get-Help Move-RDMPrivateSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMPrivateSession -Name FolderToBeMoved | Move-RDMPrivateSession -Destination ""</dev:code> <dev:remarks> <maml:para>Move the group named FolderToBeMoved and all entries it contains to the root</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Move-RDMPrivateSession -Name EntryA, EntryB, EntryE -Destination Greener\Pastures</dev:code> <dev:remarks> <maml:para>Move the entries EntryA, EntryB, and EntryE to the group Pastures whose parent is the group Greener.</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>Move-RDMSession</command:name> <gl:group>RDMSession</gl:group> <maml:description> <maml:para>Move entries to the specified group or a new vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Move entries to the specified group. If an entry is a group, all the entries it contains will be also moved. To transfer to a new vault, its ID must used. If a transfered folder contains an non transfered entry, the folder will be copied instead of moved. Only an administrator can transfer entries between vaults. Its not possible to do so from or to the user vault. It is not allowed to move a parent group to one of its child group. It is not allowed to have a group with a duplicate name. In those two cases, the group will not be moved to the destination. To obtain the entries obtained from the user input that actually moved, use the PassThru parameter.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-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="true" position="2"> <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-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="true" position="2"> <maml:name>ToVaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMSession</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ToVaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMSession</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>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-RDMSession</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>ToVaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Destination</maml:name> <maml:description> <maml:para>New group value. It must be the complete path to the folder. It is corresponding to the Group attribute to the PSConnection object.</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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the entries to be moved.</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entries to be moved.</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="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the entries to be moved.</maml:para> </maml:description> <command:parameterValue required="true" 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the entries with the new group. Entries in a moved group will not be returned unless they were passed to the command. All unmodified entries are not returned.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh RDM UI. If RDM in not open, nothing happens.</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>ToVaultID</maml:name> <maml:description> <maml:para>ID of the vault where the entries will be moved. Cannot transfer entries from the user 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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of PSConnection to move.</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>With the PassThru parameter, all entries specified by the input parameters that actually moved will be returned as an 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 Move-RDMSession -detailed". For technical information, type "Get-Help Move-RDMSession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession -Name FolderToBeMoved | Move-RDMSession -Destination ""</dev:code> <dev:remarks> <maml:para>Move the group named FolderToBeMoved and all entries it contains to the root</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Move-RDMSession -Name EntryA, EntryB, EntryE -Destination Greener\Pastures</dev:code> <dev:remarks> <maml:para>Move the entries EntryA, EntryB, and EntryE to the group Pastures whose parent is the group Greener.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $vaultDestination = Get-RDMRepository -Name 'VaultA'; Move-RDMSession -Name EntryA, EntryB, EntryE -ToVaultID $vaultDestination.ID</dev:code> <dev:remarks> <maml:para>Move the entries EntryA, EntryB, and EntryE from the current vault to the vault named 'VaultA'.</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>2024.2.6</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="named"> <maml:name>SQLite</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>SQLServer</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrustServerCertificate</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>SQLServer</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IntegratedSecurity</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrustServerCertificate</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>SQLServer</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Database</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DontSavePassword</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrustServerCertificate</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserEditable</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>DOD</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptingApplicationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptingTenantID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>Dropbox</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>DVLS</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptingApplicationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptingTenantID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>DVLS</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IntegratedSecurity</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>XML</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>MySQL</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Hostname</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Schema</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>HubBusiness</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptingApplicationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptingTenantID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Server</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMDataSource</maml:name> <command:parameter required="true" position="named"> <maml:name>HubPersonal</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetDatasource</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Not supported anymore</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="named"> <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="named"> <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="named"> <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="named"> <maml:name>MySQL</maml:name> <maml:description> <maml:para>Not supported anymore</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="named"> <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="named"> <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="named"> <maml:name>Schema</maml:name> <maml:description> <maml:para>Not supported anymore.</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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>TrustServerCertificate</maml:name> <maml:description> <maml:para>Trust the server's self-signed certificate</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DefaultBoolean</command:parameterValue> <dev:type> <maml:name>DefaultBoolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="false" position="named"> <maml:name>AutoAssign</maml:name> </command:parameter> <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="named"> <maml:name>SetLicense</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="false" position="3"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</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:parameter required="true" position="2"> <maml:name>Notes</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:parameter required="true" position="4"> <maml:name>StartDateTime</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="3"> <maml:name>Connections</maml:name> <command:parameterValue required="true">Connection[]</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="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExportConnection</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="4"> <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>2024.2.6</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="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:parameter required="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Default</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>MinimumLength</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimumUppercase</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimumSymbol</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimumLowercase</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimumDigit</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeCharacter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Passphrase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WordSeparator</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassphraseLength</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Dictionary</maml:name> <command:parameterValue required="true">English | French</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CapitalizeFirstLetter</maml:name> <command:parameterValue required="true">None | FirstWord | All</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AppendNumber</maml:name> <command:parameterValue required="true">None | Randomly | LastWord</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AppendNumberFrequency</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Pattern</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Pattern</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeCharacter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Shuffle</maml:name> </command:parameter> </command:syntaxItem> <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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Pronounceable</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>MinimumLength</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CaseMode</maml:name> <command:parameterValue required="true">LowerCase | UpperCase | MixedCase | RandomCase | RandomMixedCase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MorePronounceable</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDigit</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCharacter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">HumanReadable</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Digit</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Syllables</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Symbols</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">SpecifiedSettings</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Length</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>XMLCompliant</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Uppercase</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Underline</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Special</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Space</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Minus</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lowercase</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCharacterCount</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCharacter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HighANSI</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeCharacter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Digit</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Bracket</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <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:parameter required="false" position="1"> <maml:name>TemplateName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Strong</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendNumber</maml:name> <maml:description> <maml:para>Strategy to append a number to words. For the Randomly strategy, the AppendNumberFrequency parameter allows to chose how many words will end with a number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PassphraseAppendNumber</command:parameterValue> <dev:type> <maml:name>PassphraseAppendNumber</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendNumberFrequency</maml:name> <maml:description> <maml:para>Set the number of words who will be appended by a number. Only for the Randomly strategy and can not be bigger than the length. By default, the value is set at 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="named"> <maml:name>Bracket</maml:name> <maml:description> <maml:para>The password will include at least the specified number of bracket characters ([, ], {, }, (, ), <, >). If not set, the password will not contain bracket characters.</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="named"> <maml:name>CapitalizeFirstLetter</maml:name> <maml:description> <maml:para>Strategy of first letter capitalization. By default, no capitalization is present.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PassphraseCapitalizeFirstLetter</command:parameterValue> <dev:type> <maml:name>PassphraseCapitalizeFirstLetter</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="named"> <maml:name>CaseMode</maml:name> <maml:description> <maml:para>The case mode of the password. The mixed case mode means every pronounceable part of the password will start with a capital letter. The random mixed case means some pronounceable part of the password will start with a capital letter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PronounceableCaseMode</command:parameterValue> <dev:type> <maml:name>PronounceableCaseMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dictionary</maml:name> <maml:description> <maml:para>Source of the words. By default, an english dictionary is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PassphraseDictionary</command:parameterValue> <dev:type> <maml:name>PassphraseDictionary</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="named"> <maml:name>Digit</maml:name> <maml:description> <maml:para>The password will contain the specified number of digits.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeCharacter</maml:name> <maml:description> <maml:para>Password will not contained the specified characters.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HighANSI</maml:name> <maml:description> <maml:para>The password will include at least the specified number of high ANSI characters (¶, ò, ®, à, Ô, ...). If not set, the password will not contain high ANSI characters.</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="named"> <maml:name>IncludeCharacter</maml:name> <maml:description> <maml:para>Add the specified characters to the allowed characters in the 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeCharacterCount</maml:name> <maml:description> <maml:para>The password will contain at least the specified number of characters from the custom characters list.</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="named"> <maml:name>IncludeDigit</maml:name> <maml:description> <maml:para>Include digits in the 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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Length</maml:name> <maml:description> <maml:para>Minimum password length must be at least 1.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Lowercase</maml:name> <maml:description> <maml:para>The password will include at least the specified number of lowercase characters. If not set, the password will not contain lowercase characters.</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="named"> <maml:name>MinimumDigit</maml:name> <maml:description> <maml:para>Minimum digits included in the password. If it is 0, digits will not be included in the password.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLength</maml:name> <maml:description> <maml:para>Minimum password length must be at least 1. If no minimum of a type of character is specified, the password might contain lowercase, uppercase and numerical characters.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumLowercase</maml:name> <maml:description> <maml:para>Minimum lowercase characters included in the password. If it is 0, lowercase characters will not be included in the password.</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="named"> <maml:name>MinimumSymbol</maml:name> <maml:description> <maml:para>Minimum symbol characters included in the password. If it is 0, symbol characters will not be included in the password.</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="named"> <maml:name>MinimumUppercase</maml:name> <maml:description> <maml:para>Minimum uppercase characters included in the password. If it is 0, uppercase characters will not be included in the password.</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="named"> <maml:name>Minus</maml:name> <maml:description> <maml:para>The password will include at least the specified number of minus characters (-). If not set, the password will not contain minus characters.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <maml:name>MorePronounceable</maml:name> <maml:description> <maml:para>To make te password more pronounceable, it will avoid double consonants.</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="named"> <maml:name>PassphraseLength</maml:name> <maml:description> <maml:para>Number of words composing the password. Must have between 2 and 20 words. By default, 5 words will composed the password.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Pattern</maml:name> <maml:description> <maml:para>The password will follow this pattern: Key | Description | Sample a | Lower-Case Alphanumeric | abcdefghijklmnopqrstuvwxyz 0123456789 A | Mixed-Case Alphanumeric | ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz 0123456789 b | Bracket | ()[]{}<> c | Lower-Case Consonant | bcdfghjklmnpqrstvwxyz C | Mixed-Case Consonant | BCDFGHJKLMNPQRSTVWXYZ bcdfghjklmnpqrstvwxyz d | Digit | 0123456789 h | Lower-Case Hex Character | 0123456789 abcdef H | Upper-Case Hex Character | 0123456789 ABCDEF l | Lower-Case Letter | abcdefghijklmnopqrstuvwxyz L | Mixed-Case Letter | ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz p | Punctuation | ,.;: s | Printable 7-Bit Special Character | !"#$%&'()*+,-./:;<=>?[\]^_{|}~ S | Printable 7-Bit ASCII | A-Z, a-z, 0-9, !"#$%&'()*+,-./:;<=>?[\]^_{|}~ u | Upper-Case Letter | ABCDEFGHIJKLMNOPQRSTUVWXYZ U | Upper-Case Alphanumeric | ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789 v | Lower-Case Vowel | aeiou V | Mixed-Case Vowel | AEIOU aeiou x | High ANSI | From '~' to U255 (excluding U255) z | Upper-Case Consonant | BCDFGHJKLMNPQRSTVWXYZ Z | Upper-Case Vowel | AEIOU \ | Escape (Fixed Char) | Use following character as is {n} | Escape (Repeat) | Repeat the previous character n times [x] | Custom character | Define a custom character sequence</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>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="named"> <maml:name>Shuffle</maml:name> <maml:description> <maml:para>Shuffle the characters.</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="named"> <maml:name>Space</maml:name> <maml:description> <maml:para>The password will include at least the specified number of space characters ( ). If not set, the password will not contain space characters.</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="named"> <maml:name>Special</maml:name> <maml:description> <maml:para>The password will include at least the specified number of special characters (!, $, %, &, ...). If not set, the password will not contain special characters.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Syllables</maml:name> <maml:description> <maml:para>The password will contain the specified number of syllables. At least one is requiered.</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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Symbols</maml:name> <maml:description> <maml:para>The password will contain the specified number of symbols (*, ?, /, \, %, $, #, @, !, ~).</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: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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Underline</maml:name> <maml:description> <maml:para>The password will include at least the specified number of underline characters (_). If not set, the password will not contain underline characters.</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="named"> <maml:name>Uppercase</maml:name> <maml:description> <maml:para>The password will include at least the specified number of uppercase characters. If not set, the password will not contain uppercase characters.</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="named"> <maml:name>WordSeparator</maml:name> <maml:description> <maml:para>Character separating words. By default, '-' will be used.</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="named"> <maml:name>XMLCompliant</maml:name> <maml:description> <maml:para>The password will not contain those characters: (&, <, >, ', ").</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 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:example> <maml:title>------------------EXAMPLE 6-----------------------</maml:title> <dev:code>PS C:\> $pwd = New-RandomPassword -Mode Passphrase -AppendNumber LastWord -CapitalizeFirstLetter FirstWord -PassphraseLength 10 -WordSeparator ""</dev:code> <dev:remarks> <maml:para>Generate a random password composed of 10 unspaced english words. Its first letter is the only one capitalized, and it ends with the only digit. </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>2024.2.6</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="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="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>VaultContentType</maml:name> <command:parameterValue required="true">Default | Everything | Secrets | Credentials | BusinessInformation</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetRepository</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>VaultContentType</maml:name> <maml:description> <maml:para>Specify the vault content type. Except for Default and Everything, it will restrict which type of entries allowed in the vault.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultContentType</command:parameterValue> <dev:type> <maml:name>VaultContentType</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>2024.2.6</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="false" position="3"> <maml:name>SetRole</maml:name> </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="true" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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>2024.2.6</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="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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 | ScriptDashboard | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentAttachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentFileName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Host</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>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="4"> <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="1"> <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="named"> <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="named"> <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="2"> <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", "ScriptDashboard", "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>2024.2.6</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="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">OpenSSH</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Round</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">OpenSSH</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Round</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePublicKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMSSHKey</maml:name> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">PKCS1</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Encryption</maml:name> <command:parameterValue required="true">AES_128_CBC | DES_EDE3_CBC | AES_192_CBC | AES_256_CBC</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">PKCS1</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Encryption</maml:name> <command:parameterValue required="true">AES_128_CBC | DES_EDE3_CBC | AES_192_CBC | AES_256_CBC</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePublicKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMSSHKey</maml:name> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">PKCS8</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Encryption</maml:name> <command:parameterValue required="true">MD5_DES | SHA1_DES | SHA1_RC4_128 | SHA1_3DES | SHA1_2DES</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Round</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">PKCS8</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Encryption</maml:name> <command:parameterValue required="true">MD5_DES | SHA1_DES | SHA1_RC4_128 | SHA1_3DES | SHA1_2DES</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Round</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePublicKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMSSHKey</maml:name> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">Putty</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Format</maml:name> <command:parameterValue required="true">Putty</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePrivateKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePublicKey</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>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="named"> <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="false" position="named"> <maml:name>Encryption</maml:name> <maml:description> <maml:para>The encryption used with the passphrase to save the private key in the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SshPkcs1Encryption</command:parameterValue> <dev:type> <maml:name>SshPkcs1Encryption</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <maml:name>Round</maml:name> <maml:description> <maml:para>The number of rounds of key derivations. The default value is 64 rounds. The maximum value for the OpenSSH format is 1000 rounds. For PKCS8, the maximum number of rounds is 32768.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="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="named"> <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="named"> <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>2024.2.6</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="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Entry</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DueDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Priority</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetTask</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Status</maml:name> <command:parameterValue required="true">Assigned | Cancelled | Closed | Done | InProgress | Open | Postponed</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="2"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="1"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="false" position="named"> <maml:name>SetTemplate</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="2"> <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>2024.2.6</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="named"> <maml:name>IntegratedSecurity</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Login</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Administrator</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disable</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoginEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipCreateSQLServerLogin</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthentificationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthenticationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BypassAzureADValidationEvenIfUnsupported</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetUser</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMUser</maml:name> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Login</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Administrator</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disable</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoginEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipCreateSQLServerLogin</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthentificationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthenticationType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BypassAzureADValidationEvenIfUnsupported</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetUser</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $user = = New-RDMUser -AuthenticationType SqlServer -Login 'PSTest' -Password (ConvertTo-SecureString -String 'password' -AsPlainText -Force); $user.UserInfo.UserProfile.Company = 'UsersCompany'; $user.UserInfo.UserProfile.Department = 'UsersDepartment'; $user.UserInfo.UserProfile.Address = '123 UsersAddress'; $user.UserInfo.UserProfile.Phone = '555-0100'; Set-RDMUser -User $user</dev:code> <dev:remarks> <maml:para>Create a user and add some details about him before saving him.</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 in Remote Desktop Manager app.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Open</command:verb> <command:noun>RDMSession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Open the specified session in Remote Desktop Manager app.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RDMSession</maml:name> <command:parameter required="false" position="named"> <maml:name>Embedded</maml:name> </command:parameter> <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="named"> <maml:name>Silent</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceExternal</maml:name> </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="false" position="2"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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>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="named"> <maml:name>Embedded</maml:name> <maml:description> <maml:para>Open the session within PowerShell. </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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="2"> <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:navigationLink> <maml:linkText>Send-RDMSessionCommand</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>2024.2.6</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="false" position="5"> <maml:name>Connection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <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="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TemplateID</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <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="4"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="3"> <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="6"> <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="2"> <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>2024.2.6</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="named"> <maml:name>DontSetSessions</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </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="named"> <maml:name>DontSetSessions</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="false" position="3"> <maml:name>DuplicateAction</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="true" position="1"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>2024.2.6</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="named"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Download</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeRead</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>From</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MarkAsRead</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>Subject</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Vault</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>Register-RDMSecretVault</command:name> <gl:group>RDMSecretVault</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>RDMSecretVault</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-RDMSecretVault</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserVault</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Secret vault's 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="named"> <maml:name>UserVault</maml:name> <maml:description> <maml:para>Use the current data source's user 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 Register-RDMSecretVault -detailed". For technical information, type "Get-Help Register-RDMSecretVault -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-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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="1"> <maml:name>License</maml:name> <command:parameterValue required="true">PSLicenseInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="2"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMMessage</maml:name> <command:parameter required="true" position="1"> <maml:name>Message</maml:name> <command:parameterValue required="true">DataSourceMessage</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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="1"> <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>2024.2.6</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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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-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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove session attachment. Only advanced data sources support attachment. The user must have the permission to delete attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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; Remove-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> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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-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>2024.2.6</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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="named"> <maml:name>All</maml:name> </command:parameter> <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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="named"> <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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="true" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="true" position="1"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMSessionDocumentation</maml:name> <command:parameter required="true" position="2"> <maml:name>Page</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:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Task</maml:name> <command:parameterValue required="true">PSTask</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="named"> <maml:name>DeleteSQLLogin</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>DeleteSQLLogin</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Rename the group in a connection. All entries contained in the folder will also be updated.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-RDMGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>NewGroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Rename-RDMGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>NewGroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Session</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the session to be renamed.</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="named"> <maml:name>NewGroupName</maml:name> <maml:description> <maml:para>New group name. Must not include '\'.</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="named"> <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>2024.2.6</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>2024.2.6</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="false" position="3"> <maml:name>Body</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <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="named"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpiresIn</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpiresOn</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-RDMMessage</maml:name> <command:parameter required="false" position="named"> <maml:name>Body</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="named"> <maml:name>Subject</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpiresIn</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpiresOn</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>Send-RDMSessionCommand</command:name> <gl:group>RDMSessionCommand</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>Send</command:verb> <command:noun>RDMSessionCommand</command:noun> <dev:version>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Send-RDMSessionCommand</maml:name> <command:parameter required="true" position="1"> <maml:name>Container</maml:name> <command:parameterValue required="true">PSEmbeddedContainer</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Command</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ShowReply</maml:name> </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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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>Command</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="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>Container</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="false">PSEmbeddedContainer</command:parameterValue> <dev:type> <maml:name>PSEmbeddedContainer</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>Password</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="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="3"> <maml:name>ShowReply</maml:name> <maml:description> <maml:para>PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.</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 Send-RDMSessionCommand -detailed". For technical information, type "Get-Help Send-RDMSessionCommand -full".</maml:para> </maml:alert> </maml:alertSet> <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>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>2024.2.6</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="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMCurrentRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>Repository</maml:name> <command:parameterValue required="true">PSRepositoryInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" 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-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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMDatasourceMasterKey</maml:name> <command:parameter required="true" position="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="2"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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="3"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</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="3"> <maml:name>AlwaysAskPassword</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <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="3"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>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>2024.2.6</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="false" position="named"> <maml:name>ImportConnection</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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="false" position="named"> <maml:name>ImportConnection</maml:name> </command:parameter> <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="named"> <maml:name>PrivateVault</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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>2024.2.6</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</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 attachments in the user vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Save attachments in the user vault. Only advanced data sources support attachment. The user must have the permission to edit attachments.</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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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>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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of PSConnectionAttachment to save. Can be obtained from Get-RDMPrivateSessionAttachment.</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-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:\> $entry = Get-RDMPrivateSession -Name EntryA; $attachments = Get-RDMPrivateSessionAttachment -Session $entry; $attachments[0].Description = 'New description'; Set-RDMPrivateSessionAttachment -Attachment $attachments[0]</dev:code> <dev:remarks> <maml:para>Get the attachments of the session EntryA in the user vault. Change the description of the desired attachment and save the modification.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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-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>2024.2.6</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="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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>2024.2.6</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="named"> <maml:name>CredentialEntryID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionCredentials</maml:name> <command:parameter required="true" position="named"> <maml:name>CredentialsType</maml:name> <command:parameterValue required="true">SessionSpecific | Embedded | Parent | Inherited | MyDefault | Personal | None | PrivateVaultSearch</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the domain from the specified session. To persist the new domain, the switch SetSession must be used.</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="true" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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: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>Entry with the newly assigned domain is returned when PassThru is used.</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" -SetSession</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" -SetSession -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:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSession -Name 'UniqueName' | Set-RDMUserVaultSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMUserVaultSessionPassword -Password $securePassword -PassThru | Set-RDMUserVaultSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMUserVaultSession</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMUserVaultSession call.</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>2024.2.6</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. To persist the new password, the switch SetSession must be used.</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="true" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="3"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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>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="3"> <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="4"> <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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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: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>Entry with the newly assigned password is returned when PassThru is used.</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") -SetSession</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") -SetSession</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:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMUserVaultSession -Name 'UniqueName' | Set-RDMUserVaultSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMUserVaultSessionPassword -Password $securePassword -PassThru | Set-RDMUserVaultSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMUserVaultSession</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMUserVaultSession call.</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>2024.2.6</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="named"> <maml:name>Refresh</maml:name> </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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="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="named"> <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>2024.2.6</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="3"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Status</maml:name> <command:parameterValue required="true">Default | Disabled | Expired | Locked | Warning</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="3"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Status</maml:name> <command:parameterValue required="true">Default | Disabled | Expired | Locked | Warning</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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="3"> <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="2"> <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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the username on the specified session. To persist the new domain, the switch SetSession must be used.</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="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Entry with the newly assigned username is returned when PassThru is used.</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" -SetSession</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 -SetSession</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:\> Get-RDMUserVaultSession -Name 'UniqueName' | Set-RDMUserVaultSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMUserVaultSessionPassword -Password $securePassword -PassThru | Set-RDMUserVaultSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMUserVaultSession</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMUserVaultSession call.</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>2024.2.6</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="4"> <maml:name>AlwaysAskPassword</maml:name> <command:parameterValue required="true">Boolean</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="3"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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: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-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>2024.2.6</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="2"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</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:parameter required="true" position="3"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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="3"> <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>2024.2.6</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="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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-RDMSessionAttachment</command:name> <gl:group>RDMSessionAttachment</gl:group> <maml:description> <maml:para>Save attachments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Save attachments. Only advanced data sources support attachment.</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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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>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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of PSConnectionAttachment to save. Can be obtained from Get-RDMSessionAttachment.</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-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:\> $entry = Get-RDMSession -Name EntryA; $attachments = Get-RDMSessionAttachment -Session $entry; $attachments[0].Description = 'New description'; Set-RDMSessionAttachment -Attachment $attachments[0]</dev:code> <dev:remarks> <maml:para>Get the attachments of the session EntryA in the user vault. Change the description of the desired attachment and save the modification.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMSessionAttachment</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-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>2024.2.6</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="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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>2024.2.6</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="named"> <maml:name>CredentialEntryID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionCredentials</maml:name> <command:parameter required="true" position="named"> <maml:name>CredentialsType</maml:name> <command:parameterValue required="true">SessionSpecific | Embedded | Parent | Inherited | MyDefault | Personal | None | PrivateVaultSearch</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSConnection</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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>2024.2.6</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="2"> <maml:name>Handbook</maml:name> <command:parameterValue required="true">PSHandbook</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLastPage</maml:name> </command:parameter> <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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>AsLastPage</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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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: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="named"> <maml:name>AsLastPage</maml:name> </command:parameter> <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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="false" position="2"> <maml:name>DefaultPage</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="false" position="2"> <maml:name>DefaultPage</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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMSessionDocumentation</maml:name> <command:parameter required="false" position="2"> <maml:name>DefaultPage</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:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="2"> <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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the domain from the specified session. To persist the new domain, the switch SetSession must be used.</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="true" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use SetSession to persist the modification.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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: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>Entry with the newly assigned domain is returned when PassThru is used.</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" -SetSession</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" -SetSession -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:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession -Name 'UniqueName' | Set-RDMSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMSessionPassword -Password $securePassword -PassThru | Set-RDMSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMSession</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMSession call.</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>2024.2.6</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. To persist the new password, the switch SetSession must be used.</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="true" position="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="3"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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>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="3"> <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="4"> <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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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: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>Entry with the newly assigned password is returned when PassThru is used.</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") -SetSession</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") -SetSession</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:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession -Name 'UniqueName' | Set-RDMSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMSessionPassword -Password $securePassword -PassThru | Set-RDMSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMSession</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMSession call.</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>2024.2.6</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="named"> <maml:name>Refresh</maml:name> </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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="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="named"> <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>2024.2.6</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="3"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Status</maml:name> <command:parameterValue required="true">Default | Disabled | Expired | Locked | Warning</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="3"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Status</maml:name> <command:parameterValue required="true">Default | Disabled | Expired | Locked | Warning</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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="3"> <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="2"> <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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the username on the specified session. To persist the new username, the switch SetSession must be used.</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="true" position="2"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> <maml:description> <maml:para>Entry with the newly assigned username is returned when PassThru is used.</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:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMSession -Name 'UniqueName' | Set-RDMSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMSessionPassword -Password $securePassword -PassThru | Set-RDMSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMSession</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMSession call.</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>2024.2.6</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="2"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSQLiteDatasourcePassword</maml:name> <command:parameter required="true" position="named"> <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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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="named"> <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>2024.2.6</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="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DueDate</maml:name> <command:parameterValue required="true">DateFilter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Priority</maml:name> <command:parameterValue required="true">DateFilter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Status</maml:name> <command:parameterValue required="true">Assigned | Cancelled | Closed | Done | InProgress | Open | Postponed</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Task</maml:name> <command:parameterValue required="true">PSTask</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UnassignUser</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <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="named"> <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="named"> <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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <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="named"> <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="named"> <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="1"> <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="named"> <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="named"> <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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-RDMUser -detailed". For technical information, type "Get-Help Set-RDMUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $user = Get-RDMUser -Name MyUser; $user.UserInfo.UserProfile.Company = 'UsersCompany'; $user.UserInfo.UserProfile.Department = 'UsersDepartment'; $user.UserInfo.UserProfile.Address = '123 UsersAddress'; $user.UserInfo.UserProfile.Phone = '555-0100'; Set-RDMUser -User $user</dev:code> <dev:remarks> <maml:para>Update information about the user MyUser.</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-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>2024.2.6</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="2"> <maml:name>Property</maml:name> <command:parameterValue required="true">String</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:parameter required="true" position="3"> <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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="3"> <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>2024.2.6</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="3"> <maml:name>AllowDragAndDrop</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>OfflineMode</maml:name> <command:parameterValue required="true">Disabled | Cache | ReadOnly | ReadWrite</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetUser</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>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="named"> <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 -AllowRevealPassword $false -OfflineMode "Read/Write"</dev:code> <dev:remarks> <maml:para>Disallow the user to reveal password and set offline mode to read/write</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>2024.2.6</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:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>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>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Start-RDMInstance</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Start a Remote Desktop Manager process</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RDMProcess</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 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>2024.2.6</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>2024.2.6</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">Free | Enterprise</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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-RDMEntries</command:name> <gl:group>RDMEntries</gl:group> <maml:description> <maml:para>Refresh entries list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMEntries</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Refresh entries list.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMEntries</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-RDMEntries -detailed". For technical information, type "Get-Help Update-RDMEntries -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-RDMEntries</dev:code> <dev:remarks> <maml:para>Refresh entries 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-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>2024.2.6</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">Free | Enterprise</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Quiet</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>Refresh repository list.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Refresh repository list.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMRepository</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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>Refresh 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 session attachment</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMSessionAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update session attachment. Only advanced data sources support attachment. The user must have the permission to edit attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-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="true" position="2"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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> <maml:navigationLink> <maml:linkText>Add-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMPrivateSessionAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSessionAttachment</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>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>2024.2.6</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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </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="2"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update RDM user interface.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMUI</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-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> <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-DSRootSession</command:name> <gl:group>DSRootSession</gl:group> <maml:description> <maml:para>Get the root entry of the specified vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSRootSession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the root entry of the specified vault.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSRootSession</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Specify the ID of the desired 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>System.Management.Automation.PSObject</maml:name> <maml:uri /> <maml:description> <maml:para>Root session object</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the server response containg the root in the data field.</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-DSRootSession -detailed". For technical information, type "Get-Help Get-DSRootSession -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-DSVault</command:name> <gl:group>DSVault</gl:group> <maml:description> <maml:para>Get vault(s) from the Devolutions Server instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSVault</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get vaults in the Devolutions Server instance in three ways: a single vault by its ID, all vaults, or a subset of vaults from pagination.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSVault</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSVault</maml:name> <command:parameter required="false" position="named"> <maml:name>Descending</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageNumber</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageSize</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SortField</maml:name> <command:parameterValue required="true">Name | Description</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSVault</maml:name> <command:parameter required="true" position="named"> <maml:name>Legacy</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSVault</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Fetches all vaults.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>Sort the field 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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Legacy</maml:name> <maml:description> <maml:para>Deprecated. Do not use.</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="named"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>Specify the desired page. If not specified, the first one will be returned.</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="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Number of vaults in a page. If not specified, there will be 25 vaults per page.</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="named"> <maml:name>SortField</maml:name> <maml:description> <maml:para>Specify the field on which the vaults will be ordered.</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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Specify the ID of the desired 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>Devolutions.RemoteDesktopManager.Business.Entities.RepositoryEntity[]</maml:name> <maml:uri /> <maml:description> <maml:para>Vault objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.RepositoryEntity, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response with a single vault in the Data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.RepositoryEntity, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response with the vaults in the Data field.</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-DSVault -detailed". For technical information, type "Get-Help Get-DSVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $vaults = Get-DSVault -All</dev:code> <dev:remarks> <maml:para>Retrieve all vaults and store the ServerResponse<RepositoryEntity[]> in $vaults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $vault = Get-DSVault -VaultID 00000000-0000-0000-0000-000000000000</dev:code> <dev:remarks> <maml:para>Retrieve the vault with the matching ID and store the ServerResponse<RepositoryEntity> in $vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $vaults = Get-DSVault -PageNumber 2 -PageSize 10</dev:code> <dev:remarks> <maml:para>Retrieve the second page of 10 vaults and store the ServerResponse<RepositoryEntity[]> in $vaults.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSVault</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-DSVaultPermission</command:name> <gl:group>DSVaultPermission</gl:group> <maml:description> <maml:para>Get the vault permissions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSVaultPermission</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the vault permissions.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSVaultPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>PrincipalTypes</maml:name> <command:parameterValue required="true">All | Applications | Roles | Users</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>PrincipalTypes</maml:name> <maml:description> <maml:para>Specify the type of users.</maml:para> </maml:description> <command:parameterValue required="true" 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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Specify the ID of the desired 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>Devolutions.RemoteDesktopManager.Business.Entities.RepositoryAssignmentEntity[]</maml:name> <maml:uri /> <maml:description> <maml:para>Vault permission objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.RepositoryAssignmentEntity, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response with the permissions in the Data field.</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-DSVaultPermission -detailed". For technical information, type "Get-Help Get-DSVaultPermission -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $response = Get-DSVaultPermission -VaultID $vaultID -PrincipalType Applications; $apps = response.Data | Select Name, Description, IsMember; Set-DSVaultApplication -VaultID $vaultID -AllowedApplicationsList $apps[1].Name,$apps[3].Name -Update</dev:code> <dev:remarks> <maml:para>Fetch all the applications for the vault $vaultID and keep only their name, description and isMember attributes. Update the second and fourth applications of the list, changing their membership status.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSVault</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-DSVault</command:name> <gl:group>DSVault</gl:group> <maml:description> <maml:para>Create a new vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSVault</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new vault and add users, applications and roles to it if the respective list is supplied.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSVault</maml:name> <command:parameter required="false" position="5"> <maml:name>AllowedApplicationList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AllowedRolesList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AllowedUsernameList</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="true" position="named"> <maml:name>Name</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">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SecurityLevel</maml:name> <command:parameterValue required="true">Standard | High</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5"> <maml:name>AllowedApplicationList</maml:name> <maml:description> <maml:para>Accept an array of strings containing application names (not app id) to add to the vault</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="6"> <maml:name>AllowedRolesList</maml:name> <maml:description> <maml:para>Accept an array of strings containing user group's name (not id) to add to the vault</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="4"> <maml:name>AllowedUsernameList</maml:name> <maml:description> <maml:para>Accept an array of strings containing usernames (not id) to add to the vault</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>Description</maml:name> <maml:description> <maml:para>Vault's 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>Specify if the vault is allowed to be used while offline. It is allowed by default.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Vault's master password. Backend does not verify password complexity, so you should use New-DSPassword and choose a password in the list</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="named"> <maml:name>SecurityLevel</maml:name> <maml:description> <maml:para>Set the security level. A high security level disables the offline mode. The default value is High.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultSecurityLevel</command:parameterValue> <dev:type> <maml:name>VaultSecurityLevel</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response.</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-DSVault -detailed". For technical information, type "Get-Help New-DSVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>$Vault = @{ Name = 'NewVault' Description = 'This is a description for the new vault.' IsAllowedOffline = $true Password = 'Pa$$w0rd!' AllowedUsernameList = @("User1") AllowedRolesList = @("Role1", "Role2") AllowedApplicationList = @("App1") } $response = New-DSVault @Vault</dev:code> <dev:remarks> <maml:para>Create the vault NewVault who can be accessed by User1, App1 and the roles Role1 and Role2.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSVault</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-DSVault</command:name> <gl:group>DSVault</gl:group> <maml:description> <maml:para>Delete a vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSVault</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Deletes a vault from DVLS instance and delete all entries inside of it. Be careful, this action is irreversible if you don't have a recent back-up.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSVault</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Vault's ID 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response.</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-DSVault -detailed". For technical information, type "Get-Help Remove-DSVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSVault</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-DSVaultApplication</command:name> <gl:group>DSVaultApplication</gl:group> <maml:description> <maml:para>Sets the allowed applications for a given vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DSVaultApplication</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Sets which application have access to a given vault. If the "Update" flag is present and a supplied application name is already a member of the vault, it will remove this application.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DSVaultApplication</maml:name> <command:parameter required="false" position="1"> <maml:name>AllowedApplicationsList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Update</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AllowedApplicationsList</maml:name> <maml:description> <maml:para>Accept an array of strings containing application names (not id) to allow in vault</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Update</maml:name> <maml:description> <maml:para>Update the current applications instead of overwriting 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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Vault's ID to update</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response</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-DSVaultApplication -detailed". For technical information, type "Get-Help Set-DSVaultApplication -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultApplication @("App1", "App2")</dev:code> <dev:remarks> <maml:para>No application allowed in the vault before the execution. App1 and App2 allowed in the vault after the command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultApplication @("App3")</dev:code> <dev:remarks> <maml:para>App1 and User2 allowed in the vault before the execution. App3 is the only application allowed in the vault after the command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultApplication @("App2") -Update</dev:code> <dev:remarks> <maml:para>App1 allowed in the vault before the execution. App1 and App2 allowed in the vault after the command. The update flag keeps previous applications.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultApplication @("App2", "App3") -Update</dev:code> <dev:remarks> <maml:para>App1 and App2 allowed in the vault before the execution. App1 and App3 allowed in the vault after the command. App2 lose his access because of the presence of the update flag.</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-DSVaultRole</command:name> <gl:group>DSVaultRole</gl:group> <maml:description> <maml:para>Sets the allowed user groups for a given vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DSVaultRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Sets which users have access to a given vault. If the "Update" flag is present and a supplied username is already a member of the vault, it will remove this user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DSVaultRole</maml:name> <command:parameter required="false" position="1"> <maml:name>AllowedRolesList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Update</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AllowedRolesList</maml:name> <maml:description> <maml:para>Accept an array of strings containing usernames (not id) to allow in vault</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Update</maml:name> <maml:description> <maml:para>Update the current users instead of overwriting 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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Vault's ID to update</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the server response</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-DSVaultRole -detailed". For technical information, type "Get-Help Set-DSVaultRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultRole @("Role1", "Role2")</dev:code> <dev:remarks> <maml:para>No role allowed in the vault before the execution. Role1 and Role2 allowed in the vault after the command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultRole @("Role3")</dev:code> <dev:remarks> <maml:para>Role1 and Role2 allowed in the vault before the execution. Role3 is the only role allowed in the vault after the command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultRole @("Role2") -Update</dev:code> <dev:remarks> <maml:para>User1 allowed in the vault before the execution. Role1 and Role2 allowed in the vault after the command. The update flag keeps previous users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultRole @("User2", "Role3") -Update</dev:code> <dev:remarks> <maml:para>Role1 and Role2 allowed in the vault before the execution. Role1 and Role3 allowed in the vault after the command. Role2 lose his access because of the presence of the update flag.</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-DSVaultUser</command:name> <gl:group>DSVaultUser</gl:group> <maml:description> <maml:para>Sets the allowed users for a given vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DSVaultUser</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Sets which users have access to a given vault. If the "Update" flag is present and a supplied username is already a member of the vault, it will remove this user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DSVaultUser</maml:name> <command:parameter required="false" position="1"> <maml:name>AllowedUsernameList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Update</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AllowedUsernameList</maml:name> <maml:description> <maml:para>Accept an array of strings containing usernames (not id) to allow in vault</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Update</maml:name> <maml:description> <maml:para>Update the current users instead of overwriting 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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Vault's ID to update</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the server response</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-DSVaultUser -detailed". For technical information, type "Get-Help Set-DSVaultUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultUser @("User1", "User2")</dev:code> <dev:remarks> <maml:para>No user allowed in the vault before the execution. User1 and User2 allowed in the vault after the command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultUser @("User3")</dev:code> <dev:remarks> <maml:para>User1 and User2 allowed in the vault before the execution. User3 is the only user allowed in the vault after the command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultUser @("User2") -Update</dev:code> <dev:remarks> <maml:para>User1 allowed in the vault before the execution. User1 and User2 allowed in the vault after the command. The update flag keeps previous users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Set-DSVaultUser @("User2", "User3") -Update</dev:code> <dev:remarks> <maml:para>User1 and User2 allowed in the vault before the execution. User1 and User3 allowed in the vault after the command. User2 lose his access because of the presence of the update flag.</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-DSVault</command:name> <gl:group>DSVault</gl:group> <maml:description> <maml:para>Update a vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSVault</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a vault using the supplied parameters. If name is present, it cannot be null nor empty. Backend does not verify password complexity, so use New-DSPassword to generate a strong password with house policy.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSVault</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AllowedUsernameList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AllowedApplicationList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AllowedRolesList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IsAllowedOffline</maml:name> <command:parameterValue required="true">Boolean</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="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-DSVault</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">RepositoryEntity</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AllowedUsernameList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AllowedApplicationList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AllowedRolesList</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IsAllowedOffline</maml:name> <command:parameterValue required="true">Boolean</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="2"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="6"> <maml:name>AllowedApplicationList</maml:name> <maml:description> <maml:para>Accept an array of strings containing application names (not app id) to add to the vault</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="7"> <maml:name>AllowedRolesList</maml:name> <maml:description> <maml:para>Accept an array of strings containing user group's name (not id) to add to the vault</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="5"> <maml:name>AllowedUsernameList</maml:name> <maml:description> <maml:para>Accept an array of strings containing usernames (not id) to add to the vault</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>Description</maml:name> <maml:description> <maml:para>Vault's 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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Vault obtained from Get-DSVault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RepositoryEntity</command:parameterValue> <dev:type> <maml:name>RepositoryEntity</maml: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>IsAllowedOffline</maml:name> <maml:description> <maml:para>Specify if the vault is allowed to be used while offline. Its default value is 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="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Vault's master password. Backend does not verify password complexity, so you should use New-DSPassword and choose a password in the list</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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Vault's ID to update</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the object representing the server response.</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-DSVault -detailed". For technical information, type "Get-Help Update-DSVault -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>$UpdatedVault = @{ VaultID = "36120922-539d-4550-8567-fc4f21d77352" Name = "Test" Description = "Test" IsAllowedOffline = $false Password = 'Pa$$w0rd!' AllowedUsersList = @("User1") AllowedRolesList = @("Role1") AllowedApplicationList = @("App1") } Update-DSVault @UpdatedVault -Verbose</dev:code> <dev:remarks> <maml:para>Update an existing vault whose ID is 36120922-539d-4550-8567-fc4f21d77352. All other fields are modified by the value specified in the hash table.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSVault</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSVault</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>Convert-PSCustomObjectToXML</command:name> <gl:group>PSCustomObjectToXML</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>PSCustomObjectToXML</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-PSCustomObjectToXML</maml:name> <command:parameter required="true" position="named"> <maml:name>Object</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, ByPropertyName)" position="named"> <maml:name>Object</maml:name> <maml:description> <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 Convert-PSCustomObjectToXML -detailed". For technical information, type "Get-Help Convert-PSCustomObjectToXML -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>Convert-XMLToPSCustomObject</command:name> <gl:group>XMLToPSCustomObject</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>XMLToPSCustomObject</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-XMLToPSCustomObject</maml:name> <command:parameter required="true" position="named"> <maml:name>XML</maml:name> <command:parameterValue required="true">XmlDocument</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>XML</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> <dev:type> <maml:name>XmlDocument</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 Convert-XMLToPSCustomObject -detailed". For technical information, type "Get-Help Convert-XMLToPSCustomObject -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>Convert-XMLToSerializedString</command:name> <gl:group>XMLToSerializedString</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>XMLToSerializedString</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-XMLToSerializedString</maml:name> <command:parameter required="true" position="named"> <maml:name>XML</maml:name> <command:parameterValue required="true">XmlDocument</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>XML</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> <dev:type> <maml:name>XmlDocument</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 Convert-XMLToSerializedString -detailed". For technical information, type "Get-Help Convert-XMLToSerializedString -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>Invoke-DSResetServerCache</command:name> <gl:group>DSResetServerCache</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>DSResetServerCache</command:noun> <dev:version>2024.2.6</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 Invoke-DSResetServerCache -detailed". For technical information, type "Get-Help Invoke-DSResetServerCache -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-DSEntryOTP</command:name> <gl:group>DSEntryOTP</gl:group> <maml:description> <maml:para>Get a PSObject containing the OTP code with the remaining time of an OTP entry and the corresponding end time (UTC)</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSEntryOTP</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a PSObject containing the OTP code with the remaining time of an OTP entry and the corresponding end time (UTC). The entry must be specified by its ID.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSEntryOTP</maml:name> <command:parameter required="true" position="named"> <maml:name>EntryID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>EntryID</maml:name> <maml:description> <maml:para>ID of the entry for which you want to retrieve the OTP</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>System.Management.Automation.PSObject</maml:name> <maml:uri /> <maml:description> <maml:para>PSObject containing three values (code, endTimeUTC, remainingSeconds)</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, terver response with a PSObject containing three values (code, endTimeUTC, remainingSeconds) in the data field</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-DSEntryOTP -detailed". For technical information, type "Get-Help Get-DSEntryOTP -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $response = Get-DSEntryOTP -EntryID '12345678-1234-1234-1234-123456789ABC' $otpCode = $response.code</dev:code> <dev:remarks> <maml:para>Get the OTP code of the entry whose ID is '12345678-1234-1234-1234-123456789ABC'</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-DSPasswordsReport</command:name> <gl:group>DSPasswordsReport</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPasswordsReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPasswordsReport</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>OutputPath</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>OutputPath</maml:name> <maml:description> <maml:para>Output path (including file ending in .csv) of the generated report</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="named"> <maml:name>VaultID</maml:name> <maml:description> <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-DSPasswordsReport -detailed". For technical information, type "Get-Help Get-DSPasswordsReport -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-DSEntityPermissions</command:name> <gl:group>DSEntityPermissions</gl:group> <maml:description> <maml:para>Sets the permissions on a given entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DSEntityPermissions</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Sets the permissions on a given entity (Vault, folder or entry).</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DSEntityPermissions</maml:name> <command:parameter required="true" position="named"> <maml:name>EntityId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PermissionOverride</maml:name> <command:parameterValue required="true">Default | Custom | Inherited | Everyone | Never</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Permissions</maml:name> <command:parameterValue required="true">ConnectionPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>OverrideExistingPermissions</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>EntityId</maml:name> <maml:description> <maml:para>ID of the entity for which you want to change the permissions</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>OverrideExistingPermissions</maml:name> <maml:description> <maml:para>ID of the entity for which you want to change the permissions</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>PermissionOverride</maml:name> <maml:description> <maml:para>ID of the entity for which you want to change the permissions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecurityRoleOverride</command:parameterValue> <dev:type> <maml:name>SecurityRoleOverride</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>Permissions</maml:name> <maml:description> <maml:para>ID of the entity for which you want to change the permissions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ConnectionPermission[]</command:parameterValue> <dev:type> <maml:name>ConnectionPermission[]</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating if the operation is successful.</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-DSEntityPermissions -detailed". For technical information, type "Get-Help Set-DSEntityPermissions -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>$Permissions = @( [RemoteDesktopManager.PowerShellModule.Private.models.ConnectionPermission]@{ IsEmpty = $false Override = [RemoteDesktopManager.PowerShellModule.Private.enums.SecurityRoleOverride]::Custom Right = [RemoteDesktopManager.PowerShellModule.Private.enums.SecurityRoleRight]::View Roles = @($UserId1, $UserId2, $RoleId1) }, [RemoteDesktopManager.PowerShellModule.Private.models.ConnectionPermission]@{ IsEmpty = $false Override = [RemoteDesktopManager.PowerShellModule.Private.enums.SecurityRoleOverride]::Inherited Right = [RemoteDesktopManager.PowerShellModule.Private.enums.SecurityRoleRight]::Edit Roles = @($UserId1, $UserId2, $RoleId1) } ) > Set-DSEntityPermissions -EntityId $ID -Permissions $Permissions</dev:code> <dev:remarks> <maml:para>- To override already existing permissions, please use the 'OverrideExistingPermissions' switch parameter. - When using this CMDlet, your entity's override mode will default to 'Custom'. Use the 'PermissionOverride' parameter if you wish to set it to anything else.</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-DSUser</command:name> <gl:group>DSUser</gl:group> <maml:description> <maml:para>Get one or more users</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSUser</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a single user, a page of users, or all users.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSUser</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSUser</maml:name> <command:parameter required="false" position="named"> <maml:name>PageNumber</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageSize</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSUser</maml:name> <command:parameter required="true" position="named"> <maml:name>UserID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>All users will be fetched.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>Specify the page of users fetched. First page is fetched by default.</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="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Number of users per page. 10 users per page by default.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserID</maml:name> <maml:description> <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>Devolutions.RemoteDesktopManager.Business.Entities.UserEntity</maml:name> <maml:uri /> <maml:description> <maml:para>Complete user object.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.Models.UserListItem[]</maml:name> <maml:uri /> <maml:description> <maml:para>User object with basic information</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.UserEntity, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with the user in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Models.UserListItem, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with users in the data field.</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-DSUser -detailed". For technical information, type "Get-Help Get-DSUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-DSUser -All</dev:code> <dev:remarks> <maml:para>Get all the users</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-DSUser -UserID $userID</dev:code> <dev:remarks> <maml:para>Get a specific user</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-DSUser -PageNumber 1 -PageSize 10</dev:code> <dev:remarks> <maml:para>Get the first page containing 10 users</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSUSer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSUser</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-DSUser</command:name> <gl:group>DSUser</gl:group> <maml:description> <maml:para>Create a new user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSUser</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new user with the supplied parameters.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSUser</maml:name> <command:parameter required="false" position="named"> <maml:name>AuthenticationType</maml:name> <command:parameterValue required="true">Builtin | Domain | AzureAD</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserType</maml:name> <command:parameterValue required="true">Admin | User | Restricted | ReadOnly</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserLicenceType</maml:name> <command:parameterValue required="true">Default | ConnectionManagement | PasswordManagement</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FirstName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LastName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <command:parameterValue required="true">English | French | German | Spanish | Hungarian | Italian | Dutch | Polish (Poland) | Russian | Swedish | Ukrainian | Chinese (Simplified) Legacy | Chinese (Traditional, Taiwan) | Czech</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Enabled</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserMustChangePasswordAtNextLogin</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CompanyName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>JobTitle</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Department</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GravatarEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>State</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CountryName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Phone</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Workphone</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CellPhone</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fax</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessRDM</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessWebLogin</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessLauncher</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessWeb</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessCLI</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowDragAndDrop</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanViewInformations</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanViewGlobalLogs</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanImport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanExport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OfflineMode</maml:name> <command:parameterValue required="true">Disabled | ReadOnly | ReadWrite</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>Address of the user.</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="named"> <maml:name>AllowDragAndDrop</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Authentication type of the server user. Builtin (Devolutions Server) by default. Domain: authenticate using the Active Directory user account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ServerUserType</command:parameterValue> <dev:type> <maml:name>ServerUserType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanExport</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CanImport</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CanViewGlobalLogs</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CanViewInformations</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CellPhone</maml:name> <maml:description> <maml:para>Cell phone number to contact the user.</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="named"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>Company name that employs the user.</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="named"> <maml:name>CountryName</maml:name> <maml:description> <maml:para>Country of the user.</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="named"> <maml:name>Department</maml:name> <maml:description> <maml:para>Department in which the user is working.</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="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email of the user.</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="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Determine if the user is activated. True by default.</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="named"> <maml:name>Fax</maml:name> <maml:description> <maml:para>Fax number to contact the user.</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="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>First name of the user.</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="named"> <maml:name>GravatarEmail</maml:name> <maml:description> <maml:para>Gravatar email to obtain the user's avatar.</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="named"> <maml:name>HasAccessCLI</maml:name> <maml:description> <maml:para>Allow the user to use to CLI (command line interface). True by default.</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="named"> <maml:name>HasAccessLauncher</maml:name> <maml:description> <maml:para>Allow the user can open remote connections with Devolutions Launcher. True by default.</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="named"> <maml:name>HasAccessRDM</maml:name> <maml:description> <maml:para>Allow the user to access to Devolutions Server through RDM. True by default.</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="named"> <maml:name>HasAccessWeb</maml:name> <maml:description> <maml:para>Allow the user to use Devolutions Server web interface. True by default.</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="named"> <maml:name>HasAccessWebLogin</maml:name> <maml:description> <maml:para>Allow the user to auto fill username and passwords on websites with Devolutions Web Login. True by default.</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="named"> <maml:name>JobTitle</maml:name> <maml:description> <maml:para>Job title of the user.</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="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Language of the user's web interface. English by default.</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="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>Last name of the user.</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="named"> <maml:name>OfflineMode</maml:name> <maml:description> <maml:para>Offline mode. Read/Write by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OfflineMode</command:parameterValue> <dev:type> <maml:name>OfflineMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password of the user.</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="named"> <maml:name>Phone</maml:name> <maml:description> <maml:para>Phone number to contact the user.</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="named"> <maml:name>State</maml:name> <maml:description> <maml:para>State of the user.</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="named"> <maml:name>UserLicenceType</maml:name> <maml:description> <maml:para>Select the type of the license that the user has: Default: Connection Management. | Connection Management: for users who open remote connections. | Password Management: for users who only use Devolutions Server as a password manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UserLicenceTypeMode</command:parameterValue> <dev:type> <maml:name>UserLicenceTypeMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserMustChangePasswordAtNextLogin</maml:name> <maml:description> <maml:para>Force the user to change the password next time they log on.</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="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>User login 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="named"> <maml:name>UserType</maml:name> <maml:description> <maml:para>User type defining his rights. User by default. Choices: Administrator: grant full administrative rights to the user. | Read only user: grant only the View access to the user. | Restricted user: select which rights to grant to the user. | User: grant all basic rights to the user (Add, Edit, Delete).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UserType</command:parameterValue> <dev:type> <maml:name>UserType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workphone</maml:name> <maml:description> <maml:para>Work phone number to contact the user.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSUser -detailed". For technical information, type "Get-Help New-DSUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-DSUser -AuthenticationType Builtin -UserType ReadOnly -Username ASimpleUser -Password 123456 -FirstName First -LastName Last -Email myemail@email.com -Language French -CountryName Canada -OfflineMode Disabled</dev:code> <dev:remarks> <maml:para>Create a new read only user.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSUSer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSUser</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-DSUSer</command:name> <gl:group>DSUSer</gl:group> <maml:description> <maml:para>Delete a user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSUSer</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete a user specified by the ID attribute.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSUSer</maml:name> <command:parameter required="true" position="named"> <maml:name>UserID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>UserID</maml:name> <maml:description> <maml:para>Id of the user 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSUSer -detailed". For technical information, type "Get-Help Remove-DSUSer -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSUser</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>Update-DSUser</command:name> <gl:group>DSUser</gl:group> <maml:description> <maml:para>Update a user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSUser</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a user with the supplied parameters.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSUser</maml:name> <command:parameter required="true" position="named"> <maml:name>UserID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomRoles</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserType</maml:name> <command:parameterValue required="true">Admin | User | Restricted | ReadOnly</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserLicenceType</maml:name> <command:parameterValue required="true">Default | ConnectionManagement | PasswordManagement</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FirstName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LastName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <command:parameterValue required="true">English | French | German | Spanish | Hungarian | Italian | Dutch | Polish (Poland) | Russian | Swedish | Ukrainian | Chinese (Simplified) Legacy | Chinese (Traditional, Taiwan) | Czech</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Enabled</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserMustChangePasswordAtNextLogin</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CompanyName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>JobTitle</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Department</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GravatarEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>State</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CountryName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Phone</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Workphone</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CellPhone</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fax</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessRDM</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessWebLogin</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessLauncher</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessWeb</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HasAccessCLI</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowDragAndDrop</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanViewInformations</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanViewGlobalLogs</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanImport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanExport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OfflineMode</maml:name> <command:parameterValue required="true">Disabled | ReadOnly | ReadWrite</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>Address of the user.</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="named"> <maml:name>AllowDragAndDrop</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CanExport</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CanImport</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CanViewGlobalLogs</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CanViewInformations</maml:name> <maml:description> <maml:para>True by default.</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="named"> <maml:name>CellPhone</maml:name> <maml:description> <maml:para>Cell phone number to contact the user.</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="named"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>Company name that employs the user.</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="named"> <maml:name>CountryName</maml:name> <maml:description> <maml:para>Country of the user.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomRoles</maml:name> <maml:description> <maml:para>Role ids the user will be assigned to.</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="named"> <maml:name>Department</maml:name> <maml:description> <maml:para>Department in which the user is working.</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="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email of the user.</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="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Determine if the user is activated. True by default.</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="named"> <maml:name>Fax</maml:name> <maml:description> <maml:para>Fax number to contact the user.</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="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>First name of the user.</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="named"> <maml:name>GravatarEmail</maml:name> <maml:description> <maml:para>Gravatar email to obtain the user's avatar.</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="named"> <maml:name>HasAccessCLI</maml:name> <maml:description> <maml:para>Allow the user to use to CLI (command line interface). True by default.</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="named"> <maml:name>HasAccessLauncher</maml:name> <maml:description> <maml:para>Allow the user can open remote connections with Devolutions Launcher. True by default.</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="named"> <maml:name>HasAccessRDM</maml:name> <maml:description> <maml:para>Allow the user to access to Devolutions Server through RDM. True by default.</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="named"> <maml:name>HasAccessWeb</maml:name> <maml:description> <maml:para>Allow the user to use Devolutions Server web interface. True by default.</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="named"> <maml:name>HasAccessWebLogin</maml:name> <maml:description> <maml:para>Allow the user to auto fill username and passwords on websites with Devolutions Web Login. True by default.</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="named"> <maml:name>JobTitle</maml:name> <maml:description> <maml:para>Job title of the user.</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="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Language of the user's web interface. English by default.</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="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>Last name of the user.</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="named"> <maml:name>OfflineMode</maml:name> <maml:description> <maml:para>Offline mode. Read/Write by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OfflineMode</command:parameterValue> <dev:type> <maml:name>OfflineMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password of the user.</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="named"> <maml:name>Phone</maml:name> <maml:description> <maml:para>Phone number to contact the user.</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="named"> <maml:name>State</maml:name> <maml:description> <maml:para>State of the user.</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="named"> <maml:name>UserID</maml:name> <maml:description> <maml:para>Id of the user to update.</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="named"> <maml:name>UserLicenceType</maml:name> <maml:description> <maml:para>Select the type of the license that the user has: Default: Connection Management. | Connection Management: for users who open remote connections. | Password Management: for users who only use Devolutions Server as a password manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UserLicenceTypeMode</command:parameterValue> <dev:type> <maml:name>UserLicenceTypeMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserMustChangePasswordAtNextLogin</maml:name> <maml:description> <maml:para>Force the user to change the password next time they log on.</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="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Ignored. User login 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="named"> <maml:name>UserType</maml:name> <maml:description> <maml:para>User type defining his rights. User by default. Choices: Administrator: grant full administrative rights to the user. | Read only user: grant only the View access to the user. | Restricted user: select which rights to grant to the user. | User: grant all basic rights to the user (Add, Edit, Delete).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UserType</command:parameterValue> <dev:type> <maml:name>UserType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workphone</maml:name> <maml:description> <maml:para>Work phone number to contact the user.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSUser -detailed". For technical information, type "Get-Help Update-DSUser -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-DSUSer -UserId $uid -CustomRoles "d8f94f53-e073-48fd-85b7-d4bfb127bd2d"</dev:code> <dev:remarks> <maml:para>Assign the role "d8f94f53-e073-48fd-85b7-d4bfb127bd2d" to the user whose id is $uid. All others previous roles are unassigned.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSUSer</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-DSAuthenticationModes</command:name> <gl:group>DSAuthenticationModes</gl:group> <maml:description> <maml:para>Get the authentication modes allowed by the server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSAuthenticationModes</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the authentication modes allowed by the server. The possibilities of authentication are AzureAD, Otka, Custom (Devolutions Server), Domain and Windows Authentication</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSAuthenticationModes</maml:name> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>Authentication modes objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the server response with the result in the data field.</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-DSAuthenticationModes -detailed". For technical information, type "Get-Help Get-DSAuthenticationModes -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-DSAuthenticationModes</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-DSPrivateServerInfo</command:name> <gl:group>DSPrivateServerInfo</gl:group> <maml:description> <maml:para>Obtain the private server information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPrivateServerInfo</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Obtain the private server information at the specified URL. Must be connected to the server via New-DSSession.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPrivateServerInfo</maml:name> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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.RemoteDesktopManager.Business.Entities.PrivateWebInstanceInfo</maml:name> <maml:uri /> <maml:description> <maml:para>Private server information object</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.PrivateWebInstanceInfo, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the server response containing the private server information.</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-DSPrivateServerInfo -detailed". For technical information, type "Get-Help Get-DSPrivateServerInfo -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-DSSession -BaseURI 'Your/DVLS/Instance/URL' -WindowsAuthentication; $privateInfo = Get-DSPrivateServerInfo; $privateInfo.Data</dev:code> <dev:remarks> <maml:para>Obtain the private server information of the dvls instance located at 'Your/DVLS/Instance/URL'.</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-DSPublicServerInfo</command:name> <gl:group>DSPublicServerInfo</gl:group> <maml:description> <maml:para>Obtain the public server information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPublicServerInfo</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Obtain the public server information at the specified URL.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPublicServerInfo</maml:name> <command:parameter required="true" position="named"> <maml:name>URL</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>URL</maml:name> <maml:description> <maml:para>URL of the server.</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>Devolutions.RemoteDesktopManager.Business.Entities.PublicWebInstanceInfo</maml:name> <maml:uri /> <maml:description> <maml:para>Public server information object</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.PublicWebInstanceInfo, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the server response containing the public server information.</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-DSPublicServerInfo -detailed". For technical information, type "Get-Help Get-DSPublicServerInfo -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSPublicServerInfo -URL https://here.is.myapp/dvls</dev:code> <dev:remarks> <maml:para>Obtain the public server information of the dvls instance located at "https://here.is.myapp/dvls".</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-DSAuthenticationModes</command:name> <gl:group>DSAuthenticationModes</gl:group> <maml:description> <maml:para>Modify the authentification modes allowed.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DSAuthenticationModes</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Modify the authentification modes allowed. AzureAD, Custom (Devolutions Server) and Domain authentications can be modified.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DSAuthenticationModes</maml:name> <command:parameter required="false" position="named"> <maml:name>AzureADAuthenticationEnabled</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomAuthenticationEnabled</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainAuthenticationEnabled</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AzureADAuthenticationEnabled</maml:name> <maml:description> <maml:para>Allow or not AzureAD authentication method.</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="named"> <maml:name>CustomAuthenticationEnabled</maml:name> <maml:description> <maml:para>Allow or not Custom (Devolutions Server) authentication method.</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="named"> <maml:name>DomainAuthenticationEnabled</maml:name> <maml:description> <maml:para>Allow or not Domain authentication method.</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch,the server response indicating the success of the operation.</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-DSAuthenticationModes -detailed". For technical information, type "Get-Help Set-DSAuthenticationModes -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Set-DSAuthenticationModes -AzureADAuthenticationEnabled $true</dev:code> <dev:remarks> <maml:para>Allow AzureAD authentication on the dlvs server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-DSAuthenticationModes</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-DSSearchCriteria</command:name> <gl:group>DSSearchCriteria</gl:group> <maml:description> <maml:para>Create a search criterion to be used in the Search-DSEntry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSSearchCriteria</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a search criterion to be used in the Search-DSEntry. The vaults to be searched are determined in the Search-DSEntry cmdlet. A criterion is determined at two fields: By, to indicate the field where the seach will be applied, and Value, the value whose type depend of the field. For a standard string value, the parameter Match indicates how to search is conducted. For date values, to use a custom interval, the value must be set to Custom and specified with the parameters After and Before. Search by ConnectionType or Description will ignore PAM vaults.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSSearchCriteria</maml:name> <command:parameter required="true" position="named"> <maml:name>By</maml:name> <command:parameterValue required="true">CreationDate | LastUpdateDate</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</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="named"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSSearchCriteria</maml:name> <command:parameter required="true" position="named"> <maml:name>By</maml:name> <command:parameterValue required="true">DocumentType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">Certificate | Data Source Configuration (.rdd) | Document | Documentation Editor | Email | Html | Image | Microsoft Excel | Microsoft OneNote | Microsoft PowerPoint | Microsoft Visio | Microsoft Word | PDF | Text (RDF) | Video</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSSearchCriteria</maml:name> <command:parameter required="true" position="named"> <maml:name>By</maml:name> <command:parameterValue required="true">ConnectionType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">Credential | Document | Group | RDPConfigured | Root | VPN</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSSearchCriteria</maml:name> <command:parameter required="true" position="named"> <maml:name>By</maml:name> <command:parameterValue required="true">Expiration</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeExpired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeManuallyFlaggedExpired</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSSearchCriteria</maml:name> <command:parameter required="true" position="named"> <maml:name>By</maml:name> <command:parameterValue required="true">State</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">Check Out | Edit Lock | Runnning</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSSearchCriteria</maml:name> <command:parameter required="true" position="named"> <maml:name>By</maml:name> <command:parameterValue required="true">Status</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">Default | Locked | Disabled | Warning | Expired | Archived | Broken</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Set the inclusive lower custom limit 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="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Set the inclusive upper custom limit 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="1"> <maml:name>By</maml:name> <maml:description> <maml:para>Field on which the expression will be applied</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SearchItemType</command:parameterValue> <dev:type> <maml:name>SearchItemType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeExpired</maml:name> <maml:description> <maml:para>Include expired entries</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="named"> <maml:name>IncludeManuallyFlaggedExpired</maml:name> <maml:description> <maml:para>Include manually flagged expired entries</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="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Search date interval for the creation or the last update. For a custom value, use After and Before parameters. By default, it will be set to Last Week.</maml:para> </maml:description> <command:parameterValue required="true" 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: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.MultiVaultSearchItemData</maml:name> <maml:uri /> <maml:description> <maml:para>A criterion for the search</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-DSSearchCriteria -detailed". For technical information, type "Get-Help New-DSSearchCriteria -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> New-DSSearchCriteria -By Name -Match StartsWith -Value ThePrefix | Search-DSEntry</dev:code> <dev:remarks> <maml:para>Search all entries whose name starts with ThePrefix in all vaults, excluding the User vault and the PAM vaults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $criteria = @(); $criteria += New-DSSearchCriteria -By Username -Value AUsername; $criteria += New-DSSearchCriteria -By CreationDate -Value Last30Days; Search-DSEntry -InputObject $criteria -IncludePamVaults -IncludeVault @()</dev:code> <dev:remarks> <maml:para>Search all PAM entries whose username contains AUsername created in the last 30 days. Only the PAM vaults will be searched.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Search-DSEntry</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>Search-DSEntry</command:name> <gl:group>DSEntry</gl:group> <maml:description> <maml:para>Search an entry in the DVLS instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Search</command:verb> <command:noun>DSEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Search an entry in the DVLS instance. There are two way to execute a search. This cmdlet allows a simple search with a single criterion using three parameters: By, Match, and Value. For a more complex search or ease of use, criteria can be created with the cmdlet New-DSSearchCriteria. The InputObject will accept an array of those criteria. By default, all vaults are searched, except the User vault and the PAM vaults. For those two vaults, each will be included by using the corresponding parameter: IncludeUserVault and IncludePAMVaults. It is also possible to search only a subset of vaults by using one of IncludeVault and ExcludeVault.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Search-DSEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">MultiVaultSearchItemData[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeVault</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeVault</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludePAMVaults</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserVault</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Search-DSEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>By</maml:name> <command:parameterValue required="true">AccountingNumber | AssetTag | CheckedOutBy | ConnectionSubType | ConnectionType | CreationDate | Description | DocumentType | Expiration | Folder | InvoiceNumber | LastUpdateDate | Name | PONumber | ServiceTag | State | Status | Tags | Username</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <command:parameterValue required="true">Contains | EndsWith | ExactExpression | StartsWith</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeVault</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeVault</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludePAMVaults</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserVault</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>By</maml:name> <maml:description> <maml:para>Field on which the expression will be applied</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SearchItemType</command:parameterValue> <dev:type> <maml:name>SearchItemType</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"> <maml:name>ExcludeVault</maml:name> <maml:description> <maml:para>Vaults to be excluded from the search.</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="named"> <maml:name>IncludePAMVaults</maml:name> <maml:description> <maml:para>Include the PAM Vaults</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="named"> <maml:name>IncludeUserVault</maml:name> <maml:description> <maml:para>Include the user 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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVault</maml:name> <maml:description> <maml:para>Vaults to be searched. If not specified, all of them will be searched except the PAM Vaults and User vault. For the PAM vaults or User vault, use the corresponding switch.</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="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Search criteria created from New-DSSearchCriteria</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">MultiVaultSearchItemData[]</command:parameterValue> <dev:type> <maml:name>MultiVaultSearchItemData[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Condition the expression must respect. By default, the condition is 'Contains'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SearchItemText</command:parameterValue> <dev:type> <maml:name>SearchItemText</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="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>String value</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>Devolutions.RemoteDesktopManager.Business.MultiVaultSearchItemData[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of criteria created by New-DSSearchCriteria calls.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Search result response with the result in the data field</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 Search-DSEntry -detailed". For technical information, type "Get-Help Search-DSEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Search-DSEntry -By Name -Match ExactExpression -Value 'SomeValue' -IncludeVault @($pamVaultAID, $pamVaultBID)</dev:code> <dev:remarks> <maml:para>Search in the two vaults identified by the IDs stored in $pamvaultAID and $pamVaultBID for an entry whose name named 'SomeValue'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> New-DSSearchCriteria -By Name -Match StartsWith -Value ThePrefix | Search-DSEntry</dev:code> <dev:remarks> <maml:para>Search all entries whose name starts with ThePrefix in all vaults, excluding the User vault and the PAM vaults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $criteria = @(); $criteria += New-DSSearchCriteria -By Username -Value AUsername; $criteria += New-DSSearchCriteria -By CreationDate -Value Last30Days; Search-DSEntry -InputObject $criteria -IncludePamVaults -IncludeVault @()</dev:code> <dev:remarks> <maml:para>Search all PAM entries whose username contains AUsername created in the last 30 days. Only the PAM vaults will be searched.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSSearchCriteria</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-DSRole</command:name> <gl:group>DSRole</gl:group> <maml:description> <maml:para>Fetch one or more existing roles.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Fetch one or more existing roles. Three alternative methods are possible: all roles, a single one or a page of roles.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSRole</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSRole</maml:name> <command:parameter required="false" position="named"> <maml:name>PageNumber</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageSize</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSRole</maml:name> <command:parameter required="true" position="named"> <maml:name>RoleID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>All roles will be fetched.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>Specify the page of roles fetched. First page is fetched by default.</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="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Number of roles per page. 10 roles per page by default.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleID</maml:name> <maml:description> <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>Devolutions.RemoteDesktopManager.Business.Entities.RoleEntity</maml:name> <maml:uri /> <maml:description> <maml:para>Complete role object</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Devolutions.Server.ApiWrapper.Models.RoleBaseReference[]</maml:name> <maml:uri /> <maml:description> <maml:para>Roles, with only basic fields.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.ApiWrapper.Models.RoleBaseReference, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response containing multiple roles, with only basic fields.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.RemoteDesktopManager.Business.Entities.RoleEntity, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response containing a single role, with all fields.</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-DSRole -detailed". For technical information, type "Get-Help Get-DSRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-DSRole -All</dev:code> <dev:remarks> <maml:para>Get all the roles</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-DSRole -RoleID $roleID</dev:code> <dev:remarks> <maml:para>Get a specific role</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-DSRole -PageNumber 1 -PageSize 10</dev:code> <dev:remarks> <maml:para>Get the first page containing 10 roles</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSRole</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-DSRole</command:name> <gl:group>DSRole</gl:group> <maml:description> <maml:para>Create a new role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new role and pre-validate offlineMode value, if supplied.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSRole</maml:name> <command:parameter required="false" position="named"> <maml:name>AuthenticationType</maml:name> <command:parameterValue required="true">Builtin | Domain | AzureAD</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsAdministrator</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowDragAndDrop</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanAdd</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanEdit</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanDelete</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OfflineMode</maml:name> <command:parameterValue required="true">Cache | Disabled | ReadOnly | ReadWrite</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowDragAndDrop</maml:name> <maml:description> <maml:para>Allow the drag and drop option</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Authentication type. Builtin by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ServerUserType</command:parameterValue> <dev:type> <maml:name>ServerUserType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanAdd</maml:name> <maml:description> <maml:para>Allow the user to add</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="named"> <maml:name>CanDelete</maml:name> <maml:description> <maml:para>Allow the user to delete</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="named"> <maml:name>CanEdit</maml:name> <maml:description> <maml:para>Allow the user to edit</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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Role's 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="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Domain 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="named"> <maml:name>IsAdministrator</maml:name> <maml:description> <maml:para>Give the administrative 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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Role's 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="named"> <maml:name>OfflineMode</maml:name> <maml:description> <maml:para>Offline access permissions. Disabled < Read Only < Read/Write</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OfflineMode</command:parameterValue> <dev:type> <maml:name>OfflineMode</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSRole -detailed". For technical information, type "Get-Help New-DSRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-DSRole -AuthenticationType Builtin -Name NoDeleteNoOffline -Description "Role where the user can not delete and offline mode is disabled." -CanAdd -CanEdit -AllowDragAndDrop -OfflineMode Disabled</dev:code> <dev:remarks> <maml:para>Create a role where the user is allowed to add and edit entries. Deleting entries is not allowed.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSRole</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-DSRole</command:name> <gl:group>DSRole</gl:group> <maml:description> <maml:para>Delete a role</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete a role specified by the ID attribute.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSRole</maml:name> <command:parameter required="true" position="named"> <maml:name>RoleID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>RoleID</maml:name> <maml:description> <maml:para>Id of the role 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSRole -detailed". For technical information, type "Get-Help Remove-DSRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSRole</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>Update-DSRole</command:name> <gl:group>DSRole</gl:group> <maml:description> <maml:para>Create a new role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new role and pre-validate offlineMode value, if supplied.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSRole</maml:name> <command:parameter required="true" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsAdministrator</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowDragAndDrop</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanAdd</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanEdit</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanDelete</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanImport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CanExport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DenyAddInRoot</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OfflineMode</maml:name> <command:parameterValue required="true">Cache | Disabled | ReadOnly | ReadWrite</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowDragAndDrop</maml:name> <maml:description> <maml:para>Allow the drag and drop option</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CanAdd</maml:name> <maml:description> <maml:para>Allow the user to add</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="named"> <maml:name>CanDelete</maml:name> <maml:description> <maml:para>Allow the user to delete</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="named"> <maml:name>CanEdit</maml:name> <maml:description> <maml:para>Allow the user to edit</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="named"> <maml:name>CanExport</maml:name> <maml:description> <maml:para>Allow the user to export</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="named"> <maml:name>CanImport</maml:name> <maml:description> <maml:para>Allow the user to import</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="named"> <maml:name>DenyAddInRoot</maml:name> <maml:description> <maml:para>Prevent the user from adding entries 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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Role's 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="named"> <maml:name>IsAdministrator</maml:name> <maml:description> <maml:para>Give the administrative rights</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Role'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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OfflineMode</maml:name> <maml:description> <maml:para>Offline access permissions. Disabled < Read Only < Read/Write</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OfflineMode</command:parameterValue> <dev:type> <maml:name>OfflineMode</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="named"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Id of the role to be updated.</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSRole -detailed". For technical information, type "Get-Help Update-DSRole -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-DSRole -RoleId $roleID -IsAdministrator $false -AllowDragAndDrop $false -CanAdd $false -CanEdit $false -CanDelete $false -CanImport $false -CanExport $false -DenyAddInRoot $true -OfflineMode Disabled</dev:code> <dev:remarks> <maml:para>Remove all rights (add, delete, edit, export, import, drag and drop, add in root), admistrator status and offline access of the role whose id is $roleID.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSRole</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-DSPamSecurity</command:name> <gl:group>DSPamSecurity</gl:group> <maml:description> <maml:para>Create a new PamUserPermission object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSPamSecurity</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new PamUserPermission object. This can be used to update the security of pam vaults and pam accounts.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSPamSecurity</maml:name> <command:parameter required="true" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">None | Approver | Contributor | LogReader | Manager | Operator | Owner | Reader</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Mode</maml:name> <command:parameterValue required="true">Global | Override | Both</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>UserID</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Resolution mode: Global (System default | Inherited), Override (Custom), Both</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PermissionResolutionMode</command:parameterValue> <dev:type> <maml:name>PermissionResolutionMode</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>Predefined role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamRoleType</command:parameterValue> <dev:type> <maml:name>PamRoleType</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="3"> <maml:name>UserID</maml:name> <maml:description> <maml:para>Ids of the users or applications to give access</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: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.Server.ApiWrapper.Models.Pam.Dto.Permission.PamUserPermission</maml:name> <maml:uri /> <maml:description> <maml:para>PamUserPermission object representing for a specific role</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-DSPamSecurity -detailed". For technical information, type "Get-Help New-DSPamSecurity -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $security = New-DSPamSecurity -Role Approver -Mode Global; Update-DSPamFolder -FolderID $pamFolderID -Security $security</dev:code> <dev:remarks> <maml:para>For the PAM folder whose ID is stored in $pamFolderID, its approver security will be set to 'System default'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $usersResponse = Get-DSUser; $user = $usersResponse.Data | Where Name -eq 'MyUserName'; $security = New-DSPamSecurity -Role Owner -Mode Override -UserID $user.ID; New-DSPamFolder -Name 'MyNewPamVault' -Security $security -AsNewvault</dev:code> <dev:remarks> <maml:para>Create a new PAM vault whose owner is 'MyUserName'</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-DSScriptConfigurationSummary</command:name> <gl:group>DSScriptConfigurationSummary</gl:group> <maml:description> <maml:para>Get a summary of the PAM script configurations</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSScriptConfigurationSummary</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a summary of the PAM script configurations. The summary includes the configuration's ID, name, and template ID.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSScriptConfigurationSummary</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="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive search.</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="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the script configurations by their 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.Private.models.PamScriptConfigurationSummary[]</maml:name> <maml:uri /> <maml:description> <maml:para>Summary of the PAM script configurations</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-DSScriptConfigurationSummary -detailed". For technical information, type "Get-Help Get-DSScriptConfigurationSummary -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSScriptConfigurationSummary -Name 'My script config' | Select -ExpandProperty ID</dev:code> <dev:remarks> <maml:para>Retrieve the ID of the configuration named 'My script config'</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-DSPamScanConfiguration</command:name> <gl:group>DSPamScanConfiguration</gl:group> <maml:description> <maml:para>Get the PAM scan configurations</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamScanConfiguration</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the PAM scan configurations, which can be filtered by name. Use the 'Name' parameter for wildcard searches, and the 'LiteralName' parameter for exact matches as it doesn't interpret characters as wildcards.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamScanConfiguration</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="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSPamScanConfiguration</maml:name> <command:parameter required="true" position="1"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive search</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>LiteralName</maml:name> <maml:description> <maml:para>Filter the scan configurations by their name. No characters will be interpreted as wildcards.</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="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the scan configurations by their 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>Devolutions.Server.NetworkDiscovery.Dto.ScanConfigurationDto[]</maml:name> <maml:uri /> <maml:description> <maml:para>PAM scan configurations 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-DSPamScanConfiguration -detailed". For technical information, type "Get-Help Get-DSPamScanConfiguration -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $configurations = Get-DSPamScanConfiguration -Name 'Config*'</dev:code> <dev:remarks> <maml:para>Get all PAM scan configurations with names starting with 'Config'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $configuration = Get-DSPamScanConfiguration -LiteralName 'Config [A]'</dev:code> <dev:remarks> <maml:para>Get the PAM scan configuration named 'Config [A]'. The 'LiteralName' parameter ensures that the characters '[' and ']' are not treated as wildcards.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamScanResult</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-DSPamScanResult</command:name> <gl:group>DSPamScanResult</gl:group> <maml:description> <maml:para>Retrieve the outcome of the most recent scan job associated with a specific scan configuration</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamScanResult</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Retrieve the outcome of the most recent scan job associated with a specific scan configuration.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamScanResult</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">ScanConfigurationDto</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Filter</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeManaged</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeManaged</maml:name> <maml:description> <maml:para>Exclude the managed users</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>Filter</maml:name> <maml:description> <maml:para>The global filter, identical to the web UI filter, is designed to be applied to the username, hostname, fullname, and description fields.</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>InputObject</maml:name> <maml:description> <maml:para>PAM scan configuration object obtained from Get-DSPamScanConfiguration</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScanConfigurationDto</command:parameterValue> <dev:type> <maml:name>ScanConfigurationDto</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.Server.NetworkDiscovery.Dto.ScanConfigurationDto</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PAM scan configuration object obtained from Get-DSPamScanConfiguration</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSScanResult.PSScanResult[]</maml:name> <maml:uri /> <maml:description> <maml:para>All users from the scan result</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-DSPamScanResult -detailed". For technical information, type "Get-Help Get-DSPamScanResult -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-DSPamScanConfiguration -LiteralName 'ScanA' | Get-DSPamScanResult</dev:code> <dev:remarks> <maml:para>Get the scan result for the configuration named 'ScanA'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $providerID = 'the-desired-pam-provider-ID' $folderID = 'the-desired-pam-vault-or-folder-ID' $configuration = Get-DSPamScanConfiguration -LiteralName 'ScanA'; $toImport = Get-DSPamScanResult -InputObject $configuration -Filter '@domain.net' -ExcludedManaged; $providerResult = Get-DSPamProvider $provider = $providerResult.Data | Where -Property ID -eq $providerID $importResult = Import-DSPamScanResult -ScanResult $toImport -Provider $provider -FolderID $folderID</dev:code> <dev:remarks> <maml:para>From the 'ScanA' PAM scan's result, import all users who have '@domain.net' in their username, hostname, fullname, or description in the PAM folder specified by $folderID.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamScanConfiguration</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-DSPamScanResult</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>Import-DSPamScanResult</command:name> <gl:group>DSPamScanResult</gl:group> <maml:description> <maml:para>Import the accounts of a PAM scan result</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>DSPamScanResult</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Import the accounts of a PAM scan result</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-DSPamScanResult</maml:name> <command:parameter required="false" position="named"> <maml:name>ResetPasswordOnImport</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ScanResult</maml:name> <command:parameterValue required="true">PSScanResult[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-DSPamScanResult</maml:name> <command:parameter required="false" position="named"> <maml:name>UnmanagedAction</maml:name> <command:parameterValue required="true">SetPasswordManually | ResetPassword</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Unmanaged</maml:name> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ScanResult</maml:name> <command:parameterValue required="true">PSScanResult[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Pam Folder</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>Provider</maml:name> <maml:description> <maml:para>Provider obtained from Get-DSPamProvider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamProvider</command:parameterValue> <dev:type> <maml:name>PamProvider</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> <maml:description> <maml:para>Reset password on check in</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="named"> <maml:name>ResetPasswordOnImport</maml:name> <maml:description> <maml:para>Reset password on import</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>ScanResult</maml:name> <maml:description> <maml:para>Pam accounts revealed by a PAM scan. Must be of the same type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSScanResult[]</command:parameterValue> <dev:type> <maml:name>PSScanResult[]</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="named"> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>Set accounts to unmanaged</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="named"> <maml:name>UnmanagedAction</maml:name> <maml:description> <maml:para>Set accounts to unmanaged. To manually set the password, you must modify directly the scan results. The default action is to set the password manually.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UnmanagedImportAction</command:parameterValue> <dev:type> <maml:name>UnmanagedImportAction</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.Server.Pam.Dto.Import.PamMultipleOperationResult[]</maml:name> <maml:uri /> <maml:description> <maml:para>Result of the import action for each account</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-DSPamScanResult -detailed". For technical information, type "Get-Help Import-DSPamScanResult -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $providerID = 'the-desired-pam-provider-ID' $folderID = 'the-desired-pam-vault-or-folder-ID' $configuration = Get-DSPamScanConfiguration -LiteralName 'ScanA'; $toImport = Get-DSPamScanResult -InputObject $configuration -Filter '@domain.net' -ExcludedManaged; $providerResult = Get-DSPamProvider $provider = $providerResult.Data | Where -Property ID -eq $providerID $importResult = Import-DSPamScanResult -ScanResult $toImport -Provider $provider -FolderID $folderID</dev:code> <dev:remarks> <maml:para>From the 'ScanA' PAM scan's result, import all accounts who have '@domain.net' in their username, hostname, fullname, or description in the PAM folder specified by $folderID.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamScanResult</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-DSPamScanConfiguration</command:name> <gl:group>DSPamScanConfiguration</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSPamScanConfiguration</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSPamScanConfiguration</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="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">AzureAD</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SearchMode</maml:name> <command:parameterValue required="true">Groups | Roles</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyUnits</maml:name> <command:parameterValue required="true">Minutes | Hours | Days | Weeks | Months | Years</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyValue</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Start</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScanNow</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamScanConfiguration</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="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">Domain</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Container</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyUnits</maml:name> <command:parameterValue required="true">Minutes | Hours | Days | Weeks | Months | Years</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyValue</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Start</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScanNow</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamScanConfiguration</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="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">LocalAccounts</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSystemUsers</maml:name> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyUnits</maml:name> <command:parameterValue required="true">Minutes | Hours | Days | Weeks | Months | Years</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyValue</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Start</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScanNow</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamScanConfiguration</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="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">SQL</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DatabaseName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyUnits</maml:name> <command:parameterValue required="true">Minutes | Hours | Days | Weeks | Months | Years</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyValue</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Start</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScanNow</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamScanConfiguration</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="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">Windows</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludedAccounts</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Provider</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyUnits</maml:name> <command:parameterValue required="true">Minutes | Hours | Days | Weeks | Months | Years</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FrequencyValue</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Start</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScanNow</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Container</maml:name> <maml:description> <maml:para>Domain containers.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Database 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain names. The provider's domains are added by default if none are specified.</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="named"> <maml:name>ExcludedAccounts</maml:name> <maml:description> <maml:para>Excluded accounts from the scan. By default, the value 'DefaultExcludedWindowsAccount' is present.</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="named"> <maml:name>FrequencyUnits</maml:name> <maml:description> <maml:para>Frequecy unit for the recurrence</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">InventoryScanFrequencyUnits</command:parameterValue> <dev:type> <maml:name>InventoryScanFrequencyUnits</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FrequencyValue</maml:name> <maml:description> <maml:para>Frequecy value for the recurrence</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="named"> <maml:name>IgnoreSystemUsers</maml:name> <maml:description> <maml:para>Ignore system users</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 scan</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Obtain the scan configuration object</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>Provider</maml:name> <maml:description> <maml:para>Provider obtained from Get-DSPamProvider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamProvider</command:parameterValue> <dev:type> <maml:name>PamProvider</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScanNow</maml:name> <maml:description> <maml:para>Start scan on save</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="named"> <maml:name>SearchMode</maml:name> <maml:description> <maml:para>Search mode</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureSearchMode</command:parameterValue> <dev:type> <maml:name>AzureSearchMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>Start date time of the scan for the recurrence</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>Type</maml:name> <maml:description> <maml:para>Scan configuration type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InventoryScanType</command:parameterValue> <dev:type> <maml:name>InventoryScanType</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-DSPamScanConfiguration -detailed". For technical information, type "Get-Help New-DSPamScanConfiguration -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-DSPamProvider</command:name> <gl:group>DSPamProvider</gl:group> <maml:description> <maml:para>Get all PAM providers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamProvider</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get all PAM providers.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamProvider</maml:name> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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.Server.Pam.Dto.PamProvider[]</maml:name> <maml:uri /> <maml:description> <maml:para>All PAM providers</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Pam.Dto.PamProvider, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with all PAM providers in the data field.</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-DSPamProvider -detailed". For technical information, type "Get-Help Get-DSPamProvider -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-DSPamProvider</command:name> <gl:group>DSPamProvider</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSPamProvider</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSPamProvider</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">DomainUser</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Protocol</maml:name> <command:parameterValue required="true">LDAP | LDAPS</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamProvider</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">LocalUser</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Host</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamProvider</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">SqlServer</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ServerName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>Provider's type: DomainUser (AD), LocalUser (SSH), SqlServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamCredentialType</command:parameterValue> <dev:type> <maml:name>PamCredentialType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provider's 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="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Domain'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="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provider's 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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Credentials - 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Port used for the communication. By default, the port 636 is used.</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="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Protocol used: LDAP or LDAPS. By default, LDAPS is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Protocol</command:parameterValue> <dev:type> <maml:name>Protocol</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Server's name / IP Address</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="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Credentials - 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 New-DSPamProvider -detailed". For technical information, type "Get-Help New-DSPamProvider -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-DSPamProvider</command:name> <gl:group>DSPamProvider</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSPamProvider</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSPamProvider</maml:name> <command:parameter required="true" position="named"> <maml:name>ProviderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>ProviderID</maml:name> <maml:description> <maml:para>Provider's 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 Remove-DSPamProvider -detailed". For technical information, type "Get-Help Remove-DSPamProvider -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>Update-DSPamProvider</command:name> <gl:group>DSPamProvider</gl:group> <maml:description> <maml:para>Update a PAM Provider with given values.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSPamProvider</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a PAM Provider with given parameters. Goes through every parameter and check if key match a key in current Provider data. If so, updates current Provider data and send 'PUT' web request.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSPamProvider</maml:name> <command:parameter required="true" position="named"> <maml:name>ProviderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutApprovalMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory | Optional</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutTime</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-DSPamProvider</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PamProvider</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <maml:description> <maml:para>Ignored</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CheckoutApprovalMode</maml:name> <maml:description> <maml:para>New checkout approval mode to assign the provider</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutApprovalMode</command:parameterValue> <dev:type> <maml:name>CheckoutApprovalMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <maml:description> <maml:para>New checkout reason mode to assign the provider</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutReasonMode</command:parameterValue> <dev:type> <maml:name>CheckoutReasonMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutTime</maml:name> <maml:description> <maml:para>New default checkout time in minutes to assign the provider</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="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <maml:description> <maml:para>Ignored</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="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <maml:description> <maml:para>Ignored</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provider object obtained from Get-DSPamProvider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamProvider</command:parameterValue> <dev:type> <maml:name>PamProvider</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name to assign to the provider</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="named"> <maml:name>ProviderID</maml:name> <maml:description> <maml:para>Id of the provider to update</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>Devolutions.Server.Pam.Dto.PamProvider</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PAM provider object obtained from Get-DSPamProvider</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation</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-DSPamProvider -detailed". For technical information, type "Get-Help Update-DSPamProvider -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Update-DSProvider -ProviderID '00000000-0000-0000-0000-000000000000' -Name 'MyNewProviderName'</dev:code> <dev:remarks> <maml:para>Update the name of the provider whose ID is '00000000-0000-0000-0000-000000000000'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $getResponse = Get-DSPamProvider $provider = $getResponse | Where Label -eq 'MyDomainUserProvider' $desiredGroups = Get-DSADGroup -ProviderID $provider.ID -DN 'OU=Test,DC=mydomain,DC=loc' $provider.JitElevationSettings.AuthorizedGroups = $desiredGroups Update-DSPamProvider -InputObject $provider</dev:code> <dev:remarks> <maml:para>Add all groups of the 'Test' organizational unit in the JIT settings' authorized groups of the provider 'MyDomainUserProvider' and save the modification</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $getResponse = Get-DSPamProvider $provider = $getResponse | Where Label -eq 'MyAzureADUserProvider' $groupsResponse = Get-DSAzureADGroup -ProviderID $provider.ID $desiredGroups = $groupsResponse | Where Name -like group* $provider.JitElevationSettings.AuthorizedGroups = $desiredGroups Update-DSPamProvider -InputObject $provider</dev:code> <dev:remarks> <maml:para>Add all groups whose name starts with 'group' in the JIT settings' authorized groups of the provider 'MyAzureADUserProvider' and save the modification</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSADGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSAzureADGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamProvider</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-DSADGroup</command:name> <gl:group>DSADGroup</gl:group> <maml:description> <maml:para>Get groups from a domain user PAM provider</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSADGroup</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get groups from a domain user PAM provider. It returns the groups of the oganizational unit specified by DN. If the DN parameter is not used, it will look at the root. It is not possible to fetch all groups directly. The data returned can be added to the JIT settings' authorized groups of the provider.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSADGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>ProviderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DN</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsJITSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsJITSettings</maml:name> <maml:description> <maml:para>Return the object as the JIT settings value. Useful it is not initialized in the provider.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>DN</maml:name> <maml:description> <maml:para>Distinguished name of the container searched</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>ProviderID</maml:name> <maml:description> <maml:para>PAM Provider to obtain the domains 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>Devolutions.Server.Models.Shared.Pam.Dto.Active_Directory.PamAdDomainGroup[]</maml:name> <maml:uri /> <maml:description> <maml:para>Groups of the domain user provider</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Devolutions.Server.Models.Shared.Pam.Entities.DvlsPamAdJitElevationSettings</maml:name> <maml:uri /> <maml:description> <maml:para>With the switches AsLegacyResponse and AsJITSettings, the JIT settings of the domain user provider. The groups are in the AuthorizedGroup field of the JIT settings. Useful when the JIT settings is not initialized in the provider.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Models.Shared.Pam.Dto.Active_Directory.PamAdDomainGroup, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response containing the groups of the domain user provider in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Models.Shared.Pam.Entities.DvlsPamAdJitElevationSettings, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response when the AsJITSettings switch is used. It contains the JIT settings of the domain user provider in the data field. The groups are in the AuthorizedGroup field of the JIT settings. Useful when the JIT settings is not initialized in the provider.</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-DSADGroup -detailed". For technical information, type "Get-Help Get-DSADGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $getResponse = Get-DSPamProvider $provider = $getResponse | Where Label -eq 'MyDomainUserProvider' $desiredGroups = Get-DSADGroup -ProviderID $provider.ID -DN 'OU=Test,DC=mydomain,DC=loc' $provider.JitElevationSettings.AuthorizedGroups = $desiredGroups Update-DSPamProvider -InputObject $provider</dev:code> <dev:remarks> <maml:para>Add all groups of the 'Test' organizational unit in the JIT settings' authorized groups of the provider 'MyDomainUserProvider' and save the modification</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamProvider</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamProvider</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-DSAzureADGroup</command:name> <gl:group>DSAzureADGroup</gl:group> <maml:description> <maml:para>Get groups from a Azure AD User PAM provider</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSAzureADGroup</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get groups from a Azure AD User PAM provider. The data returned is the name and sid of each groups. Those values can be added to the JIT settings' authorized groups of the provider.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSAzureADGroup</maml:name> <command:parameter required="true" position="1"> <maml:name>ProviderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsJITSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsJITSettings</maml:name> <maml:description> <maml:para>Return the object as the JIT settings value. Useful it is not initialized in the provider.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>ProviderID</maml:name> <maml:description> <maml:para>PAM Provider to obtain the domains 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>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Models.Shared.Pam.Dto.Active_Directory.PamAzureAdGroup, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response containing the groups of the Azure AD User PAM provider in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Models.Shared.Pam.Entities.DvlsPamAzureAdJitElevationSettings, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response when the AsJITSettings switch is used. It contains the JIT settings of the domain user provider in the data field. The groups are in the AuthorizedGroup field of the JIT settings. Useful when the JIT settings is not initialized in the provider.</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-DSAzureADGroup -detailed". For technical information, type "Get-Help Get-DSAzureADGroup -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $getResponse = Get-DSPamProvider $provider = $getResponse | Where Label -eq 'MyAzureADUserProvider' $groupsResponse = Get-DSAzureADGroup -ProviderID $provider.ID $desiredGroups = $groupsResponse | Where Name -like group* $provider.JitElevationSettings.AuthorizedGroups = $desiredGroups Update-DSPamProvider -InputObject $provider</dev:code> <dev:remarks> <maml:para>Add all groups whose name starts with 'group' in the JIT settings' authorized groups of the provider 'MyAzureADUserProvider' and save the modification</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamProvider</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamProvider</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-DSPamPassword</command:name> <gl:group>DSPamPassword</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamPassword</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamPassword</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>ID of the pam account containing the password</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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 Get-DSPamPassword -detailed". For technical information, type "Get-Help Get-DSPamPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckoutPending</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-DSPamFolder</command:name> <gl:group>DSPamFolder</gl:group> <maml:description> <maml:para>Get pam folders</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get pam folders with three alternatives ways: all of them with the optional inclusion of the root folder, a single one by its ID, or the root folder.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSPamFolder</maml:name> <command:parameter required="false" position="named"> <maml:name>IncludeFolder</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSPamFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Root</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Id of the pam folder to get.</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="named"> <maml:name>IncludeFolder</maml:name> <maml:description> <maml:para>Root folder will be included with all the others.</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="named"> <maml:name>Root</maml:name> <maml:description> <maml:para>Root folder will be fetched.</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.Server.Pam.Dto.PamFolder[]</maml:name> <maml:uri /> <maml:description> <maml:para>Pam folders</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.PamFolder, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response containing a single pam folder in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Pam.Dto.PamFolder, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response containing an array of pam folders in the data field.</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-DSPamFolder -detailed". For technical information, type "Get-Help Get-DSPamFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamFolder</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-DSPamFolderSecurity</command:name> <gl:group>DSPamFolderSecurity</gl:group> <maml:description> <maml:para>Get the security of a pam folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamFolderSecurity</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the security of a pam folder.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamFolderSecurity</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="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>ID</maml:name> <maml:description> <maml:para>Id of the pam folder whose security will be get.</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>Devolutions.Server.ApiWrapper.Models.Pam.Dto.Permission.PamUserPermission[]</maml:name> <maml:uri /> <maml:description> <maml:para>Permissions of a PAM folder</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.ApiWrapper.Models.Pam.Dto.Permission.PamUserPermission[], RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response containing the security of a pam folder in the data field.</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-DSPamFolderSecurity -detailed". For technical information, type "Get-Help Get-DSPamFolderSecurity -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $foldersResponse = Get-DSPamFolder; $pamVault = $foldersResponse | Where Name -eq 'AnExistingVault'; $security = Get-DSPamFolderSecurity -ID $pamVault.ID; New-DSPamFolder -Name 'PamVaultA' -Security $security -AsNewVault</dev:code> <dev:remarks> <maml:para>Create a new PAM vault named 'PamFolderA' with the same security as the PAM vault named 'AnExistingVault'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamFolder</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-DSPamFolder</command:name> <gl:group>DSPamFolder</gl:group> <maml:description> <maml:para>Create a pam folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSPamFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a pam folder. Set it as a new vault or a subfolder of an existing folder.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSPamFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>ParentFolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>AsNewVault</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AsNewVault</maml:name> <maml:description> <maml:para>The new folder's parent will be the root.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Folder's 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="named"> <maml:name>ParentFolderID</maml:name> <maml:description> <maml:para>Id of the new folder's parent.</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"> <maml:name>Security</maml:name> <maml:description> <maml:para>Security permissions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PamUserPermission[]</command:parameterValue> <dev:type> <maml:name>PamUserPermission[]</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSPamFolder -detailed". For technical information, type "Get-Help New-DSPamFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> New-DSPamFolder -Name 'PamVaultA' -AsNewVault</dev:code> <dev:remarks> <maml:para>Create a new PAM vault named 'PamVaultA'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $foldersResponse = Get-DSPamFolder; $parentFolder = $foldersResponse | Where Name -eq 'AnExistingVault'; $usersResponse = Get-DSUser; $user = $usersResponse | Where Name -eq 'ManagerA'; $security = @(); $security += New-DSPamSecurity -Role Manager -Mode Override -UserID $userID; $security += New-DSPamSecurity -Role Approver -Mode Both -UserID $userID; New-DSPamFolder -Name 'PamFolderA' -ParentFolderID $parentFolder.ID -Security $security</dev:code> <dev:remarks> <maml:para>Create a new PAM folder in the PAM vault named 'AnExistingVault'. The only manager will be the user named 'ManagerA'. That user will also be granted the approver role.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $foldersResponse = Get-DSPamFolder; $pamVault = $foldersResponse | Where Name -eq 'AnExistingVault'; $security = Get-DSPamFolderSecurity -ID $pamVault.ID; New-DSPamFolder -Name 'PamVaultA' -Security $security -AsNewVault</dev:code> <dev:remarks> <maml:para>Create a new PAM vault named 'PamFolderA' with the same security as the PAM vault named 'AnExistingVault'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamFolder</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-DSPamFolder</command:name> <gl:group>DSPamFolder</gl:group> <maml:description> <maml:para>Remove a pam folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSPamFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove a pam folder identified by its ID. For the moment, the pam folder must be empty of subfolders and credentials.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSPamFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Id of the pam folder 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSPamFolder -detailed". For technical information, type "Get-Help Remove-DSPamFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamFolder</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>Update-DSPamFolder</command:name> <gl:group>DSPamFolder</gl:group> <maml:description> <maml:para>Update a PAM folder with given values.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSPamFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a PAM folder with given parameters. Goes through every parameter and check if key match a key in current folder data. If so, updates current folder data and send 'PUT' web request.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSPamFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ParentFolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutApprovalMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory | Optional</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutTime</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <maml:description> <maml:para>Users can approve their own Check-out requests</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CheckoutApprovalMode</maml:name> <maml:description> <maml:para>New checkout approval mode to assign the provider</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutApprovalMode</command:parameterValue> <dev:type> <maml:name>CheckoutApprovalMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <maml:description> <maml:para>New checkout reason mode to assign the provider</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutReasonMode</command:parameterValue> <dev:type> <maml:name>CheckoutReasonMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutTime</maml:name> <maml:description> <maml:para>New default checkout time in minutes to assign the provider</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Id of the pam folder to update.</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="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <maml:description> <maml:para>Include administrators when listing approvers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <maml:description> <maml:para>Include PAM managers when listing approvers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name to assign to the provider</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="named"> <maml:name>ParentFolderID</maml:name> <maml:description> <maml:para>Id of the new folder's parent.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Security</maml:name> <maml:description> <maml:para>Security permissions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PamUserPermission[]</command:parameterValue> <dev:type> <maml:name>PamUserPermission[]</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSPamFolder -detailed". For technical information, type "Get-Help Update-DSPamFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamFolder</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamFolder</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-DSPamCheckoutPolicy</command:name> <gl:group>DSPamCheckoutPolicy</gl:group> <maml:description> <maml:para>Return checkout policies</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamCheckoutPolicy</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>If a policy ID is supplied, it will try to fetch and return the policy matching the ID. If no ID is supplied, it will return a list of all policies in place.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamCheckoutPolicy</maml:name> <command:parameter required="false" position="named"> <maml:name>PolicyID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>PolicyID</maml:name> <maml:description> <maml:para>ID of the policy to get</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>Devolutions.Server.Pam.Dto.PamCheckoutPolicy[]</maml:name> <maml:uri /> <maml:description> <maml:para>Policy objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCheckoutPolicy, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with the specified policy in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCheckoutPolicy, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with all checkout policies in the data field.</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-DSPamCheckoutPolicy -detailed". For technical information, type "Get-Help Get-DSPamCheckoutPolicy -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $response = Get-DSPamCheckoutPolicy</dev:code> <dev:remarks> <maml:para>Return all checkout policies currently in place.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $response = Get-DSPamCheckoutPolicy $PolicyID</dev:code> <dev:remarks> <maml:para>Return the checkout policy, if found.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamCheckoutPolicy</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-DSPamCheckoutPolicy</command:name> <gl:group>DSPamCheckoutPolicy</gl:group> <maml:description> <maml:para>Create a new PAM checkout policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSPamCheckoutPolicy</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new PAM checkout policy using supplied parameters. If one or more parameters are omitted, they default to a certain value. Only mandatory value is "Name"</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSPamCheckoutPolicy</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutApprovalMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory | Optional</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutTime</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <maml:description> <maml:para>Indicate if owner can self-checkout.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CheckoutApprovalMode</maml:name> <maml:description> <maml:para>Indicate if the checkout must be approved. Approval mode choices: Default, None, Mandatory</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutApprovalMode</command:parameterValue> <dev:type> <maml:name>CheckoutApprovalMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <maml:description> <maml:para>Indicate if a reason must be given for the checkout. Checkout reason mode choices: Default, None, Mandatory, Optional</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutReasonMode</command:parameterValue> <dev:type> <maml:name>CheckoutReasonMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutTime</maml:name> <maml:description> <maml:para>Default duration assigned to checkout's request. If set at 0, the default value will be used.</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="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <maml:description> <maml:para>Indicate if administrators can approve checkout.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <maml:description> <maml:para>Indicate if managers can approve checkout.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Set as the default policy. It will affect all policies refering to default values.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Policy's name. Must be unique. Cannot be null or white spaces only.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSPamCheckoutPolicy -detailed". For technical information, type "Get-Help New-DSPamCheckoutPolicy -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-DSPamCheckoutPolicy -Name "Public accounts" -CheckoutTime 120 -IsDefault</dev:code> <dev:remarks> <maml:para>Create a new policy that will be used as the default one.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamCheckoutPolicy</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-DSPamCheckoutPolicy</command:name> <gl:group>DSPamCheckoutPolicy</gl:group> <maml:description> <maml:para>Delete a PAM checkout policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSPamCheckoutPolicy</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete a checkout policy if it exists. If not, throws an error indicating that the policy was not found.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSPamCheckoutPolicy</maml:name> <command:parameter required="true" position="named"> <maml:name>PolicyID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>PolicyID</maml:name> <maml:description> <maml:para>ID of the policy 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSPamCheckoutPolicy -detailed". For technical information, type "Get-Help Remove-DSPamCheckoutPolicy -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $response = Get-DSPamCheckoutPolicy; $policy = $reponse | Where Name -eq "Policy A"; Remove-DSPamCheckoutPolicy -PolicyID $policy.ID</dev:code> <dev:remarks> <maml:para>Delete the policy named "Policy A".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamCheckoutPolicy</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>Update-DSPamCheckoutPolicy</command:name> <gl:group>DSPamCheckoutPolicy</gl:group> <maml:description> <maml:para>Update a PAM checkout policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSPamCheckoutPolicy</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a checkout policy using supplied parameters. Omitted parameters are ignored.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSPamCheckoutPolicy</maml:name> <command:parameter required="true" position="named"> <maml:name>PolicyID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutApprovalMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <command:parameterValue required="true">Default | None | Mandatory | Optional</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <command:parameterValue required="true">Default | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutTime</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowCheckoutOwnerAsApprover</maml:name> <maml:description> <maml:para>Indicate if owner can self-checkout.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CheckoutApprovalMode</maml:name> <maml:description> <maml:para>Indicate if the checkout must be approved. Approval mode choices: Default, None, Mandatory</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutApprovalMode</command:parameterValue> <dev:type> <maml:name>CheckoutApprovalMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutReasonMode</maml:name> <maml:description> <maml:para>Indicate if a reason must be given for the checkout. Checkout reason mode choices: Default, None, Mandatory, Optional</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckoutReasonMode</command:parameterValue> <dev:type> <maml:name>CheckoutReasonMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckoutTime</maml:name> <maml:description> <maml:para>Default duration assigned to checkout's request. If set at 0, the default value will be used.</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="named"> <maml:name>IncludeAdminsAsApprovers</maml:name> <maml:description> <maml:para>Indicate if administrators can approve checkout.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeManagersAsApprovers</maml:name> <maml:description> <maml:para>Indicate if managers can approve checkout.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ApproverOptions</command:parameterValue> <dev:type> <maml:name>ApproverOptions</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Set as the default policy. It will affect all policies refering to default values.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Policy's name. Must be unique. Cannot be null or white spaces only.</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="named"> <maml:name>PolicyID</maml:name> <maml:description> <maml:para>ID of the policy to update</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Server response indicating the success of the operation.</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-DSPamCheckoutPolicy -detailed". For technical information, type "Get-Help Update-DSPamCheckoutPolicy -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamCheckoutPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamCheckoutPolicy</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-DSPamCheckout</command:name> <gl:group>DSPamCheckout</gl:group> <maml:description> <maml:para>Return the Pam credential password</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamCheckout</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Return the PAM credential password if it is currently checked out and user has rights.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamCheckout</maml:name> <command:parameter required="true" position="named"> <maml:name>CheckoutID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSPamCheckout</maml:name> <command:parameter required="true" position="named"> <maml:name>ActiveAndPending</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveAndPending</maml:name> <maml:description> <maml:para>Get all active and pending checkouts</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CheckoutID</maml:name> <maml:description> <maml:para>Pam account's 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>Devolutions.Server.Pam.Dto.DvlsPamCheckout[]</maml:name> <maml:uri /> <maml:description> <maml:para>PAM checkout objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.DvlsPamCheckout, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with single pam checkout in the data field. Obtained with the CheckoutID parameter.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.DvlsPamCheckout[], RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with pam checkouts in the data field.</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-DSPamCheckout -detailed". For technical information, type "Get-Help Get-DSPamCheckout -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $checkoutResponse = Get-DSPamCheckout -ActiveAndPending; $pending = $checkoutResponse | Where Status -eq "Pending"; Invoke-DSPamCheckoutPending -Checkout $pending[0] -Approve -ApproverMessage "Accepted"</dev:code> <dev:remarks> <maml:para>Get all pending checkouts. Select the desired checkout and approve it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $checkout = Get-DSPamCheckout -CheckoutID "2735a06c-baa0-4ff9-911c-aa1fcc03ea1e"; Invoke-DSPamCheckin -Checkout $checkout</dev:code> <dev:remarks> <maml:para>Get a pam checkout and check in.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckoutPending</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamPassword</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-DSPamCheckin</command:name> <gl:group>DSPamCheckin</gl:group> <maml:description> <maml:para>Check in a currently checked out PAM credential.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>DSPamCheckin</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Check in a currently checked out PAM credential. To retreive the checkout, as a PamCheckout object, please use Get-DSPamCheckout CMDlet or store the result of Invoke-DSPamCheckout.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-DSPamCheckin</maml:name> <command:parameter required="true" position="named"> <maml:name>Checkout</maml:name> <command:parameterValue required="true">DvlsPamCheckout</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>Pam checkout to check in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DvlsPamCheckout</command:parameterValue> <dev:type> <maml:name>DvlsPamCheckout</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.Server.Pam.Dto.DvlsPamCheckout</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Pam checkout obtained from Get-DSPamCheckout.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Server response indicating the success of the operation.</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-DSPamCheckin -detailed". For technical information, type "Get-Help Invoke-DSPamCheckin -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $Response = Invoke-DSPamCheckout -PamCredentialID '92e1d27f-6e7b-4c62-86da-a04fc22603c2' -Verbose $BobPassword = $Response.Password $BobCheckoutInfo = $Response.CheckoutInfo $BobCheckinResponse = Invoke-DSPamCheckin $BobCheckoutInfo</dev:code> <dev:remarks> <maml:para>Check in the pam checkout</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $checkoutResponse = Get-DSPamCheckout -ActiveAndPending; $checkoutResponse | Where Status -eq "Active" | Invoke-DSPamCheckin</dev:code> <dev:remarks> <maml:para>Check in all active checkouts.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckoutPending</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamPassword</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-DSPamCheckout</command:name> <gl:group>DSPamCheckout</gl:group> <maml:description> <maml:para>Creates a checkout request.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>DSPamCheckout</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Creates a checkout request for the provided PAM credential. Also return the password if approval is not required or if approved ID is the same as the asking user's ID.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-DSPamCheckout</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Reason</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproverID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Duration</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>ID of the pam credential to checkout</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="named"> <maml:name>ApproverID</maml:name> <maml:description> <maml:para>Approver's ID. Necessary if approval is mandatory.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>Duration, in minutes, of the checkout request. By default, it is set to 4 hours (240 minutes).</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="named"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Information on the checkout request to be sent to an administrator for approval.</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>Devolutions.Server.Pam.Dto.DvlsPamCheckout</maml:name> <maml:uri /> <maml:description> <maml:para>Pending pam checkout</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> <maml:description> <maml:para>Active pam checkout and the password</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.DvlsPamCheckout, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response with the pending pam checkout in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response with the active pam checkout and the password in the data field.</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-DSPamCheckout -detailed". For technical information, type "Get-Help Invoke-DSPamCheckout -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $Response = Invoke-DSPamCheckout -PamCredentialID '92e1d27f-6e7b-4c62-86da-a04fc22603c2' -Verbose $BobPassword = $Response.Password $BobCheckoutInfo = $Response.CheckoutInfo $BobCheckinResponse = Invoke-DSPamCheckin $BobCheckoutInfo</dev:code> <dev:remarks> <maml:para>Auto checkout of the pam credential (approval not required)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $Response = Invoke-DSPamCheckout -PamCredentialID '2735a06c-baa0-4ff9-911c-aa1fcc03ea1e' -Reason 'Because' -ApproverID '49a60972-b1ff-4be9-ac73-47c6d4a4125d' $MauricePassword = $Response.Password $MauriceCheckoutInfo = $Response.CheckoutInfo $MauriceCheckinResponse = Invoke-DSPamCheckin $MauriceCheckoutInfo</dev:code> <dev:remarks> <maml:para>Self checkout of the pam credential (approver is the same person who request the checkout)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $Response = Invoke-DSPamCheckout -PamCredentialID '08a521fe-14f7-4ae5-b2b9-d9f6164c15e8' -ApproverID '2364ec1f-a739-450b-afe8-d85b5a3db50e' -Reason 'Because' # After approval $CheckoutResponse = Get-DSPamCheckout -CheckoutID $Response.ID $KellyPassword = Get-DSPamPassword -PamCredentialID $CheckoutResponse.CredentialID $KellyCheckoutInfo = $CheckoutResponse.CheckoutInfo $KellyCheckinResponse = Invoke-DSPamCheckin $KellyCheckoutInfo</dev:code> <dev:remarks> <maml:para>Approved checkout of the pam credential (approval done by the specified approver)</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckoutPending</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamPassword</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-DSPamCheckoutPending</command:name> <gl:group>DSPamCheckoutPending</gl:group> <maml:description> <maml:para>Approve or deny a pending checkout request.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>DSPamCheckoutPending</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Change the state of a pending checkout request depending on the -Accept flag parameter.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-DSPamCheckoutPending</maml:name> <command:parameter required="true" position="named"> <maml:name>Checkout</maml:name> <command:parameterValue required="true">DvlsPamCheckout</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproverMessage</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Approve the checkout request</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="named"> <maml:name>ApproverMessage</maml:name> <maml:description> <maml:para>Test</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>Pending pam checkout to accept</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DvlsPamCheckout</command:parameterValue> <dev:type> <maml:name>DvlsPamCheckout</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSPamCheckoutPending -detailed". For technical information, type "Get-Help Invoke-DSPamCheckoutPending -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $checkoutResponse = Get-DSPamCheckout -ActiveAndPending; $pending = $checkoutResponse | Where Status -eq "Pending"; Invoke-DSPamCheckoutPending -Checkout $pending[0] -Approve -ApproverMessage "Accepted"</dev:code> <dev:remarks> <maml:para>Get all pending checkouts. Select the desired checkout and approve it.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-DSPamCheckout</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamPassword</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-DSPamAccountAccessReport</command:name> <gl:group>DSPamAccountAccessReport</gl:group> <maml:description> <maml:para>Generate a report detailing PAM credential access</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>DSPamAccountAccessReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Generate a report detailing PAM credential access, available in CSV, HTML, and XML formats. By default, the system will overwrite any existing file. To prevent this, employ the NoClobber switch. Specify the credentials to be included in the report using either the AccountID or FolderID parameters. Use AccountID for individual credentials, and FolderID to include all credentials within a specified folder.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-DSPamAccountAccessReport</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">Csv | Html | Xml</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResolveUserGroups</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-DSPamAccountAccessReport</maml:name> <command:parameter required="false" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">Csv | Html | Xml</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResolveUserGroups</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Pam accounts' ID</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Pam folders' ID</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="named"> <maml:name>NoClobber</maml:name> <maml:description> <maml:para>Prevents the cmdlet from overwriting existing files. If a file with the specified name already exists, the cmdlet will generate an error instead of overwriting the 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Enables the cmdlet to output objects it has processed, useful for further pipeline processing or inspection.</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="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the output file where the data will be exported. The path can be either absolute or relative. If only a file name is provided, the file will be created in the current directory. If the specified file already exists, it will be overwritten. To prevent overwriting an existing file, use the -NoClobber switch.</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="named"> <maml:name>ResolveUserGroups</maml:name> <maml:description> <maml:para>Replace user groups by its members</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="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the report type: HTML (default) and CSV</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ReportExportType</command:parameterValue> <dev:type> <maml:name>ReportExportType</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.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>With the PassThru parameter, the users/groups that have access to pam credentials</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the PassThru and AsLegacyResponse parameters, the server response containing the users/groups that have access to pam credentials in the data field.</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-DSPamAccountAccessReport -detailed". For technical information, type "Get-Help Export-DSPamAccountAccessReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Export-DSPamAccountAccessReport -FolderID '12345678-1234-1234-1234-1234567890AB' -Path 'myName.html' -Type Html</dev:code> <dev:remarks> <maml:para>Export an html report named 'myName' in the current directory</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-DSPamAccount</command:name> <gl:group>DSPamAccount</gl:group> <maml:description> <maml:para>Fetch pam accounts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamAccount</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Fetch pam accounts. There is three way to do so. First, get a specific account by using the AccountID parameter. Second, get all pam accounts by calling the cmdlet without parameters. Third, get all pam accounts of a specific folder by using the FolderID parameter. In case there is a lot of PAM accounts, it is possible an TryGoOfflineException occurs. If that is the case, there is two way to avoid that error. First, when calling New-DSSession, use the Timeout parameter to increase the polling delay. Another way is to use AsBasicInformation switch of this cmdlet. This will return a simplified object with the information to quickly identify the PAM accounts of interest.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSPamAccount</maml:name> <command:parameter required="false" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsBasicInformation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Pam account's 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="named"> <maml:name>AsBasicInformation</maml:name> <maml:description> <maml:para>The returned object will be simplified. It allows simple identification of the PAM Account (ID, Label, Username, Domain), its PAM folder (FolderID, FolderName), and its PAM vault (TeamFolderID). It is quicker than obtaining the complete PAM Accounts objects.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Get all accounts in the specified folder</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>Devolutions.Server.Pam.Dto.PamCredential[]</maml:name> <maml:uri /> <maml:description> <maml:para>PAM accounts</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>Simplified PAM accounts.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCredential, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response containg a single pam account in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCredential, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response containing pam accounts in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response containing simplified pam accounts in the data field.</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-DSPamAccount -detailed". For technical information, type "Get-Help Get-DSPamAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $searchRes = Search-DSEntry -By Username -Match ExactExpression -Value 'MyUsername' -IncludePamVaults -IncludeVault @(); $search = $searchRes[0]; $pamAccountRes = Get-DSPamAccount -AccountID $search.ID</dev:code> <dev:remarks> <maml:para>Get the PAM account whose username is 'MyUsername'. It is assumed in this example that the username is unique, so the search result contains a single result.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $pamBasicRes = Get-DSPamAccount -AsBasicInformation; $nameStarts = $pamBasicRes | Where Label -like 'MyName*'; foreach ($pamBasic in $nameStarts) { Remove-DSPamAccount -AccountID $pamBasic.ID }</dev:code> <dev:remarks> <maml:para>Delete all PAM Accounts whose name starts with 'MyName'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamAccountSyncStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamAccount</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-DSPamAccountSecurity</command:name> <gl:group>DSPamAccountSecurity</gl:group> <maml:description> <maml:para>Get the security of a pam account</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamAccountSecurity</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the security of a pam account.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamAccountSecurity</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="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>ID</maml:name> <maml:description> <maml:para>Id of the pam folder whose security will be get.</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>Devolutions.Server.ApiWrapper.Models.Pam.Dto.Permission.PamUserPermission[]</maml:name> <maml:uri /> <maml:description> <maml:para>Permission of a PAM folder</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.ApiWrapper.Models.Pam.Dto.Permission.PamUserPermission[], RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response containing the security of a pam folder in the data field.</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-DSPamAccountSecurity -detailed". For technical information, type "Get-Help Get-DSPamAccountSecurity -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $security = Get-DSPamAccountSecurity -ID $existingAccountID; New-DSPamAccount -Name DomAcc -CredentialType DomainUser -FolderID $folderID -Username MyUsername -Password Pa$$w0rd! -ProviderID $providerID -Security $security</dev:code> <dev:remarks> <maml:para>Create a new PAM account named 'DomAcc' with the same security as the PAM account whose ID is stored in $existingAccountID</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamAccount</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-DSPamAccountSyncStatus</command:name> <gl:group>DSPamAccountSyncStatus</gl:group> <maml:description> <maml:para>Verify if the provider can still access the account in the Domain or the Local SSH machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSPamAccountSyncStatus</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Verify if the provider can still access the account in the Domain or the Local SSH machine. The supported credential types are AzureADUser, DomainUser, LocalUser, SqlServer, and WindowsLocalAccount. If not, an internal server error will be received.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSPamAccountSyncStatus</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Pam account's 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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>System.Management.Automation.PSObject</maml:name> <maml:uri /> <maml:description> <maml:para>Synchronization status</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with the synchronization status in the data field.</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-DSPamAccountSyncStatus -detailed". For technical information, type "Get-Help Get-DSPamAccountSyncStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamAccount</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-DSPamAccount</command:name> <gl:group>DSPamAccount</gl:group> <maml:description> <maml:para>Create a pam account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSPamAccount</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a pam account. For custom account, custom properties are not supported yet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">Certificate</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Certificate</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">Custom</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ProviderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">[AzureADUser | DomainUser | LocalUser | SqlServer | WindowsLocalAccount]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ProviderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>CredentialType</maml:name> <command:parameterValue required="true">Standalone</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Certificate's value</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="named"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>Account's credential type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamCredentialType</command:parameterValue> <dev:type> <maml:name>PamCredentialType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Pam account's 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="named"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>ID of the folder that will contains the new pam account.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Pam account's 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="named"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>Certificate' passphrase</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Pam account'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="false" position="named"> <maml:name>ProviderID</maml:name> <maml:description> <maml:para>Provider's ID where the account will be synced</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="named"> <maml:name>ResetPasswordOnCheckIn</maml:name> <maml:description> <maml:para>Reset password on check in</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="named"> <maml:name>Security</maml:name> <maml:description> <maml:para>Security permissions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PamUserPermission[]</command:parameterValue> <dev:type> <maml:name>PamUserPermission[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Pam account's credentials 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>Devolutions.Server.Pam.Dto.PamCredential</maml:name> <maml:uri /> <maml:description> <maml:para>PAM account created</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCredential, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response with the pam account in the data field.</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-DSPamAccount -detailed". For technical information, type "Get-Help New-DSPamAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> New-DSPamAccount -Name DomAcc -CredentialType DomainUser -FolderID $folderID -Username MyUsername -Password Pa$$w0rd! -Description "My description" -ProviderID $providerID</dev:code> <dev:remarks> <maml:para>Create an account with a pam provider of the type "Domain User" where the account will be synchronized.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> New-DSPamAccount -Name LoneAcc -CredentialType Standalone -FolderID $folderID -Username MyUsername -Password Pa$$w0rd! -Description "My description"</dev:code> <dev:remarks> <maml:para>Create a standalone account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> New-DSPamAccount -Name CertAcc -CredentialType Certificate -FolderID $folderID -Certificate "certificateValue" -Passphrase "passphraseValue"</dev:code> <dev:remarks> <maml:para>Create a certificate account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> $security = Get-DSPamAccountSecurity -ID $existingAccountID; New-DSPamAccount -Name DomAcc -CredentialType DomainUser -FolderID $folderID -Username MyUsername -Password Pa$$w0rd! -ProviderID $providerID -Security $security</dev:code> <dev:remarks> <maml:para>Create a new PAM account named 'DomAcc' with the same security as the PAM account whose ID is stored in $existingAccountID</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamAccountSyncStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamAccount</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-DSPamAccount</command:name> <gl:group>DSPamAccount</gl:group> <maml:description> <maml:para>Delete a pam account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSPamAccount</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete a pam account.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Id of the account 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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.Server.Pam.Dto.PamCredential</maml:name> <maml:uri /> <maml:description> <maml:para>PAM account deleted</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCredential, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with the pam account in the data field.</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-DSPamAccount -detailed". For technical information, type "Get-Help Remove-DSPamAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamAccountSyncStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSPamAccount</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>Update-DSPamAccount</command:name> <gl:group>DSPamAccount</gl:group> <maml:description> <maml:para>Update a pam account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSPamAccount</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a pam account. All modifications are made on the pam account object obtained from Get-DSPamAccount.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSPamAccount</maml:name> <command:parameter required="true" position="named"> <maml:name>PamAccount</maml:name> <command:parameterValue required="true">PamCredential</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Security</maml:name> <command:parameterValue required="true">PamUserPermission[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>PamAccount</maml:name> <maml:description> <maml:para>Modified pam account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PamCredential</command:parameterValue> <dev:type> <maml:name>PamCredential</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New 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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Security</maml:name> <maml:description> <maml:para>Security permissions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PamUserPermission[]</command:parameterValue> <dev:type> <maml:name>PamUserPermission[]</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.Server.Pam.Dto.PamCredential</maml:name> <maml:uri /> <maml:description> <maml:para>PAM account updated</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.Pam.Dto.PamCredential, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with the pam account in the data field.</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-DSPamAccount -detailed". For technical information, type "Get-Help Update-DSPamAccount -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $pamAccount = Get-DSPamAccount -AccountID $accountID; $pamAccount.Label = NewName; $pamAccount.password = N3wPa$$w0rd!; Update-DSPamAccount -PamAccount $pamAccount</dev:code> <dev:remarks> <maml:para>Obtain the pam account to modify. Change its name and password and persist the changes.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSPamAccountSyncStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSPamAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSPamAccount</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>Reset-DSPamPassword</command:name> <gl:group>DSPamPassword</gl:group> <maml:description> <maml:para>Reset the password of a PAM account</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>DSPamPassword</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Reset the password of a PAM account.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-DSPamPassword</maml:name> <command:parameter required="true" position="named"> <maml:name>AccountID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>ID of the pam account containing the password</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>System.Guid</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ID of the PAM account whose password will be reset.</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 Reset-DSPamPassword -detailed". For technical information, type "Get-Help Reset-DSPamPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Reset-DSPamPassword -AccountID 'my-pam-account-id'</dev:code> <dev:remarks> <maml:para>Reset the password of the PAM account whose ID is 'my-pam-account-id'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSPamAccount</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-DSSecureMessages</command:name> <gl:group>DSSecureMessages</gl:group> <maml:description> <maml:para>Fetch all secure messages for the currently authenticated user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSSecureMessages</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>It fetch messages for the user you logged in with (New-DSSession). For other users, you need to re-authenticate and type the command again.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSSecureMessages</maml:name> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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.Server.Models.Shared.Models.SecureMessage.SecureMessage[]</maml:name> <maml:uri /> <maml:description> <maml:para>User's messages received.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.Models.Shared.Models.SecureMessage.SecureMessage, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with the secure messages in the data field.</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-DSSecureMessages -detailed". For technical information, type "Get-Help Get-DSSecureMessages -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>Get-DSSecureMessages</dev:code> <dev:remarks> <maml:para>Fetch all the secure message for the authentififed 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>Get-DSLicense</command:name> <gl:group>DSLicense</gl:group> <maml:description> <maml:para>Get all licenses, except the server one</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSLicense</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get all licenses, except the server one. To obtain the users who have been assigned to a specific license, use the cmdlet Get-DSUserLicense.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSLicense</maml:name> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>License objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseInfo, Devolutions.PowerShell, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response containing the licenses in the data field.</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-DSLicense -detailed". For technical information, type "Get-Help Get-DSLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $licenses = Get-DSLicence</dev:code> <dev:remarks> <maml:para>Obtain all licenses, except the server one</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $licResponse = Get-DSLicence -AsLegacyResponse; $licRespones.Data | Where -Property Status -eq Expired | Unregister-DSLicense</dev:code> <dev:remarks> <maml:para>Remove all expired licenses</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $licResponse = Get-DSLicence; $license = $licRespones.Data | Where -Property License -like XXXXX* | Select -First 1 $assignResponse = Get-DSUserLicense -InputObject $license $assignments = $assignResponse.Data $aUserAssignment = $asssignments | Where Name -eq 'Name of the user to assign' $aUserAssignment.IsMember = $true Set-DSUserLicense -InputObject $aUserAssignment</dev:code> <dev:remarks> <maml:para>Assign the license starting with XXXXX to the user 'Name of the user to assign'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSUserLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-DSUserLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-DSLicense</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-DSUserLicense</command:name> <gl:group>DSUserLicense</gl:group> <maml:description> <maml:para>Get all the assignments of a specific license</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSUserLicense</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get all the assignments of a specific license. To assign a license, modify the IsMember field of the desired user. Once the modifications are done, use the Set-DSUserLicense cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSUserLicense</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSLicenseInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSUserLicense</maml:name> <command:parameter required="true" position="named"> <maml:name>Serial</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>User license assignments of this specific serial</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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Serial</maml:name> <maml:description> <maml:para>User license assignments of this specific 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>License object obtained from the data field of the Get-DSLicense response</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseAssignmentInfo[]</maml:name> <maml:uri /> <maml:description> <maml:para>License assignments</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[RemoteDesktopManager.PowerShellModule.PSOutputObject.PSLicenseAssignmentInfo, Devolutions.PowerShell, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with all users' assignment to a specific license</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-DSUserLicense -detailed". For technical information, type "Get-Help Get-DSUserLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $assignResponse = Get-DSUserLicense -Serial XXXXX-XXXXX-XXXXX-XXXXX-XXXXX $assignments = $assignResponse.Data $asssignments | Where -Property IsMember -eq $true | Select Name, UserId</dev:code> <dev:remarks> <maml:para>Obtain all the users who have been assigned the license 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $AsLegacyResponse = $true $licResponse = Get-DSLicence; $license = $licRespones.Data | Where -Property License -like XXXXX* | Select -First 1 $assignResponse = Get-DSUserLicense -InputObject $license $assignments = $assignResponse.Data $aUserAssignment = $asssignments | Where Name -eq 'Name of the user to assign' $aUserAssignment.IsMember = $true Set-DSUserLicense -InputObject $aUserAssignment</dev:code> <dev:remarks> <maml:para>Assign the license starting with XXXXX to the user 'Name of the user to assign'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-DSUserLicense</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>Register-DSLicense</command:name> <gl:group>DSLicense</gl:group> <maml:description> <maml:para>Register a new license</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>DSLicense</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Register a new license. For the server license, use the cmdlet Register-DSServerLicense. For the AutoAssign parameter, it will be ignored for modules, except the Gateway module. Some examples of modules: CyberArk Integration, Delinea Integration, and Privileged Access Management (PAM).</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-DSLicense</maml:name> <command:parameter required="true" position="named"> <maml:name>Serial</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAssign</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Auto assign new users. Ignored for modules, such as the PAM module.</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="named"> <maml:name>Serial</maml:name> <maml:description> <maml:para>Serial to add to the DVLS 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation</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 Register-DSLicense -detailed". For technical information, type "Get-Help Register-DSLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Register-DSLicense -Serial XXXXX-XXXXX-XXXXX-XXXXX-XXXXX -AutoAssign</dev:code> <dev:remarks> <maml:para>Add a new license with the AutoAssign set</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>Register-DSServerLicense</command:name> <gl:group>DSServerLicense</gl:group> <maml:description> <maml:para>Register the server license</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>DSServerLicense</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Register the server license. For the other licenses, use the cmdlet Register-DSLicense. Using this cmdlet will overwrite the existing server serial if it is already set. </maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-DSServerLicense</maml:name> <command:parameter required="true" position="named"> <maml:name>Serial</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Serial</maml:name> <maml:description> <maml:para>Server 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse, the server response indicating the success of the operation</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 Register-DSServerLicense -detailed". For technical information, type "Get-Help Register-DSServerLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Register-DSServerLicense -Serial XXXXX-XXXXX-XXXXX-XXXXX-XXXXX</dev:code> <dev:remarks> <maml:para>Set the server 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-DSUserLicense</command:name> <gl:group>DSUserLicense</gl:group> <maml:description> <maml:para>Set the license assignments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DSUserLicense</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the license assignments. To assign or unassign a user to a license, modify the IsMember field of the desired user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DSUserLicense</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSLicenseAssignmentInfo[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>User assignements to a license obtained from Get-DSUserLicense</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSLicenseAssignmentInfo[]</command:parameterValue> <dev:type> <maml:name>PSLicenseAssignmentInfo[]</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.PSLicenseAssignmentInfo[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Modified assignments obtained from Get-DSUserLicense</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation</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-DSUserLicense -detailed". For technical information, type "Get-Help Set-DSUserLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $AsLegacyResponse = $true $licResponse = Get-DSLicence; $license = $licRespones.Data | Where -Property License -like XXXXX* | Select -First 1 $assignResponse = Get-DSUserLicense -InputObject $license $assignments = $assignResponse.Data $aUserAssignment = $asssignments | Where Name -eq 'Name of the user to assign' $aUserAssignment.IsMember = $true Set-DSUserLicense -InputObject $aUserAssignment</dev:code> <dev:remarks> <maml:para>Assign the license starting with XXXXX to the user 'Name of the user to assign'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSUserLicense</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>Unregister-DSLicense</command:name> <gl:group>DSLicense</gl:group> <maml:description> <maml:para>Unregister a license</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>DSLicense</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Unregister a license. The server license cannot be unregistered.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-DSLicense</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSLicenseInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>License to delete obtained from Get-DSLicense</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation</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 Unregister-DSLicense -detailed". For technical information, type "Get-Help Unregister-DSLicense -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $licResponse = Get-DSLicence; $licRespones | Where -Property Status -eq Expired | Unregister-DSLicense</dev:code> <dev:remarks> <maml:para>Remove all expired licenses</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSLicense</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-DSGateway</command:name> <gl:group>DSGateway</gl:group> <maml:description> <maml:para>Get gateways</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSGateway</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a single or multiple gateways. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>GatewayID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Obtain all gateways.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>GatewayID</maml:name> <maml:description> <maml:para>ID of the gateway to fetch.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the gateway to fetch.</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>Devolutions.Server.ApiWrapper.Models.Gateway.Gateway[]</maml:name> <maml:uri /> <maml:description> <maml:para>Gateway objects</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[Devolutions.Server.ApiWrapper.Models.Gateway.Gateway, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with the id specified gateway in the data field.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.ApiWrapper.Models.Gateway.Gateway, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with all gateways, or those with the specified name, in the data field.</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-DSGateway -detailed". For technical information, type "Get-Help Get-DSGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $gateways = Get-DSGateway -All; $gateways = $response.Data</dev:code> <dev:remarks> <maml:para>Get all gateways.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $gateway = Get-DSGateway -Name "A Common Name"</dev:code> <dev:remarks> <maml:para>Get the gateway named "A Common Name".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewayLogs</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewaySession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSGateway</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-DSGatewayLogs</command:name> <gl:group>DSGatewayLogs</gl:group> <maml:description> <maml:para>Get a gateway's logs</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSGatewayLogs</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a gateway's logs. The logs will be stored in the specified path. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSGatewayLogs</maml:name> <command:parameter required="true" position="named"> <maml:name>GatewayID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>OutputPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>GatewayID</maml:name> <maml:description> <maml:para>Gateway's 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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Path, including the file name and extension, where the file will be the saved.</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>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Gateway logs</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with the id specified gateway's logs in the data field.</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-DSGatewayLogs -detailed". For technical information, type "Get-Help Get-DSGatewayLogs -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $response = Get-DSGateway -All -AsLegacyResponse; $gateways = $response.Data; $gateways | ForEach-Object {Get-DSGatewayLogs -GatewayID $_.Id -OutputPath "C:\my\path\filename_$_.Name.txt"}</dev:code> <dev:remarks> <maml:para>Get logs for all gateways and create a file for each of them.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewaySession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSGateway</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-DSGatewaySession</command:name> <gl:group>DSGatewaySession</gl:group> <maml:description> <maml:para>Get a gateway's sessions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSGatewaySession</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a gateway's sessions. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSGatewaySession</maml:name> <command:parameter required="true" position="named"> <maml:name>GatewayID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>GatewayID</maml:name> <maml:description> <maml:para>Gateway's 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>Devolutions.Server.ApiWrapper.Models.Gateway.GatewaySession[]</maml:name> <maml:uri /> <maml:description> <maml:para>Gateway session objects.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[Devolutions.Server.ApiWrapper.Models.Gateway.GatewaySession, RemoteDesktopManager.Business, Version=2024.2.6.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response with the gateway sessions in the data field.</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-DSGatewaySession -detailed". For technical information, type "Get-Help Get-DSGatewaySession -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $response = Get-DSGatewaySession -GatewayID "08a521fe-14f7-4ae5-b2b9-d9f6164c15e8" -AsLegacyResponse; $gateway = $response.Data; $gwSessions -GatewayID $gateway.Id</dev:code> <dev:remarks> <maml:para>Get all sessions of the specified gateway.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewayLogs</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSGateway</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-DSGatewayToken</command:name> <gl:group>DSGatewayToken</gl:group> <maml:description> <maml:para>Get a connection's token information</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSGatewayToken</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a connection's token information.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSGatewayToken</maml:name> <command:parameter required="true" position="named"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Gateway's 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>Devolutions.Server.ApiWrapper.Models.Gateway.TokenContainer</maml:name> <maml:uri /> <maml:description> <maml:para>Gateway's token information 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-DSGatewayToken -detailed". For technical information, type "Get-Help Get-DSGatewayToken -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-DSGateway</command:name> <gl:group>DSGateway</gl:group> <maml:description> <maml:para>Create a gateway</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSGateway</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a gateway. Use the parameters to create the gateway. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DevolutionsGatewayUrl</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TCPListeningPort</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TokenDuration</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HealthCheckInterval</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceIpAddressForRdpConnections</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the gateway</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="named"> <maml:name>DevolutionsGatewayUrl</maml:name> <maml:description> <maml:para>URL to reach the Devolutions Gateway. Must be a valid URI and unique to this gateway.</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="named"> <maml:name>ForceIpAddressForRdpConnections</maml:name> <maml:description> <maml:para>Force using IP address for RDP 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HealthCheckInterval</maml:name> <maml:description> <maml:para>Health check interval in minutes. By default, it is set to 60 minutes.</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="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Set as the default gateway</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Gateway's name. The value will be trimmed.</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="named"> <maml:name>TCPListeningPort</maml:name> <maml:description> <maml:para>Port used for RDP sessions, and eventually the SSH sessions.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TokenDuration</maml:name> <maml:description> <maml:para>Generated token duration in minutes. Must be between 1 and 120 minutes. By default, it is set to 5 minutes.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSGateway -detailed". For technical information, type "Get-Help New-DSGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> New-DSGateway -Name "New Gateway" -DevolutionsGatewayUrl "http://localhost" -TCPListeningPort 8181.</dev:code> <dev:remarks> <maml:para>Create a gateway with minimal information.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> New-DSGateway -Name "New Default Gateway" -DevolutionsGatewayUrl "http://localhost" -TCPListeningPort 8181 -Description "A simple description" -IsDefault -ForceIpAddressForRdpConnections -TokenDuration 60 -HealthCheckInterval 240.</dev:code> <dev:remarks> <maml:para>Create the new default gateway.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewayLogs</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewaySession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSGateway</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-DSGateway</command:name> <gl:group>DSGateway</gl:group> <maml:description> <maml:para>Delete a gateway</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSGateway</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete a gateway. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>GatewayID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>GatewayID</maml:name> <maml:description> <maml:para>ID of the gateway 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSGateway -detailed". For technical information, type "Get-Help Remove-DSGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewayLogs</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewaySession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSGateway</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>Start-DSJetsocat</command:name> <gl:group>DSJetsocat</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>DSJetsocat</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-DSJetsocat</maml:name> <command:parameter required="true" position="1"> <maml:name>Token</maml:name> <command:parameterValue required="true">TokenContainer</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ListenerAddress</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ListenerMode</maml:name> <command:parameterValue required="true">Socks5Proxy | HttpProxy | TcpForward</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ListenerAddress</maml:name> <maml:description> <maml:para>Jetsocat listener binding address</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>ListenerMode</maml:name> <maml:description> <maml:para>Jetsocat listener mode</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JetsocatListenerMode</command:parameterValue> <dev:type> <maml:name>JetsocatListenerMode</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>Token</maml:name> <maml:description> <maml:para>Token of the gateway</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TokenContainer</command:parameterValue> <dev:type> <maml:name>TokenContainer</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 Start-DSJetsocat -detailed". For technical information, type "Get-Help Start-DSJetsocat -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>Test-DSGateway</command:name> <gl:group>DSGateway</gl:group> <maml:description> <maml:para>Ping the gateway server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>DSGateway</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Ping the gateway server. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>GatewayID</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>GatewayID</maml:name> <maml:description> <maml:para>ID of the gateway to fetch.</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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 Test-DSGateway -detailed". For technical information, type "Get-Help Test-DSGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewayLogs</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewaySession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSGateway</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>Update-DSGateway</command:name> <gl:group>DSGateway</gl:group> <maml:description> <maml:para>Update a gateway</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSGateway</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a gateway. Use the parameters to modify the gateway. The Devolutions Gateway module is required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSGateway</maml:name> <command:parameter required="true" position="named"> <maml:name>GatewayID</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the gateway</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="named"> <maml:name>DevolutionsGatewayUrl</maml:name> <maml:description> <maml:para>URL to reach the Devolutions Gateway. Must be a valid URI and unique to this gateway.</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="named"> <maml:name>ForceIpAddressForRdpConnections</maml:name> <maml:description> <maml:para>Force using IP address for RDP connections.</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="named"> <maml:name>GatewayID</maml:name> <maml:description> <maml:para>ID of the gateway to update.</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="named"> <maml:name>HealthCheckInterval</maml:name> <maml:description> <maml:para>Health check interval in minutes.</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="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Set as the default gateway</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Gateway's name. The value will be trimmed.</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="named"> <maml:name>TCPListeningPort</maml:name> <maml:description> <maml:para>Port used for RDP sessions, and eventually the SSH sessions.</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="named"> <maml:name>TokenDuration</maml:name> <maml:description> <maml:para>Generated token duration in minutes. Must be between 1 and 120 minutes.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the AsLegacyResponse switch, the server response indicating the success of the operation.</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-DSGateway -detailed". For technical information, type "Get-Help Update-DSGateway -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $response = Get-DSGateway -Name "Old default gateway" -AsLegacyResponse; $gateway = $response.Data[0]; Update-DSGateway -Name "Standard Gateway" -Description "Not the default anymore" -IsDefault $false</dev:code> <dev:remarks> <maml:para>Update the gateway named "Old default gateway" by removing its default status. A new description will indicate the change.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewayLogs</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSGatewaySession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DSGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DSGateway</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-DSEntriesPermissions</command:name> <gl:group>DSEntriesPermissions</gl:group> <maml:description> <maml:para>Gets the permissions for all entries in a vault or for a specific entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSEntriesPermissions</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Recursivly gets all permissions for all entries in a given vault or for a specific entry.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSEntriesPermissions</maml:name> <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="named"> <maml:name>IncludePrincipalsName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSEntriesPermissions</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="named"> <maml:name>IncludePrincipalsName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSEntriesPermissions</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="named"> <maml:name>IncludePrincipalsName</maml:name> </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 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="named"> <maml:name>IncludePrincipalsName</maml:name> <maml:description> <maml:para>Add a PrincipalsName field containing the name associated with the ids of the Principals field.</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>VaultID</maml:name> <maml:description> <maml:para>Id of the vault containing the entries</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>VaultName</maml:name> <maml:description> <maml:para>Name of the vault containing the entries. Case sensitive.</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>System.Management.Automation.PSCustomObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>An array of PSCustomObject containing the permissions information</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-DSEntriesPermissions -detailed". For technical information, type "Get-Help Get-DSEntriesPermissions -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntriesPermissions -VaultID $vaultID</dev:code> <dev:remarks> <maml:para>Get all permisissions in the vault whose ID is stored in $vaultID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntriesPermissions -VaultName 'My Vault'</dev:code> <dev:remarks> <maml:para>Get all permisissions in the vault name 'My Vault'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntriesPermissions -Entry $entryID</dev:code> <dev:remarks> <maml:para>Get all permisissions for the entry whose ID is stored in $entryID.</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-DSEntry</command:name> <gl:group>DSEntry</gl:group> <maml:description> <maml:para>Get entry(ies) from your Devolutions Server instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Using different parameter sets, returns either all entries (from one or all vaults), a specific entry by filter (Get-Help Get-DSEntry -Parameter FilterBy) or paginated results.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchAllVaults</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSEntry</maml:name> <command:parameter required="false" position="named"> <maml:name>AsRDMConnection</maml:name> </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="2"> <maml:name>VaultPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchAllVaults</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSEntry</maml:name> <command:parameter required="false" position="2"> <maml:name>FilterBy</maml:name> <command:parameterValue required="true">Name | Username | Group | Description | Keywords</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FilterMatch</maml:name> <command:parameterValue required="true">Contains | StartsWith | EndsWith | ExactExpression</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>FilterValue</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchAllVaults</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DSEntry</maml:name> <command:parameter required="false" position="3"> <maml:name>FolderID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PageNumber</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PageSize</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchAllVaults</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Get all entries.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AsRDMConnection</maml:name> <maml:description> <maml:para>Return a ConnectionInfoEntity instead of a partial 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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of the desired 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="2"> <maml:name>FilterBy</maml:name> <maml:description> <maml:para>Field on which the filter will be applied. It will be on the Name by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SearchItemType</command:parameterValue> <dev:type> <maml:name>SearchItemType</maml: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>FilterMatch</maml:name> <maml:description> <maml:para>Determine the condition of the search. Default condition is Contains.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SearchItemText</command:parameterValue> <dev:type> <maml:name>SearchItemText</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>FilterValue</maml:name> <maml:description> <maml:para>Value used in the filter</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>FolderID</maml:name> <maml:description> <maml:para>Folder where the entries will be fetched. The default value will the root.</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="2"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>Determine which page is fetched.</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>PageSize</maml:name> <maml:description> <maml:para>Number of entries in a page. Default value is 25 entries per page.</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="named"> <maml:name>SearchAllVaults</maml:name> <maml:description> <maml:para>All vaults will bew considered for the search.</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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Id of the vault to be searched</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="2"> <maml:name>VaultPassword</maml:name> <maml:description> <maml:para>Password of the 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Server response in case of failure with the switch AsLegacyResponse.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the server response with a single entry in the Data field with the switch AsLegacyResponse.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the server response with multiple entries in the Data field with the switch AsLegacyResponse.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>Entries fetched. The format depends on the presence of the switch AsRDMConnection.</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-DSEntry -detailed". For technical information, type "Get-Help Get-DSEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntry</dev:code> <dev:remarks> <maml:para>Get the first page containing 25 entries directly in the root of the default vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntry -SearchAllVaults $EntryId $entryId -AsRDMConnection</dev:code> <dev:remarks> <maml:para>Get the entry by its ID. The search covers all vaults. The </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntry -VaultID $vaultID -All</dev:code> <dev:remarks> <maml:para>Get all entries of the specified vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Get-DSEntry -Filter Name -FilterMatch StartsWith -FilterValue ABC -SearchAllVaults</dev:code> <dev:remarks> <maml:para>Get all entries whose name starts with "ABC" in all the vaults.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntryPasswordHistory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntrySensitiveData</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntrySubConnections</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-DSEntryPasswordHistory</command:name> <gl:group>DSEntryPasswordHistory</gl:group> <maml:description> <maml:para>Return the password history for a given entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSEntryPasswordHistory</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Returns the password history for a given entry. The user must have the appropriate rights.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSEntryPasswordHistory</maml:name> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of 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>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>The password history of an entry.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject[], System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Response with the history in the data field</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-DSEntryPasswordHistory -detailed". For technical information, type "Get-Help Get-DSEntryPasswordHistory -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSEntryPasswordHistory -EntryId $entryId</dev:code> <dev:remarks> <maml:para>Get the password historyfor the entry identified by $entryId.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntrySensitiveData</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntrySubConnections</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-DSEntrySensitiveData</command:name> <gl:group>DSEntrySensitiveData</gl:group> <maml:description> <maml:para>Return sensitive data for a specified entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSEntrySensitiveData</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Return sensitive data for a specified entry. DVLS version must be at least 2020.3.17 to be supported.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSEntrySensitiveData</maml:name> <command:parameter required="true" position="named"> <maml:name>EntryID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>EntryID</maml:name> <maml:description> <maml:para>Id of 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>System.Management.Automation.PSObject</maml:name> <maml:uri /> <maml:description> <maml:para>Sensitive data of an entry.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>ServerResponse containing the sensitive data of an entry.</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-DSEntrySensitiveData -detailed". For technical information, type "Get-Help Get-DSEntrySensitiveData -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSEntrySensitiveData -EntryId $entryId</dev:code> <dev:remarks> <maml:para>Get the sensitive data for the entry identified by $entryId.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntryPasswordHistory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntrySubConnections</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-DSEntrySubConnections</command:name> <gl:group>DSEntrySubConnections</gl:group> <maml:description> <maml:para>Return the subconnections of the entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSEntrySubConnections</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Return the subconnections of the entry.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSEntrySubConnections</maml:name> <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="2"> <maml:name>VaultPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsRDMConnections</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AsRDMConnections</maml:name> <maml:description> <maml:para>Return as ConnectionInfoEntity instead of a partial 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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntryID</maml:name> <maml:description> <maml:para>Id of 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>VaultPassword</maml:name> <maml:description> <maml:para>Password of the 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: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.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>All subconnections of an entry.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>Server response containing the subconnections in the data field.</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-DSEntrySubConnections -detailed". For technical information, type "Get-Help Get-DSEntrySubConnections -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSEntrySubConnections -EntryId $entryId</dev:code> <dev:remarks> <maml:para>Get the subconnetions for the entry identified by $entryId.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntryPasswordHistory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DSEntrySensitiveData</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-DSCredentialEntry</command:name> <gl:group>DSCredentialEntry</gl:group> <maml:description> <maml:para>Create a new entry of type 'Credentials'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSCredentialEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new entry of type 'Credentials' with the parameters supplied. For the supported subtypes, see the ConnectionSubType parameter.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSCredentialEntry</maml:name> <command:parameter required="false" position="named"> <maml:name>ConnectionSubType</maml:name> <command:parameterValue required="true">Default | PrivateKey</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="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <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">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MnemonicPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromptForPassword</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tags</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Expiration</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutMode</maml:name> <command:parameterValue required="true">Default | NotSupported | Automatic | Manual | Inherited | Optional | AutomaticWhenAvailable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowOffline</maml:name> <command:parameterValue required="true">Default | True | False | Inherited</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyType</maml:name> <command:parameterValue required="true">Data | NoKey</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyPassphrase</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromptForPassphrase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowOffline</maml:name> <maml:description> <maml:para>Entry's offline mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AllowOffline</command:parameterValue> <dev:type> <maml:name>AllowOffline</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>CheckoutMode</maml:name> <maml:description> <maml:para>Entry's checkout mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckOutMode</command:parameterValue> <dev:type> <maml:name>CheckOutMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionSubType</maml:name> <maml:description> <maml:para>Connection sub-type. Used for connections of type Credentials. Supported sub-type are Default (Username/Password) or PrivateKey</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CredentialResolverConnectionType</command:parameterValue> <dev:type> <maml:name>CredentialResolverConnectionType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number</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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Entry's 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>Domain</maml:name> <maml:description> <maml:para>Domain'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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>Entry's expiration date (ISO-8601 format (yyyy-mm-ddThh:mm:ss.000Z)</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="7"> <maml:name>Group</maml:name> <maml:description> <maml:para>Entry's location in the vault (folder name, noot 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>MnemonicPassword</maml:name> <maml:description> <maml:para>Entry's mnemonic password to help remembering the 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>Name</maml:name> <maml:description> <maml:para>Entry's 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>Password</maml:name> <maml:description> <maml:para>Entry's 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrivateKeyPassphrase</maml:name> <maml:description> <maml:para>Private key passphrase</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="named"> <maml:name>PrivateKeyPath</maml:name> <maml:description> <maml:para>Full private key path (*.ppk)</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="named"> <maml:name>PrivateKeyType</maml:name> <maml:description> <maml:para>Private key type. The default type is Data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PrivateKeyType</command:parameterValue> <dev:type> <maml:name>PrivateKeyType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PromptForPassphrase</maml:name> <maml:description> <maml:para>Prompt for passphrase before checkout.</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="named"> <maml:name>PromptForPassword</maml:name> <maml:description> <maml:para>Prompt for password when checkout</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="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Entry's tags (keywords). Each word separated by a space is considered a keyword.</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="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> <maml:description> <maml:para>A ticket number is required to view entry's 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="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Username</maml:name> <maml:description> <maml:para>Entry's 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Entry's vault 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSCredentialEntry -detailed". For technical information, type "Get-Help New-DSCredentialEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $NewCredEntry = @{ VaultId = ([guid]::Empty) EntryName = 'rootlocal ' Username = 'root' Password = 'Pa$$w0rd!' Folder = 'Powershell rules' credentialViewedCommentIsRequired = $true credentialViewedPrompt = $true ticketNumberIsRequiredOnCredentialViewed = $true checkOutMode = 'Default' Description = 'This is a description' Tags = '1 2 3 4 5' }; New-DSCredentialEntry @NewCredEntry</dev:code> <dev:remarks> <maml:para>Create a 'Username/Password' credential.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSEntryBase</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSRDPEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSSSHShellEntry</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-DSEntryBase</command:name> <gl:group>DSEntryBase</gl:group> <maml:description> <maml:para>Create a new entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSEntryBase</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new entry without validating anything. This is the functional equivalent of a passthrough. Unless you know exactly what you are doing, you should probably use the CMDlets created by us to generate new entries.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSEntryBase</maml:name> <command:parameter required="true" position="1"> <maml:name>JsonBody</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DSEntryBase</maml:name> <command:parameter required="true" position="1"> <maml:name>FromRDMConnection</maml:name> <command:parameterValue required="true">ConnectionInfoEntity</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>FromRDMConnection</maml:name> <maml:description> <maml:para>Entry obtained from Get-DSEntry -AsRDMConnection. It can be used to create a copy of an existing entry wihtout losing any data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectionInfoEntity</command:parameterValue> <dev:type> <maml:name>ConnectionInfoEntity</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>JsonBody</maml:name> <maml:description> <maml:para>Entry in JSON</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSEntryBase -detailed". For technical information, type "Get-Help New-DSEntryBase -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSCredentialEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSRDPEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSSSHShellEntry</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-DSRDPEntry</command:name> <gl:group>DSRDPEntry</gl:group> <maml:description> <maml:para>Create a new RDP entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSRDPEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new RDP entry with the parameters supplied. All fields have a default value corresponding to those of Remote Desktop Manager.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSRDPEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</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="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">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MnemonicPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromptCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tags</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Expiration</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WarnIfAlreadyOpened</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutMode</maml:name> <command:parameterValue required="true">Default | NotSupported | Automatic | Manual | Inherited | Optional | AutomaticWhenAvailable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowOffline</maml:name> <command:parameterValue required="true">Default | True | False | Inherited</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HostName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdminMode</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RDPType</maml:name> <command:parameterValue required="true">Normal | Azure | HyperV</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureInstanceID</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HyperVInstance</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseEnhancedSessionMode</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesClipboard</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesDevices</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesHardDrives</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesPrinters</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesSerialPorts</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesSmartDevices</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SoundHook</maml:name> <command:parameterValue required="true">BringToThisComputer | DoNotPlay | LeaveAtRemoteComputer | Default</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AudioQualityMode</maml:name> <command:parameterValue required="true">Dynamic | High | Medium | Default</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AudioCaptureRedirectionMode</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeyboardHook</maml:name> <command:parameterValue required="true">OnTheLocalComputer | InFullScreenMode | OnTheRemoteComputer</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlternateShell</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShellWorkingDirectory</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterLoginProgram</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterLoginDelay</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoteApplicationProgram</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoteApplicationCmdLine</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NetworkConnectionType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DesktopBackground</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontSmoothing</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DesktopComposition</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Animations</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VisualStyles</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NetworkAutoDetect</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoReconnection</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RedirectDirectX</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RedirectVideoPlayback</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowContentWhileDragging</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DataCompression</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistentBitmapCaching</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BandwidthAutoDetect</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoadAddonsMode</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSpec</maml:name> <command:parameterValue required="true">Default | FullMode | ThinClientMode | SmallCacheMode</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepAliveInternal</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMode</maml:name> <command:parameterValue required="true">Embedded | External | Undocked</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMonitor</maml:name> <command:parameterValue required="true">Primary | Secondary | Current | Configured | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <command:parameterValue required="true">Current | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NewFieldsList</maml:name> <command:parameterValue required="true">Field[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdminMode</maml:name> <maml:description> <maml:para>Open the administration console</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="named"> <maml:name>AfterLoginDelay</maml:name> <maml:description> <maml:para>Delay (in miliseconds) to launch application after login. 500 ms by default. Must be betwen 0 and 60000.</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="named"> <maml:name>AfterLoginProgram</maml:name> <maml:description> <maml:para>Path (including filename) of application to launch in alternate shell</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="named"> <maml:name>AllowOffline</maml:name> <maml:description> <maml:para>Entry's offline mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AllowOffline</command:parameterValue> <dev:type> <maml:name>AllowOffline</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateShell</maml:name> <maml:description> <maml:para>Path (including filename) of application to launch in alternate shell</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="named"> <maml:name>Animations</maml:name> <maml:description> <maml:para>Enable animations</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>ecord audio from RDP session. True by default.</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="named"> <maml:name>AudioQualityMode</maml:name> <maml:description> <maml:para>RDP Audio Quality. Dynamic by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDPAudioQualityMode</command:parameterValue> <dev:type> <maml:name>RDPAudioQualityMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoReconnection</maml:name> <maml:description> <maml:para>Enable automatic reconnection if RDP drop. True by default.</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="named"> <maml:name>AzureInstanceID</maml:name> <maml:description> <maml:para>Azure Cloud Service's instance ID</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="named"> <maml:name>BandwidthAutoDetect</maml:name> <maml:description> <maml:para>Enable bandwith autodetection. True by default.</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="named"> <maml:name>CheckoutMode</maml:name> <maml:description> <maml:para>Entry's checkout mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckOutMode</command:parameterValue> <dev:type> <maml:name>CheckOutMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClientSpec</maml:name> <maml:description> <maml:para>Cache specifications</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDPClientSpec</command:parameterValue> <dev:type> <maml:name>RDPClientSpec</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on close</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="named"> <maml:name>CloseCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on close</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="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number</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="named"> <maml:name>DataCompression</maml:name> <maml:description> <maml:para>Enable data compression. True by default.</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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Entry's 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="named"> <maml:name>DesktopBackground</maml:name> <maml:description> <maml:para>Enable desktop background. True by default.</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="named"> <maml:name>DesktopComposition</maml:name> <maml:description> <maml:para>Enable desktop composition</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="named"> <maml:name>DisplayMode</maml:name> <maml:description> <maml:para>Display mode used by RDP. Embedded by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ConnectionDisplayMode</command:parameterValue> <dev:type> <maml:name>ConnectionDisplayMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayMonitor</maml:name> <maml:description> <maml:para>Display monitor used by RDP. Primary by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayMonitor</command:parameterValue> <dev:type> <maml:name>DisplayMonitor</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <maml:description> <maml:para>Virtual desktop used by RPD. Current by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayVirtualDesktop</command:parameterValue> <dev:type> <maml:name>DisplayVirtualDesktop</maml: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>Domain</maml:name> <maml:description> <maml:para>Domain'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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>Entry's expiration date (ISO-8601 format (yyyy-mm-ddThh:mm:ss.000Z)</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="named"> <maml:name>FontSmoothing</maml:name> <maml:description> <maml:para>Enable font smoothing</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="6"> <maml:name>Group</maml:name> <maml:description> <maml:para>Entry's location in the vault (folder name, not 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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>RDP's host name (Address)</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="named"> <maml:name>HyperVInstance</maml:name> <maml:description> <maml:para>Hyper-V 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="named"> <maml:name>KeepAliveInternal</maml:name> <maml:description> <maml:para>Keep alive. 1000 by default.</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="named"> <maml:name>KeyboardHook</maml:name> <maml:description> <maml:para>Sets the destination for Windows key combinations (ALT+TAB, for example)</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="named"> <maml:name>LoadAddonsMode</maml:name> <maml:description> <maml:para>Sets if addons load in embedded or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DefaultBoolean</command:parameterValue> <dev:type> <maml:name>DefaultBoolean</maml: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>MnemonicPassword</maml:name> <maml:description> <maml:para>Ignored. Entry's mnemonic password to help remembering the 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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Entry's 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="named"> <maml:name>NetworkAutoDetect</maml:name> <maml:description> <maml:para>Enable network autodetection</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="named"> <maml:name>NetworkConnectionType</maml:name> <maml:description> <maml:para>Connection speed to use for RDP</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFieldsList</maml:name> <maml:description> <maml:para>Fields to add</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Field[]</command:parameterValue> <dev:type> <maml:name>Field[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on open</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="named"> <maml:name>OpenCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on open</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>Password</maml:name> <maml:description> <maml:para>Entry's 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PersistentBitmapCaching</maml:name> <maml:description> <maml:para>Enable persistent bitmap caching. True by default.</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="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Port used by RDP. 3389 by default.</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="named"> <maml:name>PromptCredentials</maml:name> <maml:description> <maml:para>Prompt for password when checkout</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="named"> <maml:name>RDPType</maml:name> <maml:description> <maml:para>RDP Type. Normal by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDPType</command:parameterValue> <dev:type> <maml:name>RDPType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RedirectDirectX</maml:name> <maml:description> <maml:para>Enable DirectX redirection</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="named"> <maml:name>RedirectVideoPlayback</maml:name> <maml:description> <maml:para>Enable video playback redirection</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="named"> <maml:name>RemoteApplicationCmdLine</maml:name> <maml:description> <maml:para>Parameters for the remote application</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="named"> <maml:name>RemoteApplicationProgram</maml:name> <maml:description> <maml:para>Path (including filename and extension) of application to launch</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="named"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Azure Cloud Services 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShellWorkingDirectory</maml:name> <maml:description> <maml:para>Path for alternate shell directory</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="named"> <maml:name>ShowContentWhileDragging</maml:name> <maml:description> <maml:para>Enable content showing while dragging across screen. True by default.</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="named"> <maml:name>SoundHook</maml:name> <maml:description> <maml:para>Choose destination for sounds. BringToThisComputer by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SoundHook</command:parameterValue> <dev:type> <maml:name>SoundHook</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Entry's tags (keywords). Each word separated by a space is considered a keyword.</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="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> <maml:description> <maml:para>A ticket number is required on close</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="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> <maml:description> <maml:para>A ticket number is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> <maml:description> <maml:para>A ticket number is required on open</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="named"> <maml:name>UseEnhancedSessionMode</maml:name> <maml:description> <maml:para>Hyper-V enhanced session (Uses machine's local resources, such as USB drive or printer)</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>Username</maml:name> <maml:description> <maml:para>Entry's 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UsesClipboard</maml:name> <maml:description> <maml:para>RDP access to clipboard. True by default.</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="named"> <maml:name>UsesDevices</maml:name> <maml:description> <maml:para>RDP access to "devices" (Such as cameras...)</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="named"> <maml:name>UsesHardDrives</maml:name> <maml:description> <maml:para>RDP access to hard drives. True by default.</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="named"> <maml:name>UsesPrinters</maml:name> <maml:description> <maml:para>RDP access to printers</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="named"> <maml:name>UsesSerialPorts</maml:name> <maml:description> <maml:para>RDP access to serial ports. True by default.</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="named"> <maml:name>UsesSmartDevices</maml:name> <maml:description> <maml:para>RDP access to smart devices</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>VaultID</maml:name> <maml:description> <maml:para>Entry's vault 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="named"> <maml:name>VisualStyles</maml:name> <maml:description> <maml:para>Enable visual styles. True by default.</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="named"> <maml:name>WarnIfAlreadyOpened</maml:name> <maml:description> <maml:para>Warns the user if RDP session is already opened</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSRDPEntry -detailed". For technical information, type "Get-Help New-DSRDPEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $NewRDPEntry = @{ VaultId = ([guid]::Empty) Name = 'rootlocal ' Username = 'root' Password = 'Pa$$w0rd!' Group = 'Powershell rules' credentialViewedCommentIsRequired = $true credentialViewedPrompt = $true ticketNumberIsRequiredOnCredentialViewed = $true checkOutMode = 'Default' Description = 'This is a description' Tags = '1 2 3 4 5' HostName = 'TBD' }; New-DSRDPEntry @NewRDPEntry</dev:code> <dev:remarks> <maml:para>Create a new RDP entry.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSEntryBase</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSCredentialEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSSSHShellEntry</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-DSSSHShellEntry</command:name> <gl:group>DSSSHShellEntry</gl:group> <maml:description> <maml:para>Create a new SSH Shell entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSSSHShellEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new SSH Shell entry using supplied parameters. New fields in RDM are automatically supported with the 'NewFieldsList' parameter</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSSSHShellEntry</maml:name> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tags</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMode</maml:name> <command:parameterValue required="true">Embedded | External</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMonitor</maml:name> <command:parameterValue required="true">Primary | Secondary | Current | Configured | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <command:parameterValue required="true">Current | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlwaysAskForPassword</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyType</maml:name> <command:parameterValue required="true">Data | NoKey</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyPassphrase</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromptForPassphrase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HostName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HostPort</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterConnectMacroDelay</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterConnectMacros</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterConnectMacroEnterAfterCommand</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BeforeDisconnectMacroDelay</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BeforeDisconnectMacro</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BeforeDisconnectMacroEnterAfterCommand</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverrideTerminalName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <command:parameterValue required="true">Default | UseFontEncoding | UTF_8 | ISO_8859_1 | ISO_8859_2 | ISO_8859_3 | ISO_8859_4 | ISO_8859_5 | ISO_8859_6 | ISO_8859_7 | ISO_8859_8 | ISO_8859_9 | ISO_8859_10 | ISO_8859_11 | ISO_8859_13 | ISO_8859_14 | ISO_8859_15 | ISO_8859_16 | KOI8_U | KOI8_R | HP_ROMAN8 | VSCII | DEC_MCS | Win1250 | Win1251 | Win1252 | Win1253 | Win1254 | Win1255 | Win1256 | Win1257 | Win1258 | CP437 | CP620 | CP819 | CP852 | CP878 | CP932 | EUCJP | CP936</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoWrap</maml:name> <command:parameterValue required="true">Default | On | Off</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocalEcho</maml:name> <command:parameterValue required="true">Default | Auto | On | Off</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InitialKeypadMode</maml:name> <command:parameterValue required="true">Default | Enable | Disable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableKeypadMode</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CursorType</maml:name> <command:parameterValue required="true">Default | Block | Underline | VerticalLine</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CursorBlink</maml:name> <command:parameterValue required="true">Default | On | Off</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceNonDestructiveBackspace</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImplicitCRinLF</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImplicitLFinCR</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxScrollbackLines</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoubleClickDelimiters</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontMode</maml:name> <command:parameterValue required="true">Default | Override</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BellMode</maml:name> <command:parameterValue required="true">Default | None | Sound | Visual | ChangeTabColor</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoteCommand</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CursorKeyMode</maml:name> <command:parameterValue required="true">Default | Normal | Application</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BackspaceKeyMode</maml:name> <command:parameterValue required="true">Default | ControlH | ControlQuestionMark</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HomeEndKeyMode</maml:name> <command:parameterValue required="true">Default | Standard | Rxvt</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FunctionKeyMode</maml:name> <command:parameterValue required="true">Default | EscN | Linux | XtermR6 | VT400 | VT100Plus | SCO | Common | Alternative | HpUx | Linux220 | LinuxAlternative | Pick | VT52 | Wyse | Xterm</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyMode</maml:name> <command:parameterValue required="true">None | Custom</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyType</maml:name> <command:parameterValue required="true">Socks5 | Socks4 | Http</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyHost</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyHostPort</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyUsername</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyLocalHostConnections</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyExcludedHosts</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyDNSLookupType</maml:name> <command:parameterValue required="true">Automatic | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyTelnetCommand</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WarnIfAlreadyOpened</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NewFieldsList</maml:name> <command:parameterValue required="true">Field[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AfterConnectMacroDelay</maml:name> <maml:description> <maml:para>Delay in ms before starting after-connection macros. The default value is the minimal one, 500 ms.</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="named"> <maml:name>AfterConnectMacroEnterAfterCommand</maml:name> <maml:description> <maml:para>If it should send 'Enter' input after entering an after-connection macro. True by default.</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="named"> <maml:name>AfterConnectMacros</maml:name> <maml:description> <maml:para>Macros to run after connection</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="named"> <maml:name>AlwaysAskForPassword</maml:name> <maml:description> <maml:para>If it should always ask for password when checking out</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AutoWrap</maml:name> <maml:description> <maml:para>Toggle terminal autowrapping</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalAutoWrap</command:parameterValue> <dev:type> <maml:name>TerminalAutoWrap</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackspaceKeyMode</maml:name> <maml:description> <maml:para>Keyboard backspace key mode (Default/Control-H/Control-? (ASCII code 127))</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalBackspaceKeyMode</command:parameterValue> <dev:type> <maml:name>TerminalBackspaceKeyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BeforeDisconnectMacro</maml:name> <maml:description> <maml:para>Macros to run before disconnect</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="named"> <maml:name>BeforeDisconnectMacroDelay</maml:name> <maml:description> <maml:para>Delay in ms before starting before-disconnect macro. The default value is the minimal one, 500 ms.</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="named"> <maml:name>BeforeDisconnectMacroEnterAfterCommand</maml:name> <maml:description> <maml:para>If it should send 'Enter' input after entering a before-disconnect macro. True by default.</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="named"> <maml:name>BellMode</maml:name> <maml:description> <maml:para>Select bell mode behavior (Default/None/Sound/Visual)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalBellMode</command:parameterValue> <dev:type> <maml:name>TerminalBellMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on close</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="named"> <maml:name>CloseCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on close</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="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number</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="named"> <maml:name>CursorBlink</maml:name> <maml:description> <maml:para>Toggle terminal cursor blink</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalCursorBlink</command:parameterValue> <dev:type> <maml:name>TerminalCursorBlink</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CursorKeyMode</maml:name> <maml:description> <maml:para>Keyboard cursor key mode (Default/Normal/Application)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalCursorKeyMode</command:parameterValue> <dev:type> <maml:name>TerminalCursorKeyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CursorType</maml:name> <maml:description> <maml:para>Select terminal cursor type (Block/Underline/Vertical line)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalCursorType</command:parameterValue> <dev:type> <maml:name>TerminalCursorType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Entry's 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="named"> <maml:name>DisableKeypadMode</maml:name> <maml:description> <maml:para>Disable terminal application keypad mode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DefaultBoolean</command:parameterValue> <dev:type> <maml:name>DefaultBoolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayMode</maml:name> <maml:description> <maml:para>Display mode used by SSH Shell. Embedded by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ConnectionDisplayMode</command:parameterValue> <dev:type> <maml:name>ConnectionDisplayMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayMonitor</maml:name> <maml:description> <maml:para>Display monitor used by SSH Shell. Primary by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayMonitor</command:parameterValue> <dev:type> <maml:name>DisplayMonitor</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <maml:description> <maml:para>Virtual desktop used by SSH Shell.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayVirtualDesktop</command:parameterValue> <dev:type> <maml:name>DisplayVirtualDesktop</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoubleClickDelimiters</maml:name> <maml:description> <maml:para>Delemiters for double-clicking in terminal</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="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Select terminal encoding</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalEncoding</command:parameterValue> <dev:type> <maml:name>TerminalEncoding</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FontMode</maml:name> <maml:description> <maml:para>Select font mode (Default/Override)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalFontMode</command:parameterValue> <dev:type> <maml:name>TerminalFontMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceNonDestructiveBackspace</maml:name> <maml:description> <maml:para>Force non-destructive backspaces (Disable character 127)</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="named"> <maml:name>FunctionKeyMode</maml:name> <maml:description> <maml:para>Keyboard fn key mode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalFunctionKeysMode</command:parameterValue> <dev:type> <maml:name>TerminalFunctionKeysMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Entry's location in the vault (folder name, not 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HomeEndKeyMode</maml:name> <maml:description> <maml:para>Keyboard home/end key mode (Default/Standard/RXVT)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalHomeEndKeyMode</command:parameterValue> <dev:type> <maml:name>TerminalHomeEndKeyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Entry's hostname</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="named"> <maml:name>HostPort</maml:name> <maml:description> <maml:para>Entry's host port. 22 by default.</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="named"> <maml:name>ImplicitCRinLF</maml:name> <maml:description> <maml:para>Convert CR to LF</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="named"> <maml:name>ImplicitLFinCR</maml:name> <maml:description> <maml:para>Convert LF to CR</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="named"> <maml:name>InitialKeypadMode</maml:name> <maml:description> <maml:para>Terminal's initial keypad mode (Default/Enable (Application in Putty)/Disable (Normal in Putty))</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalKeypadMode</command:parameterValue> <dev:type> <maml:name>TerminalKeypadMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalEcho</maml:name> <maml:description> <maml:para>Toggle terminal local echo</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalLocalEcho</command:parameterValue> <dev:type> <maml:name>TerminalLocalEcho</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxScrollbackLines</maml:name> <maml:description> <maml:para>Terminal max scrollback lines. 2000 lines by default.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Entry's 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFieldsList</maml:name> <maml:description> <maml:para>Fields to add</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Field[]</command:parameterValue> <dev:type> <maml:name>Field[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on open</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="named"> <maml:name>OpenCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on open</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="named"> <maml:name>OverrideTerminalName</maml:name> <maml:description> <maml:para>Override terminal type</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Entry's 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrivateKeyPassphrase</maml:name> <maml:description> <maml:para>Private key passphrase</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="named"> <maml:name>PrivateKeyPath</maml:name> <maml:description> <maml:para>Full private key path (*.ppk)</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="named"> <maml:name>PrivateKeyType</maml:name> <maml:description> <maml:para>Private key type. The default type is NoKey.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PrivateKeyType</command:parameterValue> <dev:type> <maml:name>PrivateKeyType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PromptForPassphrase</maml:name> <maml:description> <maml:para>Prompt for passphrase before checkout.</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="named"> <maml:name>ProxyDNSLookupType</maml:name> <maml:description> <maml:para>Proxy DNS lookup mode. Automatic by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TelnetTerminalDnsLookupType</command:parameterValue> <dev:type> <maml:name>TelnetTerminalDnsLookupType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyExcludedHosts</maml:name> <maml:description> <maml:para>Proxy excluded hosts</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="named"> <maml:name>ProxyHost</maml:name> <maml:description> <maml:para>Proxy Hostname</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="named"> <maml:name>ProxyHostPort</maml:name> <maml:description> <maml:para>Proxy host port</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="named"> <maml:name>ProxyLocalHostConnections</maml:name> <maml:description> <maml:para>Proxy localhost connections</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="named"> <maml:name>ProxyMode</maml:name> <maml:description> <maml:para>Proxy mode (Only None/custom supported)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ProxyMode</command:parameterValue> <dev:type> <maml:name>ProxyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>Proxy 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyTelnetCommand</maml:name> <maml:description> <maml:para>Telnet/local proxy command (blank for default)</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="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Proxy type. Socks5 by default.</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="named"> <maml:name>ProxyUsername</maml:name> <maml:description> <maml:para>Proxy 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoteCommand</maml:name> <maml:description> <maml:para>Ignored. Absolute path of the application on the remote computer</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="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Entry's tags (keywords). Each word separated by a space is considered a keyword.</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="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> <maml:description> <maml:para>A ticket number is required on close</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="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> <maml:description> <maml:para>A ticket number is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> <maml:description> <maml:para>A ticket number is required on open</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="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Entry's 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Entry's vault 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="named"> <maml:name>WarnIfAlreadyOpened</maml:name> <maml:description> <maml:para>Warns the user if session is already opened</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSSSHShellEntry -detailed". For technical information, type "Get-Help New-DSSSHShellEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $parameters = @{ Name = 'TestSSHShell' HostName = 'hostname' Username = 'username' Password = 'Pa$$w0rd!' VaultID = '00000000-0000-0000-0000-000000000000' Tags = 'Test "SSH Shell"' Group = 'Powershell rules' } New-DSSSHShellEntry @parameters</dev:code> <dev:remarks> <maml:para>Create a new SSH entry.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-DSEntryBase</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSCredentialEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-DSRDPEntry</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-DSEntry</command:name> <gl:group>DSEntry</gl:group> <maml:description> <maml:para>Remove a specified entry from the database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove an entry specified by its id from the database.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>EntryID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>EntryID</maml:name> <maml:description> <maml:para>ID of the entry 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSEntry -detailed". For technical information, type "Get-Help Remove-DSEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Remove-DSEntry -EntrID $id</dev:code> <dev:remarks> <maml:para>Delete the entry whose ID is stored in $id</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</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>Update-DSEntryBase</command:name> <gl:group>DSEntryBase</gl:group> <maml:description> <maml:para>Update an entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSEntryBase</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update an entry (Modified entry should be in jsonBody). Unless you know exactly what you are doing, you should probably use the CMDlets created by us to update entries.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSEntryBase</maml:name> <command:parameter required="true" position="1"> <maml:name>JsonBody</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-DSEntryBase</maml:name> <command:parameter required="true" position="1"> <maml:name>FromRDMConnection</maml:name> <command:parameterValue required="true">ConnectionInfoEntity</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>FromRDMConnection</maml:name> <maml:description> <maml:para>Entry obtained from Get-DSEntry -AsRDMConnection. It can be used to update an entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectionInfoEntity</command:parameterValue> <dev:type> <maml:name>ConnectionInfoEntity</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>JsonBody</maml:name> <maml:description> <maml:para>Entry in JSON</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSEntryBase -detailed". For technical information, type "Get-Help Update-DSEntryBase -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $credResponse = Get-DSEntry -EntryID $id $cred = $credResponse.data $cred.data.passwordItem | Add-Member -MemberType NoteProperty -Name SensitiveData -Value 'newPassword' Update-DSEntryBase -JsonBody (ConvertTo-Json -InputObject $cred -Depth 4)</dev:code> <dev:remarks> <maml:para>An existing credential entry with an existing password is fetched. Its password is changed to 'newPassword' by adding a sensitive data property to passwordItem. The entry is converted in json with the requiered depth to avoid being flatten. The entry is updated afterwards.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSRDPEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSSSHShellEntry</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>Update-DSRDPEntry</command:name> <gl:group>DSRDPEntry</gl:group> <maml:description> <maml:para>Update a RDP entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSRDPEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a RDP entry with the parameters supplied.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSRDPEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>EntryID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceAlternateShellProgram</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MnemonicPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromptCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tags</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Expiration</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WarnIfAlreadyOpened</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckoutMode</maml:name> <command:parameterValue required="true">Default | NotSupported | Automatic | Manual | Inherited | Optional | AutomaticWhenAvailable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowOffline</maml:name> <command:parameterValue required="true">Default | True | False | Inherited</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HostName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdminMode</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Port</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RDPType</maml:name> <command:parameterValue required="true">Normal | Azure | HyperV</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureInstanceID</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HyperVInstance</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseEnhancedSessionMode</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesClipboard</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesDevices</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesHardDrives</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesPrinters</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesSerialPorts</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsesSmartDevices</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SoundHook</maml:name> <command:parameterValue required="true">BringToThisComputer | DoNotPlay | LeaveAtRemoteComputer | Default</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AudioQualityMode</maml:name> <command:parameterValue required="true">Dynamic | High | Medium | Default</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AudioCaptureRedirectionMode</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeyboardHook</maml:name> <command:parameterValue required="true">OnTheLocalComputer | InFullScreenMode | OnTheRemoteComputer</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlternateShell</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShellWorkingDirectory</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterLoginProgram</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterLoginDelay</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoteApplicationProgram</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoteApplicationCmdLine</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NetworkConnectionType</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DesktopBackground</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontSmoothing</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DesktopComposition</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Animations</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VisualStyles</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NetworkAutoDetect</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoReconnection</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RedirectDirectX</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RedirectVideoPlayback</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowContentWhileDragging</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DataCompression</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistentBitmapCaching</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BandwidthAutoDetect</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoadAddonsMode</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSpec</maml:name> <command:parameterValue required="true">Default | FullMode | ThinClientMode | SmallCacheMode</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepAliveInternal</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMode</maml:name> <command:parameterValue required="true">Embedded | External | Undocked</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMonitor</maml:name> <command:parameterValue required="true">Primary | Secondary | Current | Configured | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <command:parameterValue required="true">Current | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NewFieldsList</maml:name> <command:parameterValue required="true">Field[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdminMode</maml:name> <maml:description> <maml:para>Open the administration console</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="named"> <maml:name>AfterLoginDelay</maml:name> <maml:description> <maml:para>Delay (in miliseconds) to launch application after login. 500 ms by default. Must be betwen 0 and 6000.</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="named"> <maml:name>AfterLoginProgram</maml:name> <maml:description> <maml:para>Path (including filename) of application to launch in alternate shell</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="named"> <maml:name>AllowOffline</maml:name> <maml:description> <maml:para>Entry's offline mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AllowOffline</command:parameterValue> <dev:type> <maml:name>AllowOffline</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateShell</maml:name> <maml:description> <maml:para>Path (including filename) of application to launch in alternate shell</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="named"> <maml:name>Animations</maml:name> <maml:description> <maml:para>Enable animations</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AudioCaptureRedirectionMode</maml:name> <maml:description> <maml:para>ecord audio from RDP session. True by default.</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="named"> <maml:name>AudioQualityMode</maml:name> <maml:description> <maml:para>RDP Audio Quality. Dynamic by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDPAudioQualityMode</command:parameterValue> <dev:type> <maml:name>RDPAudioQualityMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoReconnection</maml:name> <maml:description> <maml:para>Enable automatic reconnection if RDP drop. True by default.</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="named"> <maml:name>AzureInstanceID</maml:name> <maml:description> <maml:para>Azure Cloud Service's instance ID</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="named"> <maml:name>BandwidthAutoDetect</maml:name> <maml:description> <maml:para>Enable bandwith autodetection. True by default.</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="named"> <maml:name>CheckoutMode</maml:name> <maml:description> <maml:para>Entry's checkout mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckOutMode</command:parameterValue> <dev:type> <maml:name>CheckOutMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClientSpec</maml:name> <maml:description> <maml:para>Cache specifications</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDPClientSpec</command:parameterValue> <dev:type> <maml:name>RDPClientSpec</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on close</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="named"> <maml:name>CloseCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on close</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="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number</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="named"> <maml:name>DataCompression</maml:name> <maml:description> <maml:para>Enable data compression. True by default.</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="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Entry's 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="named"> <maml:name>DesktopBackground</maml:name> <maml:description> <maml:para>Enable desktop background. True by default.</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="named"> <maml:name>DesktopComposition</maml:name> <maml:description> <maml:para>Enable desktop composition</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="named"> <maml:name>DisplayMode</maml:name> <maml:description> <maml:para>Display mode used by RDP. Embedded by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ConnectionDisplayMode</command:parameterValue> <dev:type> <maml:name>ConnectionDisplayMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayMonitor</maml:name> <maml:description> <maml:para>Display monitor used by RDP. Primary by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayMonitor</command:parameterValue> <dev:type> <maml:name>DisplayMonitor</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <maml:description> <maml:para>Virtual desktop used by RPD. Current by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayVirtualDesktop</command:parameterValue> <dev:type> <maml:name>DisplayVirtualDesktop</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain'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="false" position="named"> <maml:name>EntryID</maml:name> <maml:description> <maml:para>ID of the entry to modify.</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="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>Entry's expiration date (ISO-8601 format (yyyy-mm-ddThh:mm:ss.000Z)</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="named"> <maml:name>FontSmoothing</maml:name> <maml:description> <maml:para>Enable font smoothing</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="named"> <maml:name>ForceAlternateShellProgram</maml:name> <maml:description> <maml:para>Force alternate shell use instead of the preferred method RemoteApp.</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="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Entry's location in the vault (folder name, not 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>RDP's host name (Address)</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="named"> <maml:name>HyperVInstance</maml:name> <maml:description> <maml:para>Hyper-V 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="named"> <maml:name>KeepAliveInternal</maml:name> <maml:description> <maml:para>Keep alive. 1000 by default.</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="named"> <maml:name>KeyboardHook</maml:name> <maml:description> <maml:para>Sets the destination for Windows key combinations (ALT+TAB, for example)</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="named"> <maml:name>LoadAddonsMode</maml:name> <maml:description> <maml:para>Sets if addons load in embedded or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DefaultBoolean</command:parameterValue> <dev:type> <maml:name>DefaultBoolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MnemonicPassword</maml:name> <maml:description> <maml:para>Ignored. Entry's mnemonic password to help remembering the 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Entry'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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkAutoDetect</maml:name> <maml:description> <maml:para>Enable network autodetection</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="named"> <maml:name>NetworkConnectionType</maml:name> <maml:description> <maml:para>Connection speed to use for RDP</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFieldsList</maml:name> <maml:description> <maml:para>Fields to add</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Field[]</command:parameterValue> <dev:type> <maml:name>Field[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on open</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="named"> <maml:name>OpenCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on open</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Entry's 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PersistentBitmapCaching</maml:name> <maml:description> <maml:para>Enable persistent bitmap caching. True by default.</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="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Port used by RDP. 3389 by default.</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="named"> <maml:name>PromptCredentials</maml:name> <maml:description> <maml:para>Prompt for password when checkout</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="named"> <maml:name>RDPType</maml:name> <maml:description> <maml:para>RDP Type. Normal by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RDPType</command:parameterValue> <dev:type> <maml:name>RDPType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RedirectDirectX</maml:name> <maml:description> <maml:para>Enable DirectX redirection</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="named"> <maml:name>RedirectVideoPlayback</maml:name> <maml:description> <maml:para>Enable video playback redirection</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="named"> <maml:name>RemoteApplicationCmdLine</maml:name> <maml:description> <maml:para>Parameters for the remote application</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="named"> <maml:name>RemoteApplicationProgram</maml:name> <maml:description> <maml:para>Path (including filename and extension) of application to launch</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="named"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Azure Cloud Services 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShellWorkingDirectory</maml:name> <maml:description> <maml:para>Path for alternate shell directory</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="named"> <maml:name>ShowContentWhileDragging</maml:name> <maml:description> <maml:para>Enable content showing while dragging across screen. True by default.</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="named"> <maml:name>SoundHook</maml:name> <maml:description> <maml:para>Choose destination for sounds. BringToThisComputer by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SoundHook</command:parameterValue> <dev:type> <maml:name>SoundHook</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Entry's tags (keywords). Each word separated by a space is considered a keyword.</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="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> <maml:description> <maml:para>A ticket number is required on close</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="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> <maml:description> <maml:para>A ticket number is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> <maml:description> <maml:para>A ticket number is required on open</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="named"> <maml:name>UseEnhancedSessionMode</maml:name> <maml:description> <maml:para>Hyper-V enhanced session (Uses machine's local resources, such as USB drive or printer)</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="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Entry's 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UsesClipboard</maml:name> <maml:description> <maml:para>RDP access to clipboard. True by default.</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="named"> <maml:name>UsesDevices</maml:name> <maml:description> <maml:para>RDP access to "devices" (Such as cameras...)</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="named"> <maml:name>UsesHardDrives</maml:name> <maml:description> <maml:para>RDP access to hard drives. True by default.</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="named"> <maml:name>UsesPrinters</maml:name> <maml:description> <maml:para>RDP access to printers</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="named"> <maml:name>UsesSerialPorts</maml:name> <maml:description> <maml:para>RDP access to serial ports. True by default.</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="named"> <maml:name>UsesSmartDevices</maml:name> <maml:description> <maml:para>RDP access to smart devices</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="named"> <maml:name>VisualStyles</maml:name> <maml:description> <maml:para>Enable visual styles. True by default.</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="named"> <maml:name>WarnIfAlreadyOpened</maml:name> <maml:description> <maml:para>Warns the user if RDP session is already opened</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating if the operation is successful.</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-DSRDPEntry -detailed". For technical information, type "Get-Help Update-DSRDPEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $parameters = @{ EntryID = $rdpID WarnIfAlreadyOpened = $true OpenCommentPrompt = $true TicketNumberIsRequiredOnOpen = $true } Update-DSRDPEntry @parameters</dev:code> <dev:remarks> <maml:para>Update a specified RDP entry by activating the warn if already opened and requesting a prompt with a ticket number on opening it.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSRDPEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSSSHShellEntry</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>Update-DSSSHShellEntry</command:name> <gl:group>DSSSHShellEntry</gl:group> <maml:description> <maml:para>Update an SSH Shell entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSSSHShellEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update an SSH Shell entry using supplied parameters.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSSSHShellEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>EntryID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tags</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMode</maml:name> <command:parameterValue required="true">Embedded | External</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayMonitor</maml:name> <command:parameterValue required="true">Primary | Secondary | Current | Configured | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <command:parameterValue required="true">Current | Default | First | Second | Third | Fourth | Fifth | Sixth | PromptOnConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlwaysAskForPassword</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyType</maml:name> <command:parameterValue required="true">Data | NoKey</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PrivateKeyPassphrase</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromptForPassphrase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HostName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HostPort</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterConnectMacroDelay</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterConnectMacros</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AfterConnectMacroEnterAfterCommand</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BeforeDisconnectMacroDelay</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BeforeDisconnectMacro</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BeforeDisconnectMacroEnterAfterCommand</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverrideTerminalName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <command:parameterValue required="true">Default | UseFontEncoding | UTF_8 | ISO_8859_1 | ISO_8859_2 | ISO_8859_3 | ISO_8859_4 | ISO_8859_5 | ISO_8859_6 | ISO_8859_7 | ISO_8859_8 | ISO_8859_9 | ISO_8859_10 | ISO_8859_11 | ISO_8859_13 | ISO_8859_14 | ISO_8859_15 | ISO_8859_16 | KOI8_U | KOI8_R | HP_ROMAN8 | VSCII | DEC_MCS | Win1250 | Win1251 | Win1252 | Win1253 | Win1254 | Win1255 | Win1256 | Win1257 | Win1258 | CP437 | CP620 | CP819 | CP852 | CP878 | CP932 | EUCJP | CP936</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoWrap</maml:name> <command:parameterValue required="true">Default | On | Off</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocalEcho</maml:name> <command:parameterValue required="true">Default | Auto | On | Off</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InitialKeypadMode</maml:name> <command:parameterValue required="true">Default | Enable | Disable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableKeypadMode</maml:name> <command:parameterValue required="true">Default | True | False</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CursorType</maml:name> <command:parameterValue required="true">Default | Block | Underline | VerticalLine</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CursorBlink</maml:name> <command:parameterValue required="true">Default | On | Off</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceNonDestructiveBackspace</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImplicitCRinLF</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImplicitLFinCR</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxScrollbackLines</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoubleClickDelimiters</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontMode</maml:name> <command:parameterValue required="true">Default | Override</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BellMode</maml:name> <command:parameterValue required="true">Default | None | Sound | Visual | ChangeTabColor</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoteCommand</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CursorKeyMode</maml:name> <command:parameterValue required="true">Default | Normal | Application</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BackspaceKeyMode</maml:name> <command:parameterValue required="true">Default | ControlH | ControlQuestionMark</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HomeEndKeyMode</maml:name> <command:parameterValue required="true">Default | Standard | Rxvt</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FunctionKeyMode</maml:name> <command:parameterValue required="true">Default | EscN | Linux | XtermR6 | VT400 | VT100Plus | SCO | Common | Alternative | HpUx | Linux220 | LinuxAlternative | Pick | VT52 | Wyse | Xterm</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyMode</maml:name> <command:parameterValue required="true">None | Custom</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyType</maml:name> <command:parameterValue required="true">Socks5 | Socks4 | Http</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyHost</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyHostPort</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyUsername</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyLocalHostConnections</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyExcludedHosts</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyDNSLookupType</maml:name> <command:parameterValue required="true">Automatic | Yes | No</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProxyTelnetCommand</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WarnIfAlreadyOpened</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentPrompt</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NewFieldsList</maml:name> <command:parameterValue required="true">Field[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AfterConnectMacroDelay</maml:name> <maml:description> <maml:para>Delay in ms before starting after-connection macros. The default value is the minimal one, 500 ms.</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="named"> <maml:name>AfterConnectMacroEnterAfterCommand</maml:name> <maml:description> <maml:para>If it should send 'Enter' input after entering an after-connection macro. True by default.</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="named"> <maml:name>AfterConnectMacros</maml:name> <maml:description> <maml:para>Macros to run after connection</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="named"> <maml:name>AlwaysAskForPassword</maml:name> <maml:description> <maml:para>If it should always ask for password when checking out</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AutoWrap</maml:name> <maml:description> <maml:para>Toggle terminal autowrapping</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalAutoWrap</command:parameterValue> <dev:type> <maml:name>TerminalAutoWrap</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackspaceKeyMode</maml:name> <maml:description> <maml:para>Keyboard backspace key mode (Default/Control-H/Control-? (ASCII code 127))</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalBackspaceKeyMode</command:parameterValue> <dev:type> <maml:name>TerminalBackspaceKeyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BeforeDisconnectMacro</maml:name> <maml:description> <maml:para>Macros to run before disconnect</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="named"> <maml:name>BeforeDisconnectMacroDelay</maml:name> <maml:description> <maml:para>Delay in ms before starting before-disconnect macro. The default value is the minimal one, 500 ms.</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="named"> <maml:name>BeforeDisconnectMacroEnterAfterCommand</maml:name> <maml:description> <maml:para>If it should send 'Enter' input after entering a before-disconnect macro. True by default.</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="named"> <maml:name>BellMode</maml:name> <maml:description> <maml:para>Select bell mode behavior (Default/None/Sound/Visual)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalBellMode</command:parameterValue> <dev:type> <maml:name>TerminalBellMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on close</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="named"> <maml:name>CloseCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on close</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="named"> <maml:name>CredentialViewedCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialViewedPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number</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="named"> <maml:name>CursorBlink</maml:name> <maml:description> <maml:para>Toggle terminal cursor blink</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalCursorBlink</command:parameterValue> <dev:type> <maml:name>TerminalCursorBlink</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CursorKeyMode</maml:name> <maml:description> <maml:para>Keyboard cursor key mode (Default/Normal/Application)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalCursorKeyMode</command:parameterValue> <dev:type> <maml:name>TerminalCursorKeyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CursorType</maml:name> <maml:description> <maml:para>Select terminal cursor type (Block/Underline/Vertical line)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalCursorType</command:parameterValue> <dev:type> <maml:name>TerminalCursorType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Entry's 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="named"> <maml:name>DisableKeypadMode</maml:name> <maml:description> <maml:para>Disable terminal application keypad mode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DefaultBoolean</command:parameterValue> <dev:type> <maml:name>DefaultBoolean</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayMode</maml:name> <maml:description> <maml:para>Display mode used by SSH Shell. Embedded by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ConnectionDisplayMode</command:parameterValue> <dev:type> <maml:name>ConnectionDisplayMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayMonitor</maml:name> <maml:description> <maml:para>Display monitor used by SSH Shell. Primary by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayMonitor</command:parameterValue> <dev:type> <maml:name>DisplayMonitor</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayVirtualDesktop</maml:name> <maml:description> <maml:para>Virtual desktop used by SSH Shell.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DisplayVirtualDesktop</command:parameterValue> <dev:type> <maml:name>DisplayVirtualDesktop</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoubleClickDelimiters</maml:name> <maml:description> <maml:para>Delemiters for double-clicking in terminal</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="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Select terminal encoding</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalEncoding</command:parameterValue> <dev:type> <maml:name>TerminalEncoding</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="named"> <maml:name>EntryID</maml:name> <maml:description> <maml:para>ID of the entry to modify.</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="named"> <maml:name>FontMode</maml:name> <maml:description> <maml:para>Select font mode (Default/Override)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalFontMode</command:parameterValue> <dev:type> <maml:name>TerminalFontMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceNonDestructiveBackspace</maml:name> <maml:description> <maml:para>Force non-destructive backspaces (Disable character 127)</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="named"> <maml:name>FunctionKeyMode</maml:name> <maml:description> <maml:para>Keyboard fn key mode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalFunctionKeysMode</command:parameterValue> <dev:type> <maml:name>TerminalFunctionKeysMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Entry's location in the vault (folder name, not 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HomeEndKeyMode</maml:name> <maml:description> <maml:para>Keyboard home/end key mode (Default/Standard/RXVT)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalHomeEndKeyMode</command:parameterValue> <dev:type> <maml:name>TerminalHomeEndKeyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Entry's hostname</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="named"> <maml:name>HostPort</maml:name> <maml:description> <maml:para>Entry's host port. 22 by default.</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="named"> <maml:name>ImplicitCRinLF</maml:name> <maml:description> <maml:para>Convert CR to LF</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="named"> <maml:name>ImplicitLFinCR</maml:name> <maml:description> <maml:para>Convert LF to CR</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="named"> <maml:name>InitialKeypadMode</maml:name> <maml:description> <maml:para>Terminal's initial keypad mode (Default/Enable (Application in Putty)/Disable (Normal in Putty))</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalKeypadMode</command:parameterValue> <dev:type> <maml:name>TerminalKeypadMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalEcho</maml:name> <maml:description> <maml:para>Toggle terminal local echo</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TerminalLocalEcho</command:parameterValue> <dev:type> <maml:name>TerminalLocalEcho</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxScrollbackLines</maml:name> <maml:description> <maml:para>Terminal max scrollback lines. 2000 lines by default.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Entry'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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFieldsList</maml:name> <maml:description> <maml:para>Fields to add</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Field[]</command:parameterValue> <dev:type> <maml:name>Field[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OpenCommentIsRequired</maml:name> <maml:description> <maml:para>A comment is required on open</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="named"> <maml:name>OpenCommentPrompt</maml:name> <maml:description> <maml:para>Prompt the user for comment/ticket number on open</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="named"> <maml:name>OverrideTerminalName</maml:name> <maml:description> <maml:para>Override terminal type</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Entry's 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrivateKeyPassphrase</maml:name> <maml:description> <maml:para>Private key passphrase</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="named"> <maml:name>PrivateKeyPath</maml:name> <maml:description> <maml:para>Full private key path (*.ppk)</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="named"> <maml:name>PrivateKeyType</maml:name> <maml:description> <maml:para>Private key type. The default type is NoKey.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PrivateKeyType</command:parameterValue> <dev:type> <maml:name>PrivateKeyType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PromptForPassphrase</maml:name> <maml:description> <maml:para>Prompt for passphrase before checkout.</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="named"> <maml:name>ProxyDNSLookupType</maml:name> <maml:description> <maml:para>Proxy DNS lookup mode. Automatic by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TelnetTerminalDnsLookupType</command:parameterValue> <dev:type> <maml:name>TelnetTerminalDnsLookupType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyExcludedHosts</maml:name> <maml:description> <maml:para>Proxy excluded hosts</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="named"> <maml:name>ProxyHost</maml:name> <maml:description> <maml:para>Proxy Hostname</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="named"> <maml:name>ProxyHostPort</maml:name> <maml:description> <maml:para>Proxy host port</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="named"> <maml:name>ProxyLocalHostConnections</maml:name> <maml:description> <maml:para>Proxy localhost connections</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="named"> <maml:name>ProxyMode</maml:name> <maml:description> <maml:para>Proxy mode (Only None/custom supported)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ProxyMode</command:parameterValue> <dev:type> <maml:name>ProxyMode</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>Proxy 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyTelnetCommand</maml:name> <maml:description> <maml:para>Telnet/local proxy command (blank for default)</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="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Proxy type. Socks5 by default.</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="named"> <maml:name>ProxyUsername</maml:name> <maml:description> <maml:para>Proxy 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoteCommand</maml:name> <maml:description> <maml:para>Ignored. Absolute path of the application on the remote computer</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="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Entry's tags (keywords). Each word separated by a space is considered a keyword.</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="named"> <maml:name>TicketNumberIsRequiredOnClose</maml:name> <maml:description> <maml:para>A ticket number is required on close</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="named"> <maml:name>TicketNumberIsRequiredOnCredentialViewed</maml:name> <maml:description> <maml:para>A ticket number is required to view entry's 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TicketNumberIsRequiredOnOpen</maml:name> <maml:description> <maml:para>A ticket number is required on open</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="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Entry's 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WarnIfAlreadyOpened</maml:name> <maml:description> <maml:para>Warns the user if session is already opened</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AslegacyResponse, the server response indicating if the operation is successful.</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-DSSSHShellEntry -detailed". For technical information, type "Get-Help Update-DSSSHShellEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $parameters = @{ EntryID = '00000000-0000-0000-0000-000000000000' Password = 'n3WPa$$w0rd!' } Update-DSSSHShellEntry @parameters</dev:code> <dev:remarks> <maml:para>Change the name and password of the specified entry.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSEntryBase</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DSRDPEntry</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-DSFolder</command:name> <gl:group>DSFolder</gl:group> <maml:description> <maml:para>Return a folder by ID</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Return a folder by ID, with possibility of including advanced folder properties</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>FolderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludedAdvancedProperties</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Folder's 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>IncludedAdvancedProperties</maml:name> <maml:description> <maml:para>Used to select if advanced properties should be included</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>System.Management.Automation.PSObject</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the folder</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.DataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the object representing the response with the folder in the Data field.</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-DSFolder -detailed". For technical information, type "Get-Help Get-DSFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSFolder -FolderId $folderId -IncludeAdvancedProperties</dev:code> <dev:remarks> <maml:para>Fetch a specific folder, including its advanced properties</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-DSFolders</command:name> <gl:group>DSFolders</gl:group> <maml:description> <maml:para>Gets all folders for a given vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSFolders</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Gets all folders for a given vaults and include all subfolders if 'IncludeSubFolders' flag is present.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSFolders</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>Used to select if subfolders should be included</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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>Folder's 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>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>Folders fetched</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the object representing the response with the folders in the Data field.</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-DSFolders -detailed". For technical information, type "Get-Help Get-DSFolders -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSFolders -VaultId '00000000-0000-0000-0000-000000000000' -IncludeSubFolders</dev:code> <dev:remarks> <maml:para>Return all folders and subfolders in default vault</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-DSFolder</command:name> <gl:group>DSFolder</gl:group> <maml:description> <maml:para>Create a new folder in a vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new folder in the specified vault</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSFolder</maml:name> <command:parameter required="false" position="9"> <maml:name>CheckOutCommentMode</maml:name> <command:parameterValue required="true">Default | True | False | Inherited</command:parameterValue> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CheckOutMode</maml:name> <command:parameterValue required="true">Default | NotSupported | Automatic | Manual | Inherited | Optional | AutomaticWhenAvailable</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>Domain</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Keywords</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="5"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Username</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="9"> <maml:name>CheckOutCommentMode</maml:name> <maml:description> <maml:para>How the checkout comment mode is set.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckOutCommentMode</command:parameterValue> <dev:type> <maml:name>CheckOutCommentMode</maml: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>CheckOutMode</maml:name> <maml:description> <maml:para>How the checkout mode is set.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">CheckOutMode</command:parameterValue> <dev:type> <maml:name>CheckOutMode</maml: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>Description</maml:name> <maml:description> <maml:para>Description of the 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="3"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain of the 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="7"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group where the folder will be created</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="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>Tags of the folder</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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the folder</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>Password</maml:name> <maml:description> <maml:para>Password of the 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="4"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username of the 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="named"> <maml:name>VaultID</maml:name> <maml:description> <maml:para>ID of the vault where the folder will be created</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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the response.</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-DSFolder -detailed". For technical information, type "Get-Help New-DSFolder -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>Update-DSFolderCredentials</command:name> <gl:group>DSFolderCredentials</gl:group> <maml:description> <maml:para>Updates the credentials (Username/password) on a folder.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSFolderCredentials</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>If the "ClearCredentials" switch parameter is present, it will delete both username AND password from folder. If not, it checks which field was provided and check with the current folder credentials to update accordingly with what credentials were supplied.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSFolderCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>ClearCredentials</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FolderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-DSFolderCredentials</maml:name> <command:parameter required="false" position="2"> <maml:name>Password</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="named"> <maml:name>FolderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-DSFolderCredentials</maml:name> <command:parameter required="true" position="1"> <maml:name>SetInherited</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FolderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>ClearCredentials</maml:name> <maml:description> <maml:para>Clear the username and the password of the folder.</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="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID of the folder to update the credentials</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>Password</maml:name> <maml:description> <maml:para>Password of the 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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetInherited</maml:name> <maml:description> <maml:para>Set the credential mode to inherited.</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 of the 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>Object representing the response.</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-DSFolderCredentials -detailed". For technical information, type "Get-Help Update-DSFolderCredentials -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Update-DSFolderCredentials -FolderId "[guid]" -Username "YourNewUsername" -Password "YourNewPassword"</dev:code> <dev:remarks> <maml:para>Update</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>Unprotect-DSSealedEntry</command:name> <gl:group>DSSealedEntry</gl:group> <maml:description> <maml:para>Unseal an entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unprotect</command:verb> <command:noun>DSSealedEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Unseal an entry.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unprotect-DSSealedEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>ID of the entry to unseal.</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 Unprotect-DSSealedEntry -detailed". For technical information, type "Get-Help Unprotect-DSSealedEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $entry = Get-DSEntry -FilterBy Name -FilterMatch ExactExpression -FilterValue 'InCaseOfEmergency'; PS C:\> Unprotect-DSSealedEntry -ID $entry.ID; PS C:\> $sensitiveData = Get-DSEntrySensitiveData -EntryID $entry.ID; PS C:\> Update-DSEntryBase -FromRDMConnection $entry</dev:code> <dev:remarks> <maml:para>Unseal the entry 'InCaseOfEmergency', get its sensitive data, and reseal the entry. The entry is sealed because the seal state value in $entry has never been modified.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSEntry</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-DSAdDomain</command:name> <gl:group>DSAdDomain</gl:group> <maml:description> <maml:para>Get domains of the server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSAdDomain</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get domains of the server. The Platinum Edition license is required to enable the Multi Domain feature.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSAdDomain</maml:name> <command:parameter required="false" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Ignored parameter.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>Domains obtained</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with the domains in the data field.</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-DSAdDomain -detailed". For technical information, type "Get-Help Get-DSAdDomain -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-DSDomainUsers</command:name> <gl:group>DSDomainUsers</gl:group> <maml:description> <maml:para>Get all users of the specified domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DSDomainUsers</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get all users of the specified domain.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DSDomainUsers</maml:name> <command:parameter required="true" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Name of the domain containing the desired users.</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>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> <maml:description> <maml:para>User informations fetched</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.Private.MultipleDataServerResponse`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=7.4.4.500, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response with the user informations in the data field.</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-DSDomainUsers -detailed". For technical information, type "Get-Help Get-DSDomainUsers -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-DSDomainUsers -DomainName "domain.loc"</dev:code> <dev:remarks> <maml:para>Get all users of the domain "domain.loc".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-DSAdUsers</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>Import-DSAdUsers</command:name> <gl:group>DSAdUsers</gl:group> <maml:description> <maml:para>Import users from the domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>DSAdUsers</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Import users from the domain. Two alternatives are offered: import all users or import users based on their name.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-DSAdUsers</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-DSAdUsers</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Import all users from the specified domain.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Name of the domain containing the users.</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Names of the users to import. It is corresponding to the samAccountName field from the users obtained from Get-DSDomainUsers.</maml:para> </maml:description> <command:parameterValue required="true" 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: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.Private.DataServerResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]][]</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AslegacyResponse, a server response per user imported. The value in the data field is the sid. This is to allow the identification of the user in case of a failure.</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-DSAdUsers -detailed". For technical information, type "Get-Help Import-DSAdUsers -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Import-DSAdUsers -DomainName "domain.loc" -All</dev:code> <dev:remarks> <maml:para>Import all users of the domain "domain.loc".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSDomainUsers</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-DSAdDomain</command:name> <gl:group>DSAdDomain</gl:group> <maml:description> <maml:para>Add a domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DSAdDomain</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Add a domain with the supplied parameters. The Platinum Edition license is required to enable the Multi Domain feature. The administration account supplied needs to be able to retrieve user account information and group memberships. It may requires higher privileges than being part of the Domain Users built-in Active Directory group. In most case, it should be sufficient.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DSAdDomain</maml:name> <command:parameter required="true" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AdministrationUsername</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AdministrationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsLDAPS</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LDAPSCustomPort</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoCreateEnabled</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainUsernameFormatType</maml:name> <command:parameterValue required="true">UPN | NetBios | Username</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainUserReadOnly</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultVault</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdministrationPassword</maml:name> <maml:description> <maml:para>Password part of the credentials of a domain or service account to access the Active Directory forest and obtain user account information through LDAP queries.</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="named"> <maml:name>AdministrationUsername</maml:name> <maml:description> <maml:para>Username part of the credentials of a domain or service account to access the Active Directory forest and obtain user account information through LDAP queries.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AutoCreateEnabled</maml:name> <maml:description> <maml:para>Automatically create the domain user account in the Devolutions Server on the first login attempt.</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="named"> <maml:name>DefaultVault</maml:name> <maml:description> <maml:para>Name of the vault the user will have access to.</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="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Domain name that will be displayed in the application usage like informational messages.</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="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Remote computer 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainUsernameFormatType</maml:name> <maml:description> <maml:para>Select the username format that will be created in the database. UPN : The user will be created using the UPN format ex: bill@windjammer.loc. NetBios : The user will be created using the NetBios format ex: WINDJAMMER\bill. Username : The user will be created using the SAM account name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DomainUsernameFormatType</command:parameterValue> <dev:type> <maml:name>DomainUsernameFormatType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainUserReadOnly</maml:name> <maml:description> <maml:para>Set Read only user instead of User type 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsLDAPS</maml:name> <maml:description> <maml:para>Enable the LDAP over SSL communication.</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="named"> <maml:name>LDAPSCustomPort</maml:name> <maml:description> <maml:para>LDAPS communication port. If not specified, it will be the default one.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSAdDomain -detailed". For technical information, type "Get-Help New-DSAdDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-DSAdDomain -DomainName domain.loc -DisplayName Dom -AdministrationUsername admin -AdministrationPassword "Pa$$w0rd!" -IsLDAPS -LDAPSCustomPort 1500 -AutoCreateEnabled -DomainUsernameFormatType NetBios -DomainUserReadOnly</dev:code> <dev:remarks> <maml:para>Create a new domain with the supplied parameters.</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-DSAdDomain</command:name> <gl:group>DSAdDomain</gl:group> <maml:description> <maml:para>Remove a domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>DSAdDomain</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove a domain identified by the supplied id.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DSAdDomain</maml:name> <command:parameter required="true" position="named"> <maml:name>DomainID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>DomainID</maml:name> <maml:description> <maml:para>Id of the domain 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: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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSAdDomain -detailed". For technical information, type "Get-Help Remove-DSAdDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $domains = Get-DSAdDomain; Remove-DSAdDomain -DomainID $domains.Data[0].ID</dev:code> <dev:remarks> <maml:para>Get all domains. After spotting the ID of the domain to delete (first one in this case), delete the domain.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DSAdDomain</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>Update-DSAdDomain</command:name> <gl:group>DSAdDomain</gl:group> <maml:description> <maml:para>Update a domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DSAdDomain</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update a domain with the supplied parameters.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DSAdDomain</maml:name> <command:parameter required="true" position="named"> <maml:name>DomainID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdministrationUsername</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdministrationPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsLDAPS</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LDAPSCustomPort</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoCreateEnabled</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainUsernameFormatType</maml:name> <command:parameterValue required="true">UPN | NetBios | Username</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DomainUserReadOnly</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultVault</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdministrationPassword</maml:name> <maml:description> <maml:para>Password part of the credentials of a domain or service account to access the Active Directory forest and obtain user account information through LDAP queries.</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="named"> <maml:name>AdministrationUsername</maml:name> <maml:description> <maml:para>Username part of the credentials of a domain or service account to access the Active Directory forest and obtain user account information through LDAP queries.</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="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>AutoCreateEnabled</maml:name> <maml:description> <maml:para>Automatically create the domain user account in the Devolutions Server on the first login attempt.</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="named"> <maml:name>DefaultVault</maml:name> <maml:description> <maml:para>Name of the vault the user will have access to.</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="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Domain name that will be displayed in the application usage like informational messages.</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="named"> <maml:name>DomainID</maml:name> <maml:description> <maml:para>Id of the domain to update.</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="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Remote computer domain 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="named"> <maml:name>DomainUsernameFormatType</maml:name> <maml:description> <maml:para>Select the username format that will be created in the database. UPN : The user will be created using the UPN format ex: bill@windjammer.loc. NetBios : The user will be created using the NetBios format ex: WINDJAMMER\bill. Username : The user will be created using the SAM account name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DomainUsernameFormatType</command:parameterValue> <dev:type> <maml:name>DomainUsernameFormatType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainUserReadOnly</maml:name> <maml:description> <maml:para>Set Read only user instead of User type 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="named"> <maml:name>IsLDAPS</maml:name> <maml:description> <maml:para>Enable the LDAP over SSL communication.</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="named"> <maml:name>LDAPSCustomPort</maml:name> <maml:description> <maml:para>LDAPS communication port. If not specified, it will be the default one.</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.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation.</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-DSAdDomain -detailed". For technical information, type "Get-Help Update-DSAdDomain -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>Disable-DSUser2FA</command:name> <gl:group>DSUser2FA</gl:group> <maml:description> <maml:para>Disable 2FA for a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>DSUser2FA</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Disable 2FA for a user. The server must be configured to allow 2FA enforcement on an individual basis.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-DSUser2FA</maml:name> <command:parameter required="true" position="named"> <maml:name>UserID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>UserID</maml:name> <maml:description> <maml:para>User's 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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation</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 Disable-DSUser2FA -detailed". For technical information, type "Get-Help Disable-DSUser2FA -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Disable-DSUser2FA -UserID $userId</dev:code> <dev:remarks> <maml:para>2FA disabled for the user identified by $userId.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-DSUser2FA</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>Enable-DSUser2FA</command:name> <gl:group>DSUser2FA</gl:group> <maml:description> <maml:para>Enable a predefined 2FA authentication for a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>DSUser2FA</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Enable a predefined 2FA authentication for a user. The server must be configured to allow 2FA enforcement on an individual basis.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-DSUser2FA</maml:name> <command:parameter required="true" position="named"> <maml:name>UserID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TwoFactorAuthenticationType</maml:name> <command:parameterValue required="true">GoogleAuthenticator | Yubikey | Email | Sms | Duo | AzureMFA | Radius</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLegacyResponse</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLegacyResponse</maml:name> <maml:description> <maml:para>In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.</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="named"> <maml:name>TwoFactorAuthenticationType</maml:name> <maml:description> <maml:para>2FA type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TwoFactorAuthenticationType</command:parameterValue> <dev:type> <maml:name>TwoFactorAuthenticationType</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="named"> <maml:name>UserID</maml:name> <maml:description> <maml:para>User's 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>RemoteDesktopManager.PowerShellModule.Private.ServerResponse</maml:name> <maml:uri /> <maml:description> <maml:para>With the switch AsLegacyResponse, the server response indicating the success of the operation</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 Enable-DSUser2FA -detailed". For technical information, type "Get-Help Enable-DSUser2FA -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Enable-DSUser2FA -UserID $userId -TwoFactorAuthenticationType GoogleAuthenticator</dev:code> <dev:remarks> <maml:para>Set an Authenticator (TOTP) for the user identified by $userId. The user will complete the set up on the next login.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-DSUser2FA</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-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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSDecryptedEntry</maml:name> <command:parameterValue required="true">PSDecryptedEntry</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>DocumentPath</maml:name> <maml:description> <maml:para>Path of file to attach to document entry (max 30 MB</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="named"> <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="named"> <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="named"> <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>New-BatchHubEntry</command:name> <gl:group>BatchHubEntry</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>BatchHubEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-BatchHubEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSDecryptedEntryList</maml:name> <command:parameterValue required="true">List`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <maml:name>PSDecryptedEntryList</maml:name> <maml:description> <maml:para>Hub entry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">List`1</command:parameterValue> <dev:type> <maml:name>List`1</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="named"> <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-BatchHubEntry -detailed". For technical information, type "Get-Help New-BatchHubEntry -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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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-HubEntryResolved</command:name> <gl:group>HubEntryResolved</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubEntryResolved</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubEntryResolved</maml:name> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResolveSensitives</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResolvePasswords</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>EntryId</maml:name> <maml:description> <maml:para>Id of 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <maml:name>ResolvePasswords</maml:name> <maml:description> <maml:para>Resolve 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="named"> <maml:name>ResolveSensitives</maml:name> <maml:description> <maml:para>Resolve sensitives</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="named"> <maml:name>VaultId</maml:name> <maml:description> <maml:para>Id of the 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-HubEntryResolved -detailed". For technical information, type "Get-Help Get-HubEntryResolved -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>Format-HubEntryResolved</command:name> <gl:group>HubEntryResolved</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Format</command:verb> <command:noun>HubEntryResolved</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Format-HubEntryResolved</maml:name> <command:parameter required="true" position="named"> <maml:name>Entry</maml:name> <command:parameterValue required="true">PSDecryptedEntry</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResolveSensitives</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResolvePasswords</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>Entry</maml:name> <maml:description> <maml:para>Entry to resolve sensitives and/or passwords</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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <maml:name>ResolvePasswords</maml:name> <maml:description> <maml:para>Resolve 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="named"> <maml:name>ResolveSensitives</maml:name> <maml:description> <maml:para>Resolve sensitives</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 Format-HubEntryResolved -detailed". For technical information, type "Get-Help Format-HubEntryResolved -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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PSDecryptedEntry</maml:name> <command:parameterValue required="true">PSDecryptedEntry</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <maml:name>EntryPermission</maml:name> <maml:description> <maml:para>Set custom entry permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntryPermissionRole</command:parameterValue> <dev:type> <maml:name>EntryPermissionRole</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="named"> <maml:name>EntryRoleId</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Entry Roles</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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryPermission</maml:name> <command:parameterValue required="true">EntryPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EntryId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <maml:name>EntryPermission</maml:name> <maml:description> <maml:para>Set custom entry permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntryPermissionRole</command:parameterValue> <dev:type> <maml:name>EntryPermissionRole</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="named"> <maml:name>EntryRoleId</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Entry Roles</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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>Get-HubEntryRole</command:name> <gl:group>HubEntryRole</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubEntryRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubEntryRole</maml:name> <command:parameter required="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Id of the Hub entry role</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-HubEntryRole -detailed". For technical information, type "Get-Help Get-HubEntryRole -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>2024.2.6</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="named"> <maml:name>PsDecryptedGateway</maml:name> <command:parameterValue required="true">PSDecryptedGateway</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GatewayId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>PsDecryptedGateway</maml:name> <command:parameterValue required="true">PSDecryptedGateway</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GatewayId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>PsDecryptedGatewaySettings</maml:name> <command:parameterValue required="true">PSDecryptedGatewaySettings</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupUserIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PSGroup</maml:name> <command:parameterValue required="true">PSGroup</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>UserIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>UserIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <maml:name>Url</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ApplicationKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>ApplicationKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>All</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>ListAvailable</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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, Devolutions.PowerShell, Version=2024.2.6.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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>SecurePassword</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PSHubContext</maml:name> <command:parameterValue required="true">PSHubContext</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Save-HubContext</maml:name> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PSHubContext</maml:name> <command:parameterValue required="true">PSHubContext</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>SecurePassword</maml:name> </command:parameter> <command:parameter required="true" position="named"> <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="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>PSSystemSettings</maml:name> <command:parameterValue required="true">PSSystemSettings</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>VaultRoleId</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemVaultPermission</maml:name> <command:parameterValue required="true">VaultPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>VaultRoleId</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SystemPermission</maml:name> <command:parameterValue required="true">SystemPermission</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserEmail</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>IsTemporaryPasswordSendByEmail</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Devolutions user</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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>Email</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowOfflineInRDM</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserSendMessageConfiguration</maml:name> <command:parameterValue required="true">MessagesWithAttachments | MessagesWithoutAttachments | NoMessages | Default</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>PSInvitation</maml:name> <command:parameterValue required="true">PSInvitation</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PSUser</maml:name> <command:parameterValue required="true">PSUser</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <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="named"> <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>ConvertTo-ConnectionType</command:name> <gl:group>ConnectionType</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>ConvertTo</command:verb> <command:noun>ConnectionType</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-ConnectionType</maml:name> <command:parameter required="true" position="named"> <maml:name>ConnectionType</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="named"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>String that represent ConnectionType</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 ConvertTo-ConnectionType -detailed". For technical information, type "Get-Help ConvertTo-ConnectionType -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>2024.2.6</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="named"> <maml:name>VaultName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultDescription</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Permanently</maml:name> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <maml:name>Permanently</maml:name> <maml:description> <maml:para>If remove Hub and this is set to true, the vault will be permanently deleted. If not, the vault will be soflty deleted</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="named"> <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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PSVault</maml:name> <command:parameterValue required="true">PSVault</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>VaultPermission</maml:name> <maml:description> <maml:para>Set custom vault permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultPermissionRole</command:parameterValue> <dev:type> <maml:name>VaultPermissionRole</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="named"> <maml:name>VaultRoleId</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</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-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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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>2024.2.6</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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>UserId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultRoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <maml:name>GroupId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultPermission</maml:name> <command:parameterValue required="true">VaultPermissionRole</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>VaultId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <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="named"> <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="named"> <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="named"> <maml:name>VaultPermission</maml:name> <maml:description> <maml:para>Set custom vault permission</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VaultPermissionRole</command:parameterValue> <dev:type> <maml:name>VaultPermissionRole</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="named"> <maml:name>VaultRoleId</maml:name> <maml:description> <maml:para>Set predefined permissions based on Hub Vault Roles</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-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>Get-HubVaultRole</command:name> <gl:group>HubVaultRole</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HubVaultRole</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HubVaultRole</maml:name> <command:parameter required="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <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="named"> <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="named"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Id of the Hub vault role</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-HubVaultRole -detailed". For technical information, type "Get-Help Get-HubVaultRole -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>Copy-RDMDataSource</command:name> <gl:group>RDMDataSource</gl:group> <maml:description> <maml:para>Copy an existing data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>RDMDataSource</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Copy an existing data source. The user can be prompted if the data source requires an MFA. On a Windows OS, a policy can disable this cmdlet. In case of a SQL server with a custom login, it is possible to connect using different credentials.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-RDMDataSource</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-RDMDataSource</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSDataSource</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the data source to copy</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>InputObject</maml:name> <maml:description> <maml:para>PSDataSource obtained from Get-RDMDataSource to copy</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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Data source object to copy obtained from Get-RDMDataSource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSDataSource</maml:name> <maml:uri /> <maml:description> <maml:para>Copy of the data source object with another 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 Copy-RDMDataSource -detailed". For technical information, type "Get-Help Copy-RDMDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMDataSource -Name 'CustomSQL' | Copy-RDMDataSource | Set-RDMCurrentDataSource</dev:code> <dev:remarks> <maml:para>Connect to a copy of the data source 'CustomSQL'. If the user is prompted for the credentials, different credentials can be entered.</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: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-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Export vaults of the current data source in a rdx file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Export vaults of the current data source in a rdx file. To protect the file, the parameter Password must be used. By default, if the file exists in the specified path, it will be overwritten. The NoClobber switch must be used to avoid this behavior. This command is only available for an administrator on an advanced data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-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="true" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAttachments</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeFavorite</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveAllFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Export-RDMRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSRepositoryInfo[]</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="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAttachments</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeFavorite</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveAllFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Export-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="true" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAttachments</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeFavorite</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveAllFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Export-RDMRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</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="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAttachments</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeCredentials</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentation</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeFavorite</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveAllFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the vaults to be exported.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeAttachments</maml:name> <maml:description> <maml:para>Include attachements and documents in the export</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="named"> <maml:name>IncludeCredentials</maml:name> <maml:description> <maml:para>Include credentials in the export.</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="named"> <maml:name>IncludeDocumentation</maml:name> <maml:description> <maml:para>Include entry documentation in the export.</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="named"> <maml:name>IncludeFavorite</maml:name> <maml:description> <maml:para>Keep the favorite status.</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>InputObject</maml:name> <maml:description> <maml:para>Specifies the vaults to be exported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Specifies the name of the vaults to be exported. No characters are interpreted as wildcards.</maml:para> </maml:description> <command:parameterValue required="true" 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="true" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the vaults to be exported.</maml:para> </maml:description> <command:parameterValue required="true" 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="named"> <maml:name>NoClobber</maml:name> <maml:description> <maml:para>NoClobber prevents an existing file from being overwritten and displays a message that the file already exists. By default, if a file exists in the specified path, it is overwritten.</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Protect the data with a master key.</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="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path where the file containing the exported vaults will be saved. The extension must be '.rdx'. If it is not the case, it will be modified to it.</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="named"> <maml:name>RemoveAllFolders</maml:name> <maml:description> <maml:para>Remove all folders. All other entries will have their group set at the root level.</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="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 Export-RDMRepository -detailed". For technical information, type "Get-Help Export-RDMRepository -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; Export-RDMRepository -Name Vault* -Path myFile.rdx -Password $pwd -RemoveAllFolders</dev:code> <dev:remarks> <maml:para>Export all vaults whose name start with 'Vault' in 'myFile.rdx'. The file is protected with the parameter $pwd. All folders are not exported. The entries will all be at the root level.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $filePath = 'C:\my\path\filename.rdx'; Export-RDMRepository -Name VaultA, VaultB, VaultC -Path $path -IncludeAttachments -IncludeCredentials -IncludeDocumentation; Get-RDMDataSource -Name AnotherOne | Set-RDMCurrentDataSource; Import-RDMSession -Path myFile.rdx -KeepID -Duplicate IgnoreAll</dev:code> <dev:remarks> <maml:para>Export VaultA, VaultB, and VaultC of the current data source in the file specified by $path. Change the current data source to 'AnotherOne' and import all vaults recently exported. With the KeepID switch present, all imported entries will keep their ID. As long as the new data source does not use the same database, no unexpected behaviors will happen.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-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>Get-RDMDataSourceCustomVariable</command:name> <gl:group>RDMDataSourceCustomVariable</gl:group> <maml:description> <maml:para>Get the custom variables stored in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMDataSourceCustomVariable</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the custom variables stored in the current data source. The path to access those variables in Remote Desktop Manager is Administration -> System Settings -> Common -> Custom Variables. The user must have the rights to access the data source settings. Only advanced data source have settings.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMDataSourceCustomVariable</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the custom variables by their 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>Devolutions.RemoteDesktopManager.Business.DataSourceVariable[]</maml:name> <maml:uri /> <maml:description> <maml:para>Array of the custom variables stored in the data source</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-RDMDataSourceCustomVariable -detailed". For technical information, type "Get-Help Get-RDMDataSourceCustomVariable -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $customVars = Get-RDMDataSourceCustomVariable -Name $VAR*</dev:code> <dev:remarks> <maml:para>Obtain all custom variables stored in the data source whose name start with $Var.</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-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Import vaults contained in a rdx file in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Import vaults contained in a rdx file in the current data source. If the file is protected, the parameter Password must be used to unlock the data contained. By default, all entries will have their ID changedd. This is to avoid unwanted behaviors, such as moving an entry if imported in the same database. The Duplicate parameter indicates the action (ignore, overwrite, add) to apply in presence of duplicated entries. A limitation of the command is the inability to map the imported vaults to a specific one. Each vault will be assigned to an existing one with the same ID or the same name, or a new one if none are found. This command is only available for an administrator on an advanced data source.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-RDMRepository</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="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Duplicate</maml:name> <command:parameterValue required="true">IgnoreAll | OverwriteAll | AddAll</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepID</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Duplicate</maml:name> <maml:description> <maml:para>Action to apply to the imported entries in case of a duplicate. If the KeepID switch is not present, no duplicate will be found. By default, all duplicates will be ignored.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DuplicateAction</command:parameterValue> <dev:type> <maml:name>DuplicateAction</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepID</maml:name> <maml:description> <maml:para>Keep all imported connections' ID. This is can cause unwanted behaviors, such as moving an entry if imported in the same database.</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Unlock the data contained in the 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 containing the exported vaults will be saved. The extension must be '.rdx'.</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-RDMRepository -detailed". For technical information, type "Get-Help Import-RDMRepository -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; Import-RDMRepository -Path myFile.rdx -Password $pwd</dev:code> <dev:remarks> <maml:para>Import all vaults in 'myFile.rdx'. The protected file is unlocked with the parameter $pwd.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $filePath = 'C:\my\path\filename.rdx'; Export-RDMRepository -Name VaultA, VaultB, VaultC -Path $path -IncludeAttachments -IncludeCredentials -IncludeDocumentation; Get-RDMDataSource -Name AnotherOne | Set-RDMCurrentDataSource; Import-RDMSession -Path myFile.rdx -KeepID -Duplicate IgnoreAll</dev:code> <dev:remarks> <maml:para>Export VaultA, VaultB, and VaultC of the current data source in the file specified by $path. Change the current data source to 'AnotherOne' and import all vaults recently exported. With the KeepID switch present, all imported entries will keep their ID. As long as the new data source does not use the same database, no unexpected behaviors will happen.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Export-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>New-RDMDataSourceCustomVariable</command:name> <gl:group>RDMDataSourceCustomVariable</gl:group> <maml:description> <maml:para>Create a new custom variable stored in the current data source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMDataSourceCustomVariable</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new custom variable stored in the current data source. The path to access those variables in Remote Desktop Manager is Administration -> System Settings -> Common -> Custom Variables. The user must have the rights to access the data source settings. Only advanced data source have settings.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMDataSourceCustomVariable</maml:name> <command:parameter required="false" position="3"> <maml:name>Description</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="named"> <maml:name>SetCustomVariable</maml:name> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Value</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the custom variable</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 variable. Two special characters can be used: '_' everywhere and '$' at the start and the end. Other characters are not allowed. All lower letters will be converted to upper characters.</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="named"> <maml:name>SetCustomVariable</maml:name> <maml:description> <maml:para>Save the new custom variable 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="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value of the variable</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>Devolutions.RemoteDesktopManager.Business.DataSourceVariable</maml:name> <maml:uri /> <maml:description> <maml:para>Newly created custom variable 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-RDMDataSourceCustomVariable -detailed". For technical information, type "Get-Help New-RDMDataSourceCustomVariable -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-RDMDataSourceCustomVariable -Name MyVarName -Value MyVarValue -Description MyVarDesc -SetCustomVariable</dev:code> <dev:remarks> <maml:para>Create or update a custom variable in the data source settings.</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-RDMEntryCheckIn</command:name> <gl:group>RDMEntryCheckIn</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>Invoke</command:verb> <command:noun>RDMEntryCheckIn</command:noun> <dev:version>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Invoke-RDMEntryCheckIn</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Connection to check in. Accept a PSConnection object or the connection's ID.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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-RDMEntryCheckIn -detailed". For technical information, type "Get-Help Invoke-RDMEntryCheckIn -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>Invoke-RDMEntryCheckOut</command:name> <gl:group>RDMEntryCheckOut</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>Invoke</command:verb> <command:noun>RDMEntryCheckOut</command:noun> <dev:version>2024.2.6</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:syntax> <command:syntaxItem> <maml:name>Invoke-RDMEntryCheckOut</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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 check out prompt. If it is required and the parameter not used, the user will be prompted for it.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Connection to check out. Accept a PSConnection object or the connection's ID.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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-RDMEntryCheckOut -detailed". For technical information, type "Get-Help Invoke-RDMEntryCheckOut -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-RDMDataSourceCustomVariable</command:name> <gl:group>RDMDataSourceCustomVariable</gl:group> <maml:description> <maml:para>Delete custom variables in the current data source settings.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMDataSourceCustomVariable</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete custom variables in the current data source settings. The path to access those variables in Remote Desktop Manager is Administration -> System Settings -> Common -> Custom Variables. The user must have the rights to access the data source settings. Only advanced data source have settings.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMDataSourceCustomVariable</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">DataSourceVariable[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMDataSourceCustomVariable</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="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Custom variables to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DataSourceVariable[]</command:parameterValue> <dev:type> <maml:name>DataSourceVariable[]</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>Name</maml:name> <maml:description> <maml:para>Name of the custom variables to delete.</maml:para> </maml:description> <command:parameterValue required="true" 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return all custom variables that have been deleted.</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="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.DataSourceVariable[]</maml:name> <maml:uri /> <maml:description> <maml:para>Custom variable object returned when the PassThru switch is present.</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-RDMDataSourceCustomVariable -detailed". For technical information, type "Get-Help Remove-RDMDataSourceCustomVariable -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $cv = Get-RDMDataSourceCustomVariable -Name *TEMP* | Remove-RDMDataSourceCustomVariable</dev:code> <dev:remarks> <maml:para>Delete all custom variables containing 'TEMP' in their name</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>Repair-RDMUserSqlLogin</command:name> <gl:group>RDMUserSqlLogin</gl:group> <maml:description> <maml:para>Fix the SQL login of an existing user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Repair</command:verb> <command:noun>RDMUserSqlLogin</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Fix the SQL login of an existing user, applicable to Microsoft Azure SQL or Microsoft SQL Server data sources. Ensure the user's authentication type aligns with one of the following ServerUserType property values of the PSUserInfo object: SqlServer (2), AzureAD (8), or Okta (10).</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Repair-RDMUserSqlLogin</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSUserInfo</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>User needing SQL login fixing</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the PSUserInfo object after the SQL login fix</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.PSUserInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User object obtained from Get-RDMUser</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>Fixed user object returned when the PassThru parameter is used.</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 Repair-RDMUserSqlLogin -detailed". For technical information, type "Get-Help Repair-RDMUserSqlLogin -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMUser -Name 'myUsername' | Repair-RDMUserSqlLogin</dev:code> <dev:remarks> <maml:para>Fix the SQL login of the user named 'myUserName'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-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-RDMDataSourceCustomVariable</command:name> <gl:group>RDMDataSourceCustomVariable</gl:group> <maml:description> <maml:para>Add or edit custom variables in the current data source settings.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMDataSourceCustomVariable</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Add or edit custom variables in the current data source settings. The path to access those variables in Remote Desktop Manager is Administration -> System Settings -> Common -> Custom Variables. The user must have the rights to access the data source settings. Only advanced data source have settings.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMDataSourceCustomVariable</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">DataSourceVariable[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Custom variables to save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DataSourceVariable[]</command:parameterValue> <dev:type> <maml:name>DataSourceVariable[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the custom variables that have been saved.</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="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.DataSourceVariable</maml:name> <maml:uri /> <maml:description> <maml:para>Custom variable object returned when the PassThru switch is present.</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-RDMDataSourceCustomVariable -detailed". For technical information, type "Get-Help Set-RDMDataSourceCustomVariable -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $cv = Get-RDMDataSourceCustomVariable -Name $MyVar1$; $cv.Value = 'MyVarNewValue'; Set-RDMDataSourceCustomVariable -InputObject $cv</dev:code> <dev:remarks> <maml:para>Update the value of the custom variable named $MyVar1$</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-RDMDefaultDataSource</command:name> <gl:group>RDMDefaultDataSource</gl:group> <maml:description> <maml:para>Set the data source loaded when the application starts</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMDefaultDataSource</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the data source loaded when the application starts. It is possible to modify the 'On start up' option to choose how the loaded data source is chosen. The choices are: LastUsed, Prompt, and UseDefault. Modifying this option will not alter the current default or last used data source. To change the data source loaded on the next application start, the parameter ID or Name must be used. This will modify the last used or default data source to load.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMDefaultDataSource</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>OnStartUpOption</maml:name> <command:parameterValue required="true">LastUsed | Prompt | UseDefault</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMDefaultDataSource</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="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="2"> <maml:name>OnStartUpOption</maml:name> <command:parameterValue required="true">LastUsed | Prompt | UseDefault</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Case sensitive search of 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the data source to set as default or last used</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>Name of the data source to set as default or last used</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>OnStartUpOption</maml:name> <maml:description> <maml:para>Option to determine which data source to open when the applications starts</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-RDMDefaultDataSource -detailed". For technical information, type "Get-Help Set-RDMDefaultDataSource -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMDefaultDataSource -Name MyDefaultDS -OnStartUpOption UseDefault</dev:code> <dev:remarks> <maml:para>Set the data source 'MyDefaultDS' as the default one that will be loaded on every application starts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Set-RDMDefaultDataSource -Name MyDefaultDs -CaseSensitive</dev:code> <dev:remarks> <maml:para>Set the data source 'MyDefaultDs' as the default or last used data source. The search for the data source is case sensitive.</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-RDMPrivateSessionOTP</command:name> <gl:group>RDMPrivateSessionOTP</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPrivateSessionOTP</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-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="true" position="2"> <maml:name>Key</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Account</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Application</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeStep</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CodeSize</maml:name> <command:parameterValue required="true">Six | Eight</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HashAlgorithm</maml:name> <command:parameterValue required="true">SHA1 | SHA256 | SHA512</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPrivateSessionOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Key</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Account</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Application</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeStep</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CodeSize</maml:name> <command:parameterValue required="true">Six | Eight</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HashAlgorithm</maml:name> <command:parameterValue required="true">SHA1 | SHA256 | SHA512</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>OTP's associated account 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="named"> <maml:name>Application</maml:name> <maml:description> <maml:para>QR Code's application 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="named"> <maml:name>CodeSize</maml:name> <maml:description> <maml:para>OTP code's size. Must be 6 or 8 digits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OTPCodeSize</command:parameterValue> <dev:type> <maml:name>OTPCodeSize</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HashAlgorithm</maml:name> <maml:description> <maml:para>Algorithm used to hash the code.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OTPHashAlgorithm</command:parameterValue> <dev:type> <maml:name>OTPHashAlgorithm</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>ID</maml:name> <maml:description> <maml:para>Credential entry's ID whose OTP value must be updated.</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>InputObject</maml:name> <maml:description> <maml:para>Credential entry whose OTP value must be updated.</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>Key</maml:name> <maml:description> <maml:para>Key used to generate the OTP code.</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use SetSession to persist the modification.</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="named"> <maml:name>SetSession</maml:name> <maml:description> <maml:para>Save the entry 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="named"> <maml:name>TimeStep</maml:name> <maml:description> <maml:para>Refresh rate, in seconds, of the OTP.</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 Set-RDMPrivateSessionOTP -detailed". For technical information, type "Get-Help Set-RDMPrivateSessionOTP -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-RDMSessionOTP</command:name> <gl:group>RDMSessionOTP</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMSessionOTP</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-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="true" position="2"> <maml:name>Key</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Account</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Application</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeStep</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CodeSize</maml:name> <command:parameterValue required="true">Six | Eight</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HashAlgorithm</maml:name> <command:parameterValue required="true">SHA1 | SHA256 | SHA512</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMSessionOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Key</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Account</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Application</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeStep</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CodeSize</maml:name> <command:parameterValue required="true">Six | Eight</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HashAlgorithm</maml:name> <command:parameterValue required="true">SHA1 | SHA256 | SHA512</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSession</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>OTP's associated account 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="named"> <maml:name>Application</maml:name> <maml:description> <maml:para>QR Code's application 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="named"> <maml:name>CodeSize</maml:name> <maml:description> <maml:para>OTP code's size. Must be 6 or 8 digits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OTPCodeSize</command:parameterValue> <dev:type> <maml:name>OTPCodeSize</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HashAlgorithm</maml:name> <maml:description> <maml:para>Algorithm used to hash the code.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OTPHashAlgorithm</command:parameterValue> <dev:type> <maml:name>OTPHashAlgorithm</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>ID</maml:name> <maml:description> <maml:para>Credential entry's ID whose OTP value must be updated.</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>InputObject</maml:name> <maml:description> <maml:para>Credential entry whose OTP value must be updated.</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>Key</maml:name> <maml:description> <maml:para>Key used to generate the OTP code.</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use SetSession to persist the modification.</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="named"> <maml:name>SetSession</maml:name> <maml:description> <maml:para>Save the entry 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="named"> <maml:name>TimeStep</maml:name> <maml:description> <maml:para>Refresh rate, in seconds, of the OTP.</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 Set-RDMSessionOTP -detailed". For technical information, type "Get-Help Set-RDMSessionOTP -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>Unlock-RDMRepository</command:name> <gl:group>RDMRepository</gl:group> <maml:description> <maml:para>Unlock the vault to be loaded</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unlock</command:verb> <command:noun>RDMRepository</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Unlock the vault to load it. If this fails, the user will be prompted for the password.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unlock-RDMRepository</maml:name> <command:parameter required="true" position="1"> <maml:name>Password</maml:name> <command:parameterValue required="true">PSPassword</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to unlock the vault. Accepts a string or SecureString.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSPassword</command:parameterValue> <dev:type> <maml:name>PSPassword</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 Unlock-RDMRepository -detailed". For technical information, type "Get-Help Unlock-RDMRepository -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Unlock-RDMRepository -Password 'pa$sWord!' PS C:\> Get-RDMDataSource -Name 'myDataSourceWithOnlyProtectedVaults' | Set-RDMCurrentDataSource</dev:code> <dev:remarks> <maml:para>Unlock the last used vault in the data source named 'myDataSourceWithOnlyProtectedVaults before accessing it'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Unlock-RDMRepository -Password (ConvertTo-SecureString -AsPlainText -String 'pa$sWord!') PS C:\> Get-RDMVault -Name 'myLockedVault' | Set-RDMCurrentVault</dev:code> <dev:remarks> <maml:para>Unlock the vault 'myLockedVault' before accessing 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>Export-RDMSystemInformationReport</command:name> <gl:group>RDMSystemInformationReport</gl:group> <maml:description> <maml:para>Export the system information report to a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>RDMSystemInformationReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Export the system information report to a file. Two formats are supported: *.inv and *.html. The default behavior is to overwrite existing files. To avoid this, use the switch 'NoClobber'.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-RDMSystemInformationReport</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="true" position="2"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSSystemInformationReport</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Theme</maml:name> <command:parameterValue required="true">Light | Dark</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsHtml</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>AsHtml</maml:name> <maml:description> <maml:para>Export the inventory as an html report</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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>System information report obtained with Get-RDMSystemInformationReport</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSystemInformationReport</command:parameterValue> <dev:type> <maml:name>PSSystemInformationReport</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoClobber</maml:name> <maml:description> <maml:para>Do not overwrite an existing 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 is saved</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="named"> <maml:name>Theme</maml:name> <maml:description> <maml:para>Theme of the html report</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSSystemInformationReport</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>System information report object with metadata</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-RDMSystemInformationReport -detailed". For technical information, type "Get-Help Export-RDMSystemInformationReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $lastYearReports = Get-RDMEntry -Name 'MySystemInformationReportEntry' | Get-RDMSystemInformationReport -After 2023-01-01 -Before 2023-12-31 PS C:\> foreach ($report in $lastYearReports) { $exportPath = "C:\my\path\$($report.Inventory.ComputerName)_$($report.MetaInformation.CreationDate.ToString('yyyy-MM-dd')).inv" Export-RDMSystemInformationReport -Path $exportPath -InputObject $report }</dev:code> <dev:remarks> <maml:para>Export all the last year inventories</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSystemInformationReport</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-RDMSystemInformationReport</command:name> <gl:group>RDMSystemInformationReport</gl:group> <maml:description> <maml:para>Get exisiting reports from an system information report entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSystemInformationReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get exisiting reports from an system information report entry. It is possible to filter them by their creation date with the parameters 'After' and 'Before'. Both of them are inclusive. To get the last report, simply use the switch 'Last'.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSystemInformationReport</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="named"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Last</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSystemInformationReport</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>After</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Before</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Last</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Return the inventory reports created after the specified 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="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Return the inventory reports created before the specified 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the system information report 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>System information report entry</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="named"> <maml:name>Last</maml:name> <maml:description> <maml:para>Return the last inventory report</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>System information report entry</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSSystemInformationReport</maml:name> <maml:uri /> <maml:description> <maml:para>System information report object with metadata</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-RDMSystemInformationReport -detailed". For technical information, type "Get-Help Get-RDMSystemInformationReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'MySystemInformationReportEntry' | Get-RDMSystemInformationReport -Last</dev:code> <dev:remarks> <maml:para>Get the last generated report from the entry 'MySystemInformationReportEntry'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $lastYearReports = Get-RDMEntry -Name 'MySystemInformationReportEntry' | Get-RDMSystemInformationReport -After 2023-01-01 -Before 2023-12-31 PS C:\> foreach ($report in $lastYearReports) { $exportPath = "C:\my\path\$($report.Inventory.ComputerName)_$($report.MetaInformation.CreationDate.ToString('yyyy-MM-dd')).inv" Export-RDMSystemInformationReport -Path $exportPath -InputObject $report }</dev:code> <dev:remarks> <maml:para>Export all the last year inventories</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Export-RDMSystemInformationReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSystemInformationReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMSystemInformationReport</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>Import-RDMSystemInformationReport</command:name> <gl:group>RDMSystemInformationReport</gl:group> <maml:description> <maml:para>Import a system infromation report from an .inv file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>RDMSystemInformationReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Import a system infromation report from an .inv file. It is possible to save it directly in a system information report entry by using the InputObject parameter.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-RDMSystemInformationReport</maml:name> <command:parameter required="false" position="2"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>System information report entry where the inventory will be uploaded.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Inventory file (.inv) 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>System information report entry where the inventory will be saved</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.InventorySystemInformation</maml:name> <maml:uri /> <maml:description> <maml:para>System information report</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-RDMSystemInformationReport -detailed". For technical information, type "Get-Help Import-RDMSystemInformationReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'MyInventory' | Import-RDMSystemInformationReport -Path 'C:\my\path\inventory20240723.inv' | Out-Null</dev:code> <dev:remarks> <maml:para>Save the inventory loaded from the file 'inventory20240723.inv' in the entry named 'MyInventory'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $inventoryEntry = Get-RDMEntry -Name 'MyInventory' PS C:\> $inventory = Import-RDMSystemInformationReport -Path 'C:\my\path\inventory20240723.inv' PS C:\> $inventory.Antivirus.DisplayName = 'CrowdStrike' PS C:\> Get-RDMEntry -Name 'MyInventory' | New-RDMSystemInformationReport -Inventory $inventory</dev:code> <dev:remarks> <maml:para>Extract the inventory from the file 'inventory20240723.inv' and set the display name of the antivirus to 'CrowdStrike'. Save the inventory in the entry named 'MyInventory'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-RDMSystemInformationReport</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-RDMSystemInformationReport</command:name> <gl:group>RDMSystemInformationReport</gl:group> <maml:description> <maml:para>Generate a new system information report</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMSystemInformationReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Generate a new system information report. This cmdlet only works on Windows OS.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMSystemInformationReport</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="named"> <maml:name>Inventory</maml:name> <command:parameterValue required="true">InventorySystemInformation</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExportPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RDMSystemInformationReport</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Inventory</maml:name> <command:parameterValue required="true">InventorySystemInformation</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExportPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportPath</maml:name> <maml:description> <maml:para>Path where the inventory will be saved as an '.inv' file.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the system information report 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>System information report entry</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="true (ByValue)" position="named"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory obtained from Import-RDMSystemInformationReport</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">InventorySystemInformation</command:parameterValue> <dev:type> <maml:name>InventorySystemInformation</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoClobber</maml:name> <maml:description> <maml:para>Do not overwrite an existing 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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>System information report entry</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Devolutions.RemoteDesktopManager.Business.InventorySystemInformation</maml:name> <maml:uri /> <maml:description> <maml:para>System information report 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-RDMSystemInformationReport -detailed". For technical information, type "Get-Help New-RDMSystemInformationReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'MySystemInformationReportEntry' | New-RDMSystemInformationReport</dev:code> <dev:remarks> <maml:para>Generate a new report from the entry 'MySystemInformationReportEntry' </maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSystemInformationReport</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-RDMSystemInformationReport</command:name> <gl:group>RDMSystemInformationReport</gl:group> <maml:description> <maml:para>Delete the inventory report from the history</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMSystemInformationReport</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete the inventory report from the history. Only an administrator or vault owner can use this command.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMSystemInformationReport</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSSystemInformationReport</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>System information report to delete</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSystemInformationReport</command:parameterValue> <dev:type> <maml:name>PSSystemInformationReport</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSSystemInformationReport</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>System information report object with metadata</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-RDMSystemInformationReport -detailed". For technical information, type "Get-Help Remove-RDMSystemInformationReport -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $lastYearReports = Get-RDMEntry -Name 'MySystemInformationReportEntry' | Get-RDMSystemInformationReport -After 2023-01-01 -Before 2023-12-31 PS C:\> foreach ($report in $lastYearReports) { $exportPath = "C:\my\path\$($report.Inventory.ComputerName)_$($report.MetaInformation.CreationDate.ToString('yyyy-MM-dd')).inv" Export-RDMSystemInformationReport -Path $exportPath -InputObject $report } PS C:\> $lastYearReports | Remove-RDMSystemInformationReport</dev:code> <dev:remarks> <maml:para>Export all the last year inventories and delete them from the hisotry</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSystemInformationReport</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>Add-RDMSshAgentKey</command:name> <gl:group>RDMSshAgentKey</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMSshAgentKey</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMSshAgentKey</maml:name> <command:parameter required="true" position="1"> <maml:name>KeyText</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CertificateText</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">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>CertificateText</maml:name> <maml:description> <maml:para>Content of a SSH certificate file</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>KeyText</maml:name> <maml:description> <maml:para>Content of a private key file</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>Password</maml:name> <maml:description> <maml:para>Password to access the file</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-RDMSshAgentKey -detailed". For technical information, type "Get-Help Add-RDMSshAgentKey -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-RDMSshAgentLog</command:name> <gl:group>RDMSshAgentLog</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSshAgentLog</command:noun> <dev:version>2024.2.6</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-RDMSshAgentLog -detailed". For technical information, type "Get-Help Get-RDMSshAgentLog -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-RDMSshAgent</command:name> <gl:group>RDMSshAgent</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>RDMSshAgent</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RDMSshAgent</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>VerboseLevel</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>Name</maml:name> <maml:description> <maml:para>Agent name. In a Windows environment, it is a string representing the agent name (\\.\pipe\youragentname). For the others platforms, it is the socket path (/yoursocketpath).</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>VerboseLevel</maml:name> <maml:description> <maml:para>Verbose level of the log. Level 2 is for debugging.</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 Start-RDMSshAgent -detailed". For technical information, type "Get-Help Start-RDMSshAgent -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-RDMSshAgent</command:name> <gl:group>RDMSshAgent</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>RDMSshAgent</command:noun> <dev:version>2024.2.6</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 Stop-RDMSshAgent -detailed". For technical information, type "Get-Help Stop-RDMSshAgent -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-RDMFavoriteEntry</command:name> <gl:group>RDMFavoriteEntry</gl:group> <maml:description> <maml:para>Add entries to the favorites</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMFavoriteEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Add entries to the favorites. Entries from the System Vault, as well as subentries, are prohibited from being added to the favorites.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMFavoriteEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FolderName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>Favorite folder where the entries will be added. If not specified, it will be at 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Entries to add to the favorites</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the PSConnection objects</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>Entries to be added to the favorites</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>Return the InputObject values</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-RDMFavoriteEntry -detailed". For technical information, type "Get-Help Add-RDMFavoriteEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'Entry A' | Add-RDMFavoriteEntry -FolderName 'FolderA\SubFolderA'</dev:code> <dev:remarks> <maml:para>Add the entry named 'Entry A' to the favorite folder named 'FolderA\SubFolderA'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMFavoriteEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMFavoriteEntry</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-RDMFavoriteEntry</command:name> <gl:group>RDMFavoriteEntry</gl:group> <maml:description> <maml:para>Get the entries marked as favorites</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMFavoriteEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the entries marked as favorites.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMFavoriteEntry</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="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMFavoriteEntry</maml:name> <command:parameter required="false" position="1"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering by name and group name 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>LiteralName</maml:name> <maml:description> <maml:para>Filter the entries by their name. No wildcard supports.</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="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the entries by their name. Support wildcard characters.</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: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>PSConnection objects of the favorites</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-RDMFavoriteEntry -detailed". For technical information, type "Get-Help Get-RDMFavoriteEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMFavoriteEntry | Select ID, Name</dev:code> <dev:remarks> <maml:para>List all the IDs and names of the favorites</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMFavoriteEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMFavoriteEntry</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-RDMFavoriteFolder</command:name> <gl:group>RDMFavoriteFolder</gl:group> <maml:description> <maml:para>Create a favorite folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMFavoriteFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a favorite folder. It can be used to organize the favorite entries.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMFavoriteFolder</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 favorite folder to create. It cannot contain a character that is not allowed in a filename or path 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-RDMFavoriteFolder -detailed". For technical information, type "Get-Help New-RDMFavoriteFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> New-RDMFavoriteFolder -Name 'FolderA\SubFolderA'</dev:code> <dev:remarks> <maml:para>Create a new favorite folder named 'SubFolderA' inside the existing favorite folder named 'FolderA'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-RDMFavoriteEntry</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-RDMFavoriteEntry</command:name> <gl:group>RDMFavoriteEntry</gl:group> <maml:description> <maml:para>Remove entries from the favorites</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMFavoriteEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove entries from the favorites</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMFavoriteEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Entries to remove from the favorites</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the PSConnection objects</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>Entries to be removed from the favorites</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>Return the entries of the InputObject parameter</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-RDMFavoriteEntry -detailed". For technical information, type "Get-Help Remove-RDMFavoriteEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMFavoriteEntry -Name 'EntryA' | Remove-RDMFavoriteEntry</dev:code> <dev:remarks> <maml:para>Remove the entry named 'EntryA' from the favorites</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMFavoriteEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMFavoriteEntry</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-RDMFavoriteFolder</command:name> <gl:group>RDMFavoriteFolder</gl:group> <maml:description> <maml:para>Remove a favorite folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMFavoriteFolder</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove a favorite folder. If it contains entries, the user will be prompted to see if the favorite entries will be moved to the parent folder or deleted.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMFavoriteFolder</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="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>Name</maml:name> <maml:description> <maml:para>Name of the favorite folder 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: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-RDMFavoriteFolder -detailed". For technical information, type "Get-Help Remove-RDMFavoriteFolder -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Remove-RDMFavoriteFolder -Name 'FolderA\SubFolderA'</dev:code> <dev:remarks> <maml:para>Remove the favorite folder named 'SubFolderA'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-RDMFavoriteFolder</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-RDMEntry</command:name> <gl:group>RDMEntry</gl:group> <maml:description> <maml:para>Retrieve entries in the specified vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Retrieve entries in the specified vault. The vault is specified by the VaultMode parameter. The parameter GroupName search for entries in a specific folder. The switch IncludeSubFolders is required to look in all subfolders of the specified groups. It is also possible to use the wildcard '*' at the end of the GroupName to look in the subfolders.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntry</maml:name> <command:parameter required="false" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntry</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="2"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntry</maml:name> <command:parameter required="false" position="1"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>LiteralGroupName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLocalPlaylists</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeUserSpecificSettings</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering by name and group name 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="2"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Filter the entries by the group. Support wildcard characters.</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>ID</maml:name> <maml:description> <maml:para>Filter the entries by their ID</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="named"> <maml:name>IncludeDocumentsStoredInDatabase</maml:name> <maml:description> <maml:para>Document entries returned will 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="named"> <maml:name>IncludeLocalPlaylists</maml:name> <maml:description> <maml:para>PlayList entries will 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="named"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>Filtering by group name will include entries in subfolders</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="named"> <maml:name>IncludeUserSpecificSettings</maml:name> <maml:description> <maml:para>Entries returned will 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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>LiteralGroupName</maml:name> <maml:description> <maml:para>Filter the entries by the group. Support wildcard characters.</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>LiteralName</maml:name> <maml:description> <maml:para>Filter the entries by their name. No wildcard supports.</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="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the entries by their name. Support wildcard characters.</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="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the result by the connection type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ConnectionType[]</command:parameterValue> <dev:type> <maml:name>ConnectionType[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>Entries fetched.</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-RDMEntry -detailed". For technical information, type "Get-Help Get-RDMEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -IncludeDocumentsStoredInDatabase -IncludeLocalPlaylists -IncludeUserSpecificSettings</dev:code> <dev:remarks> <maml:para>Retrieves all available entries in the current vault. Documents, playlists and user specific settings will be included in the returned entries.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name Folder?, *Folder -VaultMode Global -CaseSensitive</dev:code> <dev:remarks> <maml:para>Retrieves all available entries whose name is Folder appended with a character or is ending with Folder in the system vault. The search is case sensitive.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -GroupName Folder\SubFolder -VaultMode User -IncludeSubFolders</dev:code> <dev:remarks> <maml:para>Retrieves all available entries in the group named Folder\SubFolder and its subfolders.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntry</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-RDMEntry</command:name> <gl:group>RDMEntry</gl:group> <maml:description> <maml:para>Create a new entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a new entry. To save the new entry, the SetSession switch must be used. To save in the user vault ou the system vault, use the VaultMode parameter.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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 | ScriptDashboard | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Group</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Host</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="named"> <maml:name>DocumentAttachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentFileName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="named"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml: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>Group</maml:name> <maml:description> <maml:para>Folder where the entry will be. It is corresponding to the property 'Group' of the PSConnection object.</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>Host</maml:name> <maml:description> <maml:para>Host of the entry. Value available for specific entry types only.</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>Name</maml:name> <maml:description> <maml:para>Name of the entry. It can not be empty. However, if the parameter Host is not empty, it will be use as a fallback.</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="named"> <maml:name>Set</maml:name> <maml:description> <maml:para>Save the entry based on the vault mode: - Default => In the current vault - User => In the user vault - Global => In the system 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="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>TemplateID</maml:name> <maml:description> <maml:para>Id of the template used to create the entry. It is mandatory for entry of the type 'TemplateGroup'.</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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of the entry to create. Must be on of the following: 'ADConsole', 'AddOn', 'Agent', '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', 'ScriptDashboard', '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="true" variableLength="false">ConnectionType</command:parameterValue> <dev:type> <maml:name>ConnectionType</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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 entry 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-RDMEntry -detailed". For technical information, type "Get-Help New-RDMEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> New-RDMEntry -Name 'New Entry' -Host 'myServer' -Type 'RDPConfigured' -Set -VaultMoode User</dev:code> <dev:remarks> <maml:para>Create & save a new entry in the user vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $folder = New-RDMEntry -Name 'New Folder' -Type 'Group'; $folder.GroupDetails.UserName = 'MyUserName'; $folder.GroupDetails.Domain = 'MyDomain'; Set-RDMEntry -InputObject $folder</dev:code> <dev:remarks> <maml:para>Create a new entry without saving it and store it in $folder. Add some additionnal information in the GroupDetails. Save the entry in the current vault.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntry</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-RDMEntry</command:name> <gl:group>RDMEntry</gl:group> <maml:description> <maml:para>Delete existing entries.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete existing entries. If an entry is a folder, all entries it contains are also deleted. For each entry, the user must have the delete permission. Use the VaultMode parameter to specify the user vault ou global vault if required.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMEntry</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="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>IDs of the entries be deleted.</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entries to delete.</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return all deleted entries, including entries in a deleted folder.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Entries to delete obtained from Get-RDMEntry for a specfic vault mode.</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>All deleted entries, including those contained in a deleted folder and sub entries. The PassThru parameter must be used.</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-RDMEntry -detailed". For technical information, type "Get-Help Remove-RDMEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name Entry* | Remove-RDMEntry</dev:code> <dev:remarks> <maml:para>Delete all entries whose name starts with Entry in the current vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name Entry* -VaultMode User | Remove-RDMEntry -VaultMode User -Confirm</dev:code> <dev:remarks> <maml:para>Delete all entries whose name starts with Entry in the user vault. The user will be prompted before each entry.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> $deletedEntries = Remove-RDMEntry -ID $folderID, $entryID -VaultMode Global -PassThru</dev:code> <dev:remarks> <maml:para>Delete the entries specified by the ids stored in $folderID and $entryID in the system vault. All deleted entries, including the entries contained in the folder specified by $folderID, are stored in $deletedEntries.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntry</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-RDMEntry</command:name> <gl:group>RDMEntry</gl:group> <maml:description> <maml:para>Save the entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Save the entry. The entry must be obtained via the Get-RDMEntry cmdlet or via the New-RDMEntry cmdlet. In the system vault, the supported types are limited to Group, Contact, SessionTool, and VPN. This cmdlet cannot be used to move an entry to another vault. To do so, use the Move-RDMEntry cmdlet. The user must have the rights to add or edit the entry. In the system vault, the user must be an administator.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>PSConnection[] object retrieved from Get-RDMEntry or created via New-RDMEntry.</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the all saved entries as a PSConnection[].</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh entries in the vault. All entries of type 'Group' automatically trigger a refresh to ensure they are available for other entries. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Entries to save obtained from Get-RDMEntry or New-RDMEntry</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>Entries saved. The PassThru parameter must be used.</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-RDMEntry -detailed". For technical information, type "Get-Help Set-RDMEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $folder = New-RDMEntry -Name 'New Folder' -Type 'Group'; $folder.GroupDetails.UserName = 'MyUserName'; $folder.GroupDetails.Domain = 'MyDomain'; $folder = Set-RDMEntry -InputObject $folder -PassThru</dev:code> <dev:remarks> <maml:para>Create a new entry without saving it and store it in $folder. Add some additionnal information in the GroupDetails. Save the entry in the current vault and store it in $folder.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entries = Get-RDMEntry -Name Entry?; $entries | ForEach-Object { $_.Name = '[Deprecated]' + $_.Name }; $entries | Set-RDMEntry -Reresh</dev:code> <dev:remarks> <maml:para>Store all entries whose name is Entry followed by a character. Append '[Deprecated]' to their name and save the modifications. The switch Refresh is used to ensure subsequent commands are applied on the modified entries.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntry</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-RDMSealedEntry</command:name> <gl:group>RDMSealedEntry</gl:group> <maml:description> <maml:para>Get sealed entries.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMSealedEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>To get sealed entries, ensure that you are using a Devolutions Server data source, as only this type supports the operation. The returned object will contain only basic information. To unseal the entry, use the command Unprotect-RDMSealedEntry.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMSealedEntry</maml:name> <command:parameter required="false" position="1"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSealedEntry</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="2"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMSealedEntry</maml:name> <command:parameter required="false" position="1"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>LiteralGroupName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <command:parameterValue required="true">ADConsole | AddOn | Agent | AppleRemoteDesktop | ApplicationTool | Aws | Azure | AzureQueueStorage | AzureStorage | AzureTableStorage | 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</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSubFolders</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering by name and group name 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="2"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Filter the entries by the group. Support wildcard characters.</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>ID</maml:name> <maml:description> <maml:para>Filter the entries by their ID</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="named"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>Filtering by group name will include entries in subfolders</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="2"> <maml:name>LiteralGroupName</maml:name> <maml:description> <maml:para>Filter the entries by the group. Support wildcard characters.</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>LiteralName</maml:name> <maml:description> <maml:para>Filter the entries by their name. No wildcard supports.</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="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the entries by their name. Support wildcard characters.</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="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the result by the connection type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ConnectionType[]</command:parameterValue> <dev:type> <maml:name>ConnectionType[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSSealedConnection[]</maml:name> <maml:uri /> <maml:description> <maml:para>Sealed entry objects containing the properties ID, Name, Group, and ConnectionType</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-RDMSealedEntry -detailed". For technical information, type "Get-Help Get-RDMSealedEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMSealedEntry -Name 'InCaseOfEmergency' | Unprotect-RDMSealedEntry; PS C:\> $unsealedEntry = Get-RDMEntry -Name 'InCaseOfEmergency'; PS C:\> $password = Get-RDMEntryPassword -InputObject $unsealedEntry -AsPlainText; PS C:\> $unsealedEntry.SealState = 'Sealed'; PS C:\> Set-RDMEntry -InputObject $unsealedEntry;</dev:code> <dev:remarks> <maml:para>Unseal the entry 'InCaseOfEmergency', get its password, and reseal the entry</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unprotect-RDMSealedEntry</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>Unprotect-RDMSealedEntry</command:name> <gl:group>RDMSealedEntry</gl:group> <maml:description> <maml:para>Unseal an entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unprotect</command:verb> <command:noun>RDMSealedEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>To unseal entries, ensure that you are using a Devolutions Server data source, as only this type supports the operation. To find the sealed entries, use Get-RDMSealedEntry.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unprotect-RDMSealedEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>ID</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Unprotect-RDMSealedEntry</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSSealedConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>ID of the entry to seal</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Entry to seal</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSealedConnection</command:parameterValue> <dev:type> <maml:name>PSSealedConnection</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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 Unprotect-RDMSealedEntry -detailed". For technical information, type "Get-Help Unprotect-RDMSealedEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMSealedEntry -Name 'InCaseOfEmergency' | Unprotect-RDMSealedEntry; PS C:\> $unsealedEntry = Get-RDMEntry -Name 'InCaseOfEmergency'; PS C:\> $password = Get-RDMEntryPassword -InputObject $unsealedEntry -AsPlainText; PS C:\> $unsealedEntry.SealState = 'Sealed'; PS C:\> Set-RDMEntry -InputObject $unsealedEntry;</dev:code> <dev:remarks> <maml:para>Unseal the entry 'InCaseOfEmergency', get its password, and reseal the entry</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMSealedEntry</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-RDMEntryUsername</command:name> <gl:group>RDMEntryUsername</gl:group> <maml:description> <maml:para>Get the username from an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryUsername</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the username from an entry. To obtain the username, the user must be able to copy it. Generally, this means the right to view it. The status of the entry, such as Locked or Expired, can also prevent the obtention of the username.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryUsername</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryUsername</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entry to get the username 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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>PSConnection object representing the entry from which the username will be extracted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Username of the entry.</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-RDMEntryUsername -detailed". For technical information, type "Get-Help Get-RDMEntryUsername -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'MyEntry' | Get-RDMEntryUsername</dev:code> <dev:remarks> <maml:para>Obtain the username of the entry named 'MyEntry'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMEntryUsername</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-RDMEntryUsername</command:name> <gl:group>RDMEntryUsername</gl:group> <maml:description> <maml:para>Set the username on the specified entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryUsername</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the username on the specified entry. To persist the new username, the switch Set must be used. To modify the username, the user must have the appropriate rights: add for a new entry, and edit for an existing one.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryUsername</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMEntryUsername</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entry 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use Set switch to persist the modification.</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="named"> <maml:name>Set</maml:name> <maml:description> <maml:para>Save the modified entry.</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>Username</maml:name> <maml:description> <maml:para>New username.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnection object of the entry to modify the username from.</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>Entry with the newly assigned username is returned when PassThru is used.</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-RDMEntryUsername -detailed". For technical information, type "Get-Help Set-RDMEntryUsername -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name 'EntryA'; Set-RDMEntryUsername -InputObject $entry -UserName 'newUserName' -Set</dev:code> <dev:remarks> <maml:para>Update the specified entry's username to 'newUserName'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $securePassword = ConvertTo-SecureString -AsPlainText -String 'newPas$w0rd!'; Get-RDMEntry -Name 'UniqueName' | Set-RDMEntryDomain -Domain 'MyOtherDomain.com' -PassThru | Set-RDMEntryPassword -Password $securePassword -PassThru | Set-RDMEntryUsername -UserName 'NewUserName' -PassThru | Set-RDMEntry</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMSession call.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryDomain</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-RDMEntryStatus</command:name> <gl:group>RDMEntryStatus</gl:group> <maml:description> <maml:para>Get the status from an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryStatus</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the status from an entry. An empty string means it is in the default state, no status.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryStatus</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entry to get the status 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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>PSConnection object representing the entry from which the status will be extracted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Status of the entry.</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-RDMEntryStatus -detailed". For technical information, type "Get-Help Get-RDMEntryStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'MyEntry' | Get-RDMEntryStatus</dev:code> <dev:remarks> <maml:para>Obtain the status of the entry named 'MyEntry'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMEntryStatus</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-RDMEntryStatus</command:name> <gl:group>RDMEntryStatus</gl:group> <maml:description> <maml:para>Set the status on the specified entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryStatus</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the status on the specified entry. To persist the new status, the switch Set must be used. To modify the status, the user must have the appropriate rights: add for a new entry, and edit for an existing one.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryStatus</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Status</maml:name> <command:parameterValue required="true">Default | Disabled | Expired | Locked | Warning</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMEntryStatus</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Status</maml:name> <command:parameterValue required="true">Default | Disabled | Expired | Locked | Warning</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Message</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entries to modify. Use the VaultMode parameter to search in the User vault or the Global vault.</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entries 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="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use Set switch to persist the modification.</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="named"> <maml:name>Set</maml:name> <maml:description> <maml:para>Save the entry 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="2"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnection object of the entry to modify the status from.</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>Entry with the newly assigned status is returned when PassThru is used.</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-RDMEntryStatus -detailed". For technical information, type "Get-Help Set-RDMEntryStatus -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name 'EntryA'; Set-RDMEntrystatus -InputObject $entry -Status 'Expired' -Set</dev:code> <dev:remarks> <maml:para>Update the specified entry's status to 'Expired'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryDomain</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-RDMEntryProperty</command:name> <gl:group>RDMEntryProperty</gl:group> <maml:description> <maml:para>Get the specified property's value of an entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryProperty</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the specified property's value of an entry. Protected values will always return null. Those values are those who are ignored when entries are exported. Non value types will always return ".ToString()".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryProperty</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="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 entry to get the property 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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-RDMEntryProperty -detailed". For technical information, type "Get-Help Get-RDMEntryProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntryProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group"</dev:code> <dev:remarks> <maml:para>Get the Group value from the entry 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-RDMEntryProperty -ID "{00000000-0000-0000-0000-000000000000}" -Path "MetaInformation" -Property "OS"</dev:code> <dev:remarks> <maml:para>Get the MetaInformation.OS value from the entry with ID = "{00000000-0000-0000-0000-000000000000}".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryProperty</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-RDMEntryProperty</command:name> <gl:group>RDMEntryProperty</gl:group> <maml:description> <maml:para>Set the property's value of an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryProperty</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the property's value of an entry. The property is specified with the parameters Path and Property. The entry is found by its ID. If the VaultMode parameter is not used, the three vaults (current one, user vault, and global vault) will be searched. The user must have the right to edit the entry.".</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryProperty</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="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 entry to set the property to. 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 set (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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh entries in the vault. All entries of type 'Group' automatically trigger a refresh to ensure they are available for other entries. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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-RDMEntryProperty -detailed". For technical information, type "Get-Help Set-RDMEntryProperty -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Set-RDMEntryProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group" -Value "My New Group Name"</dev:code> <dev:remarks> <maml:para>Set the Group value of the entry 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 -ID "{00000000-0000-0000-0000-000000000000}" -Path "MetaInformation" -Property "OS" -Value "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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMEntryProperty</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-RDMEntryPrivateKey</command:name> <gl:group>RDMEntryPrivateKey</gl:group> <maml:description> <maml:para>Get an entry's private key</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryPrivateKey</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get an entry's private key. Two types of private key are supported: Embedded data and File (local). The user must also have the right to edit the entry. Additionaly, the 'ExportPath' parameter allows for the key to be saved into a file. Only a vault owner or administrator can export the key.")]</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryPrivateKey</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>ExportPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryPrivateKey</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ExportPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryPrivateKey</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ExportPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportPath</maml:name> <maml:description> <maml:para>Export file for the private key.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry for which the private key is fetched</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>InputObject</maml:name> <maml:description> <maml:para>ID of the entry for which the private key is fetched</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="named"> <maml:name>NoClobber</maml:name> <maml:description> <maml:para>NoClobber prevents an existing file from being overwritten and displays a message that the file already exists. By default, if a file exists in the specified path, it is overwritten.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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 containing the private key</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Private key</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-RDMEntryPrivateKey -detailed". For technical information, type "Get-Help Get-RDMEntryPrivateKey -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>Get-RDMEntry -Name 'My Private Key Cred' | Get-RDMEntryPrivateKey -ExportPath 'myfile.key' | Out-Null </dev:code> <dev:remarks> <maml:para>Save the private key from the entry named 'My Private Key Cred' into a file named 'myfile.key'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <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: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-RDMEntryPassword</command:name> <gl:group>RDMEntryPassword</gl:group> <maml:description> <maml:para>Resolve the password of the specified entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryPassword</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Resolve the password of the specified entry. The entry can be specified in two way: by its ID and by passing the PSConnection object. When using the ID parameter, the VaultMode parameter can be used to search the entry in the user vault or in global vault. For the InputObjet parameter, the entry can be obtained from Get-RDMEntry, Get-RDMPersonalCredentials, and Get-RDMPrivilegedAccount. If the password has been modified locally via Set-RDMEntryPassword and the entry is a credential, the old password will be returned. To see the new password, Update-RDMEntries must be called. To obtain the password, the user must be able to copy it. Generally, this means the right to view it. However, in some cases, an adminstrator might be required or a non-empty password. The status of the entry, such as Locked or Expired, can also prevent the obtention of the password. If the data source required a prompt on credentials viewed, the user will be prompted for each required field. To avoid this, the TicketID and Comment parameters must be used.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryPassword</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="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Return 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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to get the password 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Entry to get the password from. Can be obtained from Get-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount.</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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>PSConnection object of the entry obtained from Get-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Password as plain text. Output in the presence of the AsPlainText switch.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> <maml:description> <maml:para>Password as a SecureString. Default output.</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-RDMEntryPassword -detailed". For technical information, type "Get-Help Get-RDMEntryPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntryPassword -ID '00000000-0000-0000-0000-000000000000' -AsPlainText -VaultMode User</dev:code> <dev:remarks> <maml:para>Obtain, as plain text, the password of the entry in the user vault whose ID is '00000000-0000-0000-0000-000000000000'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'MyCredEntry' -VaultMode Global | Get-RDMEntryPassword -TicketID 'tick101' -Comment 'Why not'</dev:code> <dev:remarks> <maml:para>Obtain, as a SecureString, the password of the entry 'MyCredEntry' in the system vault. The ticket number and the comment are passed with the associated parameters to avoid being prompted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMPersonalCredentials | Get-RDMEntryPassword -AsPlainText</dev:code> <dev:remarks> <maml:para>Obtain, as a plain text, the password of 'My Personal Credentials' in the user settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Get-RDMPrivilegedAccount | Get-RDMEntryPassword -AsPlainText</dev:code> <dev:remarks> <maml:para>Obtain, as a plain text, the password of 'My Privileged Account' in the user settings.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntry</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPersonalCredentials</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMPrivilegedAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryPassword</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-RDMEntryPassword</command:name> <gl:group>RDMEntryPassword</gl:group> <maml:description> <maml:para>Set the password of an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryPassword</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the password of an entry. The entry to modify can be fetched by its id or by a PSConnection object obtained from Get-RDMEntry, New-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount. In the latter case, the local object will be modified. To modify the password, the user must have the appropriate rights: add for a new entry, and edit for an existing one. For data source supporting the password age, it is also possible to modify that value for the new password. It can be used to indicate when the password was generated instead of when the password has been set in the entry.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryPassword</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>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMEntryPassword</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</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="named"> <maml:name>PasswordAge</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PasswordSinceDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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>Password</maml:name> <maml:description> <maml:para>Password as SecureString. 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="named"> <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="named"> <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="named"> <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="named"> <maml:name>Set</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Entry whose password will be modified. Can be obtained from Get-RDMEntry, New-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount.</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>Entry with the newly assigned password is returned when PassThru is used.</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-RDMEntryPassword -detailed". For technical information, type "Get-Help Set-RDMEntryPassword -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = New-RDMEntry -Type Credential -Name 'NewCredEntry'; $entry.Credentials.UserName = 'MyUserName'; Set-RDMEntryPassword -InputObject $entry -Password (Read-Host -AsSecureString -Prompt 'Password') Set-RDMEntry -InputObject $entry</dev:code> <dev:remarks> <maml:para>The user create a new credential entry. Its username and password are being set. The call to Set-RDMEntryPassword does modify the local object. The user can do more modifications if desired. The last line finally save the new entry.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $pwd = ConvertTo-SecureString -AsPlainText -String 'passwordFr0mSomewhereElse'; Get-RDMEntry -Name 'EntryToModify' | Set-RDMEntryPassword -Password $pwd -PasswordAge 14 -Set -Refresh</dev:code> <dev:remarks> <maml:para>The entry named 'EntryToModify' will have an updated password, the one stored in $pwd, and it will be aged of 14 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name 'UniqueName' | Set-RDMEntryDomain -Domain 'MyOtherDomain.com' -PassThru | Set-RDMEntryPassword -Password $securePassword -PassThru | Set-RDMEntryUsername -UserName 'NewUserName' -PassThru | Set-RDMEntry</dev:code> <dev:remarks> <maml:para>Modify the domain, password and username of the entry named 'UniqueName'. The variable $securePassword is a secure string previously set. Persist the modification with the Set-RDMEntry call.</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-RDMEntryOTP</command:name> <gl:group>RDMEntryOTP</gl:group> <maml:description> <maml:para>Get a hastable of the OTP code with the remaining time of an OTP entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryOTP</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get a hastable of the OTP code with the remaining time of an OTP entry. To obtain the OTP code, the user must be able to copy it. Generally, this means the right to view it. The status of the entry, such as Locked or Expired, can also prevent the obtention of the OTP code. If the data source required a prompt on credentials viewed, the user will be prompted for each required field. To avoid this, the TicketID and Comment parameters must be used.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryOTP</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entry 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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>PSConnection object of the OTP entry obtained from Get-RDMEntry</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</maml:name> <maml:uri /> <maml:description> <maml:para>Simple object containing the OTP code (Code) and the remaining time (RemainingSeconds)</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-RDMEntryOTP -detailed". For technical information, type "Get-Help Get-RDMEntryOTP -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $otp = Get-RDMEntry -Name MyOTPEntry | Get-RDMEntryOTP; $otp.Code</dev:code> <dev:remarks> <maml:para>Get the OTP code of the entry MyOTPEntry</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMEntryOTP</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-RDMEntryOTPKey</command:name> <gl:group>RDMEntryOTPKey</gl:group> <maml:description> <maml:para>Get the OTP key of an OTP entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryOTPKey</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the OTP key of an OTP entry. The entry is either specified by its ID, or by the PSConnection obtained from Get-RDMEntry. When using the parameter ID, the parameter VaultMode can be used to specify to look in the Global vault or the User vault directly. If the parameter VaultMode is not used, the current vault will be searched, followed by the User and Global vaults. The TicketID and Comment parameters can be used to fill the log prompt. It is used to fill the prompt for comment on credentials viewed. This a setting of the data source or vault in the Common -> Logs tab. The user must have the rights to edit the entry to obtain the OTP key.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryOTPKey</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryOTPKey</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TicketID</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsPlainText</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Return the OTP key 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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>OTP entry's ID with the OTP key to extract</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>InputObject</maml:name> <maml:description> <maml:para>OTP entry obtained from Get-RDMEntry with the OTP key to extract</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="named"> <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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>PSConnection object obtained from Get-DSEntry</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>OTP key of the entry as plain text. Must use the AsPlainText sqitch.</maml:para> </maml:description> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> <maml:description> <maml:para>OTP key of the entry as a SecureString.</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-RDMEntryOTPKey -detailed". For technical information, type "Get-Help Get-RDMEntryOTPKey -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name MyOTPEntry | Get-RDMEntryOTPKey -AsPlainText</dev:code> <dev:remarks> <maml:para>Get the OTP key of the entry named MyOTPEntry</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntryOTPKey -ID $otpEntryID -VaultMode User -AsPlainText</dev:code> <dev:remarks> <maml:para>Get the OTP key of the entry, in the user vault, whose ID is stored in the variable $otpEntry</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-RDMEntryOTP</command:name> <gl:group>RDMEntryOTP</gl:group> <maml:description> <maml:para>Set OTP properties of an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryOTP</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set OTP properties of an entry. The entry to modify can be obtained from Get-RDMEntry or New-RDMEntry. To modify the OTP Entry, the user must have the appropriate rights: add for a new entry, and edit for an existing one.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryOTP</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Key</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Account</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Application</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CodeSize</maml:name> <command:parameterValue required="true">Six | Eight</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeStep</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HashAlgorithm</maml:name> <command:parameterValue required="true">SHA1 | SHA256 | SHA512</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMEntryOTP</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Key</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Account</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Application</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CodeSize</maml:name> <command:parameterValue required="true">Six | Eight</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeStep</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HashAlgorithm</maml:name> <command:parameterValue required="true">SHA1 | SHA256 | SHA512</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>OTP's associated account 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="named"> <maml:name>Application</maml:name> <maml:description> <maml:para>QR Code's application 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="named"> <maml:name>CodeSize</maml:name> <maml:description> <maml:para>OTP code's size. Must be 6 or 8 digits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OTPCodeSize</command:parameterValue> <dev:type> <maml:name>OTPCodeSize</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"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HashAlgorithm</maml:name> <maml:description> <maml:para>Algorithm used to hash the code.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OTPHashAlgorithm</command:parameterValue> <dev:type> <maml:name>OTPHashAlgorithm</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Credential entry whose OTP value must be updated.</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>Key</maml:name> <maml:description> <maml:para>Key used to generate the OTP code.</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use Set switch to persist the modification.</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="named"> <maml:name>Set</maml:name> <maml:description> <maml:para>Save the entry 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="named"> <maml:name>TimeStep</maml:name> <maml:description> <maml:para>Refresh rate, in seconds, of the OTP.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnection object of the OTP entry obtained from Get-RDMEntry</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>Modified entry is returned with the PassThru parameter</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-RDMEntryOTP -detailed". For technical information, type "Get-Help Set-RDMEntryOTP -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $otp = Get-RDMEntry -Name MyOTPEntry; $key = ConvertTo-SecureString -AsPlainText -String 'MyKey'; Set-RDMEntryOTP -InputObject $otp -Key $key -Timestep 60 -Set</dev:code> <dev:remarks> <maml:para>Update the OTP key and change the refresh rate of the code to 60 seconds. The changes are saved.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryOTP</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-RDMEntryDomain</command:name> <gl:group>RDMEntryDomain</gl:group> <maml:description> <maml:para>Get the domain from the specified entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryDomain</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get the domain of the specified entry. To obtain the domain, the user must be able to copy it. Generally, this means the right to view it. The status of the entry, such as Locked or Expired, can also prevent the obtention of the domain.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryDomain</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entry to get the domain 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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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>PSConnection object of the entry to extract the domain from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Domain of the entry</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-RDMEntryDomain -detailed". For technical information, type "Get-Help Get-RDMEntryDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name EntryA; Get-RDMEntryDomain -InputObject $entry</dev:code> <dev:remarks> <maml:para>Get the domain from the entry named EntryA.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entries = Get-RDMEntry | Where { (Get-RDMEntryDomain -InputObject $_) -eq 'mydomain' }; $entries | Set-RDMEntryDomain -InputObject $entry -Domain 'newDomain' -Set; Update-RDMEntries</dev:code> <dev:remarks> <maml:para>For all entries whose domain is 'mydomain', update it to 'newDomain' and save the change. After all the modifications, refresh the entries list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMEntryDomain</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-RDMEntryDomain</command:name> <gl:group>RDMEntryDomain</gl:group> <maml:description> <maml:para>Set the domain from the specified entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryDomain</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set the domain of the specified entry. To modify the domain, the user must have the appropriate rights: add for a new entry, and edit for an existing one.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryDomain</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Set-RDMEntryDomain</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</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:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global 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="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the entry 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the modified entry.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Send refresh notification to Remote Desktop Manager application. Use Set switch to persist the modification.</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="named"> <maml:name>Set</maml:name> <maml:description> <maml:para>Save the modified entry.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnection object of the entry to modify the domain from.</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>Entry with the newly assigned domain is returned when PassThru is used.</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-RDMEntryDomain -detailed". For technical information, type "Get-Help Set-RDMEntryDomain -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name EntryA; Set-RDMEntryDomain -InputObject $entry -Domain 'newDomain' -Set -Refresh</dev:code> <dev:remarks> <maml:para>Set the domain to 'newDomain' for the entry named EntryA.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entries = Get-RDMEntry | Where { (Get-RDMEntryDomain -InputObject $_) -eq 'mydomain' }; $entries | Set-RDMEntryDomain -InputObject $entry -Domain 'newDomain' -Set; Update-RDMEntries</dev:code> <dev:remarks> <maml:para>For all entries whose domain is 'mydomain', update it to 'newDomain' and save the change. After all the modifications, refresh the entries list.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMEntryDomain</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-RDMEntryDocumentation</command:name> <gl:group>RDMEntryDocumentation</gl:group> <maml:description> <maml:para>Get documentation pages of entries</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryDocumentation</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get documentations pages of entries. The entries must be fetched by Get-RDMEntry. There is two possibility to filter the pages: by their name and by their data (content). The data source must support the documentation feature and be online. The user must have the rights to access the documentation.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryDocumentation</maml:name> <command:parameter required="false" position="2"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Data</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Default</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryDocumentation</maml:name> <command:parameter required="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Data</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Default</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering 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="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>Filter the handbook pages by their content.</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="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Obtain only the default page. Maximum one default page per entry.</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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Entry from which to extract the documentation.</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="2"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Filter the handbook pages by their name. No characters are interpreted as</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="true" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the handbook pages by their name.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Entries, obtained from Get-RDMEntry, containing the documentation.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbookPage[]</maml:name> <maml:uri /> <maml:description> <maml:para>Documentation pages of the entries</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-RDMEntryDocumentation -detailed". For technical information, type "Get-Help Get-RDMEntryDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA; $page.Data</dev:code> <dev:remarks> <maml:para>Get the documentation page named 'PageA' of the entry named 'EntryA' and see its content.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $defaultPages = Get-RDMEntry -VaultMode Global | Get-RDMEntryDocumentation -Default; foreach ($defaultPage in $defaultPages) { $defaultPage.Default = $false } Set-RDMEntryDocumentation -InputObject $defaultPages</dev:code> <dev:remarks> <maml:para>Remove the default status of the default documentation page of each entries in the system vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Data '*Temporary*' -CaseSensitive | Remove-RDMEntryDocumentation</dev:code> <dev:remarks> <maml:para>Delete all documentation pages of the entry 'EntryA' that contains the word 'Temporary'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryDocumentation</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-RDMEntryDocumentation</command:name> <gl:group>RDMEntryDocumentation</gl:group> <maml:description> <maml:para>Create a documentation page for an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>RDMEntryDocumentation</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Create a documentation page for an entry. The entry must be fetched by Get-RDMEntry. The data source must support the documentation feature and be online. The user must have the rights to edit the documentation.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RDMEntryDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Type</maml:name> <command:parameterValue required="true">HTML | Markdown | PlainText</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Data</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsLastPage</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsNewDefault</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Set</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsLastPage</maml:name> <maml:description> <maml:para>Set the page as the last one.</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="named"> <maml:name>AsNewDefault</maml:name> <maml:description> <maml:para>Set the page as the new default one.</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>Data</maml:name> <maml:description> <maml:para>Content of the documentation page</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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Entry where the documentation page will be. Must be already saved.</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="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the documentation page</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="named"> <maml:name>Set</maml:name> <maml:description> <maml:para>Save the documentation page on the entry</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>Type</maml:name> <maml:description> <maml:para>Type of the page. The supported types are Markdown, PlainText, and HTML.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DocumentationType</command:parameterValue> <dev:type> <maml:name>DocumentationType</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>Entry, obtained from Get-RDMEntry, that will contain the new documentation page.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbookPage</maml:name> <maml:uri /> <maml:description> <maml:para>Created documentation page</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-RDMEntryDocumentation -detailed". For technical information, type "Get-Help New-RDMEntryDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryDocumentation</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-RDMEntryDocumentation</command:name> <gl:group>RDMEntryDocumentation</gl:group> <maml:description> <maml:para>Delete documentation pages</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMEntryDocumentation</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete documentation pages. The documentation pages must be fetched by Get-RDMEntryDocumentation. The data source must support the documentation feature and be online. The user must have the rights to delete the documentation.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMEntryDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSHandbookPage[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Documentation pages to delete</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSHandbookPage[]</command:parameterValue> <dev:type> <maml:name>PSHandbookPage[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="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.PSHandbookPage[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documentation pages, obtained from Get-RDMEntryDocumentation, to delete.</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-RDMEntryDocumentation -detailed". For technical information, type "Get-Help Remove-RDMEntryDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry | Get-RDMEntryDocumentation -Name 'Subject A*' -CaseSensitive | Remove-RDMEntryDocumentation</dev:code> <dev:remarks> <maml:para>Delete all documentation pages whose name starts with 'Subject A' in the current vault </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Data '*Temporary*' -CaseSensitive | Remove-RDMEntryDocumentation</dev:code> <dev:remarks> <maml:para>Delete all documentation pages of the entry 'EntryA' that contains the word 'Temporary'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryDocumentation</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-RDMEntryDocumentation</command:name> <gl:group>RDMEntryDocumentation</gl:group> <maml:description> <maml:para>Save modified documentation pages</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryDocumentation</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Save modified documentation pages. The documentation pages must be fetched by Get-RDMEntryDocumentation. The associated entry must already exists. The data source must support the documentation feature and be online. The user must have the rights to edit the documentation.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryDocumentation</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSHandbookPage[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>The documentation pages to update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSHandbookPage[]</command:parameterValue> <dev:type> <maml:name>PSHandbookPage[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="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.PSHandbookPage[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documentation pages, obtained from Get-RDMEntryDocumentation, to update.</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-RDMEntryDocumentation -detailed". For technical information, type "Get-Help Set-RDMEntryDocumentation -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $defaultPages = Get-RDMEntry -VaultMode Global | Get-RDMEntryDocumentation -Default; foreach ($defaultPage in $defaultPages) { $defaultPage.Default = $false } Set-RDMEntryDocumentation -InputObject $defaultPages</dev:code> <dev:remarks> <maml:para>Remove the default status of the default documentation page of each entries in the system vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA; $page.Name = 'My New Default Page'; $page.Default = $true; Set-RDMEntryDocumentation -InputObject $page</dev:code> <dev:remarks> <maml:para>Define the documentation page 'PageA' as the new dafault page and rename it to 'My New Default Page'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMEntryDocumentation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryDocumentation</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-RDMEntryDocument</command:name> <gl:group>RDMEntryDocument</gl:group> <maml:description> <maml:para>Get documents stored in the database</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryDocument</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get documents stored in the database. The user can specify the desired vault: default or user.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryDocument</maml:name> <command:parameter required="true" position="named"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMEntryDocument</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering by name 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Filter the document entries by their name. No characters are interpreted as wildcards.</maml:para> </maml:description> <command:parameterValue required="true" 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="true" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the document entries by their name. Support wildcard characters.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnectionDocument[]</maml:name> <maml:uri /> <maml:description> <maml:para>Document entries stored in the database 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-RDMEntryDocument -detailed". For technical information, type "Get-Help Get-RDMEntryDocument -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $doc = Get-RDMEntryDocument -Name 'SimpleTextDocument' -VaultMode User; $doc.Data = [System.Text.Encoding]::UTF8.GetBytes('My new content'); Set-RDMEntryDocument -InputObject $doc</dev:code> <dev:remarks> <maml:para>Update the content of the document stored in the database of the entry SimpleTextDocument.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $doc = Get-RDMEntryDocument -Name 'SimpleTextDocument'; $doc.Data = Get-Content -Path MyFile.txt -AsByteStream; Set-RDMEntryDocument -InputObject $doc</dev:code> <dev:remarks> <maml:para>Update the content of the document stored in the database of the entry SimpleTextDocument with the content of the file contained in the entry SimpleTextDocument</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMEntryDocument</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-RDMEntryDocument</command:name> <gl:group>RDMEntryDocument</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>RDMEntryDocument</command:noun> <dev:version>2024.2.6</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-RDMEntryDocument</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnectionDocument[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Documents obtained from Get-RDMEntryDocumentation to save</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnectionDocument[]</command:parameterValue> <dev:type> <maml:name>PSConnectionDocument[]</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-RDMEntryDocument -detailed". For technical information, type "Get-Help Set-RDMEntryDocument -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $doc = Get-RDMEntryDocument -Name 'SimpleTextDocument' -VaultMode User; $doc.Data = [System.Text.Encoding]::UTF8.GetBytes('My new content'); Set-RDMEntryDocument -InputObject $doc</dev:code> <dev:remarks> <maml:para>Update the content of the document stored in the database of the entry SimpleTextDocument.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $doc = Get-RDMEntryDocument -Name 'SimpleTextDocument'; $doc.Data = Get-Content -Path MyFile.txt -AsByteStream; Set-RDMEntryDocument -InputObject $doc</dev:code> <dev:remarks> <maml:para>Update the content of the document stored in the database of the entry SimpleTextDocument with the content of the file contained in the entry SimpleTextDocument</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryDocument</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>Update-RDMEntryDocument</command:name> <gl:group>RDMEntryDocument</gl:group> <maml:description> <maml:para>Update the document of the specified entry.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMEntryDocument</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update the document of the specified entry. The entry must of the type Document, and the document must be stored in the database. The updated document must be of the same type as the existing one. It must also respect the maximum file size defined in the system settings. This cmdlet cannot be used offline. The data source must support attachments. The user must have the right to modify the attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMEntryDocument</maml:name> <command:parameter required="true" position="2"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Update-RDMEntryDocument</maml:name> <command:parameter required="true" position="2"> <maml:name>Attachment</maml:name> <command:parameterValue required="true">PSConnectionAttachment</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Entry 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="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.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Document entry obtained from Get-RDMEntry</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 Update-RDMEntryDocument -detailed". For technical information, type "Get-Help Update-RDMEntryDocument -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name MyDocumentEntry; Update-RDMEntryDocument -InputObject $entry -Filename 'C:\Mytestfile.txt' -Refresh</dev:code> <dev:remarks> <maml:para>Update the document of the entry MyDocumentEntry with the file 'C:\Mytestfile.txt'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name MyDocumentEntry; $entryWithAttachment = Get-RDMEntry -Name MyEntryWithAttachment; $attachment = Get-RDMEntryAttachment -InputObject $entryWithAttachment -Title 'My Attachment File'; Update-RDMEntryDocument -InputObject $entry -Attachment $attachment</dev:code> <dev:remarks> <maml:para>Update the document of the entry MyDocumentEntry with the attachment 'My Attachment File' present in the entry MyEntryWithAttachment.</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-RDMEntryAttachment</command:name> <gl:group>RDMEntryAttachment</gl:group> <maml:description> <maml:para>Add new attachments to an existing entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>RDMEntryAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Add new attachments to an existing entry. Entries of the type SessionTool do not allow attachments. The type of an entry is the property ConnectionType of a PSConnection. To modify properties of the attachments, use Set-RDMEntryAttachment. To update a file of an existing attachment, use Update-RDMEntryAttachment. Only advanced data sources support attachment. The user must have the permission to add attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RDMEntryAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</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="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Attachment filenames.</maml:para> </maml:description> <command:parameterValue required="true" 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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Entry 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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the all attachments as a PSConnectionAttachment[].</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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>PSConnection object of the entry where the attachments will be. Can be obtained from Get-RDMEntry.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]</maml:name> <maml:uri /> <maml:description> <maml:para>PSConnectionAttachment object of the new attachments. Obtained from the PassThru parameter.</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-RDMEntryAttachment -detailed". For technical information, type "Get-Help Add-RDMEntryAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Add-RDMEntryAttachment -Filename 'C:\my\path\filename.txt', 'localFile.txt'</dev:code> <dev:remarks> <maml:para>Attach the files filename.txt, located in 'C:\my\path\', and localFile.txt, located in the current session directory, to the session named EntryA.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $entry = Get-RDMEntry -Name EntryA; $attachment = Add-RDMEntryAttachment -InputObject $entry -Filename 'filename.txt' -PassThru; Set-RDMEntryAttachment -InputObject $attachment -Title 'Filename' -Description 'This is an important file'</dev:code> <dev:remarks> <maml:para>Attach the file filename.txt, located in 'C:\my\path\', to the session named EntryA.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMEntryAttachment</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-RDMEntryAttachment</command:name> <gl:group>RDMEntryAttachment</gl:group> <maml:description> <maml:para>Get attachments of an entry</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMEntryAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get attachments of an entry. They can filtered by their filename and title. Only advanced data sources support attachments</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMEntryAttachment</maml:name> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering by the title and the filename 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="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Filter the attachments based on their filename.</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="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</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:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Filter the attachments based on their title.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnection object of the entry where the attachments will be. Can be obtained from Get-RDMEntry.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]</maml:name> <maml:uri /> <maml:description> <maml:para>PSConnectionAttachment object of the new attachments. Obtained from the PassThru parameter.</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-RDMEntryAttachment -detailed". For technical information, type "Get-Help Get-RDMEntryAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment</dev:code> <dev:remarks> <maml:para>Get all the attachments of the entry EntryA</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment -Title 'UniqueTitle' | Update-RDMEntryCommand -Filename 'revisedFile.txt' -Refresh</dev:code> <dev:remarks> <maml:para>Update the document of the attachment 'UniqueTitle' with the file 'revisedFile.txt' in the current session directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment -Filename 'UniqueTitle' -CaseSensitive | Update-RDMEntryCommand -Filename 'revisedFile.txt' -Refresh</dev:code> <dev:remarks> <maml:para>Update the document of the attachment 'UniqueTitle' with the file 'revisedFile.txt' in the current session directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 4-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment | Set-RDMEntryAttachment -AllowExport $false</dev:code> <dev:remarks> <maml:para>Prevent the export of all EntryA's attachments.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMEntryAttachment</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-RDMEntryAttachment</command:name> <gl:group>RDMEntryAttachment</gl:group> <maml:description> <maml:para>Remove attachments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMEntryAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Remove attachment. Only advanced data sources support attachment. The user must have the permission to delete attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMEntryAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnectionAttachment[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Attachments to delete. Can be obtained from Get-RDMEntryAttachment.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="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.PSConnectionAttachment[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnectionAttachment[] object of the attachments to delete. Can be obtained from Get-RDMEntry.</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-RDMEntryAttachment -detailed". For technical information, type "Get-Help Remove-RDMEntryAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA -VaultMode User | Get-RDMEntryAttachment | Remove-RDMEntryAttachment</dev:code> <dev:remarks> <maml:para>Remove the attachments of the entry EntryA in the user vault.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMEntryAttachment</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-RDMEntryAttachment</command:name> <gl:group>RDMEntryAttachment</gl:group> <maml:description> <maml:para>Save attachments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMEntryAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Save attachments. Only advanced data sources support attachment. The user must have the right to edit the attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMEntryAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnectionAttachment[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowExport</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="named"> <maml:name>AllowExport</maml:name> <maml:description> <maml:para>Allow or disallow the attachment to be exported.</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="named"> <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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Attachments to save. Can be obtained from Get-RDMEntryAttachment.</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="named"> <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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="named"> <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: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.PSConnectionAttachment[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of PSConnectionAttachment to save. Can be obtained from Get-RDMEntryAttachment.</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-RDMEntryAttachment -detailed". For technical information, type "Get-Help Set-RDMEntryAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment | Set-RDMEntryAttachment -AllowExport $false</dev:code> <dev:remarks> <maml:para>Prevent the export of all EntryA's attachments.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $pwd = New-RDMRandomPassword -Mode Strong; $securepwd = ConvertTo-SecureString -String $pwd -AsPlainText; Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment -Title 'AttachmentA' | Set-RDMEntryAttachment -Title 'Attachment A' -Description 'New description' -Password $securepwd</dev:code> <dev:remarks> <maml:para>Change the title, description, and password of the attachment named AttachmentA of the entry EntryA</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RDMEntryAttachment</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>Update-RDMEntryAttachment</command:name> <gl:group>RDMEntryAttachment</gl:group> <maml:description> <maml:para>Update an entry's attachment file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>RDMEntryAttachment</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Update an entry's attachment file. Only advanced data sources support attachment. The user must have the permission to edit attachments.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RDMEntryAttachment</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</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:parameter required="false" position="named"> <maml:name>Refresh</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" variableLength="false" globbing="false" pipelineInput="false" 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>InputObject</maml:name> <maml:description> <maml:para>Attachment to update. Can be obtained from Get-RDMEntryAttachment.</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="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.</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="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.PSConnectionAttachment</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnectionAttachment to update. Can be obtained from Get-RDMEntryAttachment.</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 Update-RDMEntryAttachment -detailed". For technical information, type "Get-Help Update-RDMEntryAttachment -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment -Title 'UniqueTitle' | Update-RDMEntryCommand -Filename 'revisedFile.txt' -Refresh</dev:code> <dev:remarks> <maml:para>Update the document of the attachment 'UniqueTitle' with the file 'revisedFile.txt' in the current session directory.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RDMEntryAttachment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RDMEntryAttachment</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-RDMDeletedEntry</command:name> <gl:group>RDMDeletedEntry</gl:group> <maml:description> <maml:para>Get deleted entries' history</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMDeletedEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get deleted entries' history. For the data source supporting this functionality, every time an entry is deleted it is logged. This cmdlet will return the deleted entries from the log. The cmdlet get all deleted entries of the current vault. An ID can be passed to obtain a specific entry. The cmdlet cannot be executed in offline. The user must have the right to view the deleted entries to obtain the logs.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMDeletedEntry</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMDeletedEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>LiteralName</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RDMDeletedEntry</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="named"> <maml:name>CaseSensitive</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Filtering by name 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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>Obtain the deleted history of a specific 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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>LiteralName</maml:name> <maml:description> <maml:para>Filter the result with the name. No characters are interpreted as wildcards.</maml:para> </maml:description> <command:parameterValue required="true" 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="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the result with the name.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnectionHistory[]</maml:name> <maml:uri /> <maml:description> <maml:para>Array of object representing the deleted entries. No field can be modified.</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-RDMDeletedEntry -detailed". For technical information, type "Get-Help Get-RDMDeletedEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $today = (Get-Date).Date; Get-RDMDeletedEntry | Where ModifiedDate -ge $today</dev:code> <dev:remarks> <maml:para>View all entries deleted today</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $deletedEntries = Get-RDMDeletedEntry | Where GroupName -eq 'a\group\name' Remove-RDMDeletedEntry -InputObject $deletedEntries</dev:code> <dev:remarks> <maml:para>Delete all deleted entries whose groupName is 'a\group\name'.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-RDMDeletedEntry</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-RDMDeletedEntry</command:name> <gl:group>RDMDeletedEntry</gl:group> <maml:description> <maml:para>Delete the history of one or more deleted entries</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>RDMDeletedEntry</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Delete the history of one or more deleted entries. For the data source supporting this functionality, every time an entry is deleted it is logged. This cmdlet will delete the entries from the log, permanently deleting them. The user can permanently delete an entry by its ID, or by the result of the cmdlet Get-DSDeletedEntry. The user must be an administrator or vault owner this use this cmdlet.</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RDMDeletedEntry</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="named"> <maml:name>VaultMode</maml:name> <command:parameterValue required="true">Default | User | Global</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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:syntaxItem> <maml:name>Remove-RDMDeletedEntry</maml:name> <command:parameter required="true" position="1"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnectionHistory[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PassThru</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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>ID</maml:name> <maml:description> <maml:para>Histories to delete of a specific 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="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Histories to delete obtained from Get-RDMDeletedEntry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSConnectionHistory[]</command:parameterValue> <dev:type> <maml:name>PSConnectionHistory[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the InputObject input.</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="named"> <maml:name>VaultMode</maml:name> <maml:description> <maml:para>Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the data source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">VaultMode</command:parameterValue> <dev:type> <maml:name>VaultMode</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.PSConnectionHistory[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of PSConnectionHistory obtained from Get-RDMDeletedEntry</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionHistory[]</maml:name> <maml:uri /> <maml:description> <maml:para>Array of PSConnectionHistory of the InputObject parameter</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-RDMDeletedEntry -detailed". For technical information, type "Get-Help Remove-RDMDeletedEntry -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $today = (Get-Date).Date; $deletedEntries = Get-RDMDeletedEntry | Where ModifiedDate -ge $today Remove-RDMDeletedEntry -InputObject $deletedEntries</dev:code> <dev:remarks> <maml:para>Delete all entries deleted today</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> $deletedEntries = Get-RDMDeletedEntry | Where GroupName -eq 'a\group\name' Remove-RDMDeletedEntry -InputObject $deletedEntries</dev:code> <dev:remarks> <maml:para>Delete all deleted entries whose groupName is 'a\group\name'.</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-RDMProfiler</command:name> <gl:group>RDMProfiler</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>RDMProfiler</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-RDMProfiler</maml:name> <command:parameter required="false" position="named"> <maml:name>Level</maml:name> <command:parameterValue required="true">ProfilerLevel[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoClobber</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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"> <maml:name>Level</maml:name> <maml:description> <maml:para>Determines what the profiler will show. By default, everythig will be shown.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ProfilerLevel[]</command:parameterValue> <dev:type> <maml:name>ProfilerLevel[]</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoClobber</maml:name> <maml:description> <maml:para>Prevent the overwrite of an existing 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="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Save profiler text to the specified text file</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 Start-RDMProfiler -detailed". For technical information, type "Get-Help Start-RDMProfiler -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-RDMProfiler</command:name> <gl:group>RDMProfiler</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>RDMProfiler</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-RDMProfiler</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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 Stop-RDMProfiler -detailed". For technical information, type "Get-Help Stop-RDMProfiler -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-RDMPersonalSSHKey</command:name> <gl:group>RDMPersonalSSHKey</gl:group> <maml:description> <maml:para>Get 'My Personal SSH key' from 'My Account Settings'</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>RDMPersonalSSHKey</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Get 'My Personal SSH key' from 'My Account Settings'</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RDMPersonalSSHKey</maml:name> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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-RDMPersonalSSHKey -detailed". For technical information, type "Get-Help Get-RDMPersonalSSHKey -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE------------------</maml:title> <dev:code>PS C:\> $sshKey = Get-RDMPersonalSSHKey</dev:code> <dev:remarks> <maml:para>Get 'My Personal SSH key' credential entry</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RDMPersonalSSHKey</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-RDMPersonalSSHKey</command:name> <gl:group>RDMPersonalSSHKey</gl:group> <maml:description> <maml:para>Set 'My Personal SSH key' from 'My Account Settings'</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>RDMPersonalSSHKey</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para>Set 'My Personal SSH key' from 'My Account Settings'. It can be updated in three ways: 1) InputObject: From a PSConnection object obtained from Get-RDMPersonalSSHKey. 2) Key: From a new SSH key obtained from New-RDMSSHKey. 3) Filename: From a private key file ('.pri', '.ppk', '.key')</maml:para> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RDMPersonalSSHKey</maml:name> <command:parameter required="true" position="named"> <maml:name>InputObject</maml:name> <command:parameterValue required="true">PSConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPersonalSSHKey</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <command:parameterValue required="true">PSSSHKey</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePassphrase</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutomaticallyLoadToKeyAgent</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RDMPersonalSSHKey</maml:name> <command:parameter required="true" position="named"> <maml:name>Filename</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Passphrase</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SavePassphrase</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutomaticallyLoadToKeyAgent</maml:name> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <command:parameterValue required="true">Cancel | No | Yes</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticallyLoadToKeyAgent</maml:name> <maml:description> <maml:para>Automatically load to SSH key agent</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="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Private key file ('.pri', '.ppk', '.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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ForcePromptAnswer</maml:name> <maml:description> <maml:para>Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values: - Yes: Accept the prompt. Cover the OK and Automatic value. - No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No. - Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DialogResult[]</command:parameterValue> <dev:type> <maml:name>DialogResult[]</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="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Entry representing 'My Personal SSH Key'</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="true (ByValue)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>SSH key generated with New-RDMSSHKey</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSSHKey</command:parameterValue> <dev:type> <maml:name>PSSSHKey</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>Passphrase for the private key</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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Overrides the 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="named"> <maml:name>SavePassphrase</maml:name> <maml:description> <maml:para>Save the passphrase in the credential</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="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Overrides the 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>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSConnection object obtained from Get-RDMPersonalSSHKey</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RemoteDesktopManager.PowerShellModule.PSOutputObject.PSSSHKey</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PSSSHKey object obtained from New-RDMSSHkey</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-RDMPersonalSSHKey -detailed". For technical information, type "Get-Help Set-RDMPersonalSSHKey -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1-----------------------</maml:title> <dev:code>PS C:\> $sshKey = Get-RDMPersonalSSHKey; $sshKey.Credentials.PrivateKeyAutomaticallyLoadToKeyAgent = $true Set-RDMPersonalSSHKey -InputObject $sshKey</dev:code> <dev:remarks> <maml:para>Modify 'My Personal SSH Key' to automatically load to SSH key agent</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 2-----------------------</maml:title> <dev:code>PS C:\> New-RDMSSHKey -Algorithm ED25519 -Format OpenSSH -Comment 'asdf' -Size 1024 -Round 12 | Set-RDMPersonalSSHKey</dev:code> <dev:remarks> <maml:para>Create a new PSSHKey and save it as 'My Personal SSH Key'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------EXAMPLE 3-----------------------</maml:title> <dev:code>PS C:\> Set-RDMPersonalSSHKey -Filename 'C:\my\path\filea.ppk'</dev:code> <dev:remarks> <maml:para>Change the private key file for 'My Personal SSH Key'</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RDMPersonalSSHKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RDMSSHKey</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-DPSEncryptConfiguration</command:name> <gl:group>DPSEncryptConfiguration</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSEncryptConfiguration</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSEncryptConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>ApplicationPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encrypt</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationPath</maml:name> <maml:description> <maml:para>Directory of the application</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="named"> <maml:name>Encrypt</maml:name> <maml:description> <maml:para>Encrypt the configuration. For Windows only.</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 New-DPSEncryptConfiguration -detailed". For technical information, type "Get-Help New-DPSEncryptConfiguration -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>Unprotect-DPSEncryptConfiguration</command:name> <gl:group>DPSEncryptConfiguration</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unprotect</command:verb> <command:noun>DPSEncryptConfiguration</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unprotect-DPSEncryptConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>ApplicationPath</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="named"> <maml:name>ApplicationPath</maml:name> <maml:description> <maml:para>Directory of the application</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 Unprotect-DPSEncryptConfiguration -detailed". For technical information, type "Get-Help Unprotect-DPSEncryptConfiguration -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-DPSAdministrator</command:name> <gl:group>DPSAdministrator</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSAdministrator</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSAdministrator</maml:name> <command:parameter required="true" position="named"> <maml:name>ConnectionString</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Email</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="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string found in appsettings.json</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="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Administrator email</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="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Administrator 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="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Administrator password</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-DPSAdministrator -detailed". For technical information, type "Get-Help New-DPSAdministrator -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-DPSDatabaseAppSettings</command:name> <gl:group>DPSDatabaseAppSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSDatabaseAppSettings</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSDatabaseAppSettings</maml:name> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <command:parameterValue required="true">KestrelInstallConfiguration</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">KestrelInstallConfiguration</command:parameterValue> <dev:type> <maml:name>KestrelInstallConfiguration</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-DPSDatabaseAppSettings -detailed". For technical information, type "Get-Help New-DPSDatabaseAppSettings -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-DPSDatabase</command:name> <gl:group>DPSDatabase</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSDatabase</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSDatabase</maml:name> <command:parameter required="true" position="named"> <maml:name>ConnectionString</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="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string found in appsettings.json</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-DPSDatabase -detailed". For technical information, type "Get-Help New-DPSDatabase -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-DPSDataSourceSettings</command:name> <gl:group>DPSDataSourceSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSDataSourceSettings</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSDataSourceSettings</maml:name> <command:parameter required="true" position="named"> <maml:name>ConnectionString</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="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string found in appsettings.json</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-DPSDataSourceSettings -detailed". For technical information, type "Get-Help New-DPSDataSourceSettings -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>Register-DPSDatabaseApp</command:name> <gl:group>DPSDatabaseApp</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>DPSDatabaseApp</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-DPSDatabaseApp</maml:name> <command:parameter required="true" position="named"> <maml:name>ApplicationPath</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="named"> <maml:name>ApplicationPath</maml:name> <maml:description> <maml:para>Directory of the application</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 Register-DPSDatabaseApp -detailed". For technical information, type "Get-Help Register-DPSDatabaseApp -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>Update-DPSDatabase</command:name> <gl:group>DPSDatabase</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DPSDatabase</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DPSDatabase</maml:name> <command:parameter required="true" position="named"> <maml:name>InstallationPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ConnectionString</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="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string found in appsettings.json</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="named"> <maml:name>InstallationPath</maml:name> <maml:description> <maml:para>Folder containing the Devolutions.DatabaseUpgrade.dll</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 Update-DPSDatabase -detailed". For technical information, type "Get-Help Update-DPSDatabase -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-DPSInstall</command:name> <gl:group>DPSInstall</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSInstall</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSInstall</maml:name> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <command:parameterValue required="true">KestrelInstallConfiguration</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DPSPath</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="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">KestrelInstallConfiguration</command:parameterValue> <dev:type> <maml:name>KestrelInstallConfiguration</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DPSPath</maml:name> <maml:description> <maml:para>Application path containing the appsettings.json that contains the connection string</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-DPSInstall -detailed". For technical information, type "Get-Help New-DPSInstall -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-DPSInstallConfiguration</command:name> <gl:group>DPSInstallConfiguration</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSInstallConfiguration</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSInstallConfiguration</maml:name> <command:parameter required="false" position="named"> <maml:name>AcceptEula</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AccessUri</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HttpListenerUri</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApplicationPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GenerateSelfSignedCertificate</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableEncryptConfig</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SourceZipPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Version</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DatabaseHost</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DatabaseName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DatabaseUserName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DatabasePassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IntegratedSecurity</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseEncryptedConnection</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrustServerCertificate</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FailoverPartner</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinPoolSize</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxPoolSize</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryInterval</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ServerName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ServerDescription</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableTelemetry</maml:name> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdministratorUsername</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdministratorPassword</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdministratorEmail</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="named"> <maml:name>AcceptEula</maml:name> <maml:description> <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="named"> <maml:name>AccessUri</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="named"> <maml:name>AdministratorEmail</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="named"> <maml:name>AdministratorPassword</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="named"> <maml:name>AdministratorUsername</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="named"> <maml:name>ApplicationPath</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="named"> <maml:name>DatabaseHost</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="named"> <maml:name>DatabaseName</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="named"> <maml:name>DatabasePassword</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="named"> <maml:name>DatabaseUserName</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="named"> <maml:name>DisableEncryptConfig</maml:name> <maml:description> <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="named"> <maml:name>EnableTelemetry</maml:name> <maml:description> <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="named"> <maml:name>FailoverPartner</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="named"> <maml:name>GenerateSelfSignedCertificate</maml:name> <maml:description> <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="named"> <maml:name>HttpListenerUri</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="named"> <maml:name>IntegratedSecurity</maml:name> <maml:description> <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="named"> <maml:name>MaxPoolSize</maml:name> <maml:description> <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="named"> <maml:name>MinPoolSize</maml:name> <maml:description> <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="named"> <maml:name>RetryCount</maml:name> <maml:description> <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="named"> <maml:name>RetryInterval</maml:name> <maml:description> <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="named"> <maml:name>ServerDescription</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="named"> <maml:name>ServerName</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="named"> <maml:name>SourceZipPath</maml:name> <maml:description> <maml:para>Zip file of the server</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="named"> <maml:name>Timeout</maml:name> <maml:description> <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="named"> <maml:name>TrustServerCertificate</maml:name> <maml:description> <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="named"> <maml:name>UseEncryptedConnection</maml:name> <maml:description> <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="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version of the server</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-DPSInstallConfiguration -detailed". For technical information, type "Get-Help New-DPSInstallConfiguration -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-DPSAccessUri</command:name> <gl:group>DPSAccessUri</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DPSAccessUri</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DPSAccessUri</maml:name> <command:parameter required="true" position="named"> <maml:name>ConnectionString</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="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string found in appsettings.json</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-DPSAccessUri -detailed". For technical information, type "Get-Help Get-DPSAccessUri -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-DPSAppSettings</command:name> <gl:group>DPSAppSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DPSAppSettings</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DPSAppSettings</maml:name> <command:parameter required="true" position="named"> <maml:name>ApplicationPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Decrypt</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationPath</maml:name> <maml:description> <maml:para>Directory of the application</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="named"> <maml:name>Decrypt</maml:name> <maml:description> <maml:para>Decrypt the connection strings</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 Get-DPSAppSettings -detailed". For technical information, type "Get-Help Get-DPSAppSettings -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-DPSAppSettings</command:name> <gl:group>DPSAppSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>DPSAppSettings</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DPSAppSettings</maml:name> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <command:parameterValue required="true">KestrelInstallConfiguration</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">KestrelInstallConfiguration</command:parameterValue> <dev:type> <maml:name>KestrelInstallConfiguration</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-DPSAppSettings -detailed". For technical information, type "Get-Help New-DPSAppSettings -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-DPSAccessUri</command:name> <gl:group>DPSAccessUri</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DPSAccessUri</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DPSAccessUri</maml:name> <command:parameter required="true" position="named"> <maml:name>ConnectionString</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ApplicationPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AccessURI</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AdditionalAccessURIs</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="named"> <maml:name>AccessURI</maml:name> <maml:description> <maml:para>New access URI</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalAccessURIs</maml:name> <maml:description> <maml:para>New additional access URI</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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationPath</maml:name> <maml:description> <maml:para>Path to the application</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="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string found in appsettings.json</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-DPSAccessUri -detailed". For technical information, type "Get-Help Set-DPSAccessUri -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-DPSAppSettings</command:name> <gl:group>DPSAppSettings</gl:group> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DPSAppSettings</command:noun> <dev:version>2024.2.6</dev:version> </command:details> <maml:description> <maml:para /> <maml:para /> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DPSAppSettings</maml:name> <command:parameter required="true" position="named"> <maml:name>AppSettings</maml:name> <command:parameterValue required="true">AppSettingsFile</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ApplicationPath</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encrypt</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationPath</maml:name> <maml:description> <maml:para>Directory of the application</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="named"> <maml:name>AppSettings</maml:name> <maml:description> <maml:para>Directory of the application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AppSettingsFile</command:parameterValue> <dev:type> <maml:name>AppSettingsFile</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encrypt</maml:name> <maml:description> <maml:para>Encrypt the connection strings</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-DPSAppSettings -detailed". For technical information, type "Get-Help Set-DPSAppSettings -full".</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <maml:relatedLinks /> </command:command> </helpItems> |