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

openwrt.getNetworkDevice

Explore with Pulumi AI

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

A physical or virtual “device” in OpenWrt jargon. Commonly referred to as an “interface” in other networking jargon.

Example Usage

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

const brTesting = openwrt.getNetworkDevice({
    id: "br_testing",
});
Copy
import pulumi
import pulumi_openwrt as openwrt

br_testing = openwrt.get_network_device(id="br_testing")
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.LookupNetworkDevice(ctx, &openwrt.LookupNetworkDeviceArgs{
			Id: "br_testing",
		}, nil)
		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 brTesting = Openwrt.GetNetworkDevice.Invoke(new()
    {
        Id = "br_testing",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openwrt.OpenwrtFunctions;
import com.pulumi.openwrt.inputs.GetNetworkDeviceArgs;
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) {
        final var brTesting = OpenwrtFunctions.getNetworkDevice(GetNetworkDeviceArgs.builder()
            .id("br_testing")
            .build());

    }
}
Copy
variables:
  brTesting:
    fn::invoke:
      function: openwrt:getNetworkDevice
      arguments:
        id: br_testing
Copy

Using getNetworkDevice

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNetworkDevice(args: GetNetworkDeviceArgs, opts?: InvokeOptions): Promise<GetNetworkDeviceResult>
function getNetworkDeviceOutput(args: GetNetworkDeviceOutputArgs, opts?: InvokeOptions): Output<GetNetworkDeviceResult>
Copy
def get_network_device(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetNetworkDeviceResult
def get_network_device_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetNetworkDeviceResult]
Copy
func LookupNetworkDevice(ctx *Context, args *LookupNetworkDeviceArgs, opts ...InvokeOption) (*LookupNetworkDeviceResult, error)
func LookupNetworkDeviceOutput(ctx *Context, args *LookupNetworkDeviceOutputArgs, opts ...InvokeOption) LookupNetworkDeviceResultOutput
Copy

> Note: This function is named LookupNetworkDevice in the Go SDK.

public static class GetNetworkDevice 
{
    public static Task<GetNetworkDeviceResult> InvokeAsync(GetNetworkDeviceArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkDeviceResult> Invoke(GetNetworkDeviceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkDeviceResult> getNetworkDevice(GetNetworkDeviceArgs args, InvokeOptions options)
public static Output<GetNetworkDeviceResult> getNetworkDevice(GetNetworkDeviceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: openwrt:index/getNetworkDevice:getNetworkDevice
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
Name of the section. This name is only used when interacting with UCI directly.
Id This property is required. string
Name of the section. This name is only used when interacting with UCI directly.
id This property is required. String
Name of the section. This name is only used when interacting with UCI directly.
id This property is required. string
Name of the section. This name is only used when interacting with UCI directly.
id This property is required. str
Name of the section. This name is only used when interacting with UCI directly.
id This property is required. String
Name of the section. This name is only used when interacting with UCI directly.

getNetworkDevice Result

The following output properties are available:

BridgeEmpty bool
Bring up the bridge device even if no ports are attached
Dadtransmits double
Amount of Duplicate Address Detection probes to send
Id string
Name of the section. This name is only used when interacting with UCI directly.
Ipv6 bool
Enable IPv6 for the device.
Macaddr string
MAC Address of the device.
Mtu double
Maximum Transmissible Unit.
Mtu6 double
Maximum Transmissible Unit for IPv6.
Name string
Name of the device. This name is referenced in other network configuration.
Ports List<string>
Specifies the wired ports to attach to this bridge.
Txqueuelen double
Transmission queue length.
Type string
The type of device. Currently, only "bridge" is supported.
BridgeEmpty bool
Bring up the bridge device even if no ports are attached
Dadtransmits float64
Amount of Duplicate Address Detection probes to send
Id string
Name of the section. This name is only used when interacting with UCI directly.
Ipv6 bool
Enable IPv6 for the device.
Macaddr string
MAC Address of the device.
Mtu float64
Maximum Transmissible Unit.
Mtu6 float64
Maximum Transmissible Unit for IPv6.
Name string
Name of the device. This name is referenced in other network configuration.
Ports []string
Specifies the wired ports to attach to this bridge.
Txqueuelen float64
Transmission queue length.
Type string
The type of device. Currently, only "bridge" is supported.
bridgeEmpty Boolean
Bring up the bridge device even if no ports are attached
dadtransmits Double
Amount of Duplicate Address Detection probes to send
id String
Name of the section. This name is only used when interacting with UCI directly.
ipv6 Boolean
Enable IPv6 for the device.
macaddr String
MAC Address of the device.
mtu Double
Maximum Transmissible Unit.
mtu6 Double
Maximum Transmissible Unit for IPv6.
name String
Name of the device. This name is referenced in other network configuration.
ports List<String>
Specifies the wired ports to attach to this bridge.
txqueuelen Double
Transmission queue length.
type String
The type of device. Currently, only "bridge" is supported.
bridgeEmpty boolean
Bring up the bridge device even if no ports are attached
dadtransmits number
Amount of Duplicate Address Detection probes to send
id string
Name of the section. This name is only used when interacting with UCI directly.
ipv6 boolean
Enable IPv6 for the device.
macaddr string
MAC Address of the device.
mtu number
Maximum Transmissible Unit.
mtu6 number
Maximum Transmissible Unit for IPv6.
name string
Name of the device. This name is referenced in other network configuration.
ports string[]
Specifies the wired ports to attach to this bridge.
txqueuelen number
Transmission queue length.
type string
The type of device. Currently, only "bridge" is supported.
bridge_empty bool
Bring up the bridge device even if no ports are attached
dadtransmits float
Amount of Duplicate Address Detection probes to send
id str
Name of the section. This name is only used when interacting with UCI directly.
ipv6 bool
Enable IPv6 for the device.
macaddr str
MAC Address of the device.
mtu float
Maximum Transmissible Unit.
mtu6 float
Maximum Transmissible Unit for IPv6.
name str
Name of the device. This name is referenced in other network configuration.
ports Sequence[str]
Specifies the wired ports to attach to this bridge.
txqueuelen float
Transmission queue length.
type str
The type of device. Currently, only "bridge" is supported.
bridgeEmpty Boolean
Bring up the bridge device even if no ports are attached
dadtransmits Number
Amount of Duplicate Address Detection probes to send
id String
Name of the section. This name is only used when interacting with UCI directly.
ipv6 Boolean
Enable IPv6 for the device.
macaddr String
MAC Address of the device.
mtu Number
Maximum Transmissible Unit.
mtu6 Number
Maximum Transmissible Unit for IPv6.
name String
Name of the device. This name is referenced in other network configuration.
ports List<String>
Specifies the wired ports to attach to this bridge.
txqueuelen Number
Transmission queue length.
type String
The type of device. Currently, only "bridge" is supported.

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