netbox.getPrefix

Explore with Pulumi AI

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

Using getPrefix

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 getPrefix(args: GetPrefixArgs, opts?: InvokeOptions): Promise<GetPrefixResult>
function getPrefixOutput(args: GetPrefixOutputArgs, opts?: InvokeOptions): Output<GetPrefixResult>

def get_prefix(cidr: Optional[str] = None,
               custom_fields: Optional[Mapping[str, str]] = None,
               description: Optional[str] = None,
               family: Optional[float] = None,
               prefix: Optional[str] = None,
               role_id: Optional[float] = None,
               site_id: Optional[float] = None,
               status: Optional[str] = None,
               tag: Optional[str] = None,
               tag_n: Optional[str] = None,
               tenant_id: Optional[float] = None,
               vlan_id: Optional[float] = None,
               vlan_vid: Optional[float] = None,
               vrf_id: Optional[float] = None,
               opts: Optional[InvokeOptions] = None) -> GetPrefixResult
def get_prefix_output(cidr: Optional[pulumi.Input[str]] = None,
               custom_fields: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               description: Optional[pulumi.Input[str]] = None,
               family: Optional[pulumi.Input[float]] = None,
               prefix: Optional[pulumi.Input[str]] = None,
               role_id: Optional[pulumi.Input[float]] = None,
               site_id: Optional[pulumi.Input[float]] = None,
               status: Optional[pulumi.Input[str]] = None,
               tag: Optional[pulumi.Input[str]] = None,
               tag_n: Optional[pulumi.Input[str]] = None,
               tenant_id: Optional[pulumi.Input[float]] = None,
               vlan_id: Optional[pulumi.Input[float]] = None,
               vlan_vid: Optional[pulumi.Input[float]] = None,
               vrf_id: Optional[pulumi.Input[float]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPrefixResult]

func LookupPrefix(ctx *Context, args *LookupPrefixArgs, opts ...InvokeOption) (*LookupPrefixResult, error)
func LookupPrefixOutput(ctx *Context, args *LookupPrefixOutputArgs, opts ...InvokeOption) LookupPrefixResultOutput

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

public static class GetPrefix 
{
    public static Task<GetPrefixResult> InvokeAsync(GetPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetPrefixResult> Invoke(GetPrefixInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrefixResult> getPrefix(GetPrefixArgs args, InvokeOptions options)
public static Output<GetPrefixResult> getPrefix(GetPrefixArgs args, InvokeOptions options)

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

The following arguments are supported:

Cidr string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
CustomFields Dictionary<string, string>
Description string: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Family double: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Prefix string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
RoleId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
SiteId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Status string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Tag string: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
TagN string: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
TenantId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanVid double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VrfId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

Cidr string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
CustomFields map[string]string
Description string: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Family float64: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Prefix string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
RoleId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
SiteId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Status string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Tag string: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
TagN string: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
TenantId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanVid float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VrfId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

cidr String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
customFields Map<String,String>
description String: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family Double: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
prefix String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
roleId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
siteId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag String: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tagN String: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenantId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanVid Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrfId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

cidr string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
customFields {[key: string]: string}
description string: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family number: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
prefix string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
roleId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
siteId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag string: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tagN string: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenantId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanVid number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrfId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

cidr str: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
custom_fields Mapping[str, str]
description str: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family float: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
prefix str: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
role_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
site_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status str: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag str: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag_n str: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenant_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlan_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlan_vid float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrf_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

cidr String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
customFields Map<String>
description String: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family Number: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
prefix String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
roleId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
siteId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag String: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tagN String: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenantId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanVid Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrfId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

getPrefix Result

The following output properties are available:

Description string: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Family double: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Id double: The ID of this resource.
RoleId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Tags List<string>
Cidr string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
CustomFields Dictionary<string, string>
Prefix string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
SiteId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Status string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Tag string: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
TagN string: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
TenantId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanVid double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VrfId double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

Description string: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Family float64: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Id float64: The ID of this resource.
RoleId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Tags []string
Cidr string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
CustomFields map[string]string
Prefix string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
SiteId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Status string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
Tag string: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
TagN string: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
TenantId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VlanVid float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
VrfId float64: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

description String: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family Double: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
id Double: The ID of this resource.
roleId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tags List<String>
cidr String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
customFields Map<String,String>
prefix String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
siteId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag String: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tagN String: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenantId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanVid Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrfId Double: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

description string: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family number: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
id number: The ID of this resource.
roleId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tags string[]
cidr string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
customFields {[key: string]: string}
prefix string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
siteId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status string: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag string: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tagN string: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenantId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanVid number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrfId number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

description str: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family float: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
id float: The ID of this resource.
role_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tags Sequence[str]
cidr str: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
custom_fields Mapping[str, str]
prefix str: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
site_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status str: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag str: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag_n str: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenant_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlan_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlan_vid float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrf_id float: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

description String: Description to include in the data source filter. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
family Number: The IP family of the prefix. One of 4 or 6. At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
id Number: The ID of this resource.
roleId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tags List<String>
cidr String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with prefix.
Deprecated: Deprecated
customFields Map<String>
prefix String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given. Conflicts with cidr.
siteId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
status String: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tag String: Tag to include in the data source filter (must match the tag's slug). At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
tagN String: Tag to exclude from the data source filter (must match the tag's slug). Refer to Netbox's documentation for more information on available lookup expressions.
tenantId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vlanVid Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.
vrfId Number: At least one of description, family, prefix, vlan_vid, vrf_id, vlan_id, tenant_id, site_id, role_id, cidr, tag or status must be given.

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.getPrefix

On this page

On this page

Using getPrefix

getPrefix Result

Package Details

On this page

On this page