Add-RDMEntryAttachment

    2024-11-18

    Add-RDMEntryAttachment

    SYNOPSIS

    Add new attachments to an existing entry

    SYNTAX

    __AllParameterSets

    Add-RDMEntryAttachment [-InputObject] <PSConnection> [-Filename] <string[]> [-PassThru] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Add new attachments to an existing entry. Entries of the type SessionTool do not allow attachments. The type of an entry is the property ConnectionType of a PSConnection. To modify properties of the attachments, use Set-RDMEntryAttachment. To update a file of an existing attachment, use Update-RDMEntryAttachment.

    Only advanced data sources support attachment.

    The user must have the permission to add attachments.

    EXAMPLES

    EXAMPLE 1

    PS C:> Get-RDMEntry -Name EntryA | Add-RDMEntryAttachment -Filename 'C:\my\path\filename.txt', 'localFile.txt'

    Attach the files filename.txt, located in 'C:\my\path', and localFile.txt, located in the current session directory, to the session named EntryA.

    EXAMPLE 2

    PS C:> $entry = Get-RDMEntry -Name EntryA; $attachment = Add-RDMEntryAttachment -InputObject $entry -Filename 'filename.txt' -PassThru; Set-RDMEntryAttachment -InputObject $attachment -Title 'Filename' -Description 'This is an important file'

    Attach the file filename.txt, located in 'C:\my\path', to the session named EntryA.

    PARAMETERS

    -Filename

    Attachment filenames.

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

    -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

    Entry to add the attachment to.

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

    -PassThru

    Return the all attachments as a PSConnectionAttachment[].

    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 the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.

    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

    PSConnection object of the entry where the attachments will be. Can be obtained from Get-RDMEntry.

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment

    NOTES

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