1. Packages
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getAvailablePrefix
Viewing docs for netbox 5.3.0
published on Thursday, Apr 9, 2026 by e-breuninger
Viewing docs for netbox 5.3.0
published on Thursday, Apr 9, 2026 by e-breuninger

    Using getAvailablePrefix

    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 getAvailablePrefix(args: GetAvailablePrefixArgs, opts?: InvokeOptions): Promise<GetAvailablePrefixResult>
    function getAvailablePrefixOutput(args: GetAvailablePrefixOutputArgs, opts?: InvokeOptions): Output<GetAvailablePrefixResult>
    def get_available_prefix(id: Optional[str] = None,
                             prefix_id: Optional[float] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAvailablePrefixResult
    def get_available_prefix_output(id: pulumi.Input[Optional[str]] = None,
                             prefix_id: pulumi.Input[Optional[float]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAvailablePrefixResult]
    func LookupAvailablePrefix(ctx *Context, args *LookupAvailablePrefixArgs, opts ...InvokeOption) (*LookupAvailablePrefixResult, error)
    func LookupAvailablePrefixOutput(ctx *Context, args *LookupAvailablePrefixOutputArgs, opts ...InvokeOption) LookupAvailablePrefixResultOutput

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

    public static class GetAvailablePrefix 
    {
        public static Task<GetAvailablePrefixResult> InvokeAsync(GetAvailablePrefixArgs args, InvokeOptions? opts = null)
        public static Output<GetAvailablePrefixResult> Invoke(GetAvailablePrefixInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAvailablePrefixResult> getAvailablePrefix(GetAvailablePrefixArgs args, InvokeOptions options)
    public static Output<GetAvailablePrefixResult> getAvailablePrefix(GetAvailablePrefixArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getAvailablePrefix:getAvailablePrefix
      arguments:
        # arguments dictionary
    data "netbox_getavailableprefix" "name" {
        # arguments
    }

    The following arguments are supported:

    PrefixId double
    Id string
    The ID of this resource.
    PrefixId float64
    Id string
    The ID of this resource.
    prefix_id number
    id string
    The ID of this resource.
    prefixId Double
    id String
    The ID of this resource.
    prefixId number
    id string
    The ID of this resource.
    prefix_id float
    id str
    The ID of this resource.
    prefixId Number
    id String
    The ID of this resource.

    getAvailablePrefix Result

    The following output properties are available:

    id string
    The ID of this resource.
    prefix_id number
    prefixes_availables list(object)
    id String
    The ID of this resource.
    prefixId Number
    prefixesAvailables List<Property Map>

    Supporting Types

    GetAvailablePrefixPrefixesAvailable

    Family double
    Prefix string
    VrfId double
    Family float64
    Prefix string
    VrfId float64
    family number
    prefix string
    vrf_id number
    family Double
    prefix String
    vrfId Double
    family number
    prefix string
    vrfId number
    family float
    prefix str
    vrf_id float
    family Number
    prefix String
    vrfId Number

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    Viewing docs for netbox 5.3.0
    published on Thursday, Apr 9, 2026 by e-breuninger
      Try Pulumi Cloud free. Your team will thank you.