Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
published on Wednesday, Nov 4, 2026 by e-breuninger
Lists rear_port_template objects matching the given filters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getRearPortTemplates({
filters: [{
name: "name",
value: "test-rear_port_template",
}],
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_rear_port_templates(filters=[{
"name": "name",
"value": "test-rear_port_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.GetRearPortTemplates(ctx, &netbox.GetRearPortTemplatesArgs{
Filters: []netbox.GetRearPortTemplatesFilter{
{
Name: "name",
Value: "test-rear_port_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.GetRearPortTemplates.Invoke(new()
{
Filters = new[]
{
new Netbox.Inputs.GetRearPortTemplatesFilterInputArgs
{
Name = "name",
Value = "test-rear_port_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.GetRearPortTemplatesArgs;
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.getRearPortTemplates(GetRearPortTemplatesArgs.builder()
.filters(GetRearPortTemplatesFilterArgs.builder()
.name("name")
.value("test-rear_port_template")
.build())
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getRearPortTemplates
arguments:
filters:
- name: name
value: test-rear_port_template
Example coming soon!
Using getRearPortTemplates
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 getRearPortTemplates(args: GetRearPortTemplatesArgs, opts?: InvokeOptions): Promise<GetRearPortTemplatesResult>
function getRearPortTemplatesOutput(args: GetRearPortTemplatesOutputArgs, opts?: InvokeOutputOptions): Output<GetRearPortTemplatesResult>def get_rear_port_templates(filters: Optional[Sequence[GetRearPortTemplatesFilter]] = None,
limit: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetRearPortTemplatesResult
def get_rear_port_templates_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetRearPortTemplatesFilterArgs]]]] = None,
limit: pulumi.Input[Optional[float]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetRearPortTemplatesResult]func GetRearPortTemplates(ctx *Context, args *GetRearPortTemplatesArgs, opts ...InvokeOption) (*GetRearPortTemplatesResult, error)
func GetRearPortTemplatesOutput(ctx *Context, args *GetRearPortTemplatesOutputArgs, opts ...InvokeOption) GetRearPortTemplatesResultOutput> Note: This function is named GetRearPortTemplates in the Go SDK.
public static class GetRearPortTemplates
{
public static Task<GetRearPortTemplatesResult> InvokeAsync(GetRearPortTemplatesArgs args, InvokeOptions? opts = null)
public static Output<GetRearPortTemplatesResult> Invoke(GetRearPortTemplatesInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetRearPortTemplatesResult> Invoke(GetRearPortTemplatesInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetRearPortTemplatesResult> getRearPortTemplates(GetRearPortTemplatesArgs args, InvokeOptions options)
public static Output<GetRearPortTemplatesResult> getRearPortTemplates(GetRearPortTemplatesArgs args, InvokeOptions options)
public static Output<GetRearPortTemplatesResult> getRearPortTemplates(GetRearPortTemplatesArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getRearPortTemplates:getRearPortTemplates
arguments:
# arguments dictionarydata "netbox_get_rear_port_templates" "name" {
# arguments
}The following arguments are supported:
- Filters
List<Get
Rear Port Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- Limit double
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- Filters
[]Get
Rear Port Templates Filter - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- limit number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters
List<Get
Rear Port Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- limit Double
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters
Get
Rear Port Templates Filter[] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- limit number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
- filters
Sequence[Get
Rear Port Templates Filter] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- limit Number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
getRearPortTemplates Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Rear
Port List<GetTemplates Rear Port Templates Rear Port Template> - The matching rearporttemplates.
- Filters
List<Get
Rear Port Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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.
- Rear
Port []GetTemplates Rear Port Templates Rear Port Template - The matching rearporttemplates.
- Filters
[]Get
Rear Port Templates Filter - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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.
- rear_
port_ list(object)templates - The matching rearporttemplates.
- filters list(object)
- Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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.
- rear
Port List<GetTemplates Rear Port Templates Rear Port Template> - The matching rearporttemplates.
- filters
List<Get
Rear Port Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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.
- rear
Port GetTemplates Rear Port Templates Rear Port Template[] - The matching rearporttemplates.
- filters
Get
Rear Port Templates Filter[] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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.
- rear_
port_ Sequence[Gettemplates Rear Port Templates Rear Port Template] - The matching rearporttemplates.
- filters
Sequence[Get
Rear Port Templates Filter] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- 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.
- rear
Port List<Property Map>Templates - The matching rearporttemplates.
- filters List<Property Map>
- Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, moduletypeid, moduletypeidn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, type, typeempty, typeic, typeie, typeiew, typeiregex, typeisw, typen, typenic, typenie, typeniew, typenisw, type__regex. Repeating a name sends that parameter once per value.
- limit Number
- The maximum number of objects to return from the API lookup. Defaults to 1000.
Supporting Types
GetRearPortTemplatesFilter
GetRearPortTemplatesRearPortTemplate
- Color
Hex string - RGB color in hex (e.g. ff0000).
- Created string
- Description string
- Device
Type doubleId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- Id double
- NetBox id.
- Label string
- Physical label.
- Last
Updated string - Module
Type doubleId - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- Name string
- Positions double
- Number of front ports that can map to this rear port. Must be a whole number.
- Type string
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- Url string
- Color
Hex string - RGB color in hex (e.g. ff0000).
- Created string
- Description string
- Device
Type float64Id - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- Id float64
- NetBox id.
- Label string
- Physical label.
- Last
Updated string - Module
Type float64Id - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- Name string
- Positions float64
- Number of front ports that can map to this rear port. Must be a whole number.
- Type string
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- Url string
- color_
hex string - RGB color in hex (e.g. ff0000).
- created string
- description string
- device_
type_ numberid - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- id number
- NetBox id.
- label string
- Physical label.
- last_
updated string - module_
type_ numberid - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- name string
- positions number
- Number of front ports that can map to this rear port. Must be a whole number.
- type string
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- url string
- color
Hex String - RGB color in hex (e.g. ff0000).
- created String
- description String
- device
Type DoubleId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- id Double
- NetBox id.
- label String
- Physical label.
- last
Updated String - module
Type DoubleId - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- name String
- positions Double
- Number of front ports that can map to this rear port. Must be a whole number.
- type String
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- url String
- color
Hex string - RGB color in hex (e.g. ff0000).
- created string
- description string
- device
Type numberId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- id number
- NetBox id.
- label string
- Physical label.
- last
Updated string - module
Type numberId - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- name string
- positions number
- Number of front ports that can map to this rear port. Must be a whole number.
- type string
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- url string
- color_
hex str - RGB color in hex (e.g. ff0000).
- created str
- description str
- device_
type_ floatid - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- id float
- NetBox id.
- label str
- Physical label.
- last_
updated str - module_
type_ floatid - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- name str
- positions float
- Number of front ports that can map to this rear port. Must be a whole number.
- type str
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- url str
- color
Hex String - RGB color in hex (e.g. ff0000).
- created String
- description String
- device
Type NumberId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- id Number
- NetBox id.
- label String
- Physical label.
- last
Updated String - module
Type NumberId - Id of the module type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- name String
- positions Number
- Number of front ports that can map to this rear port. Must be a whole number.
- type String
- Port type as its NetBox slug, e.g. 8p8c, lc, mpo (any of NetBox's port type choices).
- 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.0
published on Wednesday, Nov 4, 2026 by e-breuninger
published on Wednesday, Nov 4, 2026 by e-breuninger