@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
257 lines (256 loc) • 8.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `f5bigip.NetTunnel` Manages a tunnel configuration
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const example1 = new f5bigip.NetTunnel("example1", {
* name: "example1",
* localAddress: "192.16.81.240",
* profile: "/Common/dslite",
* });
* ```
*/
export declare class NetTunnel extends pulumi.CustomResource {
/**
* Get an existing NetTunnel resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetTunnelState, opts?: pulumi.CustomResourceOptions): NetTunnel;
/**
* Returns true if the given object is an instance of NetTunnel. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NetTunnel;
/**
* The application service that the object belongs to
*/
readonly appService: pulumi.Output<string | undefined>;
/**
* Specifies whether auto lasthop is enabled or not
*/
readonly autoLastHop: pulumi.Output<string | undefined>;
/**
* User defined description
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies an idle timeout for wildcard tunnels in seconds
*/
readonly idleTimeout: pulumi.Output<number | undefined>;
/**
* The key field may represent different values depending on the type of the tunnel
*/
readonly key: pulumi.Output<number | undefined>;
/**
* Specifies a local IP address. This option is required
*/
readonly localAddress: pulumi.Output<string>;
/**
* Specifies how the tunnel carries traffic
*/
readonly mode: pulumi.Output<string | undefined>;
/**
* Specifies the maximum transmission unit (MTU) of the tunnel
*/
readonly mtu: pulumi.Output<number | undefined>;
/**
* Name of the tunnel
*/
readonly name: pulumi.Output<string>;
/**
* Displays the admin-partition within which this component resides
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* Specifies the profile that you want to associate with the tunnel
*/
readonly profile: pulumi.Output<string>;
/**
* Specifies a remote IP address
*/
readonly remoteAddress: pulumi.Output<string | undefined>;
/**
* Specifies a secondary non-floating IP address when the local-address is set to a floating address
*/
readonly secondaryAddress: pulumi.Output<string | undefined>;
/**
* Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
*/
readonly tos: pulumi.Output<string | undefined>;
/**
* Specifies a traffic-group for use with the tunnel
*/
readonly trafficGroup: pulumi.Output<string | undefined>;
/**
* Enables or disables the tunnel to be transparent
*/
readonly transparent: pulumi.Output<string | undefined>;
/**
* Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
*/
readonly usePmtu: pulumi.Output<string | undefined>;
/**
* Create a NetTunnel resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NetTunnelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NetTunnel resources.
*/
export interface NetTunnelState {
/**
* The application service that the object belongs to
*/
appService?: pulumi.Input<string>;
/**
* Specifies whether auto lasthop is enabled or not
*/
autoLastHop?: pulumi.Input<string>;
/**
* User defined description
*/
description?: pulumi.Input<string>;
/**
* Specifies an idle timeout for wildcard tunnels in seconds
*/
idleTimeout?: pulumi.Input<number>;
/**
* The key field may represent different values depending on the type of the tunnel
*/
key?: pulumi.Input<number>;
/**
* Specifies a local IP address. This option is required
*/
localAddress?: pulumi.Input<string>;
/**
* Specifies how the tunnel carries traffic
*/
mode?: pulumi.Input<string>;
/**
* Specifies the maximum transmission unit (MTU) of the tunnel
*/
mtu?: pulumi.Input<number>;
/**
* Name of the tunnel
*/
name?: pulumi.Input<string>;
/**
* Displays the admin-partition within which this component resides
*/
partition?: pulumi.Input<string>;
/**
* Specifies the profile that you want to associate with the tunnel
*/
profile?: pulumi.Input<string>;
/**
* Specifies a remote IP address
*/
remoteAddress?: pulumi.Input<string>;
/**
* Specifies a secondary non-floating IP address when the local-address is set to a floating address
*/
secondaryAddress?: pulumi.Input<string>;
/**
* Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
*/
tos?: pulumi.Input<string>;
/**
* Specifies a traffic-group for use with the tunnel
*/
trafficGroup?: pulumi.Input<string>;
/**
* Enables or disables the tunnel to be transparent
*/
transparent?: pulumi.Input<string>;
/**
* Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
*/
usePmtu?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NetTunnel resource.
*/
export interface NetTunnelArgs {
/**
* The application service that the object belongs to
*/
appService?: pulumi.Input<string>;
/**
* Specifies whether auto lasthop is enabled or not
*/
autoLastHop?: pulumi.Input<string>;
/**
* User defined description
*/
description?: pulumi.Input<string>;
/**
* Specifies an idle timeout for wildcard tunnels in seconds
*/
idleTimeout?: pulumi.Input<number>;
/**
* The key field may represent different values depending on the type of the tunnel
*/
key?: pulumi.Input<number>;
/**
* Specifies a local IP address. This option is required
*/
localAddress: pulumi.Input<string>;
/**
* Specifies how the tunnel carries traffic
*/
mode?: pulumi.Input<string>;
/**
* Specifies the maximum transmission unit (MTU) of the tunnel
*/
mtu?: pulumi.Input<number>;
/**
* Name of the tunnel
*/
name: pulumi.Input<string>;
/**
* Displays the admin-partition within which this component resides
*/
partition?: pulumi.Input<string>;
/**
* Specifies the profile that you want to associate with the tunnel
*/
profile: pulumi.Input<string>;
/**
* Specifies a remote IP address
*/
remoteAddress?: pulumi.Input<string>;
/**
* Specifies a secondary non-floating IP address when the local-address is set to a floating address
*/
secondaryAddress?: pulumi.Input<string>;
/**
* Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets
*/
tos?: pulumi.Input<string>;
/**
* Specifies a traffic-group for use with the tunnel
*/
trafficGroup?: pulumi.Input<string>;
/**
* Enables or disables the tunnel to be transparent
*/
transparent?: pulumi.Input<string>;
/**
* Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages
*/
usePmtu?: pulumi.Input<string>;
}