1. Packages
  2. Avi Provider
  3. API Docs
  4. getPkiprofile
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getPkiprofile

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

    <!–

    Copyright 2021 VMware, Inc.
    SPDX-License-Identifier: Mozilla Public License 2.0
    

    –>

    layout: “avi”

    page_title: “AVI: avi.Pkiprofile” sidebar_current: “docs-avi-datasource-pkiprofile” description: |- Get information of Avi PKIProfile.

    avi.Pkiprofile

    This data source is used to to get avi.Pkiprofile objects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const fooPkiprofile = avi.getPkiprofile({
        name: "foo",
        uuid: "pkiprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });
    
    import pulumi
    import pulumi_avi as avi
    
    foo_pkiprofile = avi.get_pkiprofile(name="foo",
        uuid="pkiprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := avi.LookupPkiprofile(ctx, &avi.LookupPkiprofileArgs{
    			Name: pulumi.StringRef("foo"),
    			Uuid: pulumi.StringRef("pkiprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Avi = Pulumi.Avi;
    
    return await Deployment.RunAsync(() => 
    {
        var fooPkiprofile = Avi.GetPkiprofile.Invoke(new()
        {
            Name = "foo",
            Uuid = "pkiprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.avi.AviFunctions;
    import com.pulumi.avi.inputs.GetPkiprofileArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var fooPkiprofile = AviFunctions.getPkiprofile(GetPkiprofileArgs.builder()
                .name("foo")
                .uuid("pkiprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
                .build());
    
        }
    }
    
    variables:
      fooPkiprofile:
        fn::invoke:
          function: avi:getPkiprofile
          arguments:
            name: foo
            uuid: pkiprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b
    

    Using getPkiprofile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPkiprofile(args: GetPkiprofileArgs, opts?: InvokeOptions): Promise<GetPkiprofileResult>
    function getPkiprofileOutput(args: GetPkiprofileOutputArgs, opts?: InvokeOptions): Output<GetPkiprofileResult>
    def get_pkiprofile(id: Optional[str] = None,
                       name: Optional[str] = None,
                       tenant_ref: Optional[str] = None,
                       uuid: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPkiprofileResult
    def get_pkiprofile_output(id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       tenant_ref: Optional[pulumi.Input[str]] = None,
                       uuid: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPkiprofileResult]
    func LookupPkiprofile(ctx *Context, args *LookupPkiprofileArgs, opts ...InvokeOption) (*LookupPkiprofileResult, error)
    func LookupPkiprofileOutput(ctx *Context, args *LookupPkiprofileOutputArgs, opts ...InvokeOption) LookupPkiprofileResultOutput

    > Note: This function is named LookupPkiprofile in the Go SDK.

    public static class GetPkiprofile 
    {
        public static Task<GetPkiprofileResult> InvokeAsync(GetPkiprofileArgs args, InvokeOptions? opts = null)
        public static Output<GetPkiprofileResult> Invoke(GetPkiprofileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPkiprofileResult> getPkiprofile(GetPkiprofileArgs args, InvokeOptions options)
    public static Output<GetPkiprofileResult> getPkiprofile(GetPkiprofileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: avi:index/getPkiprofile:getPkiprofile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    Search PKIProfile by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search PKIProfile by uuid.
    Id string
    Name string
    Search PKIProfile by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search PKIProfile by uuid.
    id String
    name String
    Search PKIProfile by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search PKIProfile by uuid.
    id string
    name string
    Search PKIProfile by name.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search PKIProfile by uuid.
    id str
    name str
    Search PKIProfile by name.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Search PKIProfile by uuid.
    id String
    name String
    Search PKIProfile by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search PKIProfile by uuid.

    getPkiprofile Result

    The following output properties are available:

    AllowPkiErrors List<string>
    Exempt errors during certificate verification. Enum options - ALLOW_EXPIRED_CRL, ALLOW_ALL_ERRORS. Field introduced in 30.1.1. Maximum of 1 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    CaCerts List<GetPkiprofileCaCert>
    List of certificate authorities (root and intermediate) trusted that is used for certificate validation. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<GetPkiprofileConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CrlCheck string
    When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CrlFileRefs List<string>
    Refers to fileobject containing crl body. It is a reference to an object of type fileobject. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Id string
    IgnorePeerChain string
    When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition. Special default for essentials edition is true, basic edition is true, enterprise edition is false.
    IsFederated string
    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers List<GetPkiprofileMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the pki profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ValidateOnlyLeafCrl string
    When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    AllowPkiErrors []string
    Exempt errors during certificate verification. Enum options - ALLOW_EXPIRED_CRL, ALLOW_ALL_ERRORS. Field introduced in 30.1.1. Maximum of 1 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    CaCerts []GetPkiprofileCaCert
    List of certificate authorities (root and intermediate) trusted that is used for certificate validation. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GetPkiprofileConfigpbAttribute
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CrlCheck string
    When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CrlFileRefs []string
    Refers to fileobject containing crl body. It is a reference to an object of type fileobject. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Id string
    IgnorePeerChain string
    When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition. Special default for essentials edition is true, basic edition is true, enterprise edition is false.
    IsFederated string
    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers []GetPkiprofileMarker
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the pki profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ValidateOnlyLeafCrl string
    When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    allowPkiErrors List<String>
    Exempt errors during certificate verification. Enum options - ALLOW_EXPIRED_CRL, ALLOW_ALL_ERRORS. Field introduced in 30.1.1. Maximum of 1 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    caCerts List<GetPkiprofileCaCert>
    List of certificate authorities (root and intermediate) trusted that is used for certificate validation. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GetPkiprofileConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crlCheck String
    When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crlFileRefs List<String>
    Refers to fileobject containing crl body. It is a reference to an object of type fileobject. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    id String
    ignorePeerChain String
    When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition. Special default for essentials edition is true, basic edition is true, enterprise edition is false.
    isFederated String
    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<GetPkiprofileMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the pki profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    validateOnlyLeafCrl String
    When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    allowPkiErrors string[]
    Exempt errors during certificate verification. Enum options - ALLOW_EXPIRED_CRL, ALLOW_ALL_ERRORS. Field introduced in 30.1.1. Maximum of 1 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    caCerts GetPkiprofileCaCert[]
    List of certificate authorities (root and intermediate) trusted that is used for certificate validation. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GetPkiprofileConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crlCheck string
    When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crlFileRefs string[]
    Refers to fileobject containing crl body. It is a reference to an object of type fileobject. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    id string
    ignorePeerChain string
    When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition. Special default for essentials edition is true, basic edition is true, enterprise edition is false.
    isFederated string
    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers GetPkiprofileMarker[]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of the pki profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    validateOnlyLeafCrl string
    When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    allow_pki_errors Sequence[str]
    Exempt errors during certificate verification. Enum options - ALLOW_EXPIRED_CRL, ALLOW_ALL_ERRORS. Field introduced in 30.1.1. Maximum of 1 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    ca_certs Sequence[GetPkiprofileCaCert]
    List of certificate authorities (root and intermediate) trusted that is used for certificate validation. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GetPkiprofileConfigpbAttribute]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    created_by str
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crl_check str
    When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crl_file_refs Sequence[str]
    Refers to fileobject containing crl body. It is a reference to an object of type fileobject. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    id str
    ignore_peer_chain str
    When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition. Special default for essentials edition is true, basic edition is true, enterprise edition is false.
    is_federated str
    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers Sequence[GetPkiprofileMarker]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of the pki profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    validate_only_leaf_crl str
    When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    allowPkiErrors List<String>
    Exempt errors during certificate verification. Enum options - ALLOW_EXPIRED_CRL, ALLOW_ALL_ERRORS. Field introduced in 30.1.1. Maximum of 1 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    caCerts List<Property Map>
    List of certificate authorities (root and intermediate) trusted that is used for certificate validation. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crlCheck String
    When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    crlFileRefs List<String>
    Refers to fileobject containing crl body. It is a reference to an object of type fileobject. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    id String
    ignorePeerChain String
    When enabled, avi will not trust intermediate and root certs presented by a client. Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition. Special default for essentials edition is true, basic edition is true, enterprise edition is false.
    isFederated String
    This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 17.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<Property Map>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the pki profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    validateOnlyLeafCrl String
    When enabled, avi will only validate the revocation status of the leaf certificate using crl. To enable validation for the entire chain, disable this option and provide all the relevant crls. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.

    Supporting Types

    GetPkiprofileCaCert

    GetPkiprofileCaCertIssuer

    GetPkiprofileCaCertKeyParam

    GetPkiprofileCaCertKeyParamEcParam

    Curve string
    Curve string
    curve String
    curve string
    curve str
    curve String

    GetPkiprofileCaCertKeyParamRsaParam

    Exponent string
    KeySize string
    Exponent string
    KeySize string
    exponent String
    keySize String
    exponent string
    keySize string
    exponent String
    keySize String

    GetPkiprofileCaCertSubject

    GetPkiprofileConfigpbAttribute

    Version string
    Version string
    version String
    version string
    version String

    GetPkiprofileMarker

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware