Update-DSVault

Update a vault.

Update-DSVault [-VaultID] <guid> [[-Name] <string>] [[-Password] <string>] [[-Description] <string>]
 [[-IsAllowedOffline] <bool>] [[-AllowedUsernameList] <string[]>]
 [[-AllowedApplicationList] <string[]>] [[-AllowedRolesList] <string[]>] [-AsLegacyResponse]
 [<CommonParameters>]

Update-DSVault [-InputObject] <RepositoryEntity> [[-Name] <string>] [[-Password] <string>]
 [[-Description] <string>] [[-IsAllowedOffline] <bool>] [[-AllowedUsernameList] <string[]>]
 [[-AllowedApplicationList] <string[]>] [[-AllowedRolesList] <string[]>] [-AsLegacyResponse]
 [<CommonParameters>]

Update a vault using the supplied parameters. If name is present, it cannot be null nor empty. Backend does not verify password complexity, so use New-DSPassword to generate a strong password with house policy.

$UpdatedVault = @{ VaultID = "36120922-539d-4550-8567-fc4f21d77352" Name = "Test" Description = "Test" IsAllowedOffline = $false Password = 'Pa$$w0rd!' AllowedUsersList = @("User1") AllowedRolesList = @("Role1") AllowedApplicationList = @("App1") }

Update-DSVault @UpdatedVault -Verbose

Update an existing vault whose ID is 36120922-539d-4550-8567-fc4f21d77352. All other fields are modified by the value specified in the hash table.

Accept an array of strings containing application names (not app id) to add to the vault

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

Accept an array of strings containing user group's name (not id) to add to the vault

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

Accept an array of strings containing usernames (not id) to add to the vault

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

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

Vault's description

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

Vault obtained from Get-DSVault

Type: Devolutions.RemoteDesktopManager.Business.Entities.RepositoryEntity
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: InputObject
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

Specify if the vault is allowed to be used while offline. Its default value is true.

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

Vault's name

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

Vault's master password. Backend does not verify password complexity, so you should use New-DSPassword and choose a password in the list

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

Vault's ID to update

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: VaultID
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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.

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