1. Packages
  2. Netbox Provider
  3. API Docs
  4. getDeviceInterfaces
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getDeviceInterfaces

Explore with Pulumi AI

Using getDeviceInterfaces

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 getDeviceInterfaces(args: GetDeviceInterfacesArgs, opts?: InvokeOptions): Promise<GetDeviceInterfacesResult>
function getDeviceInterfacesOutput(args: GetDeviceInterfacesOutputArgs, opts?: InvokeOptions): Output<GetDeviceInterfacesResult>
Copy
def get_device_interfaces(filters: Optional[Sequence[GetDeviceInterfacesFilter]] = None,
                          id: Optional[str] = None,
                          name_regex: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDeviceInterfacesResult
def get_device_interfaces_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeviceInterfacesFilterArgs]]]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          name_regex: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDeviceInterfacesResult]
Copy
func GetDeviceInterfaces(ctx *Context, args *GetDeviceInterfacesArgs, opts ...InvokeOption) (*GetDeviceInterfacesResult, error)
func GetDeviceInterfacesOutput(ctx *Context, args *GetDeviceInterfacesOutputArgs, opts ...InvokeOption) GetDeviceInterfacesResultOutput
Copy

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

public static class GetDeviceInterfaces 
{
    public static Task<GetDeviceInterfacesResult> InvokeAsync(GetDeviceInterfacesArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceInterfacesResult> Invoke(GetDeviceInterfacesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeviceInterfacesResult> getDeviceInterfaces(GetDeviceInterfacesArgs args, InvokeOptions options)
public static Output<GetDeviceInterfacesResult> getDeviceInterfaces(GetDeviceInterfacesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getDeviceInterfaces:getDeviceInterfaces
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters List<GetDeviceInterfacesFilter>
Id string
The ID of this resource.
NameRegex string
Filters []GetDeviceInterfacesFilter
Id string
The ID of this resource.
NameRegex string
filters List<GetDeviceInterfacesFilter>
id String
The ID of this resource.
nameRegex String
filters GetDeviceInterfacesFilter[]
id string
The ID of this resource.
nameRegex string
filters List<Property Map>
id String
The ID of this resource.
nameRegex String

getDeviceInterfaces Result

The following output properties are available:

Supporting Types

GetDeviceInterfacesFilter

Name This property is required. string
Value This property is required. string
Name This property is required. string
Value This property is required. string
name This property is required. String
value This property is required. String
name This property is required. string
value This property is required. string
name This property is required. str
value This property is required. str
name This property is required. String
value This property is required. String

GetDeviceInterfacesInterface

Description This property is required. string
DeviceId This property is required. double
Enabled This property is required. bool
Id This property is required. double
MacAddress This property is required. string
Mode This property is required. Dictionary<string, string>
Mtu This property is required. double
Name This property is required. string
TagIds This property is required. List<double>
TaggedVlans This property is required. List<GetDeviceInterfacesInterfaceTaggedVlan>
UntaggedVlans This property is required. List<GetDeviceInterfacesInterfaceUntaggedVlan>
Description This property is required. string
DeviceId This property is required. float64
Enabled This property is required. bool
Id This property is required. float64
MacAddress This property is required. string
Mode This property is required. map[string]string
Mtu This property is required. float64
Name This property is required. string
TagIds This property is required. []float64
TaggedVlans This property is required. []GetDeviceInterfacesInterfaceTaggedVlan
UntaggedVlans This property is required. []GetDeviceInterfacesInterfaceUntaggedVlan
description This property is required. String
deviceId This property is required. Double
enabled This property is required. Boolean
id This property is required. Double
macAddress This property is required. String
mode This property is required. Map<String,String>
mtu This property is required. Double
name This property is required. String
tagIds This property is required. List<Double>
taggedVlans This property is required. List<GetDeviceInterfacesInterfaceTaggedVlan>
untaggedVlans This property is required. List<GetDeviceInterfacesInterfaceUntaggedVlan>
description This property is required. string
deviceId This property is required. number
enabled This property is required. boolean
id This property is required. number
macAddress This property is required. string
mode This property is required. {[key: string]: string}
mtu This property is required. number
name This property is required. string
tagIds This property is required. number[]
taggedVlans This property is required. GetDeviceInterfacesInterfaceTaggedVlan[]
untaggedVlans This property is required. GetDeviceInterfacesInterfaceUntaggedVlan[]
description This property is required. str
device_id This property is required. float
enabled This property is required. bool
id This property is required. float
mac_address This property is required. str
mode This property is required. Mapping[str, str]
mtu This property is required. float
name This property is required. str
tag_ids This property is required. Sequence[float]
tagged_vlans This property is required. Sequence[GetDeviceInterfacesInterfaceTaggedVlan]
untagged_vlans This property is required. Sequence[GetDeviceInterfacesInterfaceUntaggedVlan]
description This property is required. String
deviceId This property is required. Number
enabled This property is required. Boolean
id This property is required. Number
macAddress This property is required. String
mode This property is required. Map<String>
mtu This property is required. Number
name This property is required. String
tagIds This property is required. List<Number>
taggedVlans This property is required. List<Property Map>
untaggedVlans This property is required. List<Property Map>

GetDeviceInterfacesInterfaceTaggedVlan

Id This property is required. double
Name This property is required. string
Vid This property is required. double
Id This property is required. float64
Name This property is required. string
Vid This property is required. float64
id This property is required. Double
name This property is required. String
vid This property is required. Double
id This property is required. number
name This property is required. string
vid This property is required. number
id This property is required. float
name This property is required. str
vid This property is required. float
id This property is required. Number
name This property is required. String
vid This property is required. Number

GetDeviceInterfacesInterfaceUntaggedVlan

Id This property is required. double
Name This property is required. string
Vid This property is required. double
Id This property is required. float64
Name This property is required. string
Vid This property is required. float64
id This property is required. Double
name This property is required. String
vid This property is required. Double
id This property is required. number
name This property is required. string
vid This property is required. number
id This property is required. float
name This property is required. str
vid This property is required. float
id This property is required. Number
name This property is required. String
vid This property is required. Number

Package Details

Repository
netbox e-breuninger/terraform-provider-netbox
License
Notes
This Pulumi package is based on the netbox Terraform Provider.