TunnelInterface resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
//
// Creates a tunnel interface with static ipv4 address
//
const scmTunnelIntf = new scm.TunnelInterface("scm_tunnel_intf", {
name: "$scm_tunnel_intf",
comment: "Managed by Pulumi",
folder: "ngfw-shared",
ips: [{
name: "198.18.1.1/32",
}],
});
//
// Creates a tunnel interface with static ipv4 address, with default value tunnel.123
//
const scmTunnelIntf2 = new scm.TunnelInterface("scm_tunnel_intf_2", {
name: "$scm_tunnel_intf_2",
comment: "Managed by Pulumi",
folder: "ngfw-shared",
ips: [{
name: "198.18.1.2/32",
}],
});
import pulumi
import pulumi_scm as scm
#
# Creates a tunnel interface with static ipv4 address
#
scm_tunnel_intf = scm.TunnelInterface("scm_tunnel_intf",
name="$scm_tunnel_intf",
comment="Managed by Pulumi",
folder="ngfw-shared",
ips=[{
"name": "198.18.1.1/32",
}])
#
# Creates a tunnel interface with static ipv4 address, with default value tunnel.123
#
scm_tunnel_intf2 = scm.TunnelInterface("scm_tunnel_intf_2",
name="$scm_tunnel_intf_2",
comment="Managed by Pulumi",
folder="ngfw-shared",
ips=[{
"name": "198.18.1.2/32",
}])
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Creates a tunnel interface with static ipv4 address
_, err := scm.NewTunnelInterface(ctx, "scm_tunnel_intf", &scm.TunnelInterfaceArgs{
Name: pulumi.String("$scm_tunnel_intf"),
Comment: pulumi.String("Managed by Pulumi"),
Folder: pulumi.String("ngfw-shared"),
Ips: scm.TunnelInterfaceIpArray{
&scm.TunnelInterfaceIpArgs{
Name: pulumi.String("198.18.1.1/32"),
},
},
})
if err != nil {
return err
}
// Creates a tunnel interface with static ipv4 address, with default value tunnel.123
_, err = scm.NewTunnelInterface(ctx, "scm_tunnel_intf_2", &scm.TunnelInterfaceArgs{
Name: pulumi.String("$scm_tunnel_intf_2"),
Comment: pulumi.String("Managed by Pulumi"),
Folder: pulumi.String("ngfw-shared"),
Ips: scm.TunnelInterfaceIpArray{
&scm.TunnelInterfaceIpArgs{
Name: pulumi.String("198.18.1.2/32"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
//
// Creates a tunnel interface with static ipv4 address
//
var scmTunnelIntf = new Scm.TunnelInterface("scm_tunnel_intf", new()
{
Name = "$scm_tunnel_intf",
Comment = "Managed by Pulumi",
Folder = "ngfw-shared",
Ips = new[]
{
new Scm.Inputs.TunnelInterfaceIpArgs
{
Name = "198.18.1.1/32",
},
},
});
//
// Creates a tunnel interface with static ipv4 address, with default value tunnel.123
//
var scmTunnelIntf2 = new Scm.TunnelInterface("scm_tunnel_intf_2", new()
{
Name = "$scm_tunnel_intf_2",
Comment = "Managed by Pulumi",
Folder = "ngfw-shared",
Ips = new[]
{
new Scm.Inputs.TunnelInterfaceIpArgs
{
Name = "198.18.1.2/32",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.TunnelInterface;
import com.pulumi.scm.TunnelInterfaceArgs;
import com.pulumi.scm.inputs.TunnelInterfaceIpArgs;
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) {
//
// Creates a tunnel interface with static ipv4 address
//
var scmTunnelIntf = new TunnelInterface("scmTunnelIntf", TunnelInterfaceArgs.builder()
.name("$scm_tunnel_intf")
.comment("Managed by Pulumi")
.folder("ngfw-shared")
.ips(TunnelInterfaceIpArgs.builder()
.name("198.18.1.1/32")
.build())
.build());
//
// Creates a tunnel interface with static ipv4 address, with default value tunnel.123
//
var scmTunnelIntf2 = new TunnelInterface("scmTunnelIntf2", TunnelInterfaceArgs.builder()
.name("$scm_tunnel_intf_2")
.comment("Managed by Pulumi")
.folder("ngfw-shared")
.ips(TunnelInterfaceIpArgs.builder()
.name("198.18.1.2/32")
.build())
.build());
}
}
resources:
#
# Creates a tunnel interface with static ipv4 address
#
scmTunnelIntf:
type: scm:TunnelInterface
name: scm_tunnel_intf
properties:
name: $scm_tunnel_intf
comment: Managed by Pulumi
folder: ngfw-shared
ips:
- name: 198.18.1.1/32
#
# Creates a tunnel interface with static ipv4 address, with default value tunnel.123
#
scmTunnelIntf2:
type: scm:TunnelInterface
name: scm_tunnel_intf_2
properties:
name: $scm_tunnel_intf_2
comment: Managed by Pulumi
folder: ngfw-shared
ips:
- name: 198.18.1.2/32
Create TunnelInterface Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TunnelInterface(name: string, args?: TunnelInterfaceArgs, opts?: CustomResourceOptions);@overload
def TunnelInterface(resource_name: str,
args: Optional[TunnelInterfaceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def TunnelInterface(resource_name: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
default_value: Optional[str] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
interface_management_profile: Optional[str] = None,
ips: Optional[Sequence[TunnelInterfaceIpArgs]] = None,
mtu: Optional[int] = None,
name: Optional[str] = None,
snippet: Optional[str] = None)func NewTunnelInterface(ctx *Context, name string, args *TunnelInterfaceArgs, opts ...ResourceOption) (*TunnelInterface, error)public TunnelInterface(string name, TunnelInterfaceArgs? args = null, CustomResourceOptions? opts = null)
public TunnelInterface(String name, TunnelInterfaceArgs args)
public TunnelInterface(String name, TunnelInterfaceArgs args, CustomResourceOptions options)
type: scm:TunnelInterface
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 TunnelInterfaceArgs
- 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 TunnelInterfaceArgs
- 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 TunnelInterfaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TunnelInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TunnelInterfaceArgs
- 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 tunnelInterfaceResource = new Scm.TunnelInterface("tunnelInterfaceResource", new()
{
Comment = "string",
DefaultValue = "string",
Device = "string",
Folder = "string",
InterfaceManagementProfile = "string",
Ips = new[]
{
new Scm.Inputs.TunnelInterfaceIpArgs
{
Name = "string",
},
},
Mtu = 0,
Name = "string",
Snippet = "string",
});
example, err := scm.NewTunnelInterface(ctx, "tunnelInterfaceResource", &scm.TunnelInterfaceArgs{
Comment: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
InterfaceManagementProfile: pulumi.String("string"),
Ips: scm.TunnelInterfaceIpArray{
&scm.TunnelInterfaceIpArgs{
Name: pulumi.String("string"),
},
},
Mtu: pulumi.Int(0),
Name: pulumi.String("string"),
Snippet: pulumi.String("string"),
})
var tunnelInterfaceResource = new TunnelInterface("tunnelInterfaceResource", TunnelInterfaceArgs.builder()
.comment("string")
.defaultValue("string")
.device("string")
.folder("string")
.interfaceManagementProfile("string")
.ips(TunnelInterfaceIpArgs.builder()
.name("string")
.build())
.mtu(0)
.name("string")
.snippet("string")
.build());
tunnel_interface_resource = scm.TunnelInterface("tunnelInterfaceResource",
comment="string",
default_value="string",
device="string",
folder="string",
interface_management_profile="string",
ips=[{
"name": "string",
}],
mtu=0,
name="string",
snippet="string")
const tunnelInterfaceResource = new scm.TunnelInterface("tunnelInterfaceResource", {
comment: "string",
defaultValue: "string",
device: "string",
folder: "string",
interfaceManagementProfile: "string",
ips: [{
name: "string",
}],
mtu: 0,
name: "string",
snippet: "string",
});
type: scm:TunnelInterface
properties:
comment: string
defaultValue: string
device: string
folder: string
interfaceManagementProfile: string
ips:
- name: string
mtu: 0
name: string
snippet: string
TunnelInterface 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 TunnelInterface resource accepts the following input properties:
- Comment string
- Description
- Default
Value string - Default interface assignment
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Interface
Management stringProfile - Interface management profile
- Ips
List<Tunnel
Interface Ip> - Tunnel Interface IP Parent
- Mtu int
- MTU
- Name string
- L3 sub-interface name
- Snippet string
- The snippet in which the resource is defined
- Comment string
- Description
- Default
Value string - Default interface assignment
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Interface
Management stringProfile - Interface management profile
- Ips
[]Tunnel
Interface Ip Args - Tunnel Interface IP Parent
- Mtu int
- MTU
- Name string
- L3 sub-interface name
- Snippet string
- The snippet in which the resource is defined
- comment String
- Description
- default
Value String - Default interface assignment
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- interface
Management StringProfile - Interface management profile
- ips
List<Tunnel
Interface Ip> - Tunnel Interface IP Parent
- mtu Integer
- MTU
- name String
- L3 sub-interface name
- snippet String
- The snippet in which the resource is defined
- comment string
- Description
- default
Value string - Default interface assignment
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- interface
Management stringProfile - Interface management profile
- ips
Tunnel
Interface Ip[] - Tunnel Interface IP Parent
- mtu number
- MTU
- name string
- L3 sub-interface name
- snippet string
- The snippet in which the resource is defined
- comment str
- Description
- default_
value str - Default interface assignment
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- interface_
management_ strprofile - Interface management profile
- ips
Sequence[Tunnel
Interface Ip Args] - Tunnel Interface IP Parent
- mtu int
- MTU
- name str
- L3 sub-interface name
- snippet str
- The snippet in which the resource is defined
- comment String
- Description
- default
Value String - Default interface assignment
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- interface
Management StringProfile - Interface management profile
- ips List<Property Map>
- Tunnel Interface IP Parent
- mtu Number
- MTU
- name String
- L3 sub-interface name
- snippet String
- The snippet in which the resource is defined
Outputs
All input properties are implicitly available as output properties. Additionally, the TunnelInterface resource produces the following output properties:
Look up Existing TunnelInterface Resource
Get an existing TunnelInterface 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?: TunnelInterfaceState, opts?: CustomResourceOptions): TunnelInterface@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
default_value: Optional[str] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
interface_management_profile: Optional[str] = None,
ips: Optional[Sequence[TunnelInterfaceIpArgs]] = None,
mtu: Optional[int] = None,
name: Optional[str] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> TunnelInterfacefunc GetTunnelInterface(ctx *Context, name string, id IDInput, state *TunnelInterfaceState, opts ...ResourceOption) (*TunnelInterface, error)public static TunnelInterface Get(string name, Input<string> id, TunnelInterfaceState? state, CustomResourceOptions? opts = null)public static TunnelInterface get(String name, Output<String> id, TunnelInterfaceState state, CustomResourceOptions options)resources: _: type: scm:TunnelInterface get: id: ${id}- 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.
- Comment string
- Description
- Default
Value string - Default interface assignment
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Interface
Management stringProfile - Interface management profile
- Ips
List<Tunnel
Interface Ip> - Tunnel Interface IP Parent
- Mtu int
- MTU
- Name string
- L3 sub-interface name
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- Comment string
- Description
- Default
Value string - Default interface assignment
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Interface
Management stringProfile - Interface management profile
- Ips
[]Tunnel
Interface Ip Args - Tunnel Interface IP Parent
- Mtu int
- MTU
- Name string
- L3 sub-interface name
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- comment String
- Description
- default
Value String - Default interface assignment
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- interface
Management StringProfile - Interface management profile
- ips
List<Tunnel
Interface Ip> - Tunnel Interface IP Parent
- mtu Integer
- MTU
- name String
- L3 sub-interface name
- snippet String
- The snippet in which the resource is defined
- tfid String
- comment string
- Description
- default
Value string - Default interface assignment
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- interface
Management stringProfile - Interface management profile
- ips
Tunnel
Interface Ip[] - Tunnel Interface IP Parent
- mtu number
- MTU
- name string
- L3 sub-interface name
- snippet string
- The snippet in which the resource is defined
- tfid string
- comment str
- Description
- default_
value str - Default interface assignment
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- interface_
management_ strprofile - Interface management profile
- ips
Sequence[Tunnel
Interface Ip Args] - Tunnel Interface IP Parent
- mtu int
- MTU
- name str
- L3 sub-interface name
- snippet str
- The snippet in which the resource is defined
- tfid str
- comment String
- Description
- default
Value String - Default interface assignment
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- interface
Management StringProfile - Interface management profile
- ips List<Property Map>
- Tunnel Interface IP Parent
- mtu Number
- MTU
- name String
- L3 sub-interface name
- snippet String
- The snippet in which the resource is defined
- tfid String
Supporting Types
TunnelInterfaceIp, TunnelInterfaceIpArgs
- Name string
- Tunnel Interface IP address(es)
- Name string
- Tunnel Interface IP address(es)
- name String
- Tunnel Interface IP address(es)
- name string
- Tunnel Interface IP address(es)
- name str
- Tunnel Interface IP address(es)
- name String
- Tunnel Interface IP address(es)
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
