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>
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<Get
Prefixes Filter> - 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
[]Get
Prefixes Filter - 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<Get
Prefixes Filter> - 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
Get
Prefixes Filter[] - 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[Get
Prefixes Filter] - 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<Get
Prefixes Prefix> - Filters
List<Get
Prefixes Filter> - 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
[]Get
Prefixes Prefix - Filters
[]Get
Prefixes Filter - 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<Get
Prefixes Prefix> - filters
List<Get
Prefixes Filter> - 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
Get
Prefixes Prefix[] - filters
Get
Prefixes Filter[] - 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[Get
Prefixes Prefix] - filters
Sequence[Get
Prefixes Filter] - 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
GetPrefixesPrefix
- Description
This property is required. string - Id
This property is required. double - Prefix
This property is required. string - Site
Id This property is required. double - Status
This property is required. string This property is required. List<string>- Tenant
Id This property is required. double - Vlan
Id This property is required. double - Vlan
Vid This property is required. double - Vrf
Id This property is required. double
- Description
This property is required. string - Id
This property is required. float64 - Prefix
This property is required. string - Site
Id This property is required. float64 - Status
This property is required. string This property is required. []string- Tenant
Id This property is required. float64 - Vlan
Id This property is required. float64 - Vlan
Vid This property is required. float64 - Vrf
Id This property is required. float64
- description
This property is required. String - id
This property is required. Double - prefix
This property is required. String - site
Id This property is required. Double - status
This property is required. String This property is required. List<String>- tenant
Id This property is required. Double - vlan
Id This property is required. Double - vlan
Vid This property is required. Double - vrf
Id This property is required. Double
- description
This property is required. string - id
This property is required. number - prefix
This property is required. string - site
Id This property is required. number - status
This property is required. string This property is required. string[]- tenant
Id This property is required. number - vlan
Id This property is required. number - vlan
Vid This property is required. number - vrf
Id 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 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 - site
Id This property is required. Number - status
This property is required. String This property is required. List<String>- tenant
Id This property is required. Number - vlan
Id This property is required. Number - vlan
Vid This property is required. Number - vrf
Id 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