Set-RDMSessionUsername

    2024-12-11

    Set-RDMSessionUsername

    SYNOPSIS

    Set the username on the specified session.

    SYNTAX

    Id

    Set-RDMSessionUsername [-ID] <guid> [-UserName] <string> [-PassThru] [-Refresh] [-SetSession]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    InputObject

    Set-RDMSessionUsername [-Session] <PSConnection> [-UserName] <string> [-PassThru] [-Refresh]
 [-SetSession] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Set the username on the specified session. To persist the new username, the switch SetSession must be used.

    EXAMPLES

    EXAMPLE 1

    PS C:> Set-RDMSessionUsername "{00000000-0000-0000-0000-000000000000}" "localadmin"

    Set the username from the session with ID = "{00000000-0000-0000-0000-000000000000}".

    EXAMPLE 2

    PS C:> $list = Get-RDMSession; Get-RDMSessionPassword -ID $list[1].ID -Username

    Retrieves the list of available sessions and gets the password from the the second element in the list.

    EXAMPLE 3

    PS C:> Get-RDMSession -Name 'UniqueName' | Set-RDMSessionDomain -Domain "MyOtherDomain.com" -PassThru | Set-RDMSessionPassword -Password $securePassword -PassThru | Set-RDMSessionUsername -UserName 'NewUserName' -PassThru | Set-RDMSession

    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.

    PARAMETERS

    -ForcePromptAnswer

    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.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ID

    Specifies the ID of the session to set the password from.

    Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Id
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -PassThru

    Return the modified entry.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Refresh

    Send refresh notification to Remote Desktop Manager application.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Session

    Specifies the session to set the username to

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: InputObject
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -SetSession

    Save the session in the current data source.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -UserName

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    System.Guid

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

    NOTES

    For more information, type "Get-Help Set-RDMSessionUsername -detailed". For technical information, type "Get-Help Set-RDMSessionUsername -full".