Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Juniper Mist Provider
  4. API Docs
  5. org
  6. Mxtunnel
Viewing docs for Juniper Mist v0.11.1
published on Friday, Jul 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-junipermist

junipermist.org.Mxtunnel

junipermist logo
Viewing docs for Juniper Mist v0.11.1
published on Friday, Jul 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-junipermist

    This resource manages Mist Tunnels in the Mist Organization.

    A Mist Tunnel (MxTunnel) defines tunneling configuration used to carry AP user VLANs to Mist Edge clusters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as junipermist from "@pulumi/juniper-mist";

const mxtunnelOne = new junipermist.org.Mxtunnel("mxtunnel_one", {
    orgId: terraformTest.id,
    name: "mxtunnel_one",
    protocol: "udp",
    helloInterval: 60,
    helloRetries: 7,
    mtu: 0,
    vlanIds: [
        10,
        20,
        30,
    ],
    mxclusterIds: [mxclusterOne.id],
    autoPreemption: {
        enabled: true,
        dayOfWeek: "mon",
        timeOfDay: "02:00",
    },
    ipsec: {
        enabled: true,
        splitTunnel: true,
        useMxedge: true,
        dnsServers: [
            "8.8.8.8",
            "8.8.4.4",
        ],
        dnsSuffixes: ["corp.example.com"],
        extraRoutes: [{
            dest: "10.0.0.0/8",
            nextHop: "192.168.1.1",
        }],
    },
});

    import pulumi
import pulumi_juniper_mist as junipermist

mxtunnel_one = junipermist.org.Mxtunnel("mxtunnel_one",
    org_id=terraform_test["id"],
    name="mxtunnel_one",
    protocol="udp",
    hello_interval=60,
    hello_retries=7,
    mtu=0,
    vlan_ids=[
        10,
        20,
        30,
    ],
    mxcluster_ids=[mxcluster_one["id"]],
    auto_preemption={
        "enabled": True,
        "day_of_week": "mon",
        "time_of_day": "02:00",
    },
    ipsec={
        "enabled": True,
        "split_tunnel": True,
        "use_mxedge": True,
        "dns_servers": [
            "8.8.8.8",
            "8.8.4.4",
        ],
        "dns_suffixes": ["corp.example.com"],
        "extra_routes": [{
            "dest": "10.0.0.0/8",
            "next_hop": "192.168.1.1",
        }],
    })

    package main

