Skip to main content

Test-KeldorSecretProvider

SYNOPSIS​

Tests Keldor secret providers.

SYNTAX​

Test-KeldorSecretProvider [[-Name] <String[]>] [-Vault <String>] [-Detailed] [-Quiet]
 [<CommonParameters>]

DESCRIPTION​

Performs safe, read-only operational checks against Keldor secret providers. This differs from Get-KeldorSecretProvider, which reports passive metadata and availability. Test-KeldorSecretProvider never retrieves, creates, modifies, or removes secret values.

EXAMPLES​

EXAMPLE 1​

Test-KeldorSecretProvider

Tests all known Keldor secret providers.

EXAMPLE 2​

Test-KeldorSecretProvider -Name OnePassword

Tests the OnePassword provider.

EXAMPLE 3​

Test-KeldorSecretProvider -Name OnePassword, SecretManagement

Tests multiple providers.

EXAMPLE 4​

Test-KeldorSecretProvider -Name SecretManagement -Vault DevOps

Tests the DevOps SecretManagement vault without enumerating secrets.

EXAMPLE 5​

Test-KeldorSecretProvider -Name OnePassword -Detailed | Format-List *

Shows detailed non-sensitive OnePassword provider check results.

EXAMPLE 6​

if (Test-KeldorSecretProvider -Name OnePassword -Quiet) {
    '1Password is ready.'
}

Uses Boolean output for control flow.

EXAMPLE 7​

'OnePassword', 'Environment' | Test-KeldorSecretProvider

Tests providers from pipeline input.

EXAMPLE 8​

Test-KDSecretProvider -Name SecretManagement

Tests the SecretManagement provider by using the Test-KDSecretProvider alias.

PARAMETERS​

-Name​

Specifies one or more provider names. Auto is provider selection behavior and is not a provider.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Vault​

Specifies a provider vault to validate where the provider supports vaults.

Type: String
Parameter Sets: (All)
Aliases:

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

-Detailed​

Includes individual non-sensitive check results.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Quiet​

Returns only a Boolean value. Returns true only when every requested provider passes all required checks.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters​

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

INPUTS​

OUTPUTS​

Keldor.SecretProviderTestResult. Returns System.Boolean when Quiet is specified.​

NOTES​

Alias: Test-KDSecretProvider

ALIASES​

Test-KDSecretProvider

PLATFORM APPLICABILITY​

Windows, macOS, and Linux.

POWERSHELL COMPATIBILITY​

See PowerShell compatibility for the supported runtime policy. PowerShell 7.6 LTS is preferred.

https://docs.keldor.dev/powershell/keldor/Test-KeldorSecretProvider