1. Packages
  2. Netbox Provider
  3. API Docs
  4. getPrefixes
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.

function getPrefixes(args: GetPrefixesArgs, opts?: InvokeOptions): Promise<GetPrefixesResult>
function getPrefixesOutput(args: GetPrefixesOutputArgs, opts?: InvokeOptions): Output<GetPrefixesResult>
Copy
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]
Copy
func GetPrefixes(ctx *Context, args *GetPrefixesArgs, opts ...InvokeOption) (*GetPrefixesResult, error)
func GetPrefixesOutput(ctx *Context, args *GetPrefixesOutputArgs, opts ...InvokeOption) GetPrefixesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPrefixesResult> getPrefixes(GetPrefixesArgs args, InvokeOptions options)
public static Output<GetPrefixesResult> getPrefixes(GetPrefixesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getPrefixes:getPrefixes
  arguments:
    # arguments dictionary
Copy

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 This property is required. 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 This property is required. string
The value to pass to the specified filter.
Name This property is required. 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 This property is required. string
The value to pass to the specified filter.
name This property is required. 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 This property is required. String
The value to pass to the specified filter.
name This property is required. 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 This property is required. string
The value to pass to the specified filter.
name This property is required. 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 This property is required. str
The value to pass to the specified filter.
name This property is required. 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 This property is required. String
The value to pass to the specified filter.

GetPrefixesPrefix

Description This property is required. string
Id This property is required. double
Prefix This property is required. string
SiteId This property is required. double
Status This property is required. string
Tags This property is required. List<string>
TenantId This property is required. double
VlanId This property is required. double
VlanVid This property is required. double
VrfId This property is required. double
Description This property is required. string
Id This property is required. float64
Prefix This property is required. string
SiteId This property is required. float64
Status This property is required. string
Tags This property is required. []string
TenantId This property is required. float64
VlanId This property is required. float64
VlanVid This property is required. float64
VrfId This property is required. float64
description This property is required. String
id This property is required. Double
prefix This property is required. String
siteId This property is required. Double
status This property is required. String
tags This property is required. List<String>
tenantId This property is required. Double
vlanId This property is required. Double
vlanVid This property is required. Double
vrfId This property is required. Double
description This property is required. string
id This property is required. number
prefix This property is required. string
siteId This property is required. number
status This property is required. string
tags This property is required. string[]
tenantId This property is required. number
vlanId This property is required. number
vlanVid This property is required. number
vrfId This property is required. number
description This property is required. str
id This property is required. float
prefix This property is required. str
site_id This property is required. float
status This property is required. str
tags This property is required. Sequence[str]
tenant_id This property is required. float
vlan_id This property is required. float
vlan_vid This property is required. float
vrf_id This property is required. float
description This property is required. String
id This property is required. Number
prefix This property is required. String
siteId This property is required. Number
status This property is required. String
tags This property is required. List<String>
tenantId This property is required. Number
vlanId This property is required. Number
vlanVid This property is required. Number
vrfId 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.
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger