netbox 3.10.0, Apr 14 25

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

netbox.getPrefixes

Explore with Pulumi AI

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

Using getPrefixes

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.

TypeScript
Python
Go
C#
Java
YAML

function getPrefixes(args: GetPrefixesArgs, opts?: InvokeOptions): Promise<GetPrefixesResult>
function getPrefixesOutput(args: GetPrefixesOutputArgs, opts?: InvokeOptions): Output<GetPrefixesResult>

def get_prefixes(filters: Optional[Sequence[GetPrefixesFilter]] = None,
                 id: Optional[str] = None,
                 limit: Optional[float] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPrefixesResult
def get_prefixes_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPrefixesFilterArgs]]]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 limit: Optional[pulumi.Input[float]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPrefixesResult]

func GetPrefixes(ctx *Context, args *GetPrefixesArgs, opts ...InvokeOption) (*GetPrefixesResult, error)
func GetPrefixesOutput(ctx *Context, args *GetPrefixesOutputArgs, opts ...InvokeOption) GetPrefixesResultOutput

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

public static class GetPrefixes 
{
    public static Task<GetPrefixesResult> InvokeAsync(GetPrefixesArgs args, InvokeOptions? opts = null)
    public static Output<GetPrefixesResult> Invoke(GetPrefixesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrefixesResult> getPrefixes(GetPrefixesArgs args, InvokeOptions options)
public static Output<GetPrefixesResult> getPrefixes(GetPrefixesArgs args, InvokeOptions options)

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

The following arguments are supported:

Filters List<GetPrefixesFilter>: A list of filters to apply to the API query when requesting prefixes.
Id string: The ID of this resource.
Limit double: The limit of objects to return from the API lookup. Defaults to 0.

Filters []GetPrefixesFilter: A list of filters to apply to the API query when requesting prefixes.
Id string: The ID of this resource.
Limit float64: The limit of objects to return from the API lookup. Defaults to 0.

filters List<GetPrefixesFilter>: A list of filters to apply to the API query when requesting prefixes.
id String: The ID of this resource.
limit Double: The limit of objects to return from the API lookup. Defaults to 0.

filters GetPrefixesFilter[]: A list of filters to apply to the API query when requesting prefixes.
id string: The ID of this resource.
limit number: The limit of objects to return from the API lookup. Defaults to 0.

filters Sequence[GetPrefixesFilter]: A list of filters to apply to the API query when requesting prefixes.
id str: The ID of this resource.
limit float: The limit of objects to return from the API lookup. Defaults to 0.

filters List<Property Map>: A list of filters to apply to the API query when requesting prefixes.
id String: The ID of this resource.
limit Number: The limit of objects to return from the API lookup. Defaults to 0.

getPrefixes Result

The following output properties are available:

Id string: The ID of this resource.
Prefixes List<GetPrefixesPrefix>
Filters List<GetPrefixesFilter>: A list of filters to apply to the API query when requesting prefixes.
Limit double: The limit of objects to return from the API lookup. Defaults to 0.

Id string: The ID of this resource.
Prefixes []GetPrefixesPrefix
Filters []GetPrefixesFilter: A list of filters to apply to the API query when requesting prefixes.
Limit float64: The limit of objects to return from the API lookup. Defaults to 0.

id String: The ID of this resource.
prefixes List<GetPrefixesPrefix>
filters List<GetPrefixesFilter>: A list of filters to apply to the API query when requesting prefixes.
limit Double: The limit of objects to return from the API lookup. Defaults to 0.

id string: The ID of this resource.
prefixes GetPrefixesPrefix[]
filters GetPrefixesFilter[]: A list of filters to apply to the API query when requesting prefixes.
limit number: The limit of objects to return from the API lookup. Defaults to 0.

id str: The ID of this resource.
prefixes Sequence[GetPrefixesPrefix]
filters Sequence[GetPrefixesFilter]: A list of filters to apply to the API query when requesting prefixes.
limit float: The limit of objects to return from the API lookup. Defaults to 0.

id String: The ID of this resource.
prefixes List<Property Map>
filters List<Property Map>: A list of filters to apply to the API query when requesting prefixes.
limit Number: The limit of objects to return from the API lookup. Defaults to 0.

Supporting Types

GetPrefixesFilter

Name string: The name of the field to filter on. Supported fields are: prefix, contains, vlan_vid, vrf_id, vlan_id, status, tenant_id, site_id, & tag.
Value string: The value to pass to the specified filter.

Name string: The name of the field to filter on. Supported fields are: prefix, contains, vlan_vid, vrf_id, vlan_id, status, tenant_id, site_id, & tag.
Value string: The value to pass to the specified filter.

name String: The name of the field to filter on. Supported fields are: prefix, contains, vlan_vid, vrf_id, vlan_id, status, tenant_id, site_id, & tag.
value String: The value to pass to the specified filter.

name string: The name of the field to filter on. Supported fields are: prefix, contains, vlan_vid, vrf_id, vlan_id, status, tenant_id, site_id, & tag.
value string: The value to pass to the specified filter.

name str: The name of the field to filter on. Supported fields are: prefix, contains, vlan_vid, vrf_id, vlan_id, status, tenant_id, site_id, & tag.
value str: The value to pass to the specified filter.

name String: The name of the field to filter on. Supported fields are: prefix, contains, vlan_vid, vrf_id, vlan_id, status, tenant_id, site_id, & tag.
value String: The value to pass to the specified filter.

GetPrefixesPrefix

Description string
Id double
Prefix string
SiteId double
Status string
Tags List<string>
TenantId double
VlanId double
VlanVid double
VrfId double

Description string
Id float64
Prefix string
SiteId float64
Status string
Tags []string
TenantId float64
VlanId float64
VlanVid float64
VrfId float64

description String
id Double
prefix String
siteId Double
status String
tags List<String>
tenantId Double
vlanId Double
vlanVid Double
vrfId Double

description string
id number
prefix string
siteId number
status string
tags string[]
tenantId number
vlanId number
vlanVid number
vrfId number

description str
id float
prefix str
site_id float
status str
tags Sequence[str]
tenant_id float
vlan_id float
vlan_vid float
vrf_id float

description String
id Number
prefix String
siteId Number
status String
tags List<String>
tenantId Number
vlanId Number
vlanVid Number
vrfId Number

Package Details

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

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

e-breuninger/terraform-provider-netbox

netbox.getPrefixes

On this page

On this page

Using getPrefixes

getPrefixes Result

Supporting Types

GetPrefixesFilter

GetPrefixesPrefix

Package Details

On this page

On this page