Zyborg.Vault.POSH.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-AuditMounts --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-AuditMounts</command:name> <command:verb>Get</command:verb> <command:noun>AuditMounts</command:noun> <maml:description> <maml:para>List the enabled audit backends.</maml:para> <maml:para>Comparable to the vault CLI audit-list command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The output lists the mounted audit providers and the options for those providers. The options may contain sensitive information, and therefore only a root Vault user can view this.</maml:para> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-AuditMounts</maml:name> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: AuditBackend --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.Audit.Models.AuditBackend</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Dismount-AuditProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Dismount-AuditProvider</command:name> <command:verb>Dismount</command:verb> <command:noun>AuditProvider</command:noun> <maml:description> <maml:para>Disable an audit provider.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Once the audit backend is disabled no more audit logs will be sent to it. The data associated with the audit backend isn't affected.</maml:para> <maml:para>The MountName parameter should map to the MountNameused in Enable-AuditProvider. If no MountName was provided when mounting, you should use the provider type (e.g. "file").</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Dismount-AuditProvider</maml:name> <!-- Parameter: MountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The name that identifies the mount point.</maml:para> <maml:para>This should map to the MountName used for Mount-AuditProvider. If no MountName was provided when mounting, you should use the provider type (e.g. "file").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The name that identifies the mount point.</maml:para> <maml:para>This should map to the MountName used for Mount-AuditProvider. If no MountName was provided when mounting, you should use the provider type (e.g. "file").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Enable-AuditProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-AuditProvider</command:name> <command:verb>Enable</command:verb> <command:noun>AuditProvider</command:noun> <maml:description> <maml:para>Enable an audit provider.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command enables an audit backend of type Type. Additional options for configuring the audit provider can be specified after the type in the same format as the Write-Data command in key/value pairs.</maml:para> <maml:para>For information on available configuration options, please see the documentation.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-AuditProvider</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type name of the audit provider (e.g. file).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MountName</maml:name> <maml:description> <maml:para>Specify a unique path for this audit provider. This is purely for referencing this audit provider. By default this will be the backend type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Config --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Config</maml:name> <maml:description> <maml:para>One or more configuration key-value settings.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>A human-friendly description for the provider. This shows up only when querying the enabled providers.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Local --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Local</maml:name> <maml:description> <maml:para>TODO: This flag is NOT currently supported.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type name of the audit provider (e.g. file).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MountName</maml:name> <maml:description> <maml:para>Specify a unique path for this audit provider. This is purely for referencing this audit provider. By default this will be the backend type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Config --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Config</maml:name> <maml:description> <maml:para>One or more configuration key-value settings.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>A human-friendly description for the provider. This shows up only when querying the enabled providers.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Local --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Local</maml:name> <maml:description> <maml:para>TODO: This flag is NOT currently supported.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>To configure the file audit provider to write audit logs at the path c:\temp\log\audit.log:</maml:para> </maml:introduction> <dev:code>## PS> Mount-VltAuditProvider file -Config @{ file_path = "c:\temp\log\audit.log" }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-Auth --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-Auth</command:name> <command:verb>New</command:verb> <command:noun>Auth</command:noun> <maml:description> <maml:para>Authenticate with Vault against an auth provider using argument auth data.</maml:para> <maml:para>Comparable to the vault CLI auth command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>By default, the AuthMethod is assumed to be token. If not supplied via the AuthData parameter, a prompt will be issued to collect the token ID used to authenticate against the token auth provider.</maml:para> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>New-Auth</maml:name> <!-- Parameter: AuthData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthData</maml:name> <maml:description> <maml:para>Specifies arbitrary authentication parameters as key-value pairs.</maml:para> <maml:para>Authentication parameters are specific to each authentication method, aka auth provider, which define various required or optional parameter key names. Refer to the documentation of specific auth providers for more details about specific auth data key names.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthMethod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthMethod</maml:name> <maml:description> <maml:para>Selects the authentication method to be used, such as userpass, GitHub, or TLS certificates.</maml:para> <maml:para>Each method corresponds to an associated auth provider which defines its own set of authentication parameters which are provided via the AuthData parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>token</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The path at which the auth provider is mounted. If an auth provider is mounted at multiple paths, this option can be used to authenticate against a specific path associated with a specific provider instance (i.e. with a distinct configuration).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoVerify --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoVerify</maml:name> <maml:description> <maml:para>Do not verify the token after creation; avoids a use count decrement.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PathData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PathData</maml:name> <maml:description> <maml:para>Defines the sub-path under the mount to authenticate against.</maml:para> <maml:para>By default authentication is targeted against the login sub-path under the mount point of an auth provider instance. This parameter allows you to define an additional sub-path to the default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SaveAs --> <command:syntaxItem> <maml:name>New-Auth</maml:name> <!-- Parameter: AuthData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthData</maml:name> <maml:description> <maml:para>Specifies arbitrary authentication parameters as key-value pairs.</maml:para> <maml:para>Authentication parameters are specific to each authentication method, aka auth provider, which define various required or optional parameter key names. Refer to the documentation of specific auth providers for more details about specific auth data key names.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthMethod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthMethod</maml:name> <maml:description> <maml:para>Selects the authentication method to be used, such as userpass, GitHub, or TLS certificates.</maml:para> <maml:para>Each method corresponds to an associated auth provider which defines its own set of authentication parameters which are provided via the AuthData parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>token</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When saving the auth token to a profile with the SaveAsProfile parameter, use this flag to overwrite an existing profile with the same name, otherwise an error will be raised.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The path at which the auth provider is mounted. If an auth provider is mounted at multiple paths, this option can be used to authenticate against a specific path associated with a specific provider instance (i.e. with a distinct configuration).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoVerify --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoVerify</maml:name> <maml:description> <maml:para>Do not verify the token after creation; avoids a use count decrement.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PathData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PathData</maml:name> <maml:description> <maml:para>Defines the sub-path under the mount to authenticate against.</maml:para> <maml:para>By default authentication is targeted against the login sub-path under the mount point of an auth provider instance. This parameter allows you to define an additional sub-path to the default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SaveAsProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SaveAsProfile</maml:name> <maml:description> <maml:para>Saves the result of the new auth token request to a Vault connection profile with the argument name.</maml:para> <maml:para>If the profile name already exists, use the Force switch parameter to overwrite it, otherwise an error will be raised</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthMethod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthMethod</maml:name> <maml:description> <maml:para>Selects the authentication method to be used, such as userpass, GitHub, or TLS certificates.</maml:para> <maml:para>Each method corresponds to an associated auth provider which defines its own set of authentication parameters which are provided via the AuthData parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>token</dev:defaultValue> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The path at which the auth provider is mounted. If an auth provider is mounted at multiple paths, this option can be used to authenticate against a specific path associated with a specific provider instance (i.e. with a distinct configuration).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PathData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PathData</maml:name> <maml:description> <maml:para>Defines the sub-path under the mount to authenticate against.</maml:para> <maml:para>By default authentication is targeted against the login sub-path under the mount point of an auth provider instance. This parameter allows you to define an additional sub-path to the default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthData</maml:name> <maml:description> <maml:para>Specifies arbitrary authentication parameters as key-value pairs.</maml:para> <maml:para>Authentication parameters are specific to each authentication method, aka auth provider, which define various required or optional parameter key names. Refer to the documentation of specific auth providers for more details about specific auth data key names.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoVerify --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoVerify</maml:name> <maml:description> <maml:para>Do not verify the token after creation; avoids a use count decrement.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SaveAsProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SaveAsProfile</maml:name> <maml:description> <maml:para>Saves the result of the new auth token request to a Vault connection profile with the argument name.</maml:para> <maml:para>If the profile name already exists, use the Force switch parameter to overwrite it, otherwise an error will be raised</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When saving the auth token to a profile with the SaveAsProfile parameter, use this flag to overwrite an existing profile with the same name, otherwise an error will be raised.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: AuthorizationInfo --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.AuthorizationInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>An example of authenticating to the 'userpass' auth provider at the default mount point.</maml:para> </maml:introduction> <dev:code>## $creds = Get-Credential ## Interactively and securely prompt for auth creds New-VltAuth -AuthMethod userpass -PathData $creds.Username ` -AuthData @{ password = $creds.GetNetworkCredential().Password }</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>An example of authenticating to the okta auth provider at the non-default mount point 'okta1'.</maml:para> </maml:introduction> <dev:code>## $creds = Get-Credential ## Interactively and securely prompt for auth creds New-VltAuth -AuthMethod okta -MountName okta1 -PathData $creds.Username ` -AuthData @{ password = $creds.GetNetworkCredential().Password }</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-VltProfile</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VltProfile</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-AuthMounts --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-AuthMounts</command:name> <command:verb>Get</command:verb> <command:noun>AuthMounts</command:noun> <maml:description> <maml:para>List the available auth provider mounts and auth methods.</maml:para> <maml:para>Comparable to the vault CLI 'auth' command with the '-methods' parameter.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-AuthMounts</maml:name> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: AuthenticationBackend --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.Authentication.Models.AuthenticationBackend</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Dismount-AuthProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Dismount-AuthProvider</command:name> <command:verb>Dismount</command:verb> <command:noun>AuthProvider</command:noun> <maml:description> <maml:para>Disable an already-enabled auth provider.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Once the auth provider is disabled its path can no longer be used to authenticate. All access tokens generated via the disabled auth provider will be revoked. This command will block until all tokens are revoked. If the command is exited early the tokens will still be revoked.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Dismount-AuthProvider</maml:name> <!-- Parameter: MountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The name that identifies the mount point.</maml:para> <maml:para>This should map to the MountName used for Mount-AuthProvider. If no MountName was provided when mounting, you should use the provider type (e.g. "file").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The name that identifies the mount point.</maml:para> <maml:para>This should map to the MountName used for Mount-AuthProvider. If no MountName was provided when mounting, you should use the provider type (e.g. "file").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Enable-AuthProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-AuthProvider</command:name> <command:verb>Enable</command:verb> <command:noun>AuthProvider</command:noun> <maml:description> <maml:para>Enable a new auth provider.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command enables a new auth provider. An auth provider is responsible for authenticating a user and assigning them policies with which they can access Vault.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-AuthProvider</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type name of the auth provider (e.g. userpass).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MountName</maml:name> <maml:description> <maml:para>Mount point for the auth provider. This defaults to the type of the mount. This will make the auth provider available at /auth/[path].</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human-friendly description of the purpose of the auth provider. This shows up in the Get-AuthMounts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Config --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Config</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Local --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Local</maml:name> <maml:description> <maml:para>TODO: This flag is NOT currently supported.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type name of the auth provider (e.g. userpass).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MountName</maml:name> <maml:description> <maml:para>Mount point for the auth provider. This defaults to the type of the mount. This will make the auth provider available at /auth/[path].</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human-friendly description of the purpose of the auth provider. This shows up in the Get-AuthMounts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Config --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Config</maml:name> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Local --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Local</maml:name> <maml:description> <maml:para>TODO: This flag is NOT currently supported.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-AuthToken --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-AuthToken</command:name> <command:verb>Get</command:verb> <command:noun>AuthToken</command:noun> <maml:description> <maml:para>Retrieves information about tokens.</maml:para> <maml:para>Comparable to the vault CLI token-lookup command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can use this command to retrieve a list of tokens, or to get information about specific tokens, either by their ID (token value) or the associated token 'accessor'.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>Get-AuthToken</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to lookup.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Accessor --> <command:syntaxItem> <maml:name>Get-AuthToken</maml:name> <!-- Parameter: Accessor --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Accessor</maml:name> <maml:description> <maml:para>The accessor of a token to lookup.</maml:para> <maml:para>Note that the response will not contain the token ID. Accessor is only meant for looking up the token properties.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Self --> <command:syntaxItem> <maml:name>Get-AuthToken</maml:name> <!-- Parameter: Self --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Self</maml:name> <maml:description> <maml:para>Indicates to do a lookup of the currently authenticated token (lookup-self).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: List --> <command:syntaxItem> <maml:name>Get-AuthToken</maml:name> <!-- Parameter: ListAccessors --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ListAccessors</maml:name> <maml:description> <maml:para>Lists the accessors of existing tokens.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to lookup.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Accessor --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Accessor</maml:name> <maml:description> <maml:para>The accessor of a token to lookup.</maml:para> <maml:para>Note that the response will not contain the token ID. Accessor is only meant for looking up the token properties.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Self --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Self</maml:name> <maml:description> <maml:para>Indicates to do a lookup of the currently authenticated token (lookup-self).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ListAccessors --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ListAccessors</maml:name> <maml:description> <maml:para>Lists the accessors of existing tokens.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: New-AuthToken --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-AuthToken</command:name> <command:verb>New</command:verb> <command:noun>AuthToken</command:noun> <maml:description> <maml:para>Create a new auth token.</maml:para> <maml:para>Comparable to the vault CLI 'token-create' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command creates a new token that can be used for authentication. This token will be created as a child of your token.The created token will inherit your policies, or can be assigned a subset of your policies.</maml:para> <maml:para>A lease can also be associated with the token.If a lease is not associated with the token, then it cannot be renewed.If a lease is associated with the token, it will expire after that amount of time unless it is renewed.</maml:para> <maml:para>Metadata associated with the token(specified with "-metadata") is written to the audit log when the token is used.</maml:para> <maml:para>If a role is specified, the role may override parameters specified here.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Wrap --> <command:syntaxItem> <maml:name>New-AuthToken</maml:name> <!-- Parameter: WrapTtl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WrapTtl</maml:name> <maml:description> <maml:para>Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.</maml:para> <maml:para>This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.</maml:para> <maml:para>The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>A display name to associate with this token.</maml:para> <maml:para>This is a non-security sensitive value used to help identify created secrets, i.e.prefixes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The token value that clients will use to authenticate with Vault.</maml:para> <maml:para>If not provided this defaults to a 36 character UUID. A root token is required to specify the ID of a token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialTtl</maml:name> <maml:description> <maml:para>Initial TTL to associate with the token; renewals can extend this value.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxTtl</maml:name> <maml:description> <maml:para>An explicit maximum lifetime for the token. Unlike normal token TTLs, which can be renewed up until the maximum TTL set on the auth/token mount or the system configuration file, this lifetime is a hard limit set on the token itself and cannot be exceeded.</maml:para> <maml:para>This corresponds to the 'explicit-max-ttl' vault CLI parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata to associate with the token.</maml:para> <maml:para>This shows up in the audit log.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoDefaultPolicy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoDefaultPolicy</maml:name> <maml:description> <maml:para>If specified, the token will not have the "default" policy included in its policy set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Orphan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Orphan</maml:name> <maml:description> <maml:para>If specified, the token will have no parent.</maml:para> <maml:para>This prevents the new token from being revoked with your token. Requires a root/sudo token to use.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>One ore more policies to associate with this token.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Renewable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Renewable</maml:name> <maml:description> <maml:para>Whether or not the token is renewable to extend its TTL up to Vault's configured maximum TTL for tokens.</maml:para> <maml:para>This defaults to true; set to false to disable renewal of this token.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: RenewalPeriod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RenewalPeriod</maml:name> <maml:description> <maml:para>TOOD: THIS PARAMETER IS CURRENTLY NOT SUPPORTED!</maml:para> <maml:para>If specified, the token will be periodic; it will have no maximum TTL (unless a MaxTtl is also set) but every renewal will use the given period. Requires a root/sudo token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>If set, the token will be created against the named role.</maml:para> <maml:para>The role may override other parameters. This requires the client to have permissions on the appropriate endpoint (auth/token/create/[name]).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseLimit</maml:name> <maml:description> <maml:para>The number of times this token can be used until it is automatically revoked.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The token value that clients will use to authenticate with Vault.</maml:para> <maml:para>If not provided this defaults to a 36 character UUID. A root token is required to specify the ID of a token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>A display name to associate with this token.</maml:para> <maml:para>This is a non-security sensitive value used to help identify created secrets, i.e.prefixes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialTtl</maml:name> <maml:description> <maml:para>Initial TTL to associate with the token; renewals can extend this value.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxTtl</maml:name> <maml:description> <maml:para>An explicit maximum lifetime for the token. Unlike normal token TTLs, which can be renewed up until the maximum TTL set on the auth/token mount or the system configuration file, this lifetime is a hard limit set on the token itself and cannot be exceeded.</maml:para> <maml:para>This corresponds to the 'explicit-max-ttl' vault CLI parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RenewalPeriod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RenewalPeriod</maml:name> <maml:description> <maml:para>TOOD: THIS PARAMETER IS CURRENTLY NOT SUPPORTED!</maml:para> <maml:para>If specified, the token will be periodic; it will have no maximum TTL (unless a MaxTtl is also set) but every renewal will use the given period. Requires a root/sudo token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Renewable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Renewable</maml:name> <maml:description> <maml:para>Whether or not the token is renewable to extend its TTL up to Vault's configured maximum TTL for tokens.</maml:para> <maml:para>This defaults to true; set to false to disable renewal of this token.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata to associate with the token.</maml:para> <maml:para>This shows up in the audit log.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Orphan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Orphan</maml:name> <maml:description> <maml:para>If specified, the token will have no parent.</maml:para> <maml:para>This prevents the new token from being revoked with your token. Requires a root/sudo token to use.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoDefaultPolicy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoDefaultPolicy</maml:name> <maml:description> <maml:para>If specified, the token will not have the "default" policy included in its policy set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>One ore more policies to associate with this token.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseLimit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseLimit</maml:name> <maml:description> <maml:para>The number of times this token can be used until it is automatically revoked.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>If set, the token will be created against the named role.</maml:para> <maml:para>The role may override other parameters. This requires the client to have permissions on the appropriate endpoint (auth/token/create/[name]).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WrapTtl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WrapTtl</maml:name> <maml:description> <maml:para>Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.</maml:para> <maml:para>This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.</maml:para> <maml:para>The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: AuthorizationInfo --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.AuthorizationInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: WrapInfo --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.WrapInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Revoke-AuthToken --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Revoke-AuthToken</command:name> <command:verb>Revoke</command:verb> <command:noun>AuthToken</command:noun> <maml:description> <maml:para>Revoke one or more auth tokens.</maml:para> <maml:para>Comparable to the vault CLI 'token-revoke' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command revokes auth tokens.</maml:para> <maml:para>The related command 'Revoke-VltSecret' is used to revoke secrets.</maml:para> <maml:para>By default a token is revoked along with all of its children.</maml:para> <maml:para>With the '-OrphanChildren' switch parameter, only the token will be revoked and all of its children will be orphaned.</maml:para> <maml:para>With the '-PathPrefix' parameter, tokens created from the given auth path prefix will be deleted, along with all their children. The path cannot specify token values or parts of token values.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>Revoke-AuthToken</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to revoke.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OrphanChildren --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrphanChildren</maml:name> <maml:description> <maml:para>This switch parameter indicates only the specific token will be revoked and all of its children will be orphaned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Accessor --> <command:syntaxItem> <maml:name>Revoke-AuthToken</maml:name> <!-- Parameter: Accessor --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Accessor</maml:name> <maml:description> <maml:para>The accessor of the token to revoke.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Self --> <command:syntaxItem> <maml:name>Revoke-AuthToken</maml:name> <!-- Parameter: Self --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Self</maml:name> <maml:description> <maml:para>This switch parameter indicates the token of the currently authenticated caller should be revoked.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PathPrefix --> <command:syntaxItem> <maml:name>Revoke-AuthToken</maml:name> <!-- Parameter: PathPrefix --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PathPrefix</maml:name> <maml:description> <maml:para>Tokens created from the given auth path prefix will be revoked along with all their children.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to revoke.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Accessor --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Accessor</maml:name> <maml:description> <maml:para>The accessor of the token to revoke.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Self --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Self</maml:name> <maml:description> <maml:para>This switch parameter indicates the token of the currently authenticated caller should be revoked.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PathPrefix --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PathPrefix</maml:name> <maml:description> <maml:para>Tokens created from the given auth path prefix will be revoked along with all their children.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OrphanChildren --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrphanChildren</maml:name> <maml:description> <maml:para>This switch parameter indicates only the specific token will be revoked and all of its children will be orphaned.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Revoke-VltSecret</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Update-AuthToken --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-AuthToken</command:name> <command:verb>Update</command:verb> <command:noun>AuthToken</command:noun> <maml:description> <maml:para>Renew an auth token, extending the amount of time it can be used.</maml:para> <maml:para>Comparable to the vault CLI 'token-renew' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can either specify a specific token ID or indicate to target auth token of the client caller.</maml:para> <maml:para>This command is similar to the command 'Update-VltSecretLease' which is used for renewing secret leases.</maml:para> <maml:para>An optional increment can be given to request a certain number of seconds to increment the lease. This request is advisory; Vault may not adhere to it at all.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>Update-AuthToken</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to be renewed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Increment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Increment</maml:name> <maml:description> <maml:para>The desired increment for the renewal.</maml:para> <maml:para>If not supplied, Vault will use the default TTL. If supplied, it may still be ignored. This can be submitted as an integer number of seconds or a string duration (e.g. "72h").</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Self --> <command:syntaxItem> <maml:name>Update-AuthToken</maml:name> <!-- Parameter: Self --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Self</maml:name> <maml:description> <maml:para>Specify this switch parameter to indicate the token used by the client caller.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Increment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Increment</maml:name> <maml:description> <maml:para>The desired increment for the renewal.</maml:para> <maml:para>If not supplied, Vault will use the default TTL. If supplied, it may still be ignored. This can be submitted as an integer number of seconds or a string duration (e.g. "72h").</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to be renewed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Self --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Self</maml:name> <maml:description> <maml:para>Specify this switch parameter to indicate the token used by the client caller.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Increment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Increment</maml:name> <maml:description> <maml:para>The desired increment for the renewal.</maml:para> <maml:para>If not supplied, Vault will use the default TTL. If supplied, it may still be ignored. This can be submitted as an integer number of seconds or a string duration (e.g. "72h").</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Update-VltSecretLease</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Read-Data --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Read-Data</command:name> <command:verb>Read</command:verb> <command:noun>Data</command:noun> <maml:description> <maml:para>Read data from Vault.</maml:para> <maml:para>Comparable to the vault CLI 'read' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reads data at the given path from Vault. This can be used to read secrets and configuration as well as generate dynamic values from materialized secret providers. Please reference the documentation for the providers in use to determine key structure.</maml:para> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Read-Data</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to read data from.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Wrap --> <command:syntaxItem> <maml:name>Read-Data</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to read data from.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WrapTtl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WrapTtl</maml:name> <maml:description> <maml:para>Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.</maml:para> <maml:para>This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.</maml:para> <maml:para>The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Unwrap --> <command:syntaxItem> <maml:name>Read-Data</maml:name> <!-- Parameter: UnwrapToken --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UnwrapToken</maml:name> <maml:description> <maml:para>One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to read data from.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WrapTtl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WrapTtl</maml:name> <maml:description> <maml:para>Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.</maml:para> <maml:para>This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.</maml:para> <maml:para>The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UnwrapToken --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UnwrapToken</maml:name> <maml:description> <maml:para>One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more paths to read data from.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Dictionary`2 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: WrapInfo --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.WrapInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-Data --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-Data</command:name> <command:verb>Remove</command:verb> <command:noun>Data</command:noun> <maml:description> <maml:para>Delete data (secrets or configuration) from Vault.</maml:para> <maml:para>Comparable to the vault CLI 'delete' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete sends a delete operation request to the given path.</maml:para> <maml:para>The behavior of the delete is determined by the backend at the given path. For example, deleting "aws/policy/ops" will delete the "ops" policy for the AWS backend.</maml:para> <maml:para>Use 'Get-VltPathHelp' for more details on whether delete is supported for a path and what the behavior is.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-Data</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One ore more paths to delete data from.</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One ore more paths to delete data from.</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One ore more paths to delete data from.</maml:para> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Write-Data --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Write-Data</command:name> <command:verb>Write</command:verb> <command:noun>Data</command:noun> <maml:description> <maml:para>Write data (secrets or configuration) into Vault to a backend provider logically mounted at a specified path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>There are 3 different Parameter Sets corresponding to 3 typical usages of this cmdlet.</maml:para> <maml:para>In the first (default) usage, a single vault path is specified and one or more key-value pairs are provided. The Keys are all provided as an array, and the values are all provided as an array, and the length of these two arrays must be equal. Additionally, the Keys and Values can be provided from the pipeline using objects with the corresponding property names.</maml:para> <maml:para>In the second and third usages, either a single map of key-values is provided or no values are provided at all using the -NoValues switch (some vault backends support writing no value to trigger an action or behavior). Multiple vault paths are specified into which all will receive the same set of data values. Tha Paths can be provided from the pipeline.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Write-Data</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to which to write one or more key-value pairs of secrets. This parameter set allows you to write multiple key-values to a single path.</maml:para> <maml:para>The behavior of the write is determined by the secret provider mounted at the given path. For example, writing to "aws/policy/ops" will create an "ops" IAM policy for the AWS secret provider (configuration), but writing to "consul/foo" will write ta value directly into Consul at that key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Name"> <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies one or more keys to set a value for.</maml:para> <maml:para>The count of corresponding values specified with the Value parameter must match the count of keys.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies one or more secret values to set for the corresponding keys.</maml:para> <maml:para>The count of corresponding keys specified with the Key parameter must match the count of values.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DataMap --> <command:syntaxItem> <maml:name>Write-Data</maml:name> <!-- Parameter: Paths --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Paths</maml:name> <maml:description> <maml:para>The paths to which to write one ore more key-value pairs. This parameter set allows you to write to multiple paths simultaneously.</maml:para> <maml:para>The behavior of the write is determined by the secret provider mounted at the given path. For example, writing to "aws/policy/ops" will create an "ops" IAM policy for the AWS secret provider (configuration), but writing to "consul/foo" will write ta value directly into Consul at that key.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Data</maml:name> <maml:description> <maml:para>A map of key-value pairs to write to the target path or paths.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: NoValues --> <command:syntaxItem> <maml:name>Write-Data</maml:name> <!-- Parameter: Paths --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Paths</maml:name> <maml:description> <maml:para>The paths to which to write one ore more key-value pairs. This parameter set allows you to write to multiple paths simultaneously.</maml:para> <maml:para>The behavior of the write is determined by the secret provider mounted at the given path. For example, writing to "aws/policy/ops" will create an "ops" IAM policy for the AWS secret provider (configuration), but writing to "consul/foo" will write ta value directly into Consul at that key.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoValues --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NoValues</maml:name> <maml:description> <maml:para>Forces the write to without any data values specified. This allows writing to keys that do not need or expect any fields to be specified.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to which to write one or more key-value pairs of secrets. This parameter set allows you to write multiple key-values to a single path.</maml:para> <maml:para>The behavior of the write is determined by the secret provider mounted at the given path. For example, writing to "aws/policy/ops" will create an "ops" IAM policy for the AWS secret provider (configuration), but writing to "consul/foo" will write ta value directly into Consul at that key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Name"> <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies one or more keys to set a value for.</maml:para> <maml:para>The count of corresponding values specified with the Value parameter must match the count of keys.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more keys to set a value for.</maml:para> <maml:para>The count of corresponding values specified with the Value parameter must match the count of keys.</maml:para> <maml:para>This is an alias of the Key parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies one or more secret values to set for the corresponding keys.</maml:para> <maml:para>The count of corresponding keys specified with the Key parameter must match the count of values.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Paths --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Paths</maml:name> <maml:description> <maml:para>The paths to which to write one ore more key-value pairs. This parameter set allows you to write to multiple paths simultaneously.</maml:para> <maml:para>The behavior of the write is determined by the secret provider mounted at the given path. For example, writing to "aws/policy/ops" will create an "ops" IAM policy for the AWS secret provider (configuration), but writing to "consul/foo" will write ta value directly into Consul at that key.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Data</maml:name> <maml:description> <maml:para>A map of key-value pairs to write to the target path or paths.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoValues --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NoValues</maml:name> <maml:description> <maml:para>Forces the write to without any data values specified. This allows writing to keys that do not need or expect any fields to be specified.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more keys to set a value for.</maml:para> <maml:para>The count of corresponding values specified with the Value parameter must match the count of keys.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more secret values to set for the corresponding keys.</maml:para> <maml:para>The count of corresponding keys specified with the Key parameter must match the count of values.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The paths to which to write one ore more key-value pairs. This parameter set allows you to write to multiple paths simultaneously.</maml:para> <maml:para>The behavior of the write is determined by the secret provider mounted at the given path. For example, writing to "aws/policy/ops" will create an "ops" IAM policy for the AWS secret provider (configuration), but writing to "consul/foo" will write ta value directly into Consul at that key.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Secret`1 --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.Secret`1[[System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-DataList --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-DataList</command:name> <command:verb>Get</command:verb> <command:noun>DataList</command:noun> <maml:description> <maml:para>List data from Vault.</maml:para> <maml:para>Comparable to the vault CLI list command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a listing of available data. The data returned, if any, is provider- and endpoint-specific.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-DataList</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths for which to list data.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Wrap --> <command:syntaxItem> <maml:name>Get-DataList</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths for which to list data.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WrapTtl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WrapTtl</maml:name> <maml:description> <maml:para>Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.</maml:para> <maml:para>This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.</maml:para> <maml:para>The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Unwrap --> <command:syntaxItem> <maml:name>Get-DataList</maml:name> <!-- Parameter: UnwrapToken --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UnwrapToken</maml:name> <maml:description> <maml:para>One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths for which to list data.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WrapTtl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WrapTtl</maml:name> <maml:description> <maml:para>Indicates that the response should be wrapped in a cubbyhole token with the requested TTL.</maml:para> <maml:para>This is a numeric string with an optional suffix "s", "m", or "h"; if no suffix is specified it will be parsed as seconds.</maml:para> <maml:para>The unwrapped response can be fetched by calling the command again but providing the wrapped token ID to the UnwrapToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UnwrapToken --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UnwrapToken</maml:name> <maml:description> <maml:para>One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more paths for which to list data.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One ore more token ID representing wrapped data returned by a prior call of this command with the WrappTtl parameter set.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ListInfo --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.Secret.Models.ListInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: WrapInfo --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.WrapInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Initialize-Instance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Initialize-Instance</command:name> <command:verb>Initialize</command:verb> <command:noun>Instance</command:noun> <maml:description> <maml:para>Initialize a new Vault server.</maml:para> <maml:para>Comparable to the vault CLI init command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command connects to a Vault server and initializes it for the first time. This sets up the initial set of master keys and the backend data store structure.</maml:para> <maml:para>This command can't be called on an already-initialized Vault server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Initialize-Instance</maml:name> <!-- Parameter: KeyShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyShares</maml:name> <maml:description> <maml:para>The number of key shares to split the master key into.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: KeyThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>KeyThreshold</maml:name> <maml:description> <maml:para>The number of key shares required to reconstruct the master key.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: KeyShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyShares</maml:name> <maml:description> <maml:para>The number of key shares to split the master key into.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: KeyThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>KeyThreshold</maml:name> <maml:description> <maml:para>The number of key shares required to reconstruct the master key.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Test-Instance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-Instance</command:name> <command:verb>Test</command:verb> <command:noun>Instance</command:noun> <maml:description> <maml:para>Gets the initialization status of Vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is an unauthenticated call and does not use a vault auth token.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-Instance</maml:name> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-KeyStatus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-KeyStatus</command:name> <command:verb>Get</command:verb> <command:noun>KeyStatus</command:noun> <maml:description> <maml:para>Provides information about the active encryption key. Specifically, the current key term and the key installation time.</maml:para> <maml:para>Comparable to the vault CLI key-status command.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-KeyStatus</maml:name> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: EncryptionKeyStatus --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.EncryptionKeyStatus</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-PathHelp --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PathHelp</command:name> <command:verb>Get</command:verb> <command:noun>PathHelp</command:noun> <maml:description> <maml:para>Look up the help for a path.</maml:para> <maml:para>Comparable to the vault CLI path-help command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>All endpoints in Vault from system paths, secret paths, and credential providers provide built-in help. This command looks up and outputs that help.</maml:para> <maml:para>The command requires that the vault be unsealed, because otherwise the mount points of the backends are unknown.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PathHelp</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to get help for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to get help for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more paths to get help for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PathHelp --> <command:returnValue> <dev:type> <maml:name>Zyborg.Vault.POSH.Model.PathHelp</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Captures help content for a given Vault path.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Policy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Policy</command:name> <command:verb>Get</command:verb> <command:noun>Policy</command:noun> <maml:description> <maml:para>List the policies that are available or read a single policy.</maml:para> <maml:para>Comparable to the vault CLI policies command. This command lists the policies that are written to the Vault server. If a name of a policy is specified, that policy is outputted.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ForName --> <command:syntaxItem> <maml:name>Get-Policy</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of one or more policies to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of one or more policies to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of one or more policies to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IEnumerable`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: Policy --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.Policy</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-Policy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-Policy</command:name> <command:verb>Remove</command:verb> <command:noun>Policy</command:noun> <maml:description> <maml:para>Delete a policy with the given name.</maml:para> <maml:para>Comparable to the vault CLI 'policy-delete' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Once the policy is deleted, all users associated with the policy will be affected immediately. When a user is associated with a policy that doesn't exist, it is identical to not being associated with that policy.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-Policy</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>One or policie names to delete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>One or policie names to delete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or policie names to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-Policy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-Policy</command:name> <command:verb>Set</command:verb> <command:noun>Policy</command:noun> <maml:description> <maml:para>Create or update a policy with the given rules.</maml:para> <maml:para>Comparable to the vault CLI 'policy-write' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If updating an existing policy, the entire contents of the existing policy rules definitions will be replaced.</maml:para> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-Policy</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the policy to create or update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rules --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Rules</maml:name> <maml:description> <maml:para>The rules content to write to the policy definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the policy to create or update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rules --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Rules</maml:name> <maml:description> <maml:para>The rules content to write to the policy definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the policy to create or update.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The rules content to write to the policy definition.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Secret`1 --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.Secret`1[[System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Profile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Profile</command:name> <command:verb>Get</command:verb> <command:noun>Profile</command:noun> <maml:description> <maml:para>Retrieves the list of Vault connection profiles defined for the current user/ or the details of a specific Vault connection profile.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: GetDetails --> <command:syntaxItem> <maml:name>Get-Profile</maml:name> <!-- Parameter: VaultProfile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>The name of one or more profiles for which to return the details.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-Profile</maml:name> <!-- Parameter: ShowLabels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowLabels</maml:name> <maml:description> <maml:para>If this switch is specified, labels will be included in the result list.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: VaultProfile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>The name of one or more profiles for which to return the details.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ShowLabels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowLabels</maml:name> <maml:description> <maml:para>If this switch is specified, labels will be included in the result list.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of one or more profiles for which to return the details.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-Profile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-Profile</command:name> <command:verb>Set</command:verb> <command:noun>Profile</command:noun> <maml:description> <maml:para>Defines or updates a Vault connection profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A connection profile is a named and persisted collection of Vault connection attributes, which may include the Vault endpoint URL address and a Vault authentication token.</maml:para> <maml:para>Most of the Vault commands (all the ones that interact directly with the Vault server) take an optional parameter '-VaultProfile' (or the alias '-vp') to reference a named profile for the current user. Additionally, any attributes defined in the profile may be individually overridden when being called upon.</maml:para> <maml:para>Beside explicitily defining a profile with this command, you can also save a profile as the result of a new authentication via the 'New-VltAuth' command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Set-Profile</maml:name> <!-- Parameter: SaveAs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>Specifies the name under which to save the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specify the Vault endpoint URL address to include in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specify the Vault authentication token to include in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Label</maml:name> <maml:description> <maml:para>Provides an optional human-friendly descriptive name to the profile for quick and easy recognition upon inspection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>This switch parameter must be specified whenever referencing a profile name that already exists. Without it, en error will be raised.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Reference an existing profile whose attributes will be copied over unless overridden by other parameters.</maml:para> <maml:para>If no overrides are specified, this will create a copy of the existing profile being referenced.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Remove --> <command:syntaxItem> <maml:name>Set-Profile</maml:name> <!-- Parameter: SaveAs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>Specifies the name under which to save the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>This switch parameter is used to remove an existing profile.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SaveAs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>Specifies the name under which to save the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specify the Vault endpoint URL address to include in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specify the Vault endpoint URL address to include in the profile.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specify the Vault authentication token to include in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specify the Vault authentication token to include in the profile.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Label</maml:name> <maml:description> <maml:para>Provides an optional human-friendly descriptive name to the profile for quick and easy recognition upon inspection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Reference an existing profile whose attributes will be copied over unless overridden by other parameters.</maml:para> <maml:para>If no overrides are specified, this will create a copy of the existing profile being referenced.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Reference an existing profile whose attributes will be copied over unless overridden by other parameters.</maml:para> <maml:para>If no overrides are specified, this will create a copy of the existing profile being referenced.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>This switch parameter must be specified whenever referencing a profile name that already exists. Without it, en error will be raised.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>This switch parameter is used to remove an existing profile.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VltProfile</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VltAuth</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Revoke-Secret --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Revoke-Secret</command:name> <command:verb>Revoke</command:verb> <command:noun>Secret</command:noun> <maml:description> <maml:para>Revoke a secret by its lease ID.</maml:para> <maml:para>Comparable to the vault CLI 'revoke' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command revokes a secret by its lease ID that was returned with it. Once the key is revoked, it is no longer valid.</maml:para> <maml:para>The related command 'Revoke-VltAuthToken' is used to revoke auth tokens.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>Revoke-Secret</maml:name> <!-- Parameter: LeaseId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LeaseId</maml:name> <maml:description> <maml:para>The lease ID of a secret to be revoked.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PathPrefix --> <command:syntaxItem> <maml:name>Revoke-Secret</maml:name> <!-- Parameter: PathPrefix --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PathPrefix</maml:name> <maml:description> <maml:para>Revoke all secrets with the matching prefix.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Delete the lease even if the actual revocation operation fails.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LeaseId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LeaseId</maml:name> <maml:description> <maml:para>The lease ID of a secret to be revoked.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PathPrefix --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PathPrefix</maml:name> <maml:description> <maml:para>Revoke all secrets with the matching prefix.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Delete the lease even if the actual revocation operation fails.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Revoke-VltSecret</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Update-SecretLease --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-SecretLease</command:name> <command:verb>Update</command:verb> <command:noun>SecretLease</command:noun> <maml:description> <maml:para>Renew the lease on a secret, extending the time that it can be used before it is revoked by Vault.</maml:para> <maml:para>Comparable to the vault CLI 'renew' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Every secret in Vault has a lease associated with it. If the user of the secret wants to use it longer than the lease, then it must be renewed. Renewing the lease will not change the contents of the secret.</maml:para> <maml:para>To renew a secret, run this command with the lease ID returned when it was read. Optionally, request a specific increment in seconds. Vault is not required to honor this request.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-SecretLease</maml:name> <!-- Parameter: LeaseId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LeaseId</maml:name> <maml:description> <maml:para>The secret lease ID to renew.</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Increment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Increment</maml:name> <maml:description> <maml:para>The desired increment for the renewal.</maml:para> <maml:para>If not supplied, Vault will use the default TTL. If supplied, it may still be ignored. This can be submitted as an integer number of seconds or a string duration (e.g. "72h").</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LeaseId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LeaseId</maml:name> <maml:description> <maml:para>The secret lease ID to renew.</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Increment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Increment</maml:name> <maml:description> <maml:para>The desired increment for the renewal.</maml:para> <maml:para>If not supplied, Vault will use the default TTL. If supplied, it may still be ignored. This can be submitted as an integer number of seconds or a string duration (e.g. "72h").</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Dictionary`2 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Update-VltAuthToken</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-SecretMountOptions --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SecretMountOptions</command:name> <command:verb>Set</command:verb> <command:noun>SecretMountOptions</command:noun> <maml:description> <maml:para>Tune configuration options for a mounted secret provider.</maml:para> <maml:para>Comparable to the vault CLI 'mount-tune' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-SecretMountOptions</maml:name> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The name of the mount point to adjust configuration options for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultLeaseTtl</maml:name> <maml:description> <maml:para>Default lease time-to-live for this backend.</maml:para> <maml:para>If not specified, uses the system default, or the previously set value. Set to 'system' to explicitly set it to use the system default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxLeaseTtl</maml:name> <maml:description> <maml:para>Max lease time-to-live for this backend.</maml:para> <maml:para>If not specified, uses the system default, or the previously set value. Set to 'system' to explicitly set it to use the system default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>The name of the mount point to adjust configuration options for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultLeaseTtl</maml:name> <maml:description> <maml:para>Default lease time-to-live for this backend.</maml:para> <maml:para>If not specified, uses the system default, or the previously set value. Set to 'system' to explicitly set it to use the system default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxLeaseTtl</maml:name> <maml:description> <maml:para>Max lease time-to-live for this backend.</maml:para> <maml:para>If not specified, uses the system default, or the previously set value. Set to 'system' to explicitly set it to use the system default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>## Set-VltSecretMountOptions -DefaultLeaseTtl 24h secret</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SecretMounts --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SecretMounts</command:name> <command:verb>Get</command:verb> <command:noun>SecretMounts</command:noun> <maml:description> <maml:para>Outputs information about the mounted secret providers.</maml:para> <maml:para>Comparable to the vault CLI mounts command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command lists the mounted secret providers, their mount points, the configured TTLs, and a human-friendly description of the mount point.</maml:para> <maml:para>A TTL of 'system' indicates that the system default is being used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SecretMounts</maml:name> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: KeepSecretWrapper --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepSecretWrapper</maml:name> <maml:description> <maml:para>When specified, the returned result maintains the meta data wrapper for the secret result.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SecretBackend --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.Secret.Models.SecretBackend</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Dismount-SecretProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Dismount-SecretProvider</command:name> <command:verb>Dismount</command:verb> <command:noun>SecretProvider</command:noun> <maml:description> <maml:para>Disable an already-enabled auth provider.</maml:para> <maml:para>Comparable to the vault CLI auth-disable command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Once the auth provider is disabled its path can no longer be used to authenticate.</maml:para> <maml:para>All access tokens generated via the disabled auth provider will be revoked.This command will block until all tokens are revoked. If the command is exited early the tokens will still be revoked.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Dismount-SecretProvider</maml:name> <!-- Parameter: MountName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>One or more paths at which auth providers are mounted. If an auth provider is mounted at multiple paths, each representing a different instance (with different configuration), this identifies the specific instance to disable.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MountName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>MountName</maml:name> <maml:description> <maml:para>One or more paths at which auth providers are mounted. If an auth provider is mounted at multiple paths, each representing a different instance (with different configuration), this identifies the specific instance to disable.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more paths at which auth providers are mounted. If an auth provider is mounted at multiple paths, each representing a different instance (with different configuration), this identifies the specific instance to disable.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Mount-SecretProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Mount-SecretProvider</command:name> <command:verb>Mount</command:verb> <command:noun>SecretProvider</command:noun> <maml:description> <maml:para>Mount a logical secrets provider.</maml:para> <maml:para>Comparable to the vault CLI mount and remount commands.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command mounts (or remounts) a logical backend for storing and/or generating secrets.</maml:para> <maml:para>When remounting, all the secrets from the old path will be revoked, but the data associated with the backend(such as configuration), will be preserved.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Mount-SecretProvider</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The name of the secrets provider to mount (e.g. generic).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MountName</maml:name> <maml:description> <maml:para>Mount point for the logical secrets provider.</maml:para> <maml:para>If not specified, this defaults to the name of the type of the mount provider.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human-friendly description of the purpose for the mount. This shows up in the list of mounts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultLeaseTtl</maml:name> <maml:description> <maml:para>Default lease time-to-live for this backend. If not specified, uses the global default, or the previously set value. Set to '0' to explicitly set it to use the global default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxLeaseTtl</maml:name> <maml:description> <maml:para>Max lease time-to-live for this provider mount. If not specified, uses the global default, or the previously set value. Set to '0' to explicitly set it to use the global default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Remount --> <command:syntaxItem> <maml:name>Mount-SecretProvider</maml:name> <!-- Parameter: NewMountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NewMountName</maml:name> <maml:description> <maml:para>The new name to move an existing secrets provider mount.</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldMountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OldMountName</maml:name> <maml:description> <maml:para>The name that identifies an existing mount point of a secrets provider to be relocated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The name of the secrets provider to mount (e.g. generic).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MountName</maml:name> <maml:description> <maml:para>Mount point for the logical secrets provider.</maml:para> <maml:para>If not specified, this defaults to the name of the type of the mount provider.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human-friendly description of the purpose for the mount. This shows up in the list of mounts.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultLeaseTtl</maml:name> <maml:description> <maml:para>Default lease time-to-live for this backend. If not specified, uses the global default, or the previously set value. Set to '0' to explicitly set it to use the global default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxLeaseTtl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxLeaseTtl</maml:name> <maml:description> <maml:para>Max lease time-to-live for this provider mount. If not specified, uses the global default, or the previously set value. Set to '0' to explicitly set it to use the global default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldMountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OldMountName</maml:name> <maml:description> <maml:para>The name that identifies an existing mount point of a secrets provider to be relocated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewMountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NewMountName</maml:name> <maml:description> <maml:para>The new name to move an existing secrets provider mount.</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>This shows an example of remounting an existing mount path.</maml:para> </maml:introduction> <dev:code>## Mount-VltSecretProvider -OldMountName secret -NewMountName generic</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Lock-Server --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Lock-Server</command:name> <command:verb>Lock</command:verb> <command:noun>Server</command:noun> <maml:description> <maml:para>Seal the vault.</maml:para> <maml:para>Comparable to the vault CLI 'seal' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sealing a vault tells the Vault server to stop responding to any access operations until it is unsealed again. A sealed vault throws away its master key to unlock the data, so it is physically blocked from responding to operations again until the vault is unsealed with the "unseal" command or via the API.</maml:para> <maml:para>This command is idempotent, if the vault is already sealed it does nothing.</maml:para> <maml:para>If an unseal has started, sealing the vault will reset the unsealing process. You'll have to re-enter every portion of the master key again.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Lock-Server</maml:name> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SealStatus --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.SealStatus</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unlock-VltServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Unlock-Server --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unlock-Server</command:name> <command:verb>Unlock</command:verb> <command:noun>Server</command:noun> <maml:description> <maml:para>Unseal the vault by entering a portion of the master key.</maml:para> <maml:para>Comparable to the vault CLI 'unseal' command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Once all portions are entered, the vault will be unsealed.</maml:para> <maml:para>Every Vault server initially starts as sealed. It cannot perform any operation except unsealing until it is unsealed. Secrets cannot be accessed in any way until the vault is unsealed. This command allows you to enter a portion of the master key to unseal the vault.</maml:para> <maml:para>In order to abort the unsealing process and discard any prior keys that have already been entered in the process, use the 'Lock-VltServer' command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Unlock-Server</maml:name> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>One or more unseal keys to apply to the unseal process.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>One or more unseal keys to apply to the unseal process.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more unseal keys to apply to the unseal process.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SealStatus --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.SealStatus</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Lock-VltServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Status --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Status</command:name> <command:verb>Get</command:verb> <command:noun>Status</command:noun> <maml:description> <maml:para>Outputs the state of the Vault, sealed or unsealed and if HA is enabled.</maml:para> <maml:para>Comparable to the vault CLI status command.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Status</maml:name> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SealStatus --> <command:returnValue> <dev:type> <maml:name>VaultSharp.Backends.System.Models.SealStatus</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-TokenCapabilities --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-TokenCapabilities</command:name> <command:verb>Get</command:verb> <command:noun>TokenCapabilities</command:noun> <maml:description> <maml:para>Fetch the capabilities of a token on a given path.</maml:para> <maml:para>Comparable to the vault CLI capabilities command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The capabilities can be fetched for a specific token ID, a token accessor or, if neither is provided, for the current user client token.</maml:para> <maml:para>If a token does not have any capability on a given path, or if any of the policies belonging to the token explicitly have["deny"] capability, or if the argument path is invalid, this command will respond with a ["deny"].</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-TokenCapabilities</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to get capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to inquire capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Accessor --> <command:syntaxItem> <maml:name>Get-TokenCapabilities</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to get capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Accessor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Accessor</maml:name> <maml:description> <maml:para>The token accessor to inquire capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to get capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The token ID to inquire capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Accessor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Accessor</maml:name> <maml:description> <maml:para>The token accessor to inquire capabilities for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>VaultSession</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vs"> <maml:name>vs</maml:name> <maml:description> <maml:para>Specifies a Vault Session object that represents a connected-state container to a Vault server.</maml:para> <maml:para>This is an alias of the VaultSession parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>VaultProfile</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vp"> <maml:name>vp</maml:name> <maml:description> <maml:para>Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.</maml:para> <maml:para>Other connection parameters on this command may override whatever attributes are defined in the profile.</maml:para> <maml:para>This is an alias of the VaultProfile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>VaultAddress</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="va"> <maml:name>va</maml:name> <maml:description> <maml:para>Specifies the Vault server connection endpoint URL.</maml:para> <maml:para>This is an alias of the VaultAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VaultToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>VaultToken</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="vt"> <maml:name>vt</maml:name> <maml:description> <maml:para>Specifies the Vault server connection authentication token to identify the caller to the server.</maml:para> <maml:para>This is an alias of the VaultToken parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more paths to get capabilities for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IEnumerable`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |