Find-VcCertificate¶
SYNOPSIS¶
Find certificates in TLSPC
SYNTAX¶
All (Default)¶
Find-VcCertificate [-Name <String>] [-KeyLength <Int32>] [-Serial <String>] [-Fingerprint <String>]
[-IsSelfSigned] [-Status <String[]>] [-ExpireBefore <DateTime>] [-ExpireAfter <DateTime>] [-Version <String>]
[-SanDns <String>] [-Application <String>] [-Tag <String[]>] [-CN <String>] [-Issuer <String>]
[-Order <PSObject[]>] [-ApplicationDetail] [-OwnerDetail] [-First <Int32>] [-VenafiSession <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Filter¶
Find-VcCertificate -Filter <ArrayList> [-Order <PSObject[]>] [-ApplicationDetail] [-OwnerDetail]
[-First <Int32>] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
SavedSearch¶
Find-VcCertificate -SavedSearchName <String> [-ApplicationDetail] [-OwnerDetail] [-First <Int32>]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Find certificates based on various attributes.
EXAMPLES¶
EXAMPLE 1¶
Find all certificates
EXAMPLE 2¶
Find the first 500 certificates
EXAMPLE 3¶
Find certificates matching all of part of the name
EXAMPLE 4¶
Find certificates matching a single value
EXAMPLE 5¶
Find certificates matching multiple values. In this case, find all certificates expiring in the next 30 days.
EXAMPLE 6¶
Find-VcCertificate -ExpireAfter (get-date) -ExpireBefore (get-date).AddDays(30)| Invoke-VcCertificateAction -Renew
Find all certificates expiring in the next 30 days and renew them
EXAMPLE 7¶
Find via a filter instead of using built-in function properties
EXAMPLE 8¶
Include application details, not just the ID. This will make additional api calls and will increase the response time.
EXAMPLE 9¶
Include user/team owner details, not just the ID. This will make additional api calls and will increase the response time.
PARAMETERS¶
-Name¶
Search for certificates with the name matching part or all of the value
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-KeyLength¶
Search by certificate key length
Type: Int32
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Serial¶
Search by serial number
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fingerprint¶
Search by fingerprint
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsSelfSigned¶
Search for only self signed certificates
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Status¶
Search by one or more certificate statuses. Valid values include ACTIVE, RETIRED, and DELETED.
Type: String[]
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpireBefore¶
Search for certificates expiring before a certain date. Use with -ExpireAfter for a defined start and end.
Type: DateTime
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpireAfter¶
Search for certificates expiring after a certain date. Use with -ExpireBefore for a defined start and end.
Type: DateTime
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Version¶
Search by version type. Valid values include CURRENT and OLD.
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SanDns¶
Search for certificates with SAN DNS matching part or all of the value
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Application¶
Application ID or name that this certificate is associated with
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tag¶
One or more tags associated with the certificate. You can specify either just a tag name or name:value.
Type: String[]
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CN¶
Search for certificates where the subject CN matches all of part of the value
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Issuer¶
Search by issuer name
Type: String
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Filter¶
Array or multidimensional array of fields and values to filter on. Each array should be of the format @(field, comparison operator, value). To combine filters, use the format @('operator', @(field, comparison operator, value), @(field2, comparison operator2, value2)). Nested filters are supported. Field names and values are case sensitive, but VenafiPS will try and convert to the proper case if able.
Available operators are:
Operator | Name | Description and Usage¶
EQ Equal operator The search result is equal to the specified value. Valid for numeric or Boolean fields. FIND Find operator The search result is based on the value of all or part of one or more strings. You can also use Regular Expressions (regex). GT Greater than The search result has a higher numeric value than the specified value. GTE Greater than or equal to The search result is equal or has a higher numeric value than the specified value. IN In clause The search result matches one of the values in an array. LT Less Than The search result has a lower value than the specified value. LTE Less than or equal to The search result is equal or less than the specified value. MATCH Match operator The search result includes a string value from the supplied list. You can also use regex for your search.
For more info comparison operators, see https://docs.venafi.cloud/api/about-api-search-operators/.
Type: ArrayList
Parameter Sets: Filter
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Order¶
1 or more fields to order on. For each item in the array, you can provide a field name by itself; this will default to ascending. You can also provide a hashtable with the field name as the key and either asc or desc as the value.
Type: PSObject[]
Parameter Sets: All, Filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SavedSearchName¶
Find certificates based on a saved search, see https://docs.venafi.cloud/vaas/certificates/saving-certificate-filters
Type: String
Parameter Sets: SavedSearch
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApplicationDetail¶
Retrieve detailed application info. This will cause additional api calls to be made and take longer.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OwnerDetail¶
Retrieve detailed user/team owner info. This will cause additional api calls to be made and take longer.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: IncludeVaasOwner
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-First¶
Only retrieve this many records
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-VenafiSession¶
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPC key can also provided.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
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.