1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectVpnQkd
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
fortimanager logo
fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev

    Configure Quantum Key Distribution servers

    Create ObjectVpnQkd Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ObjectVpnQkd(name: string, args?: ObjectVpnQkdArgs, opts?: CustomResourceOptions);
    @overload
    def ObjectVpnQkd(resource_name: str,
                     args: Optional[ObjectVpnQkdArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObjectVpnQkd(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     adom: Optional[str] = None,
                     certificates: Optional[Sequence[str]] = None,
                     comment: Optional[str] = None,
                     fosid: Optional[str] = None,
                     name: Optional[str] = None,
                     object_vpn_qkd_id: Optional[str] = None,
                     peers: Optional[Sequence[str]] = None,
                     port: Optional[float] = None,
                     scopetype: Optional[str] = None,
                     server: Optional[str] = None)
    func NewObjectVpnQkd(ctx *Context, name string, args *ObjectVpnQkdArgs, opts ...ResourceOption) (*ObjectVpnQkd, error)
    public ObjectVpnQkd(string name, ObjectVpnQkdArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectVpnQkd(String name, ObjectVpnQkdArgs args)
    public ObjectVpnQkd(String name, ObjectVpnQkdArgs args, CustomResourceOptions options)
    
    type: fortimanager:ObjectVpnQkd
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ObjectVpnQkdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ObjectVpnQkdArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ObjectVpnQkdArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectVpnQkdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectVpnQkdArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var objectVpnQkdResource = new Fortimanager.ObjectVpnQkd("objectVpnQkdResource", new()
    {
        Adom = "string",
        Certificates = new[]
        {
            "string",
        },
        Comment = "string",
        Fosid = "string",
        Name = "string",
        ObjectVpnQkdId = "string",
        Peers = new[]
        {
            "string",
        },
        Port = 0,
        Scopetype = "string",
        Server = "string",
    });
    
    example, err := fortimanager.NewObjectVpnQkd(ctx, "objectVpnQkdResource", &fortimanager.ObjectVpnQkdArgs{
    	Adom: pulumi.String("string"),
    	Certificates: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Comment:        pulumi.String("string"),
    	Fosid:          pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	ObjectVpnQkdId: pulumi.String("string"),
    	Peers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Port:      pulumi.Float64(0),
    	Scopetype: pulumi.String("string"),
    	Server:    pulumi.String("string"),
    })
    
    var objectVpnQkdResource = new ObjectVpnQkd("objectVpnQkdResource", ObjectVpnQkdArgs.builder()
        .adom("string")
        .certificates("string")
        .comment("string")
        .fosid("string")
        .name("string")
        .objectVpnQkdId("string")
        .peers("string")
        .port(0.0)
        .scopetype("string")
        .server("string")
        .build());
    
    object_vpn_qkd_resource = fortimanager.ObjectVpnQkd("objectVpnQkdResource",
        adom="string",
        certificates=["string"],
        comment="string",
        fosid="string",
        name="string",
        object_vpn_qkd_id="string",
        peers=["string"],
        port=0,
        scopetype="string",
        server="string")
    
    const objectVpnQkdResource = new fortimanager.ObjectVpnQkd("objectVpnQkdResource", {
        adom: "string",
        certificates: ["string"],
        comment: "string",
        fosid: "string",
        name: "string",
        objectVpnQkdId: "string",
        peers: ["string"],
        port: 0,
        scopetype: "string",
        server: "string",
    });
    
    type: fortimanager:ObjectVpnQkd
    properties:
        adom: string
        certificates:
            - string
        comment: string
        fosid: string
        name: string
        objectVpnQkdId: string
        peers:
            - string
        port: 0
        scopetype: string
        server: string
    

    ObjectVpnQkd Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ObjectVpnQkd resource accepts the following input properties:

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Certificates List<string>
    Names of up to 4 certificates to offer to the KME.
    Comment string
    Comment.
    Fosid string
    Quantum Key Distribution ID assigned by the KME.
    Name string
    Quantum Key Distribution configuration name.
    ObjectVpnQkdId string
    an identifier for the resource with format {{name}}.
    Peers List<string>
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    Port double
    Port to connect to on the KME.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Server string
    IPv4, IPv6 or DNS address of the KME.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Certificates []string
    Names of up to 4 certificates to offer to the KME.
    Comment string
    Comment.
    Fosid string
    Quantum Key Distribution ID assigned by the KME.
    Name string
    Quantum Key Distribution configuration name.
    ObjectVpnQkdId string
    an identifier for the resource with format {{name}}.
    Peers []string
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    Port float64
    Port to connect to on the KME.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Server string
    IPv4, IPv6 or DNS address of the KME.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates List<String>
    Names of up to 4 certificates to offer to the KME.
    comment String
    Comment.
    fosid String
    Quantum Key Distribution ID assigned by the KME.
    name String
    Quantum Key Distribution configuration name.
    objectVpnQkdId String
    an identifier for the resource with format {{name}}.
    peers List<String>
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port Double
    Port to connect to on the KME.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server String
    IPv4, IPv6 or DNS address of the KME.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates string[]
    Names of up to 4 certificates to offer to the KME.
    comment string
    Comment.
    fosid string
    Quantum Key Distribution ID assigned by the KME.
    name string
    Quantum Key Distribution configuration name.
    objectVpnQkdId string
    an identifier for the resource with format {{name}}.
    peers string[]
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port number
    Port to connect to on the KME.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server string
    IPv4, IPv6 or DNS address of the KME.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates Sequence[str]
    Names of up to 4 certificates to offer to the KME.
    comment str
    Comment.
    fosid str
    Quantum Key Distribution ID assigned by the KME.
    name str
    Quantum Key Distribution configuration name.
    object_vpn_qkd_id str
    an identifier for the resource with format {{name}}.
    peers Sequence[str]
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port float
    Port to connect to on the KME.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server str
    IPv4, IPv6 or DNS address of the KME.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates List<String>
    Names of up to 4 certificates to offer to the KME.
    comment String
    Comment.
    fosid String
    Quantum Key Distribution ID assigned by the KME.
    name String
    Quantum Key Distribution configuration name.
    objectVpnQkdId String
    an identifier for the resource with format {{name}}.
    peers List<String>
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port Number
    Port to connect to on the KME.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server String
    IPv4, IPv6 or DNS address of the KME.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectVpnQkd resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ObjectVpnQkd Resource

    Get an existing ObjectVpnQkd resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ObjectVpnQkdState, opts?: CustomResourceOptions): ObjectVpnQkd
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            adom: Optional[str] = None,
            certificates: Optional[Sequence[str]] = None,
            comment: Optional[str] = None,
            fosid: Optional[str] = None,
            name: Optional[str] = None,
            object_vpn_qkd_id: Optional[str] = None,
            peers: Optional[Sequence[str]] = None,
            port: Optional[float] = None,
            scopetype: Optional[str] = None,
            server: Optional[str] = None) -> ObjectVpnQkd
    func GetObjectVpnQkd(ctx *Context, name string, id IDInput, state *ObjectVpnQkdState, opts ...ResourceOption) (*ObjectVpnQkd, error)
    public static ObjectVpnQkd Get(string name, Input<string> id, ObjectVpnQkdState? state, CustomResourceOptions? opts = null)
    public static ObjectVpnQkd get(String name, Output<String> id, ObjectVpnQkdState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectVpnQkd    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Certificates List<string>
    Names of up to 4 certificates to offer to the KME.
    Comment string
    Comment.
    Fosid string
    Quantum Key Distribution ID assigned by the KME.
    Name string
    Quantum Key Distribution configuration name.
    ObjectVpnQkdId string
    an identifier for the resource with format {{name}}.
    Peers List<string>
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    Port double
    Port to connect to on the KME.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Server string
    IPv4, IPv6 or DNS address of the KME.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Certificates []string
    Names of up to 4 certificates to offer to the KME.
    Comment string
    Comment.
    Fosid string
    Quantum Key Distribution ID assigned by the KME.
    Name string
    Quantum Key Distribution configuration name.
    ObjectVpnQkdId string
    an identifier for the resource with format {{name}}.
    Peers []string
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    Port float64
    Port to connect to on the KME.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Server string
    IPv4, IPv6 or DNS address of the KME.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates List<String>
    Names of up to 4 certificates to offer to the KME.
    comment String
    Comment.
    fosid String
    Quantum Key Distribution ID assigned by the KME.
    name String
    Quantum Key Distribution configuration name.
    objectVpnQkdId String
    an identifier for the resource with format {{name}}.
    peers List<String>
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port Double
    Port to connect to on the KME.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server String
    IPv4, IPv6 or DNS address of the KME.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates string[]
    Names of up to 4 certificates to offer to the KME.
    comment string
    Comment.
    fosid string
    Quantum Key Distribution ID assigned by the KME.
    name string
    Quantum Key Distribution configuration name.
    objectVpnQkdId string
    an identifier for the resource with format {{name}}.
    peers string[]
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port number
    Port to connect to on the KME.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server string
    IPv4, IPv6 or DNS address of the KME.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates Sequence[str]
    Names of up to 4 certificates to offer to the KME.
    comment str
    Comment.
    fosid str
    Quantum Key Distribution ID assigned by the KME.
    name str
    Quantum Key Distribution configuration name.
    object_vpn_qkd_id str
    an identifier for the resource with format {{name}}.
    peers Sequence[str]
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port float
    Port to connect to on the KME.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server str
    IPv4, IPv6 or DNS address of the KME.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    certificates List<String>
    Names of up to 4 certificates to offer to the KME.
    comment String
    Comment.
    fosid String
    Quantum Key Distribution ID assigned by the KME.
    name String
    Quantum Key Distribution configuration name.
    objectVpnQkdId String
    an identifier for the resource with format {{name}}.
    peers List<String>
    Authenticate Quantum Key Device's certificate with the peer/peergrp.
    port Number
    Port to connect to on the KME.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server String
    IPv4, IPv6 or DNS address of the KME.

    Import

    ObjectVpn Qkd can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectVpnQkd:ObjectVpnQkd labelname {{name}}
    

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.15.0 published on Thursday, Nov 13, 2025 by fortinetdev
      Meet Neo: Your AI Platform Teammate