Set-RDMSessionDomain

Synopsis

Set the domain from the specified session.

Syntax

Id

Set-RDMSessionDomain [-ID] <guid> [-Domain] <string> [-PassThru] [-Refresh] [-SetSession]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObject

Set-RDMSessionDomain [-Session] <PSConnection> [-Domain] <string> [-PassThru] [-Refresh]
 [-SetSession] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Set the domain from the specified session. To persist the new domain, the switch SetSession must be used.

Examples

Example 1

PS C:\> Set-RDMSessionDomain "{00000000-0000-0000-0000-000000000000}" "MyOtherDomain.com" -SetSession

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

Example 2

PS C:\> $list = Get-RDMSession; Set-RDMSessionDomain -ID $list[1].ID -Domain "MyOtherDomain.com" -SetSession -Refresh

Retrieves the list of available sessions and sets the domain from the the second element in the list with UI refresh.

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

-Domain

New domain name.

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

-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 no "No" option.

• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
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 get the domain from.

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

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id
  Position: 0
  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
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. Use SetSession to persist the modification.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
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 Domain to.

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

-SetSession

Save the session in the current workspace.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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.

Outputs

Notes

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