getInterfaces

netbox 5.2.1, Mar 12 26

Viewing docs for netbox 5.2.1
published on Thursday, Mar 12, 2026 by e-breuninger

Schema (JSON)

e-breuninger/terraform-provider-netbox

Viewing docs for netbox 5.2.1
published on Thursday, Mar 12, 2026 by e-breuninger

Schema (JSON)

e-breuninger/terraform-provider-netbox

Example Usage

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

const myvmEth0 = netbox.getInterfaces({
    nameRegex: "eth0",
    filters: [{
        name: "name",
        value: "myvm",
    }],
});

import pulumi
import pulumi_netbox as netbox

myvm_eth0 = netbox.get_interfaces(name_regex="eth0",
    filters=[{
        "name": "name",
        "value": "myvm",
    }])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.GetInterfaces(ctx, &netbox.GetInterfacesArgs{
			NameRegex: pulumi.StringRef("eth0"),
			Filters: []netbox.GetInterfacesFilter{
				{
					Name:  "name",
					Value: "myvm",
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var myvmEth0 = Netbox.GetInterfaces.Invoke(new()
    {
        NameRegex = "eth0",
        Filters = new[]
        {
            new Netbox.Inputs.GetInterfacesFilterInputArgs
            {
                Name = "name",
                Value = "myvm",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetInterfacesArgs;
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 myvmEth0 = NetboxFunctions.getInterfaces(GetInterfacesArgs.builder()
            .nameRegex("eth0")
            .filters(GetInterfacesFilterArgs.builder()
                .name("name")
                .value("myvm")
                .build())
            .build());

    }
}

variables:
  myvmEth0:
    fn::invoke:
      function: netbox:getInterfaces
      arguments:
        nameRegex: eth0
        filters:
          - name: name
            value: myvm

Using getInterfaces

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 getInterfaces(args: GetInterfacesArgs, opts?: InvokeOptions): Promise<GetInterfacesResult>
function getInterfacesOutput(args: GetInterfacesOutputArgs, opts?: InvokeOptions): Output<GetInterfacesResult>

def get_interfaces(filters: Optional[Sequence[GetInterfacesFilter]] = None,
                   id: Optional[str] = None,
                   limit: Optional[float] = None,
                   name_regex: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetInterfacesResult
def get_interfaces_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetInterfacesFilterArgs]]]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   limit: Optional[pulumi.Input[float]] = None,
                   name_regex: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetInterfacesResult]

func GetInterfaces(ctx *Context, args *GetInterfacesArgs, opts ...InvokeOption) (*GetInterfacesResult, error)
func GetInterfacesOutput(ctx *Context, args *GetInterfacesOutputArgs, opts ...InvokeOption) GetInterfacesResultOutput

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

public static class GetInterfaces 
{
    public static Task<GetInterfacesResult> InvokeAsync(GetInterfacesArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfacesResult> Invoke(GetInterfacesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInterfacesResult> getInterfaces(GetInterfacesArgs args, InvokeOptions options)
public static Output<GetInterfacesResult> getInterfaces(GetInterfacesArgs args, InvokeOptions options)

fn::invoke:
  function: netbox:index/getInterfaces:getInterfaces
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetInterfacesFilter>
Id string: The ID of this resource.
Limit double: The limit of objects to return from the API lookup. Defaults to 0.
NameRegex string

Filters []GetInterfacesFilter
Id string: The ID of this resource.
Limit float64: The limit of objects to return from the API lookup. Defaults to 0.
NameRegex string

filters List<GetInterfacesFilter>
id String: The ID of this resource.
limit Double: The limit of objects to return from the API lookup. Defaults to 0.
nameRegex String

filters GetInterfacesFilter[]
id string: The ID of this resource.
limit number: The limit of objects to return from the API lookup. Defaults to 0.
nameRegex string

filters Sequence[GetInterfacesFilter]
id str: The ID of this resource.
limit float: The limit of objects to return from the API lookup. Defaults to 0.
name_regex str

filters List<Property Map>
id String: The ID of this resource.
limit Number: The limit of objects to return from the API lookup. Defaults to 0.
nameRegex String

getInterfaces Result

The following output properties are available:

Id string: The ID of this resource.
Interfaces List<GetInterfacesInterface>
Filters List<GetInterfacesFilter>
Limit double: The limit of objects to return from the API lookup. Defaults to 0.
NameRegex string

Id string: The ID of this resource.
Interfaces []GetInterfacesInterface
Filters []GetInterfacesFilter
Limit float64: The limit of objects to return from the API lookup. Defaults to 0.
NameRegex string

id String: The ID of this resource.
interfaces List<GetInterfacesInterface>
filters List<GetInterfacesFilter>
limit Double: The limit of objects to return from the API lookup. Defaults to 0.
nameRegex String

id string: The ID of this resource.
interfaces GetInterfacesInterface[]
filters GetInterfacesFilter[]
limit number: The limit of objects to return from the API lookup. Defaults to 0.
nameRegex string

id str: The ID of this resource.
interfaces Sequence[GetInterfacesInterface]
filters Sequence[GetInterfacesFilter]
limit float: The limit of objects to return from the API lookup. Defaults to 0.
name_regex str

id String: The ID of this resource.
interfaces List<Property Map>
filters List<Property Map>
limit Number: The limit of objects to return from the API lookup. Defaults to 0.
nameRegex String