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

routeros.SystemNote

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.SystemNote("test", {
        note: "For authorized use only.",
        showAtCliLogin: true,
        showAtLogin: true,
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    test = routeros.SystemNote("test",
        note="For authorized use only.",
        show_at_cli_login=True,
        show_at_login=True)
    
    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.NewSystemNote(ctx, "test", &routeros.SystemNoteArgs{
    			Note:           pulumi.String("For authorized use only."),
    			ShowAtCliLogin: pulumi.Bool(true),
    			ShowAtLogin:    pulumi.Bool(true),
    		})
    		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.SystemNote("test", new()
        {
            Note = "For authorized use only.",
            ShowAtCliLogin = true,
            ShowAtLogin = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.SystemNote;
    import com.pulumi.routeros.SystemNoteArgs;
    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 SystemNote("test", SystemNoteArgs.builder()
                .note("For authorized use only.")
                .showAtCliLogin(true)
                .showAtLogin(true)
                .build());
    
        }
    }
    
    resources:
      test:
        type: routeros:SystemNote
        properties:
          note: For authorized use only.
          showAtCliLogin: true
          showAtLogin: true
    

    Create SystemNote Resource

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

    Constructor syntax

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

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

    Note string
    Note that will be displayed.
    ShowAtCliLogin bool
    Whether to show system note before telnet login prompt.
    ShowAtLogin bool
    Whether to show system note on each login.
    SystemNoteId 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.
    Note string
    Note that will be displayed.
    ShowAtCliLogin bool
    Whether to show system note before telnet login prompt.
    ShowAtLogin bool
    Whether to show system note on each login.
    SystemNoteId 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.
    note String
    Note that will be displayed.
    ___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.
    showAtCliLogin Boolean
    Whether to show system note before telnet login prompt.
    showAtLogin Boolean
    Whether to show system note on each login.
    systemNoteId String
    The ID of this resource.
    note string
    Note that will be displayed.
    ___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.
    showAtCliLogin boolean
    Whether to show system note before telnet login prompt.
    showAtLogin boolean
    Whether to show system note on each login.
    systemNoteId string
    The ID of this resource.
    note str
    Note that will be displayed.
    ___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.
    show_at_cli_login bool
    Whether to show system note before telnet login prompt.
    show_at_login bool
    Whether to show system note on each login.
    system_note_id str
    The ID of this resource.
    note String
    Note that will be displayed.
    ___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.
    showAtCliLogin Boolean
    Whether to show system note before telnet login prompt.
    showAtLogin Boolean
    Whether to show system note on each login.
    systemNoteId String
    The ID of this resource.

    Outputs

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

    Get an existing SystemNote 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?: SystemNoteState, opts?: CustomResourceOptions): SystemNote
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            note: Optional[str] = None,
            show_at_cli_login: Optional[bool] = None,
            show_at_login: Optional[bool] = None,
            system_note_id: Optional[str] = None) -> SystemNote
    func GetSystemNote(ctx *Context, name string, id IDInput, state *SystemNoteState, opts ...ResourceOption) (*SystemNote, error)
    public static SystemNote Get(string name, Input<string> id, SystemNoteState? state, CustomResourceOptions? opts = null)
    public static SystemNote get(String name, Output<String> id, SystemNoteState state, CustomResourceOptions options)
    resources:  _:    type: routeros:SystemNote    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:
    Note string
    Note that will be displayed.
    ShowAtCliLogin bool
    Whether to show system note before telnet login prompt.
    ShowAtLogin bool
    Whether to show system note on each login.
    SystemNoteId 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.
    Note string
    Note that will be displayed.
    ShowAtCliLogin bool
    Whether to show system note before telnet login prompt.
    ShowAtLogin bool
    Whether to show system note on each login.
    SystemNoteId 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.
    note String
    Note that will be displayed.
    showAtCliLogin Boolean
    Whether to show system note before telnet login prompt.
    showAtLogin Boolean
    Whether to show system note on each login.
    systemNoteId 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.
    note string
    Note that will be displayed.
    showAtCliLogin boolean
    Whether to show system note before telnet login prompt.
    showAtLogin boolean
    Whether to show system note on each login.
    systemNoteId 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.
    note str
    Note that will be displayed.
    show_at_cli_login bool
    Whether to show system note before telnet login prompt.
    show_at_login bool
    Whether to show system note on each login.
    system_note_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.
    note String
    Note that will be displayed.
    showAtCliLogin Boolean
    Whether to show system note before telnet login prompt.
    showAtLogin Boolean
    Whether to show system note on each login.
    systemNoteId String
    The ID of this resource.

    Import

    $ pulumi import routeros:index/systemNote:SystemNote test .
    

    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