Public/Get-TppAttribute.ps1
|
<#
.SYNOPSIS Get attributes for a given object .DESCRIPTION Retrieves object attributes. You can either retrieve all attributes or individual ones. By default, the attributes returned are not the effective policy, but that can be requested with the EffectivePolicy switch. .PARAMETER InputObject TppObject which represents a unique object .PARAMETER Path Path to the object to retrieve configuration attributes. Just providing DN will return all attributes. .PARAMETER Guid Object Guid. Just providing Guid will return all attributes. .PARAMETER AttributeName Only retrieve the value/values for this attribute .PARAMETER Effective Get the effective values of the attribute .PARAMETER VenafiSession Session object created from New-VenafiSession method. The value defaults to the script session object $VenafiSession. .INPUTS InputObject, Path, Guid .OUTPUTS PSCustomObject with properties Name, Value, IsCustomField, and CustomName .EXAMPLE Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com' Retrieve all configurations for a certificate .EXAMPLE Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com' -EffectivePolicy Retrieve all effective configurations for a certificate .EXAMPLE Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com' -AttributeName 'driver name' Retrieve all the value for attribute driver name from certificate myapp.company.com .LINK http://VenafiPS.readthedocs.io/en/latest/functions/Get-TppAttribute/ .LINK https://github.com/gdbarron/VenafiPS/blob/main/VenafiPS/Public/Get-TppAttribute.ps1 .LINK https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-read.php?tocpath=Web%20SDK%7CConfig%20programming%20interface%7C_____27 .LINK https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-readall.php?tocpath=Web%20SDK%7CConfig%20programming%20interface%7C_____28 .LINK https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-readeffectivepolicy.php?tocpath=Web%20SDK%7CConfig%20programming%20interface%7C_____31 #> function Get-TppAttribute { [CmdletBinding(DefaultParameterSetName = 'ByObject')] param ( [Parameter(Mandatory, ParameterSetName = 'EffectiveByObject', ValueFromPipeline)] [Parameter(Mandatory, ParameterSetName = 'ByObject', ValueFromPipeline)] [TppObject] $InputObject, [Parameter(Mandatory, ParameterSetName = 'EffectiveByPath', ValueFromPipeline)] [Parameter(Mandatory, ParameterSetName = 'ByPath', ValueFromPipeline)] [ValidateNotNullOrEmpty()] [ValidateScript( { if ( $_ | Test-TppDnPath ) { $true } else { throw "'$_' is not a valid DN path" } })] [Alias('DN')] [String[]] $Path, [Parameter(Mandatory, ParameterSetName = 'EffectiveByGuid', ValueFromPipeline)] [Parameter(Mandatory, ParameterSetName = 'ByGuid', ValueFromPipeline)] [ValidateNotNullOrEmpty()] [guid[]] $Guid, [Parameter(Mandatory, ParameterSetName = 'EffectiveByObject')] [Parameter(ParameterSetName = 'ByObject')] [Parameter(Mandatory, ParameterSetName = 'EffectiveByPath')] [Parameter(ParameterSetName = 'ByPath')] [Parameter(Mandatory, ParameterSetName = 'EffectiveByGuid')] [Parameter(ParameterSetName = 'ByGuid')] [ValidateNotNullOrEmpty()] [String[]] $Attribute, [Parameter(Mandatory, ParameterSetName = 'EffectiveByObject')] [Parameter(Mandatory, ParameterSetName = 'EffectiveByPath')] [Parameter(Mandatory, ParameterSetName = 'EffectiveByGuid')] [Alias('EffectivePolicy')] [Switch] $Effective, [Parameter()] [VenafiSession] $VenafiSession = $script:VenafiSession ) begin { $VenafiSession.Validate() | Out-Null if ( $PSBoundParameters.ContainsKey('Attribute') ) { if ( $PSBoundParameters.ContainsKey('Effective') ) { $uriLeaf = 'config/ReadEffectivePolicy' } else { $uriLeaf = 'config/read' } } else { $uriLeaf = 'config/readall' } $baseParams = @{ VenafiSession = $VenafiSession Method = 'Post' UriLeaf = $uriLeaf Body = @{ ObjectDN = '' } } } process { switch -Wildcard ($PSCmdlet.ParameterSetName) { '*Object' { $pathToProcess = $InputObject.Path } '*Path' { $pathToProcess = $Path } '*Guid' { $pathToProcess = $Guid | ConvertTo-TppPath -VenafiSession $VenafiSession } } foreach ($thisPath in $pathToProcess) { $baseParams.Body['ObjectDN'] = $thisPath # if specifying attribute name(s), it's a different rest api if ( $PSBoundParameters.ContainsKey('Attribute') ) { # get the attribute values one by one as there is no # api which allows passing a list $configValues = foreach ($thisAttribute in $Attribute) { $params = $baseParams.Clone() $params.Body += @{ AttributeName = $thisAttribute } $response = Invoke-TppRestMethod @params if ( $response ) { [PSCustomObject] @{ Name = $thisAttribute Value = $response.Values } } } } else { $response = Invoke-TppRestMethod @baseParams if ( $response ) { $configValues = $response.NameValues | Select-Object Name, @{ n = 'Value' e = { $_.Values } } } } if ( $configValues ) { $configValues = @($configValues) # convert custom field guids to names foreach ($thisConfigValue in $configValues) { $customField = $VenafiSession.CustomField | Where-Object {$_.Guid -eq $thisConfigValue.Name} $thisConfigValue | Add-Member @{ 'IsCustomField' = $null -ne $customField 'CustomName' = $null } if ( $customField ) { $thisConfigValue.CustomName = $customField.Label } $thisConfigValue } # [PSCustomObject] @{ # Path = $thisPath # Attribute = $updatedConfigValues # } } } } end { } } |