Enrolls or provisions a new certificate
New-TppCertificate -Path <String> -Name <String> [-CommonName <String>] [-Csr <String>] [-CertificateType <String>] [-CertificateAuthorityPath <String>] [-CertificateAuthorityAttribute <Hashtable>] [-ManagementType <TppManagementType>] [-SubjectAltName <Hashtable>] [-CustomField <Hashtable>] [-NoWorkToDo] [-Device <Hashtable>] [-WorkToDoTimeout <Int32>] [-PassThru] [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
New-TppCertificate -Path <String> -Name <String> [-CommonName <String>] [-Csr <String>] [-CertificateType <String>] [-CertificateAuthorityPath <String>] [-CertificateAuthorityAttribute <Hashtable>] [-ManagementType <TppManagementType>] [-SubjectAltName <Hashtable>] [-CustomField <Hashtable>] [-NoWorkToDo] -Device <Hashtable> [-Application <Hashtable>] [-WorkToDoTimeout <Int32>] [-PassThru] [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
Enrolls or provisions a new certificate. Prior to TPP 22.1, this function is asynchronous and will always return success. Beginning with 22.1, you can control this behavior. See https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-Certificates-API-settings.php.
The folder DN path for the new certificate.
Name of the certifcate object. If CommonName isn't provided, this value will be used.
Subject Common Name. If CommonName isn't provided, Name will be used.
The PKCS#10 Certificate Signing Request (CSR). If this value is provided, any Subject DN fields and the KeyBitSize in the request are ignored.
Type of certificate to be created. The default is X.509 Server Certificate.
The path of the Certificate Authority Template object for enrolling the certificate. If the value is missing, it is expected a policy has been applied to Path.
Name/value pairs providing any CA attributes to store with the Certificate object. During enrollment, these values will be submitted to the CA.
The level of management that Trust Protection Platform applies to the certificate: - Enrollment: Default. Issue a new certificate, renewed certificate, or key generation request to a CA for enrollment. Do not automatically provision the certificate. - Provisioning: Issue a new certificate, renewed certificate, or key generation request to a CA for enrollment. Automatically install or provision the certificate. - Monitoring: Allow Trust Protection Platform to monitor the certificate for expiration and renewal. - Unassigned: Certificates are neither enrolled or monitored by Trust Protection Platform.
A list of Subject Alternate Names. The value must be 1 or more hashtables with the SAN type and value. Acceptable SAN types are OtherName, Email, DNS, URI, and IPAddress. You can provide more than 1 of the same SAN type with multiple hashtables.
Hashtable of custom field(s) to be updated when creating the certificate. This is required when the custom fields are mandatory. The key is the name, not guid, of the custom field.
Turn off lifecycle processing for this certificate update
An array of hashtables for devices to be created. Available parameters can be found at https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Certificates-request.php. If provisioning applications as well, those should be provided with the Application parameter.
An array of hashtables for applications to be created. Available parameters can be found at https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Certificates-request-ApplicationsParameter.php. In addition to the application parameters, a key/value must be provided for the associated device. The key needs to be 'DeviceName' and the value is the ObjectName from the device. See the example.
Introduced in 22.1, this controls the wait time, in seconds, for a CA to issue/renew a certificate. Providing this will override the global setting.
Return a TppObject representing the newly created certificate. If devices and/or applications were created, a 'Device' property will be available as well.
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. If providing a TPP token, an environment variable named TppServer must also be set.
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prompts you for confirmation before running the cmdlet.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.