Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Routeros Provider
  3. API Docs
  4. Wireguard
routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

routeros.Wireguard

Explore with Pulumi AI

routeros logo
routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

    # routeros.Wireguard (Resource)

    This is an alias for backwards compatibility between plugin versions.

    Please see documentation for routeros.InterfaceWireguard

    Create Wireguard Resource

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

    Constructor syntax

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

@overload
def Wireguard(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,
              mtu: Optional[str] = None,
              name: Optional[str] = None,
              private_key: Optional[str] = None,
              wireguard_id: Optional[str] = None)
    func NewWireguard(ctx *Context, name string, args WireguardArgs, opts ...ResourceOption) (*Wireguard, error)
    public Wireguard(string name, WireguardArgs args, CustomResourceOptions? opts = null)
    public Wireguard(String name, WireguardArgs args)
public Wireguard(String name, WireguardArgs args, CustomResourceOptions options)

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

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

    ListenPort double
    Port for WireGuard service to listen on for incoming sessions.
    Comment string
    Disabled bool
    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.
    WireguardId string
    ___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
    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.
    WireguardId string
    ___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
    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.
    wireguardId String
    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
    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.
    wireguardId string
    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
    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.
    wireguard_id str
    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
    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.
    wireguardId String

    Outputs

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

    Get an existing Wireguard 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?: WireguardState, opts?: CustomResourceOptions): Wireguard
    @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,
        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,
        wireguard_id: Optional[str] = None) -> Wireguard
    func GetWireguard(ctx *Context, name string, id IDInput, state *WireguardState, opts ...ResourceOption) (*Wireguard, error)
    public static Wireguard Get(string name, Input<string> id, WireguardState? state, CustomResourceOptions? opts = null)
    public static Wireguard get(String name, Output<String> id, WireguardState state, CustomResourceOptions options)
    resources:  _:    type: routeros:Wireguard    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
    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
    WireguardId string
    ___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
    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
    WireguardId string
    ___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
    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
    wireguardId String
    ___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
    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
    wireguardId string
    ___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
    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
    wireguard_id str
    ___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
    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
    wireguardId String

    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.0 published on Wednesday, Apr 16, 2025 by terraform-routeros
    terraform-routeros/terraform-provider-routeros