Update-DSPamVault

    2024-12-11

    Update-DSPamVault

    SYNOPSIS

    Update the PAM vault

    SYNTAX

    __AllParameterSets

    Update-DSPamVault -InputObject <PSVaultWrapper> [-Name <string>] [-Description <string>]
 [-Visibility <VaultAllowAccessRequestRole>] [-Owner <string[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Update the PAM vault. To give access to a user, use the Set-DSVaultUser cmdlet. To give access to a role, use the Set-DSVaultRole cmdlet.

    EXAMPLES

    EXAMPLE 1

    PS C:> Get-DSPamVault -ID $myVaultId | Update-DSVault -Name 'NewVaultName' -Description 'A new description'

    Update the name and description of the PAM vault whose id is $myVaultId

    EXAMPLE 2

    PS C:> Get-DSPamVault | Where-Object -Property Name -Like -Value PST* | Select-Object -ExpandProperty id | Update-DSVault -Visibility Never

    Set the visibility of all PAM vaults whose name starts with PST to invitation only.

    PARAMETERS

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Description

    Description of the PAM vault

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

    -InputObject

    The PAM vault to delete. Accepts the ID or the RepositoryEntity object representing the vault.

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

    -Name

    Name of the PAM vault

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

    -Owner

    Assign owners to the vault with their ID or 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: ''

    -Visibility

    Visibility of the vault

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

    -WhatIf

    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- wi
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.PSWrapper.PSVaultWrapper

    OUTPUTS

    NOTES

    For more information, type "Get-Help Update-DSPamVault -detailed". For technical information, type "Get-Help Update-DSPamVault -full".