netbox.getInterfaces

Explore with Pulumi AI

netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

e-breuninger/terraform-provider-netbox

Example Usage

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