Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
published on Monday, Nov 16, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
published on Monday, Nov 16, 2026 by e-breuninger
Lists platform objects matching the given filters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getPlatforms({
filters: [{
name: "name",
value: "test-platform",
}],
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_platforms(filters=[{
"name": "name",
"value": "test-platform",
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := netbox.GetPlatforms(ctx, &netbox.GetPlatformsArgs{
Filters: []netbox.GetPlatformsFilter{
{
Name: "name",
Value: "test-platform",
},
},
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;
return await Deployment.RunAsync(() =>
{
var test = Netbox.GetPlatforms.Invoke(new()
{
Filters = new[]
{
new Netbox.Inputs.GetPlatformsFilterInputArgs
{
Name = "name",
Value = "test-platform",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetPlatformsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var test = NetboxFunctions.getPlatforms(GetPlatformsArgs.builder()
.filters(GetPlatformsFilterArgs.builder()
.name("name")
.value("test-platform")
.build())
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getPlatforms
arguments:
filters:
- name: name
value: test-platform
Example coming soon!
Using getPlatforms
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 getPlatforms(args: GetPlatformsArgs, opts?: InvokeOptions): Promise<GetPlatformsResult>
function getPlatformsOutput(args: GetPlatformsOutputArgs, opts?: InvokeOutputOptions): Output<GetPlatformsResult>def get_platforms(filters: Optional[Sequence[GetPlatformsFilter]] = None,
limit: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetPlatformsResult
def get_platforms_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetPlatformsFilterArgs]]]] = None,
limit: pulumi.Input[Optional[float]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetPlatformsResult]func GetPlatforms(ctx *Context, args *GetPlatformsArgs, opts ...InvokeOption) (*GetPlatformsResult, error)
func GetPlatformsOutput(ctx *Context, args *GetPlatformsOutputArgs, opts ...InvokeOption) GetPlatformsResultOutput> Note: This function is named GetPlatforms in the Go SDK.
public static class GetPlatforms
{
public static Task<GetPlatformsResult> InvokeAsync(GetPlatformsArgs args, InvokeOptions? opts = null)
public static Output<GetPlatformsResult> Invoke(GetPlatformsInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetPlatformsResult> Invoke(GetPlatformsInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetPlatformsResult> getPlatforms(GetPlatformsArgs args, InvokeOptions options)
public static Output<GetPlatformsResult> getPlatforms(GetPlatformsArgs args, InvokeOptions options)
public static Output<GetPlatformsResult> getPlatforms(GetPlatformsArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getPlatforms:getPlatforms
arguments:
# arguments dictionarydata "netbox_get_platforms" "name" {
# arguments
}The following arguments are supported:
- Filters
List<Get
Platforms Filter> - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- Limit double
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- Filters
[]Get
Platforms Filter - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- Limit float64
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters list(object)
- Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters
List<Get
Platforms Filter> - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit Double
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters
Get
Platforms Filter[] - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters
Sequence[Get
Platforms Filter] - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit float
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters List<Property Map>
- Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit Number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
getPlatforms Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Platforms
List<Get
Platforms Platform> - The matching platforms.
- Filters
List<Get
Platforms Filter> - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- Limit double
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- Id string
- The provider-assigned unique ID for this managed resource.
- Platforms
[]Get
Platforms Platform - The matching platforms.
- Filters
[]Get
Platforms Filter - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- Limit float64
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- id string
- The provider-assigned unique ID for this managed resource.
- platforms list(object)
- The matching platforms.
- filters list(object)
- Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- id String
- The provider-assigned unique ID for this managed resource.
- platforms
List<Get
Platforms Platform> - The matching platforms.
- filters
List<Get
Platforms Filter> - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit Double
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- id string
- The provider-assigned unique ID for this managed resource.
- platforms
Get
Platforms Platform[] - The matching platforms.
- filters
Get
Platforms Filter[] - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- id str
- The provider-assigned unique ID for this managed resource.
- platforms
Sequence[Get
Platforms Platform] - The matching platforms.
- filters
Sequence[Get
Platforms Filter] - Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit float
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- id String
- The provider-assigned unique ID for this managed resource.
- platforms List<Property Map>
- The matching platforms.
- filters List<Property Map>
- Query filters, sent as API list parameters. Supported names: ancestor, ancestorn, ancestorid, ancestoridn, availablefordevicetype, configtemplateid, configtemplate_idn, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, manufacturer, manufacturern, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, parent, parentn, parentid, parentidn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_id_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
- limit Number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
Supporting Types
GetPlatformsFilter
GetPlatformsPlatform
- Comments string
- Config
Template doubleId - Id of the config template.
- Created string
- Custom
Fields Dictionary<string, string> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- Description string
- Device
Count double - Number of devices using the platform.
- Id double
- NetBox id.
- Last
Updated string - Manufacturer
Id double - Id of the manufacturer.
- Name string
- Owner
Id double - Id of the owner the object is assigned to.
- Parent
Id double - Id of the parent platform.
- Slug string
- URL-friendly unique shorthand; derived from name when not set.
- List<string>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<string>
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Virtual
Machine doubleCount - Number of virtual machines using the platform.
- Comments string
- Config
Template float64Id - Id of the config template.
- Created string
- Custom
Fields map[string]string - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- Description string
- Device
Count float64 - Number of devices using the platform.
- Id float64
- NetBox id.
- Last
Updated string - Manufacturer
Id float64 - Id of the manufacturer.
- Name string
- Owner
Id float64 - Id of the owner the object is assigned to.
- Parent
Id float64 - Id of the parent platform.
- Slug string
- URL-friendly unique shorthand; derived from name when not set.
- []string
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- []string
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Virtual
Machine float64Count - Number of virtual machines using the platform.
- comments string
- config_
template_ numberid - Id of the config template.
- created string
- custom_
fields map(string) - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- device_
count number - Number of devices using the platform.
- id number
- NetBox id.
- last_
updated string - manufacturer_
id number - Id of the manufacturer.
- name string
- owner_
id number - Id of the owner the object is assigned to.
- parent_
id number - Id of the parent platform.
- slug string
- URL-friendly unique shorthand; derived from name when not set.
- list(string)
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- list(string)
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- virtual_
machine_ numbercount - Number of virtual machines using the platform.
- comments String
- config
Template DoubleId - Id of the config template.
- created String
- custom
Fields Map<String,String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- device
Count Double - Number of devices using the platform.
- id Double
- NetBox id.
- last
Updated String - manufacturer
Id Double - Id of the manufacturer.
- name String
- owner
Id Double - Id of the owner the object is assigned to.
- parent
Id Double - Id of the parent platform.
- slug String
- URL-friendly unique shorthand; derived from name when not set.
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- virtual
Machine DoubleCount - Number of virtual machines using the platform.
- comments string
- config
Template numberId - Id of the config template.
- created string
- custom
Fields {[key: string]: string} - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- device
Count number - Number of devices using the platform.
- id number
- NetBox id.
- last
Updated string - manufacturer
Id number - Id of the manufacturer.
- name string
- owner
Id number - Id of the owner the object is assigned to.
- parent
Id number - Id of the parent platform.
- slug string
- URL-friendly unique shorthand; derived from name when not set.
- string[]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- string[]
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- virtual
Machine numberCount - Number of virtual machines using the platform.
- comments str
- config_
template_ floatid - Id of the config template.
- created str
- custom_
fields Mapping[str, str] - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description str
- device_
count float - Number of devices using the platform.
- id float
- NetBox id.
- last_
updated str - manufacturer_
id float - Id of the manufacturer.
- name str
- owner_
id float - Id of the owner the object is assigned to.
- parent_
id float - Id of the parent platform.
- slug str
- URL-friendly unique shorthand; derived from name when not set.
- Sequence[str]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- Sequence[str]
- Slugs of all tags on the object, including the provider's default_tags.
- url str
- virtual_
machine_ floatcount - Number of virtual machines using the platform.
- comments String
- config
Template NumberId - Id of the config template.
- created String
- custom
Fields Map<String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- device
Count Number - Number of devices using the platform.
- id Number
- NetBox id.
- last
Updated String - manufacturer
Id Number - Id of the manufacturer.
- name String
- owner
Id Number - Id of the owner the object is assigned to.
- parent
Id Number - Id of the parent platform.
- slug String
- URL-friendly unique shorthand; derived from name when not set.
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- virtual
Machine NumberCount - Number of virtual machines using the platform.
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
netbox
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
published on Monday, Nov 16, 2026 by e-breuninger