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

routeros.SystemUser

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 test = new routeros.SystemUser("test", {
        address: "0.0.0.0/0",
        comment: "Test User",
        group: "read",
        password: "secret",
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    test = routeros.SystemUser("test",
        address="0.0.0.0/0",
        comment="Test User",
        group="read",
        password="secret")
    
    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.NewSystemUser(ctx, "test", &routeros.SystemUserArgs{
    			Address:  pulumi.String("0.0.0.0/0"),
    			Comment:  pulumi.String("Test User"),
    			Group:    pulumi.String("read"),
    			Password: pulumi.String("secret"),
    		})
    		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 test = new Routeros.SystemUser("test", new()
        {
            Address = "0.0.0.0/0",
            Comment = "Test User",
            Group = "read",
            Password = "secret",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.SystemUser;
    import com.pulumi.routeros.SystemUserArgs;
    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 test = new SystemUser("test", SystemUserArgs.builder()
                .address("0.0.0.0/0")
                .comment("Test User")
                .group("read")
                .password("secret")
                .build());
    
        }
    }
    
    resources:
      test:
        type: routeros:SystemUser
        properties:
          address: 0.0.0.0/0
          comment: Test User
          group: read
          password: secret
    

    Create SystemUser Resource

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

    Constructor syntax

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

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

    Group string
    Name of the group the user belongs to.
    Address string
    Host or network address from which the user is allowed to log in.
    Comment string
    Disabled bool
    InactivityPolicy string
    Inactivity policy.
    InactivityTimeout string
    Inactivity timeout for non-GUI sessions.
    Name string
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    Password string
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    SystemUserId string
    The ID of this resource.
    ___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.
    ___skip_ string
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    Group string
    Name of the group the user belongs to.
    Address string
    Host or network address from which the user is allowed to log in.
    Comment string
    Disabled bool
    InactivityPolicy string
    Inactivity policy.
    InactivityTimeout string
    Inactivity timeout for non-GUI sessions.
    Name string
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    Password string
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    SystemUserId string
    The ID of this resource.
    ___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.
    ___skip_ string
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    group String
    Name of the group the user belongs to.
    ___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.
    ___skip_ String
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address String
    Host or network address from which the user is allowed to log in.
    comment String
    disabled Boolean
    inactivityPolicy String
    Inactivity policy.
    inactivityTimeout String
    Inactivity timeout for non-GUI sessions.
    name String
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password String
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    systemUserId String
    The ID of this resource.
    group string
    Name of the group the user belongs to.
    ___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.
    ___skip_ string
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address string
    Host or network address from which the user is allowed to log in.
    comment string
    disabled boolean
    inactivityPolicy string
    Inactivity policy.
    inactivityTimeout string
    Inactivity timeout for non-GUI sessions.
    name string
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password string
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    systemUserId string
    The ID of this resource.
    group str
    Name of the group the user belongs to.
    ___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.
    ___skip_ str
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address str
    Host or network address from which the user is allowed to log in.
    comment str
    disabled bool
    inactivity_policy str
    Inactivity policy.
    inactivity_timeout str
    Inactivity timeout for non-GUI sessions.
    name str
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password str
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    system_user_id str
    The ID of this resource.
    group String
    Name of the group the user belongs to.
    ___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.
    ___skip_ String
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address String
    Host or network address from which the user is allowed to log in.
    comment String
    disabled Boolean
    inactivityPolicy String
    Inactivity policy.
    inactivityTimeout String
    Inactivity timeout for non-GUI sessions.
    name String
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password String
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    systemUserId String
    The ID of this resource.

    Outputs

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

    Expired bool
    Password expired.
    Id string
    The provider-assigned unique ID for this managed resource.
    Expired bool
    Password expired.
    Id string
    The provider-assigned unique ID for this managed resource.
    expired Boolean
    Password expired.
    id String
    The provider-assigned unique ID for this managed resource.
    expired boolean
    Password expired.
    id string
    The provider-assigned unique ID for this managed resource.
    expired bool
    Password expired.
    id str
    The provider-assigned unique ID for this managed resource.
    expired Boolean
    Password expired.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SystemUser Resource

    Get an existing SystemUser 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?: SystemUserState, opts?: CustomResourceOptions): SystemUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            ___skip_: Optional[str] = None,
            address: Optional[str] = None,
            comment: Optional[str] = None,
            disabled: Optional[bool] = None,
            expired: Optional[bool] = None,
            group: Optional[str] = None,
            inactivity_policy: Optional[str] = None,
            inactivity_timeout: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            system_user_id: Optional[str] = None) -> SystemUser
    func GetSystemUser(ctx *Context, name string, id IDInput, state *SystemUserState, opts ...ResourceOption) (*SystemUser, error)
    public static SystemUser Get(string name, Input<string> id, SystemUserState? state, CustomResourceOptions? opts = null)
    public static SystemUser get(String name, Output<String> id, SystemUserState state, CustomResourceOptions options)
    resources:  _:    type: routeros:SystemUser    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:
    Address string
    Host or network address from which the user is allowed to log in.
    Comment string
    Disabled bool
    Expired bool
    Password expired.
    Group string
    Name of the group the user belongs to.
    InactivityPolicy string
    Inactivity policy.
    InactivityTimeout string
    Inactivity timeout for non-GUI sessions.
    Name string
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    Password string
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    SystemUserId string
    The ID of this resource.
    ___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.
    ___skip_ string
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    Address string
    Host or network address from which the user is allowed to log in.
    Comment string
    Disabled bool
    Expired bool
    Password expired.
    Group string
    Name of the group the user belongs to.
    InactivityPolicy string
    Inactivity policy.
    InactivityTimeout string
    Inactivity timeout for non-GUI sessions.
    Name string
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    Password string
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    SystemUserId string
    The ID of this resource.
    ___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.
    ___skip_ string
    A set of transformations for field names. 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.
    ___skip_ String
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address String
    Host or network address from which the user is allowed to log in.
    comment String
    disabled Boolean
    expired Boolean
    Password expired.
    group String
    Name of the group the user belongs to.
    inactivityPolicy String
    Inactivity policy.
    inactivityTimeout String
    Inactivity timeout for non-GUI sessions.
    name String
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password String
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    systemUserId String
    The ID of this resource.
    ___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.
    ___skip_ string
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address string
    Host or network address from which the user is allowed to log in.
    comment string
    disabled boolean
    expired boolean
    Password expired.
    group string
    Name of the group the user belongs to.
    inactivityPolicy string
    Inactivity policy.
    inactivityTimeout string
    Inactivity timeout for non-GUI sessions.
    name string
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password string
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    systemUserId string
    The ID of this resource.
    ___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.
    ___skip_ str
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address str
    Host or network address from which the user is allowed to log in.
    comment str
    disabled bool
    expired bool
    Password expired.
    group str
    Name of the group the user belongs to.
    inactivity_policy str
    Inactivity policy.
    inactivity_timeout str
    Inactivity timeout for non-GUI sessions.
    name str
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password str
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    system_user_id str
    The ID of this resource.
    ___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.
    ___skip_ String
    A set of transformations for field names. This is an internal service field, setting a value is not required.
    address String
    Host or network address from which the user is allowed to log in.
    comment String
    disabled Boolean
    expired Boolean
    Password expired.
    group String
    Name of the group the user belongs to.
    inactivityPolicy String
    Inactivity policy.
    inactivityTimeout String
    Inactivity timeout for non-GUI sessions.
    name String
    User name. Although it must start with an alphanumeric character, it may contain '*', '_', '.' and '@' symbols.
    password String
    User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, '*' and '_' symbols.
    systemUserId String
    The ID of this resource.

    Import

    #The ID can be found via API or the terminal

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

    $ pulumi import routeros:index/systemUser:SystemUser test *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