New-VaasCertificate¶
SYNOPSIS¶
Create certificate request
SYNTAX¶
Ask (Default)¶
New-VaasCertificate -Application <String> -IssuingTemplate <String> -ServerType <String> -CommonName <String>
[-Organization <String>] [-OrganizationalUnit <String[]>] [-City <String>] [-State <String>]
[-Country <String>] [-SanDns <String[]>] [-SanIP <String[]>] [-SanUri <String[]>] [-SanEmail <String[]>]
[-ValidUntil <DateTime>] [-PassThru] [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
Csr¶
New-VaasCertificate -Application <String> -IssuingTemplate <String> -ServerType <String> -Csr <String>
[-SanDns <String[]>] [-SanIP <String[]>] [-SanUri <String[]>] [-SanEmail <String[]>] [-ValidUntil <DateTime>]
[-PassThru] [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Create certificate request from automated secure keypair details or CSR
EXAMPLES¶
EXAMPLE 1¶
New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com'
Create certificate
EXAMPLE 2¶
New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' -SanIP '1.2.3.4'
Create certificate with optional SAN data
EXAMPLE 3¶
New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' -ValidUntil (Get-Date).AddMonths(6)
Create certificate with specific validity
EXAMPLE 4¶
New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -CommonName 'app.mycert.com' -PassThru
Create certificate and return the created object
EXAMPLE 5¶
New-VaasCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -ServerType 'F5' -Csr "-----BEGIN CERTIFICATE REQUEST-----\nMIICYzCCAUsCAQAwHj....BoiNIqtVQxFsfT+\n-----END CERTIFICATE REQUEST-----\n"
Create certificate with a CSR
PARAMETERS¶
-Application¶
Application name (wildcards supported) or id to associate this certificate.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IssuingTemplate¶
Issuing template name (wildcards supported) or id to use. The template must be available with the selected Application.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerType¶
Server type name (wildcards supported) or id to associate
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Csr¶
CSR in PKCS#10 format which conforms to the rules of the issuing template
Type: String
Parameter Sets: Csr
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CommonName¶
Common name (CN)
Type: String
Parameter Sets: Ask
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Organization¶
The Organization field for the certificate Subject DN
Type: String
Parameter Sets: Ask
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrganizationalUnit¶
One or more departments or divisions within the organization that is responsible for maintaining the certificate
Type: String[]
Parameter Sets: Ask
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-City¶
The City/Locality field for the certificate Subject DN
Type: String
Parameter Sets: Ask
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-State¶
The State field for the certificate Subject DN
Type: String
Parameter Sets: Ask
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Country¶
The Country field for the certificate Subject DN
Type: String
Parameter Sets: Ask
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SanDns¶
One or more subject alternative name dns entries
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SanIP¶
One or more subject alternative name ip address entries
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SanUri¶
One or more subject alternative name uri entries
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SanEmail¶
One or more subject alternative name email entries
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ValidUntil¶
Date at which the certificate becomes invalid. Days and hours are supported, not minutes.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-Date).AddYears(1)
Accept pipeline input: False
Accept wildcard characters: False
-PassThru¶
Return the certificate request. If the certificate was successfully issued, it will be returned as the property 'certificate'.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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 VaaS key can also provided directly.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $script:VenafiSession
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
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.
INPUTS¶
CommonName¶
OUTPUTS¶
pscustomobject, if PassThru is provided¶
NOTES¶
RELATED LINKS¶
http://VenafiPS.readthedocs.io/en/latest/functions/New-VaasCertificate/
https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/New-VaasCertificate.ps1