NetTunnel

f5bigip.NetTunnel Manages a tunnel configuration

Example Usage

using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

class MyStack : Stack
{
    public MyStack()
    {
        var example1 = new F5BigIP.NetTunnel("example1", new F5BigIP.NetTunnelArgs
        {
            LocalAddress = "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
	})
}
import pulumi
import pulumi_f5bigip as f5bigip

example1 = f5bigip.NetTunnel("example1",
    local_address="192.16.81.240",
    name="example1",
    profile="/Common/dslite")
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",
});

Create a 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)
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.

NetTunnel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 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

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 str
The provider-assigned unique ID for this managed resource.

Look up an 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)
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.

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 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

Package Details

Repository
https://github.com/pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.