Skip to content

Get-Vault.md

Latest commit

 

History

History
150 lines (118 loc) · 3.09 KB

Get-Vault.md

File metadata and controls

150 lines (118 loc) · 3.09 KB

Get-Vault

SYNOPSIS

Get information about vaults

SYNTAX

All (Default)

Get-Vault [-Type <String>] [-Active <Boolean>] [-WithUrl <Boolean>] [-Limit <Int32>]
 [-IncludeDevices <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Vault

Get-Vault [-Vault <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Get information about a vaults related to an organization or on a specific vault. If requesting information for all vaults you can filter by type, state, and URL presence.

EXAMPLES

Get a vault by ID

Get-Vault -Vault 12345

Get all vaults with filtering

Get-Vault -Type 'Private' -Active $true -WithUrl $true -IncludeDevices $false

PARAMETERS

-Vault

Vault object or ID to retrieve information on.

Type: Object
Parameter Sets: Vault
Aliases: Id

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Type

Specifies the type of vaults to retrieve. Valid values are 'Private' and 'Cloud'. Returns both types if not specified.

Type: String
Parameter Sets: All
Aliases: vault_type

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Active

Specifies whether to retrieve active vaults only. If set to $true, only active vaults will be retrieved. If set to $false, only inactive vaults will be retrieved. If not set, the result is not filtered by active state.

Type: Boolean
Parameter Sets: All
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WithUrl

Filter on presence of URL. If true, only vaults with a URL will be retrieved. If false, only vaults without a URL will be retrieved. If not set, the result is not filtered by URL presence.

Type: Boolean
Parameter Sets: All
Aliases: with_url

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Limit

Specifies the maximum number of vaults to retrieve.

Type: Int32
Parameter Sets: All
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDevices

Specifies whether to include devices associated with the vaults in the retrieved information. If set to $true, devices will be included.

Type: Boolean
Parameter Sets: All
Aliases: include_devices

Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Pipeline input is not accepted.

OUTPUTS

Returns a Vault object or array of Vault objects