1. Packages
  2. Fortios
  3. API Docs
  4. vpn
  5. Qkd
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.vpn.Qkd

Explore with Pulumi AI

Configure Quantum Key Distribution servers Applies to FortiOS Version >= 7.4.2.

Create Qkd Resource

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

Constructor syntax

new Qkd(name: string, args?: QkdArgs, opts?: CustomResourceOptions);
@overload
def Qkd(resource_name: str,
        args: Optional[QkdArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Qkd(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        certificates: Optional[Sequence[QkdCertificateArgs]] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fosid: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        peer: Optional[str] = None,
        port: Optional[int] = None,
        server: Optional[str] = None,
        vdomparam: Optional[str] = None)
func NewQkd(ctx *Context, name string, args *QkdArgs, opts ...ResourceOption) (*Qkd, error)
public Qkd(string name, QkdArgs? args = null, CustomResourceOptions? opts = null)
public Qkd(String name, QkdArgs args)
public Qkd(String name, QkdArgs args, CustomResourceOptions options)
type: fortios:vpn:Qkd
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args QkdArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args QkdArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args QkdArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args QkdArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. QkdArgs
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 qkdResource = new Fortios.Vpn.Qkd("qkdResource", new()
{
    Certificates = new[]
    {
        new Fortios.Vpn.Inputs.QkdCertificateArgs
        {
            Name = "string",
        },
    },
    Comment = "string",
    DynamicSortSubtable = "string",
    Fosid = "string",
    GetAllTables = "string",
    Name = "string",
    Peer = "string",
    Port = 0,
    Server = "string",
    Vdomparam = "string",
});
Copy
example, err := vpn.NewQkd(ctx, "qkdResource", &vpn.QkdArgs{
	Certificates: vpn.QkdCertificateArray{
		&vpn.QkdCertificateArgs{
			Name: pulumi.String("string"),
		},
	},
	Comment:             pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	Fosid:               pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Peer:                pulumi.String("string"),
	Port:                pulumi.Int(0),
	Server:              pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
})
Copy
var qkdResource = new Qkd("qkdResource", QkdArgs.builder()
    .certificates(QkdCertificateArgs.builder()
        .name("string")
        .build())
    .comment("string")
    .dynamicSortSubtable("string")
    .fosid("string")
    .getAllTables("string")
    .name("string")
    .peer("string")
    .port(0)
    .server("string")
    .vdomparam("string")
    .build());
Copy
qkd_resource = fortios.vpn.Qkd("qkdResource",
    certificates=[{
        "name": "string",
    }],
    comment="string",
    dynamic_sort_subtable="string",
    fosid="string",
    get_all_tables="string",
    name="string",
    peer="string",
    port=0,
    server="string",
    vdomparam="string")
Copy
const qkdResource = new fortios.vpn.Qkd("qkdResource", {
    certificates: [{
        name: "string",
    }],
    comment: "string",
    dynamicSortSubtable: "string",
    fosid: "string",
    getAllTables: "string",
    name: "string",
    peer: "string",
    port: 0,
    server: "string",
    vdomparam: "string",
});
Copy
type: fortios:vpn:Qkd
properties:
    certificates:
        - name: string
    comment: string
    dynamicSortSubtable: string
    fosid: string
    getAllTables: string
    name: string
    peer: string
    port: 0
    server: string
    vdomparam: string
Copy

Qkd 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 Qkd resource accepts the following input properties:

Certificates List<Pulumiverse.Fortios.Vpn.Inputs.QkdCertificate>
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Fosid string
Quantum Key Distribution ID assigned by the KME.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name Changes to this property will trigger replacement. string
Quantum Key Distribution configuration name.
Peer string
Authenticate Quantum Key Device's certificate with the peer/peergrp.
Port int
Port to connect to on the KME.
Server string
IPv4, IPv6 or DNS address of the KME.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Certificates []QkdCertificateArgs
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Fosid string
Quantum Key Distribution ID assigned by the KME.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name Changes to this property will trigger replacement. string
Quantum Key Distribution configuration name.
Peer string
Authenticate Quantum Key Device's certificate with the peer/peergrp.
Port int
Port to connect to on the KME.
Server string
IPv4, IPv6 or DNS address of the KME.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates List<QkdCertificate>
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid String
Quantum Key Distribution ID assigned by the KME.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. String
Quantum Key Distribution configuration name.
peer String
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port Integer
Port to connect to on the KME.
server String
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates QkdCertificate[]
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment string
Comment.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid string
Quantum Key Distribution ID assigned by the KME.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. string
Quantum Key Distribution configuration name.
peer string
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port number
Port to connect to on the KME.
server string
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates Sequence[QkdCertificateArgs]
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment str
Comment.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid str
Quantum Key Distribution ID assigned by the KME.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. str
Quantum Key Distribution configuration name.
peer str
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port int
Port to connect to on the KME.
server str
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates List<Property Map>
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid String
Quantum Key Distribution ID assigned by the KME.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. String
Quantum Key Distribution configuration name.
peer String
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port Number
Port to connect to on the KME.
server String
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

All input properties are implicitly available as output properties. Additionally, the Qkd 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 Qkd Resource

Get an existing Qkd 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?: QkdState, opts?: CustomResourceOptions): Qkd
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificates: Optional[Sequence[QkdCertificateArgs]] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fosid: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        peer: Optional[str] = None,
        port: Optional[int] = None,
        server: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Qkd
func GetQkd(ctx *Context, name string, id IDInput, state *QkdState, opts ...ResourceOption) (*Qkd, error)
public static Qkd Get(string name, Input<string> id, QkdState? state, CustomResourceOptions? opts = null)
public static Qkd get(String name, Output<String> id, QkdState state, CustomResourceOptions options)
resources:  _:    type: fortios:vpn:Qkd    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Certificates List<Pulumiverse.Fortios.Vpn.Inputs.QkdCertificate>
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Fosid string
Quantum Key Distribution ID assigned by the KME.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name Changes to this property will trigger replacement. string
Quantum Key Distribution configuration name.
Peer string
Authenticate Quantum Key Device's certificate with the peer/peergrp.
Port int
Port to connect to on the KME.
Server string
IPv4, IPv6 or DNS address of the KME.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Certificates []QkdCertificateArgs
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
Comment string
Comment.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Fosid string
Quantum Key Distribution ID assigned by the KME.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name Changes to this property will trigger replacement. string
Quantum Key Distribution configuration name.
Peer string
Authenticate Quantum Key Device's certificate with the peer/peergrp.
Port int
Port to connect to on the KME.
Server string
IPv4, IPv6 or DNS address of the KME.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates List<QkdCertificate>
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid String
Quantum Key Distribution ID assigned by the KME.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. String
Quantum Key Distribution configuration name.
peer String
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port Integer
Port to connect to on the KME.
server String
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates QkdCertificate[]
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment string
Comment.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid string
Quantum Key Distribution ID assigned by the KME.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. string
Quantum Key Distribution configuration name.
peer string
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port number
Port to connect to on the KME.
server string
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates Sequence[QkdCertificateArgs]
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment str
Comment.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid str
Quantum Key Distribution ID assigned by the KME.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. str
Quantum Key Distribution configuration name.
peer str
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port int
Port to connect to on the KME.
server str
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
certificates List<Property Map>
Names of up to 4 certificates to offer to the KME. The structure of certificate block is documented below.
comment String
Comment.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
fosid String
Quantum Key Distribution ID assigned by the KME.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. String
Quantum Key Distribution configuration name.
peer String
Authenticate Quantum Key Device's certificate with the peer/peergrp.
port Number
Port to connect to on the KME.
server String
IPv4, IPv6 or DNS address of the KME.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Supporting Types

QkdCertificate
, QkdCertificateArgs

Name string
Certificate name.
Name string
Certificate name.
name String
Certificate name.
name string
Certificate name.
name str
Certificate name.
name String
Certificate name.

Import

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

$ pulumi import fortios:vpn/qkd:Qkd labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:vpn/qkd:Qkd labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.