Get-DSVault

    2024-10-28

    Get-DSVault

    SYNOPSIS

    Get vault(s) from the Devolutions Server instance.

    SYNTAX

    GetPage (Default)

    Get-DSVault [-Descending] [-PageNumber <int>] [-PageSize <int>] [-SortField <string>]
 [-AsLegacyResponse] [<CommonParameters>]

    GetAll

    Get-DSVault -All [-AsLegacyResponse] [<CommonParameters>]

    GetAllLegacy

    Get-DSVault -Legacy [-AsLegacyResponse] [<CommonParameters>]

    GetOne

    Get-DSVault [-VaultID] <guid> [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get vaults in the Devolutions Server instance in three ways: a single vault by its ID, all vaults, or a subset of vaults from pagination.

    EXAMPLES

    EXAMPLE 1

    PS C:> $vaults = Get-DSVault -All

    Retrieve all vaults and store the ServerResponse<RepositoryEntity[]> in $vaults.

    EXAMPLE 2

    PS C:> $vault = Get-DSVault -VaultID 00000000-0000-0000-0000-000000000000

    Retrieve the vault with the matching ID and store the ServerResponse in $vault.

    EXAMPLE 3

    PS C:> $vaults = Get-DSVault -PageNumber 2 -PageSize 10

    Retrieve the second page of 10 vaults and store the ServerResponse<RepositoryEntity[]> in $vaults.

    PARAMETERS

    -All

    Fetches all vaults.

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

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

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

    -Descending

    Sort the field in the descending order.

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

    -Legacy

    Deprecated. Do not use.

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

    -PageNumber

    Specify the desired page. If not specified, the first one will be returned.

    Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: GetPage
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -PageSize

    Number of vaults in a page. If not specified, there will be 25 vaults per page.

    Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: GetPage
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -SortField

    Specify the field on which the vaults will be ordered.

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: GetPage
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -VaultID

    Specify the ID of the desired vault.

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: GetOne
  Position: 0
  IsRequired: true
  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

    OUTPUTS

    NOTES

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