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)
type: fortios:vpn:Qkd
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 QkdArgs
- 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 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 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 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 String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
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",
});
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
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. Qkd Certificate> - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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.
- Get
All stringTables - 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 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 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
[]Qkd
Certificate Args - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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.
- Get
All stringTables - 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 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 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<Qkd
Certificate> - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - comment String
- Comment.
- dynamic
Sort StringSubtable - 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.
- get
All StringTables - 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 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 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
Qkd
Certificate[] - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - comment string
- Comment.
- dynamic
Sort stringSubtable - 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.
- get
All stringTables - 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 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 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[Qkd
Certificate Args] - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - comment str
- Comment.
- dynamic_
sort_ strsubtable - 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_ strtables - 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 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 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.
- dynamic
Sort StringSubtable - 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.
- get
All StringTables - 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 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 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)
Resource lookup is not supported in YAML
- 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.
- Certificates
List<Pulumiverse.
Fortios. Vpn. Inputs. Qkd Certificate> - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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.
- Get
All stringTables - 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 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 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
[]Qkd
Certificate Args - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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.
- Get
All stringTables - 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 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 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<Qkd
Certificate> - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - comment String
- Comment.
- dynamic
Sort StringSubtable - 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.
- get
All StringTables - 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 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 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
Qkd
Certificate[] - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - comment string
- Comment.
- dynamic
Sort stringSubtable - 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.
- get
All stringTables - 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 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 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[Qkd
Certificate Args] - Names of up to 4 certificates to offer to the KME. The structure of
certificate
block is documented below. - comment str
- Comment.
- dynamic_
sort_ strsubtable - 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_ strtables - 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 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 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.
- dynamic
Sort StringSubtable - 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.
- get
All StringTables - 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 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 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}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:vpn/qkd:Qkd labelname {{name}}
$ 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.