Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openwrt Provider
  3. API Docs
  4. SystemSystem
openwrt 0.0.20 published on Friday, Mar 7, 2025 by joneshf
joneshf/terraform-provider-openwrt

openwrt.SystemSystem

Explore with Pulumi AI

openwrt 0.0.20 published on Friday, Mar 7, 2025 by joneshf
joneshf/terraform-provider-openwrt

Provides system data about an OpenWrt device

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as openwrt from "@pulumi/openwrt";

const _this = new openwrt.SystemSystem("this", {
    hostname: "OpenWrt",
    systemSystemId: "cfg01e48a",
    zonename: "America/Los Angeles",
});
Copy
import pulumi
import pulumi_openwrt as openwrt

this = openwrt.SystemSystem("this",
    hostname="OpenWrt",
    system_system_id="cfg01e48a",
    zonename="America/Los Angeles")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/openwrt/openwrt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := openwrt.NewSystemSystem(ctx, "this", &openwrt.SystemSystemArgs{
			Hostname:       pulumi.String("OpenWrt"),
			SystemSystemId: pulumi.String("cfg01e48a"),
			Zonename:       pulumi.String("America/Los Angeles"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Openwrt = Pulumi.Openwrt;

return await Deployment.RunAsync(() => 
{
    var @this = new Openwrt.SystemSystem("this", new()
    {
        Hostname = "OpenWrt",
        SystemSystemId = "cfg01e48a",
        Zonename = "America/Los Angeles",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openwrt.SystemSystem;
import com.pulumi.openwrt.SystemSystemArgs;
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 this_ = new SystemSystem("this", SystemSystemArgs.builder()
            .hostname("OpenWrt")
            .systemSystemId("cfg01e48a")
            .zonename("America/Los Angeles")
            .build());

    }
}
Copy
resources:
  this:
    type: openwrt:SystemSystem
    properties:
      hostname: OpenWrt
      systemSystemId: cfg01e48a
      zonename: America/Los Angeles
Copy

Create SystemSystem Resource

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

Constructor syntax

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

@overload
def SystemSystem(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 system_system_id: Optional[str] = None,
                 conloglevel: Optional[float] = None,
                 cronloglevel: Optional[float] = None,
                 description: Optional[str] = None,
                 hostname: Optional[str] = None,
                 log_size: Optional[float] = None,
                 notes: Optional[str] = None,
                 timezone: Optional[str] = None,
                 ttylogin: Optional[bool] = None,
                 zonename: Optional[str] = None)
func NewSystemSystem(ctx *Context, name string, args SystemSystemArgs, opts ...ResourceOption) (*SystemSystem, error)
public SystemSystem(string name, SystemSystemArgs args, CustomResourceOptions? opts = null)
public SystemSystem(String name, SystemSystemArgs args)
public SystemSystem(String name, SystemSystemArgs args, CustomResourceOptions options)

type: openwrt:SystemSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SystemSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SystemSystemArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SystemSystemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SystemSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemSystemArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var systemSystemResource = new Openwrt.SystemSystem("systemSystemResource", new()
{
    SystemSystemId = "string",
    Conloglevel = 0,
    Cronloglevel = 0,
    Description = "string",
    Hostname = "string",
    LogSize = 0,
    Notes = "string",
    Timezone = "string",
    Ttylogin = false,
    Zonename = "string",
});
Copy
example, err := openwrt.NewSystemSystem(ctx, "systemSystemResource", &openwrt.SystemSystemArgs{
	SystemSystemId: pulumi.String("string"),
	Conloglevel:    pulumi.Float64(0),
	Cronloglevel:   pulumi.Float64(0),
	Description:    pulumi.String("string"),
	Hostname:       pulumi.String("string"),
	LogSize:        pulumi.Float64(0),
	Notes:          pulumi.String("string"),
	Timezone:       pulumi.String("string"),
	Ttylogin:       pulumi.Bool(false),
	Zonename:       pulumi.String("string"),
})
Copy
var systemSystemResource = new SystemSystem("systemSystemResource", SystemSystemArgs.builder()
    .systemSystemId("string")
    .conloglevel(0)
    .cronloglevel(0)
    .description("string")
    .hostname("string")
    .logSize(0)
    .notes("string")
    .timezone("string")
    .ttylogin(false)
    .zonename("string")
    .build());
Copy
system_system_resource = openwrt.SystemSystem("systemSystemResource",
    system_system_id="string",
    conloglevel=0,
    cronloglevel=0,
    description="string",
    hostname="string",
    log_size=0,
    notes="string",
    timezone="string",
    ttylogin=False,
    zonename="string")
Copy
const systemSystemResource = new openwrt.SystemSystem("systemSystemResource", {
    systemSystemId: "string",
    conloglevel: 0,
    cronloglevel: 0,
    description: "string",
    hostname: "string",
    logSize: 0,
    notes: "string",
    timezone: "string",
    ttylogin: false,
    zonename: "string",
});
Copy
type: openwrt:SystemSystem
properties:
    conloglevel: 0
    cronloglevel: 0
    description: string
    hostname: string
    logSize: 0
    notes: string
    systemSystemId: string
    timezone: string
    ttylogin: false
    zonename: string
Copy

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

SystemSystemId This property is required. string
Name of the section. This name is only used when interacting with UCI directly.
Conloglevel double
The maximum log level for kernel messages to be logged to the console.
Cronloglevel double
The minimum level for cron messages to be logged to syslog.
Description string
The hostname for the system.
Hostname string
A short single-line description for the system.
LogSize double
Size of the file based log buffer in KiB.
Notes string
Multi-line free-form text about the system.
Timezone string
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
Ttylogin bool
Require authentication for local users to log in the system.
Zonename string
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
SystemSystemId This property is required. string
Name of the section. This name is only used when interacting with UCI directly.
Conloglevel float64
The maximum log level for kernel messages to be logged to the console.
Cronloglevel float64
The minimum level for cron messages to be logged to syslog.
Description string
The hostname for the system.
Hostname string
A short single-line description for the system.
LogSize float64
Size of the file based log buffer in KiB.
Notes string
Multi-line free-form text about the system.
Timezone string
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
Ttylogin bool
Require authentication for local users to log in the system.
Zonename string
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
systemSystemId This property is required. String
Name of the section. This name is only used when interacting with UCI directly.
conloglevel Double
The maximum log level for kernel messages to be logged to the console.
cronloglevel Double
The minimum level for cron messages to be logged to syslog.
description String
The hostname for the system.
hostname String
A short single-line description for the system.
logSize Double
Size of the file based log buffer in KiB.
notes String
Multi-line free-form text about the system.
timezone String
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin Boolean
Require authentication for local users to log in the system.
zonename String
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
systemSystemId This property is required. string
Name of the section. This name is only used when interacting with UCI directly.
conloglevel number
The maximum log level for kernel messages to be logged to the console.
cronloglevel number
The minimum level for cron messages to be logged to syslog.
description string
The hostname for the system.
hostname string
A short single-line description for the system.
logSize number
Size of the file based log buffer in KiB.
notes string
Multi-line free-form text about the system.
timezone string
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin boolean
Require authentication for local users to log in the system.
zonename string
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
system_system_id This property is required. str
Name of the section. This name is only used when interacting with UCI directly.
conloglevel float
The maximum log level for kernel messages to be logged to the console.
cronloglevel float
The minimum level for cron messages to be logged to syslog.
description str
The hostname for the system.
hostname str
A short single-line description for the system.
log_size float
Size of the file based log buffer in KiB.
notes str
Multi-line free-form text about the system.
timezone str
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin bool
Require authentication for local users to log in the system.
zonename str
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
systemSystemId This property is required. String
Name of the section. This name is only used when interacting with UCI directly.
conloglevel Number
The maximum log level for kernel messages to be logged to the console.
cronloglevel Number
The minimum level for cron messages to be logged to syslog.
description String
The hostname for the system.
hostname String
A short single-line description for the system.
logSize Number
Size of the file based log buffer in KiB.
notes String
Multi-line free-form text about the system.
timezone String
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin Boolean
Require authentication for local users to log in the system.
zonename String
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.

Outputs

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

Get an existing SystemSystem 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?: SystemSystemState, opts?: CustomResourceOptions): SystemSystem
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        conloglevel: Optional[float] = None,
        cronloglevel: Optional[float] = None,
        description: Optional[str] = None,
        hostname: Optional[str] = None,
        log_size: Optional[float] = None,
        notes: Optional[str] = None,
        system_system_id: Optional[str] = None,
        timezone: Optional[str] = None,
        ttylogin: Optional[bool] = None,
        zonename: Optional[str] = None) -> SystemSystem
func GetSystemSystem(ctx *Context, name string, id IDInput, state *SystemSystemState, opts ...ResourceOption) (*SystemSystem, error)
public static SystemSystem Get(string name, Input<string> id, SystemSystemState? state, CustomResourceOptions? opts = null)
public static SystemSystem get(String name, Output<String> id, SystemSystemState state, CustomResourceOptions options)
resources:  _:    type: openwrt:SystemSystem    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Conloglevel double
The maximum log level for kernel messages to be logged to the console.
Cronloglevel double
The minimum level for cron messages to be logged to syslog.
Description string
The hostname for the system.
Hostname string
A short single-line description for the system.
LogSize double
Size of the file based log buffer in KiB.
Notes string
Multi-line free-form text about the system.
SystemSystemId string
Name of the section. This name is only used when interacting with UCI directly.
Timezone string
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
Ttylogin bool
Require authentication for local users to log in the system.
Zonename string
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
Conloglevel float64
The maximum log level for kernel messages to be logged to the console.
Cronloglevel float64
The minimum level for cron messages to be logged to syslog.
Description string
The hostname for the system.
Hostname string
A short single-line description for the system.
LogSize float64
Size of the file based log buffer in KiB.
Notes string
Multi-line free-form text about the system.
SystemSystemId string
Name of the section. This name is only used when interacting with UCI directly.
Timezone string
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
Ttylogin bool
Require authentication for local users to log in the system.
Zonename string
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
conloglevel Double
The maximum log level for kernel messages to be logged to the console.
cronloglevel Double
The minimum level for cron messages to be logged to syslog.
description String
The hostname for the system.
hostname String
A short single-line description for the system.
logSize Double
Size of the file based log buffer in KiB.
notes String
Multi-line free-form text about the system.
systemSystemId String
Name of the section. This name is only used when interacting with UCI directly.
timezone String
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin Boolean
Require authentication for local users to log in the system.
zonename String
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
conloglevel number
The maximum log level for kernel messages to be logged to the console.
cronloglevel number
The minimum level for cron messages to be logged to syslog.
description string
The hostname for the system.
hostname string
A short single-line description for the system.
logSize number
Size of the file based log buffer in KiB.
notes string
Multi-line free-form text about the system.
systemSystemId string
Name of the section. This name is only used when interacting with UCI directly.
timezone string
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin boolean
Require authentication for local users to log in the system.
zonename string
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
conloglevel float
The maximum log level for kernel messages to be logged to the console.
cronloglevel float
The minimum level for cron messages to be logged to syslog.
description str
The hostname for the system.
hostname str
A short single-line description for the system.
log_size float
Size of the file based log buffer in KiB.
notes str
Multi-line free-form text about the system.
system_system_id str
Name of the section. This name is only used when interacting with UCI directly.
timezone str
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin bool
Require authentication for local users to log in the system.
zonename str
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
conloglevel Number
The maximum log level for kernel messages to be logged to the console.
cronloglevel Number
The minimum level for cron messages to be logged to syslog.
description String
The hostname for the system.
hostname String
A short single-line description for the system.
logSize Number
Size of the file based log buffer in KiB.
notes String
Multi-line free-form text about the system.
systemSystemId String
Name of the section. This name is only used when interacting with UCI directly.
timezone String
The POSIX.1 time zone string. This has no corresponding value in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.
ttylogin Boolean
Require authentication for local users to log in the system.
zonename String
The IANA/Olson time zone string. This corresponds to "Timezone" in LuCI. See: https://github.com/openwrt/luci/blob/cd82ccacef78d3bb8b8af6b87dabb9e892e2b2aa/modules/luci-base/luasrc/sys/zoneinfo/tzdata.lua.

Import

Every system.system seems to have the same UCI name of cfg01e48a

$ pulumi import openwrt:index/systemSystem:SystemSystem this cfg01e48a
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
openwrt joneshf/terraform-provider-openwrt
License
Notes
This Pulumi package is based on the openwrt Terraform Provider.
openwrt 0.0.20 published on Friday, Mar 7, 2025 by joneshf
joneshf/terraform-provider-openwrt