1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. NetTunnel
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi

f5bigip.NetTunnel

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi

    f5bigip.NetTunnel Manages a tunnel configuration

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const example1 = new f5bigip.NetTunnel("example1", {
        localAddress: "192.16.81.240",
        name: "example1",
        profile: "/Common/dslite",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    example1 = f5bigip.NetTunnel("example1",
        local_address="192.16.81.240",
        name="example1",
        profile="/Common/dslite")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := f5bigip.NewNetTunnel(ctx, "example1", &f5bigip.NetTunnelArgs{
    			LocalAddress: pulumi.String("192.16.81.240"),
    			Name:         pulumi.String("example1"),
    			Profile:      pulumi.String("/Common/dslite"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var example1 = new F5BigIP.NetTunnel("example1", new()
        {
            LocalAddress = "192.16.81.240",
            Name = "example1",
            Profile = "/Common/dslite",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.NetTunnel;
    import com.pulumi.f5bigip.NetTunnelArgs;
    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 example1 = new NetTunnel("example1", NetTunnelArgs.builder()        
                .localAddress("192.16.81.240")
                .name("example1")
                .profile("/Common/dslite")
                .build());
    
        }
    }
    
    resources:
      example1:
        type: f5bigip:NetTunnel
        properties:
          localAddress: 192.16.81.240
          name: example1
          profile: /Common/dslite
    

    Create NetTunnel Resource

    new NetTunnel(name: string, args: NetTunnelArgs, opts?: CustomResourceOptions);
    @overload
    def NetTunnel(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  app_service: Optional[str] = None,
                  auto_last_hop: Optional[str] = None,
                  description: Optional[str] = None,
                  idle_timeout: Optional[int] = None,
                  key: Optional[int] = None,
                  local_address: Optional[str] = None,
                  mode: Optional[str] = None,
                  mtu: Optional[int] = None,
                  name: Optional[str] = None,
                  partition: Optional[str] = None,
                  profile: Optional[str] = None,
                  remote_address: Optional[str] = None,
                  secondary_address: Optional[str] = None,
                  tos: Optional[str] = None,
                  traffic_group: Optional[str] = None,
                  transparent: Optional[str] = None,
                  use_pmtu: Optional[str] = None)
    @overload
    def NetTunnel(resource_name: str,
                  args: NetTunnelArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewNetTunnel(ctx *Context, name string, args NetTunnelArgs, opts ...ResourceOption) (*NetTunnel, error)
    public NetTunnel(string name, NetTunnelArgs args, CustomResourceOptions? opts = null)
    public NetTunnel(String name, NetTunnelArgs args)
    public NetTunnel(String name, NetTunnelArgs args, CustomResourceOptions options)
    
    type: f5bigip:NetTunnel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args NetTunnelArgs
    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 NetTunnelArgs
    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 NetTunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetTunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetTunnelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    NetTunnel Resource Properties

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

    Inputs

    The NetTunnel resource accepts the following input properties:

    LocalAddress string
    Specifies a local IP address. This option is required
    Name string
    Name of the tunnel
    Profile string
    Specifies the profile that you want to associate with the tunnel
    AppService string
    The application service that the object belongs to
    AutoLastHop string
    Specifies whether auto lasthop is enabled or not
    Description string
    User defined description
    IdleTimeout int
    Specifies an idle timeout for wildcard tunnels in seconds
    Key int
    The key field may represent different values depending on the type of the tunnel
    Mode string
    Specifies how the tunnel carries traffic
    Mtu int
    Specifies the maximum transmission unit (MTU) of the tunnel
    Partition string
    Displays the admin-partition within which this component resides
    RemoteAddress string
    Specifies a remote IP address
    SecondaryAddress string
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    Tos string
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    TrafficGroup string
    Specifies a traffic-group for use with the tunnel
    Transparent string
    Enables or disables the tunnel to be transparent
    UsePmtu string
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    LocalAddress string
    Specifies a local IP address. This option is required
    Name string
    Name of the tunnel
    Profile string
    Specifies the profile that you want to associate with the tunnel
    AppService string
    The application service that the object belongs to
    AutoLastHop string
    Specifies whether auto lasthop is enabled or not
    Description string
    User defined description
    IdleTimeout int
    Specifies an idle timeout for wildcard tunnels in seconds
    Key int
    The key field may represent different values depending on the type of the tunnel
    Mode string
    Specifies how the tunnel carries traffic
    Mtu int
    Specifies the maximum transmission unit (MTU) of the tunnel
    Partition string
    Displays the admin-partition within which this component resides
    RemoteAddress string
    Specifies a remote IP address
    SecondaryAddress string
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    Tos string
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    TrafficGroup string
    Specifies a traffic-group for use with the tunnel
    Transparent string
    Enables or disables the tunnel to be transparent
    UsePmtu string
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    localAddress String
    Specifies a local IP address. This option is required
    name String
    Name of the tunnel
    profile String
    Specifies the profile that you want to associate with the tunnel
    appService String
    The application service that the object belongs to
    autoLastHop String
    Specifies whether auto lasthop is enabled or not
    description String
    User defined description
    idleTimeout Integer
    Specifies an idle timeout for wildcard tunnels in seconds
    key Integer
    The key field may represent different values depending on the type of the tunnel
    mode String
    Specifies how the tunnel carries traffic
    mtu Integer
    Specifies the maximum transmission unit (MTU) of the tunnel
    partition String
    Displays the admin-partition within which this component resides
    remoteAddress String
    Specifies a remote IP address
    secondaryAddress String
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos String
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    trafficGroup String
    Specifies a traffic-group for use with the tunnel
    transparent String
    Enables or disables the tunnel to be transparent
    usePmtu String
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    localAddress string
    Specifies a local IP address. This option is required
    name string
    Name of the tunnel
    profile string
    Specifies the profile that you want to associate with the tunnel
    appService string
    The application service that the object belongs to
    autoLastHop string
    Specifies whether auto lasthop is enabled or not
    description string
    User defined description
    idleTimeout number
    Specifies an idle timeout for wildcard tunnels in seconds
    key number
    The key field may represent different values depending on the type of the tunnel
    mode string
    Specifies how the tunnel carries traffic
    mtu number
    Specifies the maximum transmission unit (MTU) of the tunnel
    partition string
    Displays the admin-partition within which this component resides
    remoteAddress string
    Specifies a remote IP address
    secondaryAddress string
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos string
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    trafficGroup string
    Specifies a traffic-group for use with the tunnel
    transparent string
    Enables or disables the tunnel to be transparent
    usePmtu string
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    local_address str
    Specifies a local IP address. This option is required
    name str
    Name of the tunnel
    profile str
    Specifies the profile that you want to associate with the tunnel
    app_service str
    The application service that the object belongs to
    auto_last_hop str
    Specifies whether auto lasthop is enabled or not
    description str
    User defined description
    idle_timeout int
    Specifies an idle timeout for wildcard tunnels in seconds
    key int
    The key field may represent different values depending on the type of the tunnel
    mode str
    Specifies how the tunnel carries traffic
    mtu int
    Specifies the maximum transmission unit (MTU) of the tunnel
    partition str
    Displays the admin-partition within which this component resides
    remote_address str
    Specifies a remote IP address
    secondary_address str
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos str
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    traffic_group str
    Specifies a traffic-group for use with the tunnel
    transparent str
    Enables or disables the tunnel to be transparent
    use_pmtu str
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    localAddress String
    Specifies a local IP address. This option is required
    name String
    Name of the tunnel
    profile String
    Specifies the profile that you want to associate with the tunnel
    appService String
    The application service that the object belongs to
    autoLastHop String
    Specifies whether auto lasthop is enabled or not
    description String
    User defined description
    idleTimeout Number
    Specifies an idle timeout for wildcard tunnels in seconds
    key Number
    The key field may represent different values depending on the type of the tunnel
    mode String
    Specifies how the tunnel carries traffic
    mtu Number
    Specifies the maximum transmission unit (MTU) of the tunnel
    partition String
    Displays the admin-partition within which this component resides
    remoteAddress String
    Specifies a remote IP address
    secondaryAddress String
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos String
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    trafficGroup String
    Specifies a traffic-group for use with the tunnel
    transparent String
    Enables or disables the tunnel to be transparent
    usePmtu String
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages

    Outputs

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

    Get an existing NetTunnel 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?: NetTunnelState, opts?: CustomResourceOptions): NetTunnel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_service: Optional[str] = None,
            auto_last_hop: Optional[str] = None,
            description: Optional[str] = None,
            idle_timeout: Optional[int] = None,
            key: Optional[int] = None,
            local_address: Optional[str] = None,
            mode: Optional[str] = None,
            mtu: Optional[int] = None,
            name: Optional[str] = None,
            partition: Optional[str] = None,
            profile: Optional[str] = None,
            remote_address: Optional[str] = None,
            secondary_address: Optional[str] = None,
            tos: Optional[str] = None,
            traffic_group: Optional[str] = None,
            transparent: Optional[str] = None,
            use_pmtu: Optional[str] = None) -> NetTunnel
    func GetNetTunnel(ctx *Context, name string, id IDInput, state *NetTunnelState, opts ...ResourceOption) (*NetTunnel, error)
    public static NetTunnel Get(string name, Input<string> id, NetTunnelState? state, CustomResourceOptions? opts = null)
    public static NetTunnel get(String name, Output<String> id, NetTunnelState 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:
    AppService string
    The application service that the object belongs to
    AutoLastHop string
    Specifies whether auto lasthop is enabled or not
    Description string
    User defined description
    IdleTimeout int
    Specifies an idle timeout for wildcard tunnels in seconds
    Key int
    The key field may represent different values depending on the type of the tunnel
    LocalAddress string
    Specifies a local IP address. This option is required
    Mode string
    Specifies how the tunnel carries traffic
    Mtu int
    Specifies the maximum transmission unit (MTU) of the tunnel
    Name string
    Name of the tunnel
    Partition string
    Displays the admin-partition within which this component resides
    Profile string
    Specifies the profile that you want to associate with the tunnel
    RemoteAddress string
    Specifies a remote IP address
    SecondaryAddress string
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    Tos string
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    TrafficGroup string
    Specifies a traffic-group for use with the tunnel
    Transparent string
    Enables or disables the tunnel to be transparent
    UsePmtu string
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    AppService string
    The application service that the object belongs to
    AutoLastHop string
    Specifies whether auto lasthop is enabled or not
    Description string
    User defined description
    IdleTimeout int
    Specifies an idle timeout for wildcard tunnels in seconds
    Key int
    The key field may represent different values depending on the type of the tunnel
    LocalAddress string
    Specifies a local IP address. This option is required
    Mode string
    Specifies how the tunnel carries traffic
    Mtu int
    Specifies the maximum transmission unit (MTU) of the tunnel
    Name string
    Name of the tunnel
    Partition string
    Displays the admin-partition within which this component resides
    Profile string
    Specifies the profile that you want to associate with the tunnel
    RemoteAddress string
    Specifies a remote IP address
    SecondaryAddress string
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    Tos string
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    TrafficGroup string
    Specifies a traffic-group for use with the tunnel
    Transparent string
    Enables or disables the tunnel to be transparent
    UsePmtu string
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    appService String
    The application service that the object belongs to
    autoLastHop String
    Specifies whether auto lasthop is enabled or not
    description String
    User defined description
    idleTimeout Integer
    Specifies an idle timeout for wildcard tunnels in seconds
    key Integer
    The key field may represent different values depending on the type of the tunnel
    localAddress String
    Specifies a local IP address. This option is required
    mode String
    Specifies how the tunnel carries traffic
    mtu Integer
    Specifies the maximum transmission unit (MTU) of the tunnel
    name String
    Name of the tunnel
    partition String
    Displays the admin-partition within which this component resides
    profile String
    Specifies the profile that you want to associate with the tunnel
    remoteAddress String
    Specifies a remote IP address
    secondaryAddress String
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos String
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    trafficGroup String
    Specifies a traffic-group for use with the tunnel
    transparent String
    Enables or disables the tunnel to be transparent
    usePmtu String
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    appService string
    The application service that the object belongs to
    autoLastHop string
    Specifies whether auto lasthop is enabled or not
    description string
    User defined description
    idleTimeout number
    Specifies an idle timeout for wildcard tunnels in seconds
    key number
    The key field may represent different values depending on the type of the tunnel
    localAddress string
    Specifies a local IP address. This option is required
    mode string
    Specifies how the tunnel carries traffic
    mtu number
    Specifies the maximum transmission unit (MTU) of the tunnel
    name string
    Name of the tunnel
    partition string
    Displays the admin-partition within which this component resides
    profile string
    Specifies the profile that you want to associate with the tunnel
    remoteAddress string
    Specifies a remote IP address
    secondaryAddress string
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos string
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    trafficGroup string
    Specifies a traffic-group for use with the tunnel
    transparent string
    Enables or disables the tunnel to be transparent
    usePmtu string
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    app_service str
    The application service that the object belongs to
    auto_last_hop str
    Specifies whether auto lasthop is enabled or not
    description str
    User defined description
    idle_timeout int
    Specifies an idle timeout for wildcard tunnels in seconds
    key int
    The key field may represent different values depending on the type of the tunnel
    local_address str
    Specifies a local IP address. This option is required
    mode str
    Specifies how the tunnel carries traffic
    mtu int
    Specifies the maximum transmission unit (MTU) of the tunnel
    name str
    Name of the tunnel
    partition str
    Displays the admin-partition within which this component resides
    profile str
    Specifies the profile that you want to associate with the tunnel
    remote_address str
    Specifies a remote IP address
    secondary_address str
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos str
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    traffic_group str
    Specifies a traffic-group for use with the tunnel
    transparent str
    Enables or disables the tunnel to be transparent
    use_pmtu str
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
    appService String
    The application service that the object belongs to
    autoLastHop String
    Specifies whether auto lasthop is enabled or not
    description String
    User defined description
    idleTimeout Number
    Specifies an idle timeout for wildcard tunnels in seconds
    key Number
    The key field may represent different values depending on the type of the tunnel
    localAddress String
    Specifies a local IP address. This option is required
    mode String
    Specifies how the tunnel carries traffic
    mtu Number
    Specifies the maximum transmission unit (MTU) of the tunnel
    name String
    Name of the tunnel
    partition String
    Displays the admin-partition within which this component resides
    profile String
    Specifies the profile that you want to associate with the tunnel
    remoteAddress String
    Specifies a remote IP address
    secondaryAddress String
    Specifies a secondary non-floating IP address when the local-address is set to a floating address
    tos String
    Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
    trafficGroup String
    Specifies a traffic-group for use with the tunnel
    transparent String
    Enables or disables the tunnel to be transparent
    usePmtu String
    Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi