Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Routeros Provider
  3. API Docs
  4. InterfaceWireguard
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

routeros.InterfaceWireguard

Explore with Pulumi AI

routeros logo
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";

const testWgInterface = new routeros.InterfaceWireguard("testWgInterface", {listenPort: 13231});

    import pulumi
import pulumi_routeros as routeros

test_wg_interface = routeros.InterfaceWireguard("testWgInterface", listen_port=13231)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := routeros.NewInterfaceWireguard(ctx, "testWgInterface", &routeros.InterfaceWireguardArgs{
			ListenPort: pulumi.Float64(13231),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testWgInterface = new Routeros.InterfaceWireguard("testWgInterface", new()
    {
        ListenPort = 13231,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.InterfaceWireguard;
import com.pulumi.routeros.InterfaceWireguardArgs;
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 testWgInterface = new InterfaceWireguard("testWgInterface", InterfaceWireguardArgs.builder()
            .listenPort("13231")
            .build());

    }
}

    resources:
  testWgInterface:
    type: routeros:InterfaceWireguard
    properties:
      listenPort: '13231'

    Create InterfaceWireguard Resource

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

    Constructor syntax

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

@overload
def InterfaceWireguard(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       listen_port: Optional[float] = None,
                       ___id_: Optional[float] = None,
                       ___path_: Optional[str] = None,
                       comment: Optional[str] = None,
                       disabled: Optional[bool] = None,
                       interface_wireguard_id: Optional[str] = None,
                       mtu: Optional[str] = None,
                       name: Optional[str] = None,
                       private_key: Optional[str] = None)
    func NewInterfaceWireguard(ctx *Context, name string, args InterfaceWireguardArgs, opts ...ResourceOption) (*InterfaceWireguard, error)
    public InterfaceWireguard(string name, InterfaceWireguardArgs args, CustomResourceOptions? opts = null)
    public InterfaceWireguard(String name, InterfaceWireguardArgs args)
public InterfaceWireguard(String name, InterfaceWireguardArgs args, CustomResourceOptions options)

    type: routeros:InterfaceWireguard
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 InterfaceWireguardArgs
    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 InterfaceWireguardArgs
    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 InterfaceWireguardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InterfaceWireguardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InterfaceWireguardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ListenPort double
    Port for WireGuard service to listen on for incoming sessions.
    Comment string
    Disabled bool
    InterfaceWireguardId string
    The ID of this resource.
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    PrivateKey string
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ListenPort float64
    Port for WireGuard service to listen on for incoming sessions.
    Comment string
    Disabled bool
    InterfaceWireguardId string
    The ID of this resource.
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    PrivateKey string
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    listenPort Double
    Port for WireGuard service to listen on for incoming sessions.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment String
    disabled Boolean
    interfaceWireguardId String
    The ID of this resource.
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    privateKey String
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    listenPort number
    Port for WireGuard service to listen on for incoming sessions.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment string
    disabled boolean
    interfaceWireguardId string
    The ID of this resource.
    mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name string
    privateKey string
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    listen_port float
    Port for WireGuard service to listen on for incoming sessions.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment str
    disabled bool
    interface_wireguard_id str
    The ID of this resource.
    mtu str
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name str
    private_key str
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    listenPort Number
    Port for WireGuard service to listen on for incoming sessions.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment String
    disabled Boolean
    interfaceWireguardId String
    The ID of this resource.
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    privateKey String
    A base64 private key. If not specified, it will be automatically generated upon interface creation.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InterfaceWireguard resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PublicKey string
    A base64 public key is calculated from the private key.
    Running bool
    Id string
    The provider-assigned unique ID for this managed resource.
    PublicKey string
    A base64 public key is calculated from the private key.
    Running bool
    id String
    The provider-assigned unique ID for this managed resource.
    publicKey String
    A base64 public key is calculated from the private key.
    running Boolean
    id string
    The provider-assigned unique ID for this managed resource.
    publicKey string
    A base64 public key is calculated from the private key.
    running boolean
    id str
    The provider-assigned unique ID for this managed resource.
    public_key str
    A base64 public key is calculated from the private key.
    running bool
    id String
    The provider-assigned unique ID for this managed resource.
    publicKey String
    A base64 public key is calculated from the private key.
    running Boolean

    Look up Existing InterfaceWireguard Resource

    Get an existing InterfaceWireguard 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?: InterfaceWireguardState, opts?: CustomResourceOptions): InterfaceWireguard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        comment: Optional[str] = None,
        disabled: Optional[bool] = None,
        interface_wireguard_id: Optional[str] = None,
        listen_port: Optional[float] = None,
        mtu: Optional[str] = None,
        name: Optional[str] = None,
        private_key: Optional[str] = None,
        public_key: Optional[str] = None,
        running: Optional[bool] = None) -> InterfaceWireguard
    func GetInterfaceWireguard(ctx *Context, name string, id IDInput, state *InterfaceWireguardState, opts ...ResourceOption) (*InterfaceWireguard, error)
    public static InterfaceWireguard Get(string name, Input<string> id, InterfaceWireguardState? state, CustomResourceOptions? opts = null)
    public static InterfaceWireguard get(String name, Output<String> id, InterfaceWireguardState state, CustomResourceOptions options)
    resources:  _:    type: routeros:InterfaceWireguard    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.
    The following state arguments are supported:
    Comment string
    Disabled bool
    InterfaceWireguardId string
    The ID of this resource.
    ListenPort double
    Port for WireGuard service to listen on for incoming sessions.
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    PrivateKey string
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    PublicKey string
    A base64 public key is calculated from the private key.
    Running bool
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    Comment string
    Disabled bool
    InterfaceWireguardId string
    The ID of this resource.
    ListenPort float64
    Port for WireGuard service to listen on for incoming sessions.
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    PrivateKey string
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    PublicKey string
    A base64 public key is calculated from the private key.
    Running bool
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment String
    disabled Boolean
    interfaceWireguardId String
    The ID of this resource.
    listenPort Double
    Port for WireGuard service to listen on for incoming sessions.
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    privateKey String
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    publicKey String
    A base64 public key is calculated from the private key.
    running Boolean
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment string
    disabled boolean
    interfaceWireguardId string
    The ID of this resource.
    listenPort number
    Port for WireGuard service to listen on for incoming sessions.
    mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name string
    privateKey string
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    publicKey string
    A base64 public key is calculated from the private key.
    running boolean
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment str
    disabled bool
    interface_wireguard_id str
    The ID of this resource.
    listen_port float
    Port for WireGuard service to listen on for incoming sessions.
    mtu str
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name str
    private_key str
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    public_key str
    A base64 public key is calculated from the private key.
    running bool
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    comment String
    disabled Boolean
    interfaceWireguardId String
    The ID of this resource.
    listenPort Number
    Port for WireGuard service to listen on for incoming sessions.
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    privateKey String
    A base64 private key. If not specified, it will be automatically generated upon interface creation.
    publicKey String
    A base64 public key is calculated from the private key.
    running Boolean

    Import

    #The ID can be found via API or the terminal

    #The command for the terminal is -> :put [/interface/wireguard get [print show-ids]]

    $ pulumi import routeros:index/interfaceWireguard:InterfaceWireguard test_wg_interface "*1"

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

    Package Details

    Repository
    routeros terraform-routeros/terraform-provider-routeros
    License
    Notes
    This Pulumi package is based on the routeros Terraform Provider.
    routeros logo
    routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros
    terraform-routeros/terraform-provider-routeros