Public/Get-PWSHYBKPIVVersion.ps1
|
function Get-PWSHYBKPIVVersion { <# .SYNOPSIS Gets the yubico-piv-tool.exe version string. .DESCRIPTION Wraps "yubico-piv-tool.exe --action version". Read-only - does not support -WhatIf since it makes no changes. Accepts the "version" action's config-declared options (-Reader, -ToolVerbose) as dynamic parameters built from Config\Posh-YBKPIV.json. .PARAMETER Reader Name of the smart card reader to target, when more than one is attached. If omitted, yubico-piv-tool.exe uses its own default reader selection. .PARAMETER ToolVerbose Verbosity level (integer) to pass to yubico-piv-tool.exe's own --verbose flag. Named ToolVerbose rather than Verbose to avoid colliding with PowerShell's built-in -Verbose common parameter. .INPUTS None. This cmdlet does not accept pipeline input. .OUTPUTS String[]. yubico-piv-tool.exe's raw version output, one line per array element. .NOTES -Reader and -ToolVerbose are declared dynamically from Config\Posh-YBKPIV.json and therefore do not appear in Get-Help's PARAMETERS/SYNTAX sections. Run `Get-Command Get-PWSHYBKPIVVersion -Syntax` for the authoritative, current parameter list. .EXAMPLE Get-PWSHYBKPIVVersion Returns the yubico-piv-tool.exe version. .LINK https://developers.yubico.com/yubico-piv-tool/Actions/ .LINK Get-PWSHYBKPIVStatus #> [CmdletBinding()] [OutputType([string[]])] param() DynamicParam { $dynamicConfig = Read-PWSHYBKPIVConfigFile Get-PWSHYBKPIVActionParameter -Action 'version' -CmdletWrapping $dynamicConfig.cmdletWrapping } begin { $config = Read-PWSHYBKPIVConfigFile Write-PWSHYBKPIVLog -Config $config -Level Debug -CmdletName $MyInvocation.MyCommand.Name ` -Message 'Cmdlet invoked' -BoundParameters $PSBoundParameters $architecture = Resolve-PWSHYBKPIVArchitecture -Architecture $config.installation.architecture $exePath = Get-PWSHYBKPIVInstallPath -Installation $config.installation -Architecture $architecture if (-not (Test-Path -Path $exePath -PathType Leaf)) { throw "yubico-piv-tool.exe was not found at '$exePath'. Run Install-PWSHYBKPIVTool first." } } end { try { $result = Invoke-PWSHYBKPIVTool -ExePath $exePath -Action 'version' ` -CmdletWrapping $config.cmdletWrapping -BoundParameters $PSBoundParameters Write-PWSHYBKPIVLog -Config $config -Level Information -CmdletName $MyInvocation.MyCommand.Name ` -Message 'Version read successfully' $result.Output } catch { Write-PWSHYBKPIVLog -Config $config -Level Error -CmdletName $MyInvocation.MyCommand.Name -Message "Failed: $_" throw } } } |