Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. vpn
  5. L2tp
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.vpn.L2tp

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure L2TP.

    Create L2tp Resource

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

    Constructor syntax

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

@overload
def L2tp(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         status: Optional[str] = None,
         compress: Optional[str] = None,
         eip: Optional[str] = None,
         enforce_ipsec: Optional[str] = None,
         hello_interval: Optional[int] = None,
         lcp_echo_interval: Optional[int] = None,
         lcp_max_echo_fails: Optional[int] = None,
         sip: Optional[str] = None,
         usrgrp: Optional[str] = None,
         vdomparam: Optional[str] = None)
    func NewL2tp(ctx *Context, name string, args L2tpArgs, opts ...ResourceOption) (*L2tp, error)
    public L2tp(string name, L2tpArgs args, CustomResourceOptions? opts = null)
    public L2tp(String name, L2tpArgs args)
public L2tp(String name, L2tpArgs args, CustomResourceOptions options)

    type: fortios:vpn:L2tp
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 L2tpArgs
    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 L2tpArgs
    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 L2tpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args L2tpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args L2tpArgs
    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 l2tpResource = new Fortios.Vpn.L2tp("l2tpResource", new()
{
    Status = "string",
    Compress = "string",
    Eip = "string",
    EnforceIpsec = "string",
    HelloInterval = 0,
    LcpEchoInterval = 0,
    LcpMaxEchoFails = 0,
    Sip = "string",
    Usrgrp = "string",
    Vdomparam = "string",
});

    example, err := vpn.NewL2tp(ctx, "l2tpResource", &vpn.L2tpArgs{
	Status:          pulumi.String("string"),
	Compress:        pulumi.String("string"),
	Eip:             pulumi.String("string"),
	EnforceIpsec:    pulumi.String("string"),
	HelloInterval:   pulumi.Int(0),
	LcpEchoInterval: pulumi.Int(0),
	LcpMaxEchoFails: pulumi.Int(0),
	Sip:             pulumi.String("string"),
	Usrgrp:          pulumi.String("string"),
	Vdomparam:       pulumi.String("string"),
})

    var l2tpResource = new L2tp("l2tpResource", L2tpArgs.builder()
    .status("string")
    .compress("string")
    .eip("string")
    .enforceIpsec("string")
    .helloInterval(0)
    .lcpEchoInterval(0)
    .lcpMaxEchoFails(0)
    .sip("string")
    .usrgrp("string")
    .vdomparam("string")
    .build());

    l2tp_resource = fortios.vpn.L2tp("l2tpResource",
    status="string",
    compress="string",
    eip="string",
    enforce_ipsec="string",
    hello_interval=0,
    lcp_echo_interval=0,
    lcp_max_echo_fails=0,
    sip="string",
    usrgrp="string",
    vdomparam="string")

    const l2tpResource = new fortios.vpn.L2tp("l2tpResource", {
    status: "string",
    compress: "string",
    eip: "string",
    enforceIpsec: "string",
    helloInterval: 0,
    lcpEchoInterval: 0,
    lcpMaxEchoFails: 0,
    sip: "string",
    usrgrp: "string",
    vdomparam: "string",
});

    type: fortios:vpn:L2tp
