Update-DSVault
Synopsis
Update a vault.
Syntax
VaultID
Update-DSVault [-VaultID] <guid> [[-Name] <string>] [[-Password] <string>] [[-Description] <string>]
[[-IsAllowedOffline] <bool>] [[-AllowedUsernameList] <string[]>]
[[-AllowedApplicationList] <string[]>] [[-AllowedRolesList] <string[]>] [-AsLegacyResponse]
[<CommonParameters>]InputObject
Update-DSVault [-InputObject] <RepositoryEntity> [[-Name] <string>] [[-Password] <string>]
[[-Description] <string>] [[-IsAllowedOffline] <bool>] [[-AllowedUsernameList] <string[]>]
[[-AllowedApplicationList] <string[]>] [[-AllowedRolesList] <string[]>] [-AsLegacyResponse]
[<CommonParameters>]Description
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.
Examples
$UpdatedVault = @{ VaultID = "36120922-539d-4550-8567-fc4f21d77352" Name = "Test" Description = "Test" IsAllowedOffline = $false Password = 'Pa$$w0rd!' AllowedUsersList = @("User1") AllowedRolesList = @("Role1") AllowedApplicationList = @("App1") }
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.
Parameters
-AllowedApplicationList
Accept an array of strings containing application names (not app id) to add to the vault
-AllowedRolesList
Accept an array of strings containing user group's name (not id) to add to the vault
-AllowedUsernameList
Accept an array of strings containing usernames (not id) to add to the vault
-AsLegacyResponse
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.
-Description
Vault's description
-InputObject
Vault obtained from Get-DSVault
-IsAllowedOffline
Specify if the vault is allowed to be used while offline. Its default value is true.
-Name
Vault's name
-Password
Vault's master password. Backend does not verify password complexity, so you should use New-DSPassword and choose a password in the list
-VaultID
Vault's ID to update
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.
Outputs
Notes
For more information, type "Get-Help Update-DSVault -detailed". For technical information, type "Get-Help Update-DSVault -full".
Last updated
Was this helpful?