Zyborg » Zyborg.Vault » Get-VltDataList

Get-VltDataList

NAME

Get-VltDataList

SYNOPSIS

List data from Vault.

Comparable to the vault CLI list command.

SYNTAX

Get-DataList [-Path] <string[]> [-KeepSecretWrapper <SwitchParameter>] [-VaultAddress <string>] [-VaultProfile <string>] [-VaultSession <object>] [-VaultToken <string>] [<CommonParameters>]

Get-DataList [-Path] <string[]> -WrapTtl <string> [-KeepSecretWrapper <SwitchParameter>] [-VaultAddress <string>] [-VaultProfile <string>] [-VaultSession <object>] [-VaultToken <string>] [<CommonParameters>]

Get-DataList [-UnwrapToken] <string[]> [-KeepSecretWrapper <SwitchParameter>] [-VaultAddress <string>] [-VaultProfile <string>] [-VaultSession <object>] [-VaultToken <string>] [<CommonParameters>]

DESCRIPTION

Retrieve a listing of available data. The data returned, if any, is provider- and endpoint-specific.

PARAMETERS


-Path <string[]>
One or more paths for which to list data.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-WrapTtl <string>
Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.

This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.

The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.

        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UnwrapToken <string[]>
One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-KeepSecretWrapper <SwitchParameter>
When specified, the returned result maintains the meta data wrapper for the secret result.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VaultSession <object>
Specifies a Vault Session object that represents a connected-state container to a Vault server.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-vs <object>
Specifies a Vault Session object that represents a connected-state container to a Vault server.

This is an alias of the VaultSession parameter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VaultProfile <string>
Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.

Other connection parameters on this command may override whatever attributes are defined in the profile.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-vp <string>
Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.

Other connection parameters on this command may override whatever attributes are defined in the profile.

This is an alias of the VaultProfile parameter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VaultAddress <string>
Specifies the Vault server connection endpoint URL.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-va <string>
Specifies the Vault server connection endpoint URL.

This is an alias of the VaultAddress parameter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VaultToken <string>
Specifies the Vault server connection authentication token to identify the caller to the server.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-vt <string>
Specifies the Vault server connection authentication token to identify the caller to the server.

This is an alias of the VaultToken parameter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 

INPUTS

System.String[]
        One or more paths for which to list data.

System.String[]
        One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.

OUTPUTS

VaultSharp.Backends.Secret.Models.ListInfo

VaultSharp.Backends.System.Models.WrapInfo

RELATED LINKS

-none-


2017-06-19 12:39:53