New-RDMEntry

2025-02-17

New-RDMEntry

SYNOPSIS

Create a new entry.

SYNTAX

__AllParameterSets

New-RDMEntry [-Type] <ConnectionType> [[-Name] <string>] [[-Group] <string>] [[-Host] <string>]
 [[-TemplateID] <guid>] [-DocumentAttachment <PSConnectionAttachment>] [-DocumentFileName <string>]
 [-Set] [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

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.

EXAMPLES

EXAMPLE 1

PS C:> New-RDMEntry -Name 'New Entry' -Host 'myServer' -Type 'RDPConfigured' -Set -VaultMoode User

Create & save a new entry in the user vault.

EXAMPLE 2

PS C:> $folder = New-RDMEntry -Name 'New Folder' -Type 'Group'; $folder.GroupDetails.UserName = 'MyUserName'; $folder.GroupDetails.Domain = 'MyDomain'; Set-RDMEntry -InputObject $folder

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.

PARAMETERS

-DocumentAttachment

New document attachement.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DocumentFileName

New document file name.

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

-Group

Folder where the entry will be. It is corresponding to the property 'Group' of the PSConnection object.

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

-Host

Host of the entry. Value available for specific entry types only.

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

-Name

Name of the entry. It can not be empty. However, if the parameter Host is not empty, it will be use as a fallback.

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

-Set

Save the entry based on the vault mode: - Default => In the current vault - User => In the user vault - Global => In the system vault

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

-TemplateID

Id of the template used to create the entry. It is mandatory for entry of the type 'TemplateGroup'.

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

-Type

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'

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

-VaultMode

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.

Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
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.

INPUTS

OUTPUTS

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

NOTES

For more information, type "Get-Help New-RDMEntry -detailed". For technical information, type "Get-Help New-RDMEntry -full".

RELATED LINKS

• Get-RDMEntry
• Remove-RDMEntry
• Set-RDMEntry