Add-RDMFavoriteEntry

    2025-01-21

    Add-RDMFavoriteEntry

    SYNOPSIS

    Add entries to the favorites

    SYNTAX

    __AllParameterSets

    Add-RDMFavoriteEntry -InputObject <PSConnection[]> [-FolderName <string>] [-PassThru]
     [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Add entries to the favorites. Entries from the System Vault, as well as subentries, are prohibited from being added to the favorites.

    EXAMPLES

    EXAMPLE

    PS C:> Get-RDMEntry -Name 'Entry A' | Add-RDMFavoriteEntry -FolderName 'FolderA\SubFolderA'

    Add the entry named 'Entry A' to the favorite folder named 'FolderA\SubFolderA'.

    PARAMETERS

    -FolderName

    Favorite folder where the entries will be added. If not specified, it will be at the root.

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

    -InputObject

    Entries to add to the favorites

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

    -PassThru

    Return the PSConnection objects

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

    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

    Entries to be added to the favorites

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

    NOTES

    For more information, type "Get-Help Add-RDMFavoriteEntry -detailed". For technical information, type "Get-Help Add-RDMFavoriteEntry -full".