properties:
    compress: string
    eip: string
    enforceIpsec: string
    helloInterval: 0
    lcpEchoInterval: 0
    lcpMaxEchoFails: 0
    sip: string
    status: string
    usrgrp: string
    vdomparam: string

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

    Status string
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    Compress string
    Enable/disable data compression. Valid values: enable, disable.
    Eip string
    End IP.
    EnforceIpsec string
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    HelloInterval int
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    LcpEchoInterval int
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    LcpMaxEchoFails int
    Maximum number of missed LCP echo messages before disconnect.
    Sip string
    Start IP.
    Usrgrp string
    User group.
    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.
    Status string
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    Compress string
    Enable/disable data compression. Valid values: enable, disable.
    Eip string
    End IP.
    EnforceIpsec string
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    HelloInterval int
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    LcpEchoInterval int
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    LcpMaxEchoFails int
    Maximum number of missed LCP echo messages before disconnect.
    Sip string
    Start IP.
    Usrgrp string
    User group.
    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.
    status String
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    compress String
    Enable/disable data compression. Valid values: enable, disable.
    eip String
    End IP.
    enforceIpsec String
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    helloInterval Integer
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcpEchoInterval Integer
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcpMaxEchoFails Integer
    Maximum number of missed LCP echo messages before disconnect.
    sip String
    Start IP.
    usrgrp String
    User group.
    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.
    status string
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    compress string
    Enable/disable data compression. Valid values: enable, disable.
    eip string
    End IP.
    enforceIpsec string
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    helloInterval number
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcpEchoInterval number
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcpMaxEchoFails number
    Maximum number of missed LCP echo messages before disconnect.
    sip string
    Start IP.
    usrgrp string
    User group.
    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.
    status str
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    compress str
    Enable/disable data compression. Valid values: enable, disable.
    eip str
    End IP.
    enforce_ipsec str
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    hello_interval int
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcp_echo_interval int
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcp_max_echo_fails int
    Maximum number of missed LCP echo messages before disconnect.
    sip str
    Start IP.
    usrgrp str
    User group.
    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.
    status String
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    compress String
    Enable/disable data compression. Valid values: enable, disable.
    eip String
    End IP.
    enforceIpsec String
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    helloInterval Number
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcpEchoInterval Number
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcpMaxEchoFails Number
    Maximum number of missed LCP echo messages before disconnect.
    sip String
    Start IP.
    usrgrp String
    User group.
    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 L2tp 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 L2tp Resource

    Get an existing L2tp 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?: L2tpState, opts?: CustomResourceOptions): L2tp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compress: Optional[str] = None,
        eip: Optional[str] = None,
        enforce_ipsec: Optional[str] = None,
        hello_interval: Optional[int] = None,
        lcp_echo_interval: Optional[int] = None,
        lcp_max_echo_fails: Optional[int] = None,
        sip: Optional[str] = None,
        status: Optional[str] = None,
        usrgrp: Optional[str] = None,
        vdomparam: Optional[str] = None) -> L2tp
    func GetL2tp(ctx *Context, name string, id IDInput, state *L2tpState, opts ...ResourceOption) (*L2tp, error)
    public static L2tp Get(string name, Input<string> id, L2tpState? state, CustomResourceOptions? opts = null)
    public static L2tp get(String name, Output<String> id, L2tpState 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.
    The following state arguments are supported:
    Compress string
    Enable/disable data compression. Valid values: enable, disable.
    Eip string
    End IP.
    EnforceIpsec string
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    HelloInterval int
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    LcpEchoInterval int
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    LcpMaxEchoFails int
    Maximum number of missed LCP echo messages before disconnect.
    Sip string
    Start IP.
    Status string
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    Usrgrp string
    User group.
    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.
    Compress string
    Enable/disable data compression. Valid values: enable, disable.
    Eip string
    End IP.
    EnforceIpsec string
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    HelloInterval int
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    LcpEchoInterval int
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    LcpMaxEchoFails int
    Maximum number of missed LCP echo messages before disconnect.
    Sip string
    Start IP.
    Status string
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    Usrgrp string
    User group.
    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.
    compress String
    Enable/disable data compression. Valid values: enable, disable.
    eip String
    End IP.
    enforceIpsec String
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    helloInterval Integer
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcpEchoInterval Integer
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcpMaxEchoFails Integer
    Maximum number of missed LCP echo messages before disconnect.
    sip String
    Start IP.
    status String
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    usrgrp String
    User group.
    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.
    compress string
    Enable/disable data compression. Valid values: enable, disable.
    eip string
    End IP.
    enforceIpsec string
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    helloInterval number
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcpEchoInterval number
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcpMaxEchoFails number
    Maximum number of missed LCP echo messages before disconnect.
    sip string
    Start IP.
    status string
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    usrgrp string
    User group.
    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.
    compress str
    Enable/disable data compression. Valid values: enable, disable.
    eip str
    End IP.
    enforce_ipsec str
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    hello_interval int
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcp_echo_interval int
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcp_max_echo_fails int
    Maximum number of missed LCP echo messages before disconnect.
    sip str
    Start IP.
    status str
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    usrgrp str
    User group.
    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.
    compress String
    Enable/disable data compression. Valid values: enable, disable.
    eip String
    End IP.
    enforceIpsec String
    Enable/disable IPsec enforcement. Valid values: enable, disable.
    helloInterval Number
    L2TP hello message interval in seconds (0 - 3600 sec, default = 60).
    lcpEchoInterval Number
    Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
    lcpMaxEchoFails Number
    Maximum number of missed LCP echo messages before disconnect.
    sip String
    Start IP.
    status String
    Enable/disable FortiGate as a L2TP gateway. Valid values: enable, disable.
    usrgrp String
    User group.
    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.

    Import

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

    $ pulumi import fortios:vpn/l2tp:L2tp labelname VpnL2Tp

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:vpn/l2tp:L2tp labelname VpnL2Tp

    $ 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.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios