Set-RDMPrivateSessionAttachment

    2024-12-11

    Set-RDMPrivateSessionAttachment

    SYNOPSIS

    Save attachments in the user vault

    SYNTAX

    __AllParameterSets

    Set-RDMPrivateSessionAttachment [-Attachment] <PSConnectionAttachment[]> [-Refresh]
     [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Save attachments in the user vault. Only advanced data sources support attachment. The user must have the permission to edit attachments.

    EXAMPLES

    EXAMPLE

    PS C:> $entry = Get-RDMPrivateSession -Name EntryA; $attachments = Get-RDMPrivateSessionAttachment -Session $entry; $attachments[0].Description = 'New description'; Set-RDMPrivateSessionAttachment -Attachment $attachments[0]

    Get the attachments of the session EntryA in the user vault. Change the description of the desired attachment and save the modification.

    PARAMETERS

    -Attachment

    PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment[]
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      Position: 1
      IsRequired: true
      ValueFromPipeline: true
      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: ''
    

    -Refresh

    Send refresh notification to Remote Desktop Manager application.

    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.PSConnectionAttachment

    Array of PSConnectionAttachment to save. Can be obtained from Get-RDMPrivateSessionAttachment.

    OUTPUTS

    NOTES

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