Move-RDMSession

2025-02-17

Move-RDMSession

SYNOPSIS

Move entries to the specified group or a new vault.

SYNTAX

IdFolder

Move-RDMSession [-ID] <guid[]> [-Destination] <string> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

IdVault

Move-RDMSession [-ID] <guid[]> [-ToVaultID] <guid> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObjectFolder

Move-RDMSession [-InputObject] <PSConnection[]> [-Destination] <string> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObjectVault

Move-RDMSession [-InputObject] <PSConnection[]> [-ToVaultID] <guid> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

NameFolder

Move-RDMSession [-Name] <string[]> [-Destination] <string> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

NameVault

Move-RDMSession [-Name] <string[]> [-ToVaultID] <guid> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

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.

EXAMPLES

EXAMPLE 1

PS C:> Get-RDMSession -Name FolderToBeMoved | Move-RDMSession -Destination ""

Move the group named FolderToBeMoved and all entries it contains to the root

EXAMPLE 2

PS C:> Move-RDMSession -Name EntryA, EntryB, EntryE -Destination Greener\Pastures

Move the entries EntryA, EntryB, and EntryE to the group Pastures whose parent is the group Greener.

EXAMPLE 3

PS C:> $vaultDestination = Get-RDMRepository -Name 'VaultA'; Move-RDMSession -Name EntryA, EntryB, EntryE -ToVaultID $vaultDestination.ID

Move the entries EntryA, EntryB, and EntryE from the current vault to the vault named 'VaultA'.

PARAMETERS

-Destination

New group value. It must be the complete path to the folder. It is corresponding to the Group attribute to the PSConnection object.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: IdFolder
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: InputObjectFolder
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: NameFolder
  Position: 2
  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 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 entries to be moved.

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

-InputObject

Specifies the entries to be moved.

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

-Name

Specifies the name of the entries to be moved.

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

-PassThru

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.

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

Refresh RDM UI. If RDM in not open, nothing happens.

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: ''

-ToVaultID

ID of the vault where the entries will be moved. Cannot transfer entries from the user vault.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: IdVault
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: InputObjectVault
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: NameVault
  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

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Array of PSConnection to move.

OUTPUTS

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

NOTES

For more information, type "Get-Help Move-RDMSession -detailed". For technical information, type "Get-Help Move-RDMSession -full".

RELATED LINKS