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 service_template objects matching the given filters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getServiceTemplates({
filters: [{
name: "name",
value: "test-service_template",
}],
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_service_templates(filters=[{
"name": "name",
"value": "test-service_template",
}])
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.GetServiceTemplates(ctx, &netbox.GetServiceTemplatesArgs{
Filters: []netbox.GetServiceTemplatesFilter{
{
Name: "name",
Value: "test-service_template",
},
},
}, 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.GetServiceTemplates.Invoke(new()
{
Filters = new[]
{
new Netbox.Inputs.GetServiceTemplatesFilterInputArgs
{
Name = "name",
Value = "test-service_template",
},
},
});
});
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.GetServiceTemplatesArgs;
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.getServiceTemplates(GetServiceTemplatesArgs.builder()
.filters(GetServiceTemplatesFilterArgs.builder()
.name("name")
.value("test-service_template")
.build())
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getServiceTemplates
arguments:
filters:
- name: name
value: test-service_template
Example coming soon!
Using getServiceTemplates
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 getServiceTemplates(args: GetServiceTemplatesArgs, opts?: InvokeOptions): Promise<GetServiceTemplatesResult>
function getServiceTemplatesOutput(args: GetServiceTemplatesOutputArgs, opts?: InvokeOutputOptions): Output<GetServiceTemplatesResult>def get_service_templates(filters: Optional[Sequence[GetServiceTemplatesFilter]] = None,
limit: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetServiceTemplatesResult
def get_service_templates_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetServiceTemplatesFilterArgs]]]] = None,
limit: pulumi.Input[Optional[float]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetServiceTemplatesResult]func GetServiceTemplates(ctx *Context, args *GetServiceTemplatesArgs, opts ...InvokeOption) (*GetServiceTemplatesResult, error)
func GetServiceTemplatesOutput(ctx *Context, args *GetServiceTemplatesOutputArgs, opts ...InvokeOption) GetServiceTemplatesResultOutput> Note: This function is named GetServiceTemplates in the Go SDK.
public static class GetServiceTemplates
{
public static Task<GetServiceTemplatesResult> InvokeAsync(GetServiceTemplatesArgs args, InvokeOptions? opts = null)
public static Output<GetServiceTemplatesResult> Invoke(GetServiceTemplatesInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetServiceTemplatesResult> Invoke(GetServiceTemplatesInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetServiceTemplatesResult> getServiceTemplates(GetServiceTemplatesArgs args, InvokeOptions options)
public static Output<GetServiceTemplatesResult> getServiceTemplates(GetServiceTemplatesArgs args, InvokeOptions options)
public static Output<GetServiceTemplatesResult> getServiceTemplates(GetServiceTemplatesArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getServiceTemplates:getServiceTemplates
arguments:
# arguments dictionarydata "netbox_get_service_templates" "name" {
# arguments
}The following arguments are supported:
- Filters
List<Get
Service Templates Filter> - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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
Service Templates Filter - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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
Service Templates Filter> - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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
Service Templates Filter[] - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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
Service Templates Filter] - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
getServiceTemplates Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Templates List<GetService Templates Service Template> - The matching service*templates.
- Filters
List<Get
Service Templates Filter> - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
- Service
Templates []GetService Templates Service Template - The matching service*templates.
- Filters
[]Get
Service Templates Filter - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
- service_
templates list(object) - The matching service*templates.
- filters list(object)
- Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
- service
Templates List<GetService Templates Service Template> - The matching service*templates.
- filters
List<Get
Service Templates Filter> - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
- service
Templates GetService Templates Service Template[] - The matching service*templates.
- filters
Get
Service Templates Filter[] - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
- service_
templates Sequence[GetService Templates Service Template] - The matching service*templates.
- filters
Sequence[Get
Service Templates Filter] - Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
- service
Templates List<Property Map> - The matching service*templates.
- filters List<Property Map>
- Query filters, sent as API list parameters. Supported names: 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, port, portempty, portgt, portgte, portlt, portlte, portn, protocol, protocolempty, protocolic, protocolie, protocoliew, protocoliregex, protocolisw, protocoln, protocolnic, protocolnie, protocolniew, protocolnisw, protocolregex, q, tag, tagany, tagn, tagid, tagidany, tag_idn. 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
GetServiceTemplatesFilter
GetServiceTemplatesServiceTemplate
- Comments string
- 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
- Id double
- NetBox id.
- Last
Updated string - Name string
- Owner
Id double - Id of the owner the object is assigned to.
- Ports List<double>
- Port numbers.
- Protocol string
- Transport protocol. One of: tcp, udp, sctp.
- 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
- Comments string
- 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
- Id float64
- NetBox id.
- Last
Updated string - Name string
- Owner
Id float64 - Id of the owner the object is assigned to.
- Ports []float64
- Port numbers.
- Protocol string
- Transport protocol. One of: tcp, udp, sctp.
- []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
- comments string
- 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
- id number
- NetBox id.
- last_
updated string - name string
- owner_
id number - Id of the owner the object is assigned to.
- ports list(number)
- Port numbers.
- protocol string
- Transport protocol. One of: tcp, udp, sctp.
- 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
- comments String
- 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
- id Double
- NetBox id.
- last
Updated String - name String
- owner
Id Double - Id of the owner the object is assigned to.
- ports List<Double>
- Port numbers.
- protocol String
- Transport protocol. One of: tcp, udp, sctp.
- 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
- comments string
- 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
- id number
- NetBox id.
- last
Updated string - name string
- owner
Id number - Id of the owner the object is assigned to.
- ports number[]
- Port numbers.
- protocol string
- Transport protocol. One of: tcp, udp, sctp.
- 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
- comments str
- 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
- id float
- NetBox id.
- last_
updated str - name str
- owner_
id float - Id of the owner the object is assigned to.
- ports Sequence[float]
- Port numbers.
- protocol str
- Transport protocol. One of: tcp, udp, sctp.
- 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
- comments String
- 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
- id Number
- NetBox id.
- last
Updated String - name String
- owner
Id Number - Id of the owner the object is assigned to.
- ports List<Number>
- Port numbers.
- protocol String
- Transport protocol. One of: tcp, udp, sctp.
- 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
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