1. Packages
  2. Routeros Provider
  3. API Docs
  4. InterfaceOvpnServer
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

routeros.InterfaceOvpnServer

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as routeros from "@pulumi/routeros";
    
    const user1 = new routeros.InterfaceOvpnServer("user1", {user: "user1"}, {
        dependsOn: [routeros_ovpn_server.server],
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    user1 = routeros.InterfaceOvpnServer("user1", user="user1",
    opts = pulumi.ResourceOptions(depends_on=[routeros_ovpn_server["server"]]))
    
    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.NewInterfaceOvpnServer(ctx, "user1", &routeros.InterfaceOvpnServerArgs{
    			User: pulumi.String("user1"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			routeros_ovpn_server.Server,
    		}))
    		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 user1 = new Routeros.InterfaceOvpnServer("user1", new()
        {
            User = "user1",
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                routeros_ovpn_server.Server,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.InterfaceOvpnServer;
    import com.pulumi.routeros.InterfaceOvpnServerArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 user1 = new InterfaceOvpnServer("user1", InterfaceOvpnServerArgs.builder()
                .user("user1")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(routeros_ovpn_server.server())
                    .build());
    
        }
    }
    
    resources:
      user1:
        type: routeros:InterfaceOvpnServer
        properties:
          user: user1
        options:
          dependsOn:
            - ${routeros_ovpn_server.server}
    

    Create InterfaceOvpnServer Resource

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

    Constructor syntax

    new InterfaceOvpnServer(name: string, args?: InterfaceOvpnServerArgs, opts?: CustomResourceOptions);
    @overload
    def InterfaceOvpnServer(resource_name: str,
                            args: Optional[InterfaceOvpnServerArgs] = None,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def InterfaceOvpnServer(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            ___id_: Optional[float] = None,
                            ___path_: Optional[str] = None,
                            comment: Optional[str] = None,
                            disabled: Optional[bool] = None,
                            interface_ovpn_server_id: Optional[str] = None,
                            name: Optional[str] = None,
                            user: Optional[str] = None)
    func NewInterfaceOvpnServer(ctx *Context, name string, args *InterfaceOvpnServerArgs, opts ...ResourceOption) (*InterfaceOvpnServer, error)
    public InterfaceOvpnServer(string name, InterfaceOvpnServerArgs? args = null, CustomResourceOptions? opts = null)
    public InterfaceOvpnServer(String name, InterfaceOvpnServerArgs args)
    public InterfaceOvpnServer(String name, InterfaceOvpnServerArgs args, CustomResourceOptions options)
    
    type: routeros:InterfaceOvpnServer
    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 InterfaceOvpnServerArgs
    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 InterfaceOvpnServerArgs
    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 InterfaceOvpnServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InterfaceOvpnServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InterfaceOvpnServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Comment string
    Disabled bool
    InterfaceOvpnServerId string
    The ID of this resource.
    Name string
    Interface name (Example: ovpn-in1).
    User string
    User name used for authentication.
    ___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
    InterfaceOvpnServerId string
    The ID of this resource.
    Name string
    Interface name (Example: ovpn-in1).
    User string
    User name used for authentication.
    ___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
    interfaceOvpnServerId String
    The ID of this resource.
    name String
    Interface name (Example: ovpn-in1).
    user String
    User name used for authentication.
    ___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
    interfaceOvpnServerId string
    The ID of this resource.
    name string
    Interface name (Example: ovpn-in1).
    user string
    User name used for authentication.
    ___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_ovpn_server_id str
    The ID of this resource.
    name str
    Interface name (Example: ovpn-in1).
    user str
    User name used for authentication.
    ___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
    interfaceOvpnServerId String
    The ID of this resource.
    name String
    Interface name (Example: ovpn-in1).
    user String
    User name used for authentication.

    Outputs

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

    ClientAddress string
    The address of the remote side.
    Encoding string
    Encryption characteristics.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mtu double
    Layer2 Maximum transmission unit. See.
    Running bool
    Uptime string
    Connection uptime.
    ClientAddress string
    The address of the remote side.
    Encoding string
    Encryption characteristics.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mtu float64
    Layer2 Maximum transmission unit. See.
    Running bool
    Uptime string
    Connection uptime.
    clientAddress String
    The address of the remote side.
    encoding String
    Encryption characteristics.
    id String
    The provider-assigned unique ID for this managed resource.
    mtu Double
    Layer2 Maximum transmission unit. See.
    running Boolean
    uptime String
    Connection uptime.
    clientAddress string
    The address of the remote side.
    encoding string
    Encryption characteristics.
    id string
    The provider-assigned unique ID for this managed resource.
    mtu number
    Layer2 Maximum transmission unit. See.
    running boolean
    uptime string
    Connection uptime.
    client_address str
    The address of the remote side.
    encoding str
    Encryption characteristics.
    id str
    The provider-assigned unique ID for this managed resource.
    mtu float
    Layer2 Maximum transmission unit. See.
    running bool
    uptime str
    Connection uptime.
    clientAddress String
    The address of the remote side.
    encoding String
    Encryption characteristics.
    id String
    The provider-assigned unique ID for this managed resource.
    mtu Number
    Layer2 Maximum transmission unit. See.
    running Boolean
    uptime String
    Connection uptime.

    Look up Existing InterfaceOvpnServer Resource

    Get an existing InterfaceOvpnServer 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?: InterfaceOvpnServerState, opts?: CustomResourceOptions): InterfaceOvpnServer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            client_address: Optional[str] = None,
            comment: Optional[str] = None,
            disabled: Optional[bool] = None,
            encoding: Optional[str] = None,
            interface_ovpn_server_id: Optional[str] = None,
            mtu: Optional[float] = None,
            name: Optional[str] = None,
            running: Optional[bool] = None,
            uptime: Optional[str] = None,
            user: Optional[str] = None) -> InterfaceOvpnServer
    func GetInterfaceOvpnServer(ctx *Context, name string, id IDInput, state *InterfaceOvpnServerState, opts ...ResourceOption) (*InterfaceOvpnServer, error)
    public static InterfaceOvpnServer Get(string name, Input<string> id, InterfaceOvpnServerState? state, CustomResourceOptions? opts = null)
    public static InterfaceOvpnServer get(String name, Output<String> id, InterfaceOvpnServerState state, CustomResourceOptions options)
    resources:  _:    type: routeros:InterfaceOvpnServer    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:
    ClientAddress string
    The address of the remote side.
    Comment string
    Disabled bool
    Encoding string
    Encryption characteristics.
    InterfaceOvpnServerId string
    The ID of this resource.
    Mtu double
    Layer2 Maximum transmission unit. See.
    Name string
    Interface name (Example: ovpn-in1).
    Running bool
    Uptime string
    Connection uptime.
    User string
    User name used for authentication.
    ___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.
    ClientAddress string
    The address of the remote side.
    Comment string
    Disabled bool
    Encoding string
    Encryption characteristics.
    InterfaceOvpnServerId string
    The ID of this resource.
    Mtu float64
    Layer2 Maximum transmission unit. See.
    Name string
    Interface name (Example: ovpn-in1).
    Running bool
    Uptime string
    Connection uptime.
    User string
    User name used for authentication.
    ___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.
    clientAddress String
    The address of the remote side.
    comment String
    disabled Boolean
    encoding String
    Encryption characteristics.
    interfaceOvpnServerId String
    The ID of this resource.
    mtu Double
    Layer2 Maximum transmission unit. See.
    name String
    Interface name (Example: ovpn-in1).
    running Boolean
    uptime String
    Connection uptime.
    user String
    User name used for authentication.
    ___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.
    clientAddress string
    The address of the remote side.
    comment string
    disabled boolean
    encoding string
    Encryption characteristics.
    interfaceOvpnServerId string
    The ID of this resource.
    mtu number
    Layer2 Maximum transmission unit. See.
    name string
    Interface name (Example: ovpn-in1).
    running boolean
    uptime string
    Connection uptime.
    user string
    User name used for authentication.
    ___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.
    client_address str
    The address of the remote side.
    comment str
    disabled bool
    encoding str
    Encryption characteristics.
    interface_ovpn_server_id str
    The ID of this resource.
    mtu float
    Layer2 Maximum transmission unit. See.
    name str
    Interface name (Example: ovpn-in1).
    running bool
    uptime str
    Connection uptime.
    user str
    User name used for authentication.
    ___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.
    clientAddress String
    The address of the remote side.
    comment String
    disabled Boolean
    encoding String
    Encryption characteristics.
    interfaceOvpnServerId String
    The ID of this resource.
    mtu Number
    Layer2 Maximum transmission unit. See.
    name String
    Interface name (Example: ovpn-in1).
    running Boolean
    uptime String
    Connection uptime.
    user String
    User name used for authentication.

    Import

    #The ID can be found via API or the terminal

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

    $ pulumi import routeros:index/interfaceOvpnServer:InterfaceOvpnServer user1 *29
    

    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