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

fortios.system.Ipiptunnel

Explore with Pulumi AI

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

    Configure IP in IP Tunneling.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.Ipiptunnel("trname", {
    "interface": "port3",
    localGw: "1.1.1.1",
    remoteGw: "2.2.2.2",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Ipiptunnel("trname",
    interface="port3",
    local_gw="1.1.1.1",
    remote_gw="2.2.2.2")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewIpiptunnel(ctx, "trname", &system.IpiptunnelArgs{
			Interface: pulumi.String("port3"),
			LocalGw:   pulumi.String("1.1.1.1"),
			RemoteGw:  pulumi.String("2.2.2.2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Ipiptunnel("trname", new()
    {
        Interface = "port3",
        LocalGw = "1.1.1.1",
        RemoteGw = "2.2.2.2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Ipiptunnel;
import com.pulumi.fortios.system.IpiptunnelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Ipiptunnel("trname", IpiptunnelArgs.builder()
            .interface_("port3")
            .localGw("1.1.1.1")
            .remoteGw("2.2.2.2")
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Ipiptunnel
    properties:
      interface: port3
      localGw: 1.1.1.1
      remoteGw: 2.2.2.2

    Create Ipiptunnel Resource

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

    Constructor syntax

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

@overload
def Ipiptunnel(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               interface: Optional[str] = None,
               local_gw: Optional[str] = None,
               remote_gw: Optional[str] = None,
               auto_asic_offload: Optional[str] = None,
               name: Optional[str] = None,
               use_sdwan: Optional[str] = None,
               vdomparam: Optional[str] = None)
    func NewIpiptunnel(ctx *Context, name string, args IpiptunnelArgs, opts ...ResourceOption) (*Ipiptunnel, error)
    public Ipiptunnel(string name, IpiptunnelArgs args, CustomResourceOptions? opts = null)
    public Ipiptunnel(String name, IpiptunnelArgs args)
public Ipiptunnel(String name, IpiptunnelArgs args, CustomResourceOptions options)

    type: fortios:system:Ipiptunnel
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 IpiptunnelArgs
    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 IpiptunnelArgs
    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 IpiptunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpiptunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpiptunnelArgs
    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 ipiptunnelResource = new Fortios.System.Ipiptunnel("ipiptunnelResource", new()
{
    Interface = "string",
    LocalGw = "string",
    RemoteGw = "string",
    AutoAsicOffload = "string",
    Name = "string",
    UseSdwan = "string",
    Vdomparam = "string",
});

    example, err := system.NewIpiptunnel(ctx, "ipiptunnelResource", &system.IpiptunnelArgs{
	Interface:       pulumi.String("string"),
	LocalGw:         pulumi.String("string"),
	RemoteGw:        pulumi.String("string"),
	AutoAsicOffload: pulumi.String("string"),
	Name:            pulumi.String("string"),
	UseSdwan:        pulumi.String("string"),
	Vdomparam:       pulumi.String("string"),
})

    var ipiptunnelResource = new Ipiptunnel("ipiptunnelResource", IpiptunnelArgs.builder()
    .interface_("string")
    .localGw("string")
    .remoteGw("string")
    .autoAsicOffload("string")
    .name("string")
    .useSdwan("string")
    .vdomparam("string")
    .build());

    ipiptunnel_resource = fortios.system.Ipiptunnel("ipiptunnelResource",
    interface="string",
    local_gw="string",
    remote_gw="string",
    auto_asic_offload="string",
    name="string",
    use_sdwan="string",
    vdomparam="string")

    const ipiptunnelResource = new fortios.system.Ipiptunnel("ipiptunnelResource", {
    "interface": "string",
    localGw: "string",
    remoteGw: "string",
    autoAsicOffload: "string",
    name: "string",
    useSdwan: "string",
    vdomparam: "string",
});

    type: fortios:system:Ipiptunnel
properties:
    autoAsicOffload: string
    interface: string
    localGw: string
    name: string
    remoteGw: string
    useSdwan: string
    vdomparam: string

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

    Interface string
    Interface name that is associated with the incoming traffic from available options.
    LocalGw string
    IPv4 address for the local gateway.
    RemoteGw string
    IPv4 address for the remote gateway.
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    Name string
    IPIP Tunnel name.
    UseSdwan string
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    Interface string
    Interface name that is associated with the incoming traffic from available options.
    LocalGw string
    IPv4 address for the local gateway.
    RemoteGw string
    IPv4 address for the remote gateway.
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    Name string
    IPIP Tunnel name.
    UseSdwan string
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    interface_ String
    Interface name that is associated with the incoming traffic from available options.
    localGw String
    IPv4 address for the local gateway.
    remoteGw String
    IPv4 address for the remote gateway.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    name String
    IPIP Tunnel name.
    useSdwan String
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    interface string
    Interface name that is associated with the incoming traffic from available options.
    localGw string
    IPv4 address for the local gateway.
    remoteGw string
    IPv4 address for the remote gateway.
    autoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    name string
    IPIP Tunnel name.
    useSdwan string
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    interface str
    Interface name that is associated with the incoming traffic from available options.
    local_gw str
    IPv4 address for the local gateway.
    remote_gw str
    IPv4 address for the remote gateway.
    auto_asic_offload str
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    name str
    IPIP Tunnel name.
    use_sdwan str
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    interface String
    Interface name that is associated with the incoming traffic from available options.
    localGw String
    IPv4 address for the local gateway.
    remoteGw String
    IPv4 address for the remote gateway.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    name String
    IPIP Tunnel name.
    useSdwan String
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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 Ipiptunnel 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 Ipiptunnel Resource

    Get an existing Ipiptunnel 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?: IpiptunnelState, opts?: CustomResourceOptions): Ipiptunnel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_asic_offload: Optional[str] = None,
        interface: Optional[str] = None,
        local_gw: Optional[str] = None,
        name: Optional[str] = None,
        remote_gw: Optional[str] = None,
        use_sdwan: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Ipiptunnel
    func GetIpiptunnel(ctx *Context, name string, id IDInput, state *IpiptunnelState, opts ...ResourceOption) (*Ipiptunnel, error)
    public static Ipiptunnel Get(string name, Input<string> id, IpiptunnelState? state, CustomResourceOptions? opts = null)
    public static Ipiptunnel get(String name, Output<String> id, IpiptunnelState 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:
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    Interface string
    Interface name that is associated with the incoming traffic from available options.
    LocalGw string
    IPv4 address for the local gateway.
    Name string
    IPIP Tunnel name.
    RemoteGw string
    IPv4 address for the remote gateway.
    UseSdwan string
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    Interface string
    Interface name that is associated with the incoming traffic from available options.
    LocalGw string
    IPv4 address for the local gateway.
    Name string
    IPIP Tunnel name.
    RemoteGw string
    IPv4 address for the remote gateway.
    UseSdwan string
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    interface_ String
    Interface name that is associated with the incoming traffic from available options.
    localGw String
    IPv4 address for the local gateway.
    name String
    IPIP Tunnel name.
    remoteGw String
    IPv4 address for the remote gateway.
    useSdwan String
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    autoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    interface string
    Interface name that is associated with the incoming traffic from available options.
    localGw string
    IPv4 address for the local gateway.
    name string
    IPIP Tunnel name.
    remoteGw string
    IPv4 address for the remote gateway.
    useSdwan string
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    auto_asic_offload str
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    interface str
    Interface name that is associated with the incoming traffic from available options.
    local_gw str
    IPv4 address for the local gateway.
    name str
    IPIP Tunnel name.
    remote_gw str
    IPv4 address for the remote gateway.
    use_sdwan str
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    interface String
    Interface name that is associated with the incoming traffic from available options.
    localGw String
    IPv4 address for the local gateway.
    name String
    IPIP Tunnel name.
    remoteGw String
    IPv4 address for the remote gateway.
    useSdwan String
    Enable/disable use of SD-WAN to reach remote gateway. Valid values: disable, enable.
    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

    System IpipTunnel can be imported using any of these accepted formats:

    $ pulumi import fortios:system/ipiptunnel:Ipiptunnel labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

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