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

routeros.SystemRouterboardButtonMode

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 modeButton = new routeros.SystemScript("modeButton", {source: "    :log info message=(\"mode button pressed\")\n"});
const settings = new routeros.SystemRouterboardButtonMode("settings", {
    enabled: true,
    holdTime: "0s..1m",
    onEvent: modeButton.name,
});

    import pulumi
import pulumi_routeros as routeros

mode_button = routeros.SystemScript("modeButton", source="    :log info message=(\"mode button pressed\")\n")
settings = routeros.SystemRouterboardButtonMode("settings",
    enabled=True,
    hold_time="0s..1m",
    on_event=mode_button.name)

    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 {
		modeButton, err := routeros.NewSystemScript(ctx, "modeButton", &routeros.SystemScriptArgs{
			Source: pulumi.String("    :log info message=(\"mode button pressed\")\n"),
		})
		if err != nil {
			return err
		}
		_, err = routeros.NewSystemRouterboardButtonMode(ctx, "settings", &routeros.SystemRouterboardButtonModeArgs{
			Enabled:  pulumi.Bool(true),
			HoldTime: pulumi.String("0s..1m"),
			OnEvent:  modeButton.Name,
		})
		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 modeButton = new Routeros.SystemScript("modeButton", new()
    {
        Source = @"    :log info message=(""mode button pressed"")
",
    });

    var settings = new Routeros.SystemRouterboardButtonMode("settings", new()
    {
        Enabled = true,
        HoldTime = "0s..1m",
        OnEvent = modeButton.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.SystemScript;
import com.pulumi.routeros.SystemScriptArgs;
import com.pulumi.routeros.SystemRouterboardButtonMode;
import com.pulumi.routeros.SystemRouterboardButtonModeArgs;
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 modeButton = new SystemScript("modeButton", SystemScriptArgs.builder()
            .source("""
    :log info message=("mode button pressed")
            """)
            .build());

        var settings = new SystemRouterboardButtonMode("settings", SystemRouterboardButtonModeArgs.builder()
            .enabled(true)
            .holdTime("0s..1m")
            .onEvent(modeButton.name())
            .build());

    }
}

    resources:
  modeButton:
    type: routeros:SystemScript
    properties:
      source: |2
            :log info message=("mode button pressed")
  settings:
    type: routeros:SystemRouterboardButtonMode
    properties:
      enabled: true
      holdTime: 0s..1m
      onEvent: ${modeButton.name}

    Create SystemRouterboardButtonMode Resource

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

    Constructor syntax

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

@overload
def SystemRouterboardButtonMode(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                ___id_: Optional[float] = None,
                                ___path_: Optional[str] = None,
                                enabled: Optional[bool] = None,
                                hold_time: Optional[str] = None,
                                on_event: Optional[str] = None,
                                system_routerboard_button_mode_id: Optional[str] = None)
    func NewSystemRouterboardButtonMode(ctx *Context, name string, args *SystemRouterboardButtonModeArgs, opts ...ResourceOption) (*SystemRouterboardButtonMode, error)
    public SystemRouterboardButtonMode(string name, SystemRouterboardButtonModeArgs? args = null, CustomResourceOptions? opts = null)
    public SystemRouterboardButtonMode(String name, SystemRouterboardButtonModeArgs args)
public SystemRouterboardButtonMode(String name, SystemRouterboardButtonModeArgs args, CustomResourceOptions options)

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

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

    Enabled bool
    An option to enable the operation of the button.
    HoldTime string
    An option to define the period within which the button should be pressed.
    OnEvent string
    An option to set the script that will be run upon pressing the button.
    SystemRouterboardButtonModeId 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.
    Enabled bool
    An option to enable the operation of the button.
    HoldTime string
    An option to define the period within which the button should be pressed.
    OnEvent string
    An option to set the script that will be run upon pressing the button.
    SystemRouterboardButtonModeId 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.
    ___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.
    enabled Boolean
    An option to enable the operation of the button.
    holdTime String
    An option to define the period within which the button should be pressed.
    onEvent String
    An option to set the script that will be run upon pressing the button.
    systemRouterboardButtonModeId 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.
    enabled boolean
    An option to enable the operation of the button.
    holdTime string
    An option to define the period within which the button should be pressed.
    onEvent string
    An option to set the script that will be run upon pressing the button.
    systemRouterboardButtonModeId 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.
    enabled bool
    An option to enable the operation of the button.
    hold_time str
    An option to define the period within which the button should be pressed.
    on_event str
    An option to set the script that will be run upon pressing the button.
    system_routerboard_button_mode_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.
    enabled Boolean
    An option to enable the operation of the button.
    holdTime String
    An option to define the period within which the button should be pressed.
    onEvent String
    An option to set the script that will be run upon pressing the button.
    systemRouterboardButtonModeId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SystemRouterboardButtonMode 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SystemRouterboardButtonMode Resource

    Get an existing SystemRouterboardButtonMode 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?: SystemRouterboardButtonModeState, opts?: CustomResourceOptions): SystemRouterboardButtonMode
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        enabled: Optional[bool] = None,
        hold_time: Optional[str] = None,
        on_event: Optional[str] = None,
        system_routerboard_button_mode_id: Optional[str] = None) -> SystemRouterboardButtonMode
    func GetSystemRouterboardButtonMode(ctx *Context, name string, id IDInput, state *SystemRouterboardButtonModeState, opts ...ResourceOption) (*SystemRouterboardButtonMode, error)
    public static SystemRouterboardButtonMode Get(string name, Input<string> id, SystemRouterboardButtonModeState? state, CustomResourceOptions? opts = null)
    public static SystemRouterboardButtonMode get(String name, Output<String> id, SystemRouterboardButtonModeState state, CustomResourceOptions options)
    resources:  _:    type: routeros:SystemRouterboardButtonMode    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:
    Enabled bool
    An option to enable the operation of the button.
    HoldTime string
    An option to define the period within which the button should be pressed.
    OnEvent string
    An option to set the script that will be run upon pressing the button.
    SystemRouterboardButtonModeId 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.
    Enabled bool
    An option to enable the operation of the button.
    HoldTime string
    An option to define the period within which the button should be pressed.
    OnEvent string
    An option to set the script that will be run upon pressing the button.
    SystemRouterboardButtonModeId 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.
    ___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.
    enabled Boolean
    An option to enable the operation of the button.
    holdTime String
    An option to define the period within which the button should be pressed.
    onEvent String
    An option to set the script that will be run upon pressing the button.
    systemRouterboardButtonModeId 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.
    enabled boolean
    An option to enable the operation of the button.
    holdTime string
    An option to define the period within which the button should be pressed.
    onEvent string
    An option to set the script that will be run upon pressing the button.
    systemRouterboardButtonModeId 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.
    enabled bool
    An option to enable the operation of the button.
    hold_time str
    An option to define the period within which the button should be pressed.
    on_event str
    An option to set the script that will be run upon pressing the button.
    system_routerboard_button_mode_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.
    enabled Boolean
    An option to enable the operation of the button.
    holdTime String
    An option to define the period within which the button should be pressed.
    onEvent String
    An option to set the script that will be run upon pressing the button.
    systemRouterboardButtonModeId String
    The ID of this resource.

    Import

    $ pulumi import routeros:index/systemRouterboardButtonMode:SystemRouterboardButtonMode settings .

    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