import (
	"github.com/pulumi/pulumi-junipermist/sdk/go/junipermist/org"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := org.NewMxtunnel(ctx, "mxtunnel_one", &org.MxtunnelArgs{
			OrgId:         pulumi.Any(terraformTest.Id),
			Name:          pulumi.String("mxtunnel_one"),
			Protocol:      pulumi.String("udp"),
			HelloInterval: pulumi.Int(60),
			HelloRetries:  pulumi.Int(7),
			Mtu:           pulumi.Int(0),
			VlanIds: pulumi.IntArray{
				pulumi.Int(10),
				pulumi.Int(20),
				pulumi.Int(30),
			},
			MxclusterIds: pulumi.StringArray{
				mxclusterOne.Id,
			},
			AutoPreemption: &org.MxtunnelAutoPreemptionArgs{
				Enabled:   pulumi.Bool(true),
				DayOfWeek: pulumi.String("mon"),
				TimeOfDay: pulumi.String("02:00"),
			},
			Ipsec: &org.MxtunnelIpsecArgs{
				Enabled:     pulumi.Bool(true),
				SplitTunnel: pulumi.Bool(true),
				UseMxedge:   pulumi.Bool(true),
				DnsServers: pulumi.StringArray{
					pulumi.String("8.8.8.8"),
					pulumi.String("8.8.4.4"),
				},
				DnsSuffixes: pulumi.StringArray{
					pulumi.String("corp.example.com"),
				},
				ExtraRoutes: org.MxtunnelIpsecExtraRouteArray{
					&org.MxtunnelIpsecExtraRouteArgs{
						Dest:    pulumi.String("10.0.0.0/8"),
						NextHop: pulumi.String("192.168.1.1"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using JuniperMist = Pulumi.JuniperMist;

return await Deployment.RunAsync(() => 
{
    var mxtunnelOne = new JuniperMist.Org.Mxtunnel("mxtunnel_one", new()
    {
        OrgId = terraformTest.Id,
        Name = "mxtunnel_one",
        Protocol = "udp",
        HelloInterval = 60,
        HelloRetries = 7,
        Mtu = 0,
        VlanIds = new[]
        {
            10,
            20,
            30,
        },
        MxclusterIds = new[]
        {
            mxclusterOne.Id,
        },
        AutoPreemption = new JuniperMist.Org.Inputs.MxtunnelAutoPreemptionArgs
        {
            Enabled = true,
            DayOfWeek = "mon",
            TimeOfDay = "02:00",
        },
        Ipsec = new JuniperMist.Org.Inputs.MxtunnelIpsecArgs
        {
            Enabled = true,
            SplitTunnel = true,
            UseMxedge = true,
            DnsServers = new[]
            {
                "8.8.8.8",
                "8.8.4.4",
            },
            DnsSuffixes = new[]
            {
                "corp.example.com",
            },
            ExtraRoutes = new[]
            {
                new JuniperMist.Org.Inputs.MxtunnelIpsecExtraRouteArgs
                {
                    Dest = "10.0.0.0/8",
                    NextHop = "192.168.1.1",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.junipermist.org.Mxtunnel;
import com.pulumi.junipermist.org.MxtunnelArgs;
import com.pulumi.junipermist.org.inputs.MxtunnelAutoPreemptionArgs;
import com.pulumi.junipermist.org.inputs.MxtunnelIpsecArgs;
import com.pulumi.junipermist.org.inputs.MxtunnelIpsecExtraRouteArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 mxtunnelOne = new Mxtunnel("mxtunnelOne", MxtunnelArgs.builder()
            .orgId(terraformTest.id())
            .name("mxtunnel_one")
            .protocol("udp")
            .helloInterval(60)
            .helloRetries(7)
            .mtu(0)
            .vlanIds(            
                10,
                20,
                30)
            .mxclusterIds(mxclusterOne.id())
            .autoPreemption(MxtunnelAutoPreemptionArgs.builder()
                .enabled(true)
                .dayOfWeek("mon")
                .timeOfDay("02:00")
                .build())
            .ipsec(MxtunnelIpsecArgs.builder()
                .enabled(true)
                .splitTunnel(true)
                .useMxedge(true)
                .dnsServers(                
                    "8.8.8.8",
                    "8.8.4.4")
                .dnsSuffixes("corp.example.com")
                .extraRoutes(MxtunnelIpsecExtraRouteArgs.builder()
                    .dest("10.0.0.0/8")
                    .nextHop("192.168.1.1")
                    .build())
                .build())
            .build());

    }
}

    resources:
  mxtunnelOne:
    type: junipermist:org:Mxtunnel
    name: mxtunnel_one
    properties:
      orgId: ${terraformTest.id}
      name: mxtunnel_one
      protocol: udp
      helloInterval: 60
      helloRetries: 7
      mtu: 0
      vlanIds:
        - 10
        - 20
        - 30
      mxclusterIds:
        - ${mxclusterOne.id}
      autoPreemption:
        enabled: true
        dayOfWeek: mon
        timeOfDay: 02:00
      ipsec:
        enabled: true
        splitTunnel: true
        useMxedge: true
        dnsServers:
          - 8.8.8.8
          - 8.8.4.4
        dnsSuffixes:
          - corp.example.com
        extraRoutes:
          - dest: 10.0.0.0/8
            nextHop: 192.168.1.1

    pulumi {
  required_providers {
    junipermist = {
      source = "pulumi/junipermist"
    }
  }
}

resource "junipermist_org_mxtunnel" "mxtunnel_one" {
  org_id         = terraformTest.id
  name           = "mxtunnel_one"
  protocol       = "udp"
  hello_interval = 60
  hello_retries  = 7
  mtu            = 0
  vlan_ids       = [10, 20, 30]
  mxcluster_ids  = [mxclusterOne.id]
  auto_preemption = {
    enabled     = true
    day_of_week = "mon"
    time_of_day = "02:00"
  }
  ipsec = {
    enabled      = true
    split_tunnel = true
    use_mxedge   = true
    dns_servers  = ["8.8.8.8", "8.8.4.4"]
    dns_suffixes = ["corp.example.com"]
    extra_routes = [{
      "dest"    = "10.0.0.0/8"
      "nextHop" = "192.168.1.1"
    }]
  }
}

    Create Mxtunnel Resource

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

    Constructor syntax

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

@overload
def Mxtunnel(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             org_id: Optional[str] = None,
             anchor_mxtunnel_ids: Optional[Sequence[str]] = None,
             auto_preemption: Optional[MxtunnelAutoPreemptionArgs] = None,
             hello_interval: Optional[int] = None,
             hello_retries: Optional[int] = None,
             ipsec: Optional[MxtunnelIpsecArgs] = None,
             mtu: Optional[int] = None,
             mxcluster_ids: Optional[Sequence[str]] = None,
             name: Optional[str] = None,
             protocol: Optional[str] = None,
             vlan_ids: Optional[Sequence[int]] = None)
    func NewMxtunnel(ctx *Context, name string, args MxtunnelArgs, opts ...ResourceOption) (*Mxtunnel, error)
    public Mxtunnel(string name, MxtunnelArgs args, CustomResourceOptions? opts = null)
    public Mxtunnel(String name, MxtunnelArgs args)
public Mxtunnel(String name, MxtunnelArgs args, CustomResourceOptions options)

    type: junipermist:org:Mxtunnel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "junipermist_org_mxtunnel" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args MxtunnelArgs
    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 MxtunnelArgs
    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 MxtunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MxtunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MxtunnelArgs
    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 mxtunnelResource = new JuniperMist.Org.Mxtunnel("mxtunnelResource", new()
{
    OrgId = "string",
    AnchorMxtunnelIds = new[]
    {
        "string",
    },
    AutoPreemption = new JuniperMist.Org.Inputs.MxtunnelAutoPreemptionArgs
    {
        DayOfWeek = "string",
        Enabled = false,
        TimeOfDay = "string",
    },
    HelloInterval = 0,
    HelloRetries = 0,
    Ipsec = new JuniperMist.Org.Inputs.MxtunnelIpsecArgs
    {
        DnsServers = new[]
        {
            "string",
        },
        DnsSuffixes = new[]
        {
            "string",
        },
        Enabled = false,
        ExtraRoutes = new[]
        {
            new JuniperMist.Org.Inputs.MxtunnelIpsecExtraRouteArgs
            {
                Dest = "string",
                NextHop = "string",
            },
        },
        SplitTunnel = false,
        UseMxedge = false,
    },
    Mtu = 0,
    MxclusterIds = new[]
    {
        "string",
    },
    Name = "string",
    Protocol = "string",
    VlanIds = new[]
    {
        0,
    },
});

    example, err := org.NewMxtunnel(ctx, "mxtunnelResource", &org.MxtunnelArgs{
	OrgId: pulumi.String("string"),
	AnchorMxtunnelIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	AutoPreemption: &org.MxtunnelAutoPreemptionArgs{
		DayOfWeek: pulumi.String("string"),
		Enabled:   pulumi.Bool(false),
		TimeOfDay: pulumi.String("string"),
	},
	HelloInterval: pulumi.Int(0),
	HelloRetries:  pulumi.Int(0),
	Ipsec: &org.MxtunnelIpsecArgs{
		DnsServers: pulumi.StringArray{
			pulumi.String("string"),
		},
		DnsSuffixes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Enabled: pulumi.Bool(false),
		ExtraRoutes: org.MxtunnelIpsecExtraRouteArray{
			&org.MxtunnelIpsecExtraRouteArgs{
				Dest:    pulumi.String("string"),
				NextHop: pulumi.String("string"),
			},
		},
		SplitTunnel: pulumi.Bool(false),
		UseMxedge:   pulumi.Bool(false),
	},
	Mtu: pulumi.Int(0),
	MxclusterIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	Protocol: pulumi.String("string"),
	VlanIds: pulumi.IntArray{
		pulumi.Int(0),
	},
})

    resource "junipermist_org_mxtunnel" "mxtunnelResource" {
  org_id              = "string"
  anchor_mxtunnel_ids = ["string"]
  auto_preemption = {
    day_of_week = "string"
    enabled     = false
    time_of_day = "string"
  }
  hello_interval = 0
  hello_retries  = 0
  ipsec = {
    dns_servers  = ["string"]
    dns_suffixes = ["string"]
    enabled      = false
    extra_routes = [{
      "dest"    = "string"
      "nextHop" = "string"
    }]
    split_tunnel = false
    use_mxedge   = false
  }
  mtu           = 0
  mxcluster_ids = ["string"]
  name          = "string"
  protocol      = "string"
  vlan_ids      = [0]
}

    var mxtunnelResource = new Mxtunnel("mxtunnelResource", MxtunnelArgs.builder()
    .orgId("string")
    .anchorMxtunnelIds("string")
    .autoPreemption(MxtunnelAutoPreemptionArgs.builder()
        .dayOfWeek("string")
        .enabled(false)
        .timeOfDay("string")
        .build())
    .helloInterval(0)
    .helloRetries(0)
    .ipsec(MxtunnelIpsecArgs.builder()
        .dnsServers("string")
        .dnsSuffixes("string")
        .enabled(false)
        .extraRoutes(MxtunnelIpsecExtraRouteArgs.builder()
            .dest("string")
            .nextHop("string")
            .build())
        .splitTunnel(false)
        .useMxedge(false)
        .build())
    .mtu(0)
    .mxclusterIds("string")
    .name("string")
    .protocol("string")
    .vlanIds(0)
    .build());

    mxtunnel_resource = junipermist.org.Mxtunnel("mxtunnelResource",
    org_id="string",
    anchor_mxtunnel_ids=["string"],
    auto_preemption={
        "day_of_week": "string",
        "enabled": False,
        "time_of_day": "string",
    },
    hello_interval=0,
    hello_retries=0,
    ipsec={
        "dns_servers": ["string"],
        "dns_suffixes": ["string"],
        "enabled": False,
        "extra_routes": [{
            "dest": "string",
            "next_hop": "string",
        }],
        "split_tunnel": False,
        "use_mxedge": False,
    },
    mtu=0,
    mxcluster_ids=["string"],
    name="string",
    protocol="string",
    vlan_ids=[0])

    const mxtunnelResource = new junipermist.org.Mxtunnel("mxtunnelResource", {
    orgId: "string",
    anchorMxtunnelIds: ["string"],
    autoPreemption: {
        dayOfWeek: "string",
        enabled: false,
        timeOfDay: "string",
    },
    helloInterval: 0,
    helloRetries: 0,
    ipsec: {
        dnsServers: ["string"],
        dnsSuffixes: ["string"],
        enabled: false,
        extraRoutes: [{
            dest: "string",
            nextHop: "string",
        }],
        splitTunnel: false,
        useMxedge: false,
    },
    mtu: 0,
    mxclusterIds: ["string"],
    name: "string",
    protocol: "string",
    vlanIds: [0],
});

    type: junipermist:org:Mxtunnel
properties:
    anchorMxtunnelIds:
        - string
    autoPreemption:
        dayOfWeek: string
        enabled: false
        timeOfDay: string
    helloInterval: 0
    helloRetries: 0
    ipsec:
        dnsServers:
            - string
        dnsSuffixes:
            - string
        enabled: false
        extraRoutes:
            - dest: string
              nextHop: string
        splitTunnel: false
        useMxedge: false
    mtu: 0
    mxclusterIds:
        - string
    name: string
    orgId: string
    protocol: string
    vlanIds:
        - 0

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

    OrgId string
    Identifier of the org that owns the Mist Tunnel
    AnchorMxtunnelIds List<string>
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    AutoPreemption Pulumi.JuniperMist.Org.Inputs.MxtunnelAutoPreemption
    Preemption behavior for restoring preferred tunnel peers after failover
    HelloInterval int
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    HelloRetries int
    Number of missed hello heartbeats before an AP tries another tunnel peer
    Ipsec Pulumi.JuniperMist.Org.Inputs.MxtunnelIpsec
    Security settings for IPsec support on this Mist Tunnel
    Mtu int
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    MxclusterIds List<string>
    Mist Edge cluster IDs that host this Mist Tunnel
    Name string
    Display name of the Mist Tunnel
    Protocol string
    Encapsulation protocol used for the Mist Tunnel
    VlanIds List<int>
    List of VLAN IDs carried by this Mist Tunnel
    OrgId string
    Identifier of the org that owns the Mist Tunnel
    AnchorMxtunnelIds []string
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    AutoPreemption MxtunnelAutoPreemptionArgs
    Preemption behavior for restoring preferred tunnel peers after failover
    HelloInterval int
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    HelloRetries int
    Number of missed hello heartbeats before an AP tries another tunnel peer
    Ipsec MxtunnelIpsecArgs
    Security settings for IPsec support on this Mist Tunnel
    Mtu int
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    MxclusterIds []string
    Mist Edge cluster IDs that host this Mist Tunnel
    Name string
    Display name of the Mist Tunnel
    Protocol string
    Encapsulation protocol used for the Mist Tunnel
    VlanIds []int
    List of VLAN IDs carried by this Mist Tunnel
    org_id string
    Identifier of the org that owns the Mist Tunnel
    anchor_mxtunnel_ids list(string)
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    auto_preemption object
    Preemption behavior for restoring preferred tunnel peers after failover
    hello_interval number
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    hello_retries number
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec object
    Security settings for IPsec support on this Mist Tunnel
    mtu number
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxcluster_ids list(string)
    Mist Edge cluster IDs that host this Mist Tunnel
    name string
    Display name of the Mist Tunnel
    protocol string
    Encapsulation protocol used for the Mist Tunnel
    vlan_ids list(number)
    List of VLAN IDs carried by this Mist Tunnel
    orgId String
    Identifier of the org that owns the Mist Tunnel
    anchorMxtunnelIds List<String>
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    autoPreemption MxtunnelAutoPreemption
    Preemption behavior for restoring preferred tunnel peers after failover
    helloInterval Integer
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    helloRetries Integer
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec MxtunnelIpsec
    Security settings for IPsec support on this Mist Tunnel
    mtu Integer
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxclusterIds List<String>
    Mist Edge cluster IDs that host this Mist Tunnel
    name String
    Display name of the Mist Tunnel
    protocol String
    Encapsulation protocol used for the Mist Tunnel
    vlanIds List<Integer>
    List of VLAN IDs carried by this Mist Tunnel
    orgId string
    Identifier of the org that owns the Mist Tunnel
    anchorMxtunnelIds string[]
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    autoPreemption MxtunnelAutoPreemption
    Preemption behavior for restoring preferred tunnel peers after failover
    helloInterval number
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    helloRetries number
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec MxtunnelIpsec
    Security settings for IPsec support on this Mist Tunnel
    mtu number
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxclusterIds string[]
    Mist Edge cluster IDs that host this Mist Tunnel
    name string
    Display name of the Mist Tunnel
    protocol string
    Encapsulation protocol used for the Mist Tunnel
    vlanIds number[]
    List of VLAN IDs carried by this Mist Tunnel
    org_id str
    Identifier of the org that owns the Mist Tunnel
    anchor_mxtunnel_ids Sequence[str]
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    auto_preemption MxtunnelAutoPreemptionArgs
    Preemption behavior for restoring preferred tunnel peers after failover
    hello_interval int
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    hello_retries int
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec MxtunnelIpsecArgs
    Security settings for IPsec support on this Mist Tunnel
    mtu int
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxcluster_ids Sequence[str]
    Mist Edge cluster IDs that host this Mist Tunnel
    name str
    Display name of the Mist Tunnel
    protocol str
    Encapsulation protocol used for the Mist Tunnel
    vlan_ids Sequence[int]
    List of VLAN IDs carried by this Mist Tunnel
    orgId String
    Identifier of the org that owns the Mist Tunnel
    anchorMxtunnelIds List<String>
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    autoPreemption Property Map
    Preemption behavior for restoring preferred tunnel peers after failover
    helloInterval Number
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    helloRetries Number
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec Property Map
    Security settings for IPsec support on this Mist Tunnel
    mtu Number
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxclusterIds List<String>
    Mist Edge cluster IDs that host this Mist Tunnel
    name String
    Display name of the Mist Tunnel
    protocol String
    Encapsulation protocol used for the Mist Tunnel
    vlanIds List<Number>
    List of VLAN IDs carried by this Mist Tunnel

    Outputs

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

    Get an existing Mxtunnel 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?: MxtunnelState, opts?: CustomResourceOptions): Mxtunnel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        anchor_mxtunnel_ids: Optional[Sequence[str]] = None,
        auto_preemption: Optional[MxtunnelAutoPreemptionArgs] = None,
        hello_interval: Optional[int] = None,
        hello_retries: Optional[int] = None,
        ipsec: Optional[MxtunnelIpsecArgs] = None,
        mtu: Optional[int] = None,
        mxcluster_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        protocol: Optional[str] = None,
        vlan_ids: Optional[Sequence[int]] = None) -> Mxtunnel
    func GetMxtunnel(ctx *Context, name string, id IDInput, state *MxtunnelState, opts ...ResourceOption) (*Mxtunnel, error)
    public static Mxtunnel Get(string name, Input<string> id, MxtunnelState? state, CustomResourceOptions? opts = null)
    public static Mxtunnel get(String name, Output<String> id, MxtunnelState state, CustomResourceOptions options)
    resources:  _:    type: junipermist:org:Mxtunnel    get:      id: ${id}
    import {
  to = junipermist_org_mxtunnel.example
  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.
    The following state arguments are supported:
    AnchorMxtunnelIds List<string>
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    AutoPreemption Pulumi.JuniperMist.Org.Inputs.MxtunnelAutoPreemption
    Preemption behavior for restoring preferred tunnel peers after failover
    HelloInterval int
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    HelloRetries int
    Number of missed hello heartbeats before an AP tries another tunnel peer
    Ipsec Pulumi.JuniperMist.Org.Inputs.MxtunnelIpsec
    Security settings for IPsec support on this Mist Tunnel
    Mtu int
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    MxclusterIds List<string>
    Mist Edge cluster IDs that host this Mist Tunnel
    Name string
    Display name of the Mist Tunnel
    OrgId string
    Identifier of the org that owns the Mist Tunnel
    Protocol string
    Encapsulation protocol used for the Mist Tunnel
    VlanIds List<int>
    List of VLAN IDs carried by this Mist Tunnel
    AnchorMxtunnelIds []string
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    AutoPreemption MxtunnelAutoPreemptionArgs
    Preemption behavior for restoring preferred tunnel peers after failover
    HelloInterval int
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    HelloRetries int
    Number of missed hello heartbeats before an AP tries another tunnel peer
    Ipsec MxtunnelIpsecArgs
    Security settings for IPsec support on this Mist Tunnel
    Mtu int
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    MxclusterIds []string
    Mist Edge cluster IDs that host this Mist Tunnel
    Name string
    Display name of the Mist Tunnel
    OrgId string
    Identifier of the org that owns the Mist Tunnel
    Protocol string
    Encapsulation protocol used for the Mist Tunnel
    VlanIds []int
    List of VLAN IDs carried by this Mist Tunnel
    anchor_mxtunnel_ids list(string)
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    auto_preemption object
    Preemption behavior for restoring preferred tunnel peers after failover
    hello_interval number
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    hello_retries number
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec object
    Security settings for IPsec support on this Mist Tunnel
    mtu number
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxcluster_ids list(string)
    Mist Edge cluster IDs that host this Mist Tunnel
    name string
    Display name of the Mist Tunnel
    org_id string
    Identifier of the org that owns the Mist Tunnel
    protocol string
    Encapsulation protocol used for the Mist Tunnel
    vlan_ids list(number)
    List of VLAN IDs carried by this Mist Tunnel
    anchorMxtunnelIds List<String>
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    autoPreemption MxtunnelAutoPreemption
    Preemption behavior for restoring preferred tunnel peers after failover
    helloInterval Integer
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    helloRetries Integer
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec MxtunnelIpsec
    Security settings for IPsec support on this Mist Tunnel
    mtu Integer
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxclusterIds List<String>
    Mist Edge cluster IDs that host this Mist Tunnel
    name String
    Display name of the Mist Tunnel
    orgId String
    Identifier of the org that owns the Mist Tunnel
    protocol String
    Encapsulation protocol used for the Mist Tunnel
    vlanIds List<Integer>
    List of VLAN IDs carried by this Mist Tunnel
    anchorMxtunnelIds string[]
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    autoPreemption MxtunnelAutoPreemption
    Preemption behavior for restoring preferred tunnel peers after failover
    helloInterval number
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    helloRetries number
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec MxtunnelIpsec
    Security settings for IPsec support on this Mist Tunnel
    mtu number
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxclusterIds string[]
    Mist Edge cluster IDs that host this Mist Tunnel
    name string
    Display name of the Mist Tunnel
    orgId string
    Identifier of the org that owns the Mist Tunnel
    protocol string
    Encapsulation protocol used for the Mist Tunnel
    vlanIds number[]
    List of VLAN IDs carried by this Mist Tunnel
    anchor_mxtunnel_ids Sequence[str]
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    auto_preemption MxtunnelAutoPreemptionArgs
    Preemption behavior for restoring preferred tunnel peers after failover
    hello_interval int
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    hello_retries int
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec MxtunnelIpsecArgs
    Security settings for IPsec support on this Mist Tunnel
    mtu int
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxcluster_ids Sequence[str]
    Mist Edge cluster IDs that host this Mist Tunnel
    name str
    Display name of the Mist Tunnel
    org_id str
    Identifier of the org that owns the Mist Tunnel
    protocol str
    Encapsulation protocol used for the Mist Tunnel
    vlan_ids Sequence[int]
    List of VLAN IDs carried by this Mist Tunnel
    anchorMxtunnelIds List<String>
    IDs of anchor Mist Tunnels used for edge-to-edge tunnel formation
    autoPreemption Property Map
    Preemption behavior for restoring preferred tunnel peers after failover
    helloInterval Number
    In seconds, used as heartbeat to detect if a tunnel is alive. AP will try another peer after missing N hellos specified by helloRetries.
    helloRetries Number
    Number of missed hello heartbeats before an AP tries another tunnel peer
    ipsec Property Map
    Security settings for IPsec support on this Mist Tunnel
    mtu Number
    0 to enable PMTU, 552-1500 to start PMTU with a lower MTU
    mxclusterIds List<String>
    Mist Edge cluster IDs that host this Mist Tunnel
    name String
    Display name of the Mist Tunnel
    orgId String
    Identifier of the org that owns the Mist Tunnel
    protocol String
    Encapsulation protocol used for the Mist Tunnel
    vlanIds List<Number>
    List of VLAN IDs carried by this Mist Tunnel

    Supporting Types

    MxtunnelAutoPreemption, MxtunnelAutoPreemptionArgs

    DayOfWeek string
    Scheduled weekday for auto preemption
    Enabled bool
    Whether auto preemption is enabled
    TimeOfDay string
    Scheduled time of day for auto preemption
    DayOfWeek string
    Scheduled weekday for auto preemption
    Enabled bool
    Whether auto preemption is enabled
    TimeOfDay string
    Scheduled time of day for auto preemption
    day_of_week string
    Scheduled weekday for auto preemption
    enabled bool
    Whether auto preemption is enabled
    time_of_day string
    Scheduled time of day for auto preemption
    dayOfWeek String
    Scheduled weekday for auto preemption
    enabled Boolean
    Whether auto preemption is enabled
    timeOfDay String
    Scheduled time of day for auto preemption
    dayOfWeek string
    Scheduled weekday for auto preemption
    enabled boolean
    Whether auto preemption is enabled
    timeOfDay string
    Scheduled time of day for auto preemption
    day_of_week str
    Scheduled weekday for auto preemption
    enabled bool
    Whether auto preemption is enabled
    time_of_day str
    Scheduled time of day for auto preemption
    dayOfWeek String
    Scheduled weekday for auto preemption
    enabled Boolean
    Whether auto preemption is enabled
    timeOfDay String
    Scheduled time of day for auto preemption

    MxtunnelIpsec, MxtunnelIpsecArgs

    DnsServers List<string>
    Name server addresses advertised for IPsec tunnel clients
    DnsSuffixes List<string>
    Search suffixes advertised for IPsec tunnel clients
    Enabled bool
    Whether IPsec support is enabled for this Mist Tunnel
    ExtraRoutes List<Pulumi.JuniperMist.Org.Inputs.MxtunnelIpsecExtraRoute>
    Additional routes advertised for the IPsec tunnel
    SplitTunnel bool
    Whether split tunneling is enabled for IPsec clients
    UseMxedge bool
    Whether IPsec termination uses Mist Edge
    DnsServers []string
    Name server addresses advertised for IPsec tunnel clients
    DnsSuffixes []string
    Search suffixes advertised for IPsec tunnel clients
    Enabled bool
    Whether IPsec support is enabled for this Mist Tunnel
    ExtraRoutes []MxtunnelIpsecExtraRoute
    Additional routes advertised for the IPsec tunnel
    SplitTunnel bool
    Whether split tunneling is enabled for IPsec clients
    UseMxedge bool
    Whether IPsec termination uses Mist Edge
    dns_servers list(string)
    Name server addresses advertised for IPsec tunnel clients
    dns_suffixes list(string)
    Search suffixes advertised for IPsec tunnel clients
    enabled bool
    Whether IPsec support is enabled for this Mist Tunnel
    extra_routes list(object)
    Additional routes advertised for the IPsec tunnel
    split_tunnel bool
    Whether split tunneling is enabled for IPsec clients
    use_mxedge bool
    Whether IPsec termination uses Mist Edge
    dnsServers List<String>
    Name server addresses advertised for IPsec tunnel clients
    dnsSuffixes List<String>
    Search suffixes advertised for IPsec tunnel clients
    enabled Boolean
    Whether IPsec support is enabled for this Mist Tunnel
    extraRoutes List<MxtunnelIpsecExtraRoute>
    Additional routes advertised for the IPsec tunnel
    splitTunnel Boolean
    Whether split tunneling is enabled for IPsec clients
    useMxedge Boolean
    Whether IPsec termination uses Mist Edge
    dnsServers string[]
    Name server addresses advertised for IPsec tunnel clients
    dnsSuffixes string[]
    Search suffixes advertised for IPsec tunnel clients
    enabled boolean
    Whether IPsec support is enabled for this Mist Tunnel
    extraRoutes MxtunnelIpsecExtraRoute[]
    Additional routes advertised for the IPsec tunnel
    splitTunnel boolean
    Whether split tunneling is enabled for IPsec clients
    useMxedge boolean
    Whether IPsec termination uses Mist Edge
    dns_servers Sequence[str]
    Name server addresses advertised for IPsec tunnel clients
    dns_suffixes Sequence[str]
    Search suffixes advertised for IPsec tunnel clients
    enabled bool
    Whether IPsec support is enabled for this Mist Tunnel
    extra_routes Sequence[MxtunnelIpsecExtraRoute]
    Additional routes advertised for the IPsec tunnel
    split_tunnel bool
    Whether split tunneling is enabled for IPsec clients
    use_mxedge bool
    Whether IPsec termination uses Mist Edge
    dnsServers List<String>
    Name server addresses advertised for IPsec tunnel clients
    dnsSuffixes List<String>
    Search suffixes advertised for IPsec tunnel clients
    enabled Boolean
    Whether IPsec support is enabled for this Mist Tunnel
    extraRoutes List<Property Map>
    Additional routes advertised for the IPsec tunnel
    splitTunnel Boolean
    Whether split tunneling is enabled for IPsec clients
    useMxedge Boolean
    Whether IPsec termination uses Mist Edge

    MxtunnelIpsecExtraRoute, MxtunnelIpsecExtraRouteArgs

    Dest string
    Route destination CIDR for the IPsec extra route
    NextHop string
    Route next-hop IPv4 address for the IPsec extra route
    Dest string
    Route destination CIDR for the IPsec extra route
    NextHop string
    Route next-hop IPv4 address for the IPsec extra route
    dest string
    Route destination CIDR for the IPsec extra route
    next_hop string
    Route next-hop IPv4 address for the IPsec extra route
    dest String
    Route destination CIDR for the IPsec extra route
    nextHop String
    Route next-hop IPv4 address for the IPsec extra route
    dest string
    Route destination CIDR for the IPsec extra route
    nextHop string
    Route next-hop IPv4 address for the IPsec extra route
    dest str
    Route destination CIDR for the IPsec extra route
    next_hop str
    Route next-hop IPv4 address for the IPsec extra route
    dest String
    Route destination CIDR for the IPsec extra route
    nextHop String
    Route next-hop IPv4 address for the IPsec extra route

    Import

    Using pulumi import, import junipermist.org.Mxtunnel with: Mist Org MxTunnel can be imported by specifying the orgId and the mxtunnelId

    $ pulumi import junipermist:org/mxtunnel:Mxtunnel mxtunnel_one 17f90707-aebe-4274-af42-f42952a665a3.d3c42998-9012-4859-9743-6a9f30d68218

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    junipermist pulumi/pulumi-junipermist
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mist Terraform Provider.
    junipermist logo
    Viewing docs for Juniper Mist v0.11.1
    published on Friday, Jul 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-junipermist

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial