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 module_bay_template objects matching the given filters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getModuleBayTemplates({
filters: [{
name: "name",
value: "test-module_bay_template",
}],
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_module_bay_templates(filters=[{
"name": "name",
"value": "test-module_bay_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.GetModuleBayTemplates(ctx, &netbox.GetModuleBayTemplatesArgs{
Filters: []netbox.GetModuleBayTemplatesFilter{
{
Name: "name",
Value: "test-module_bay_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.GetModuleBayTemplates.Invoke(new()
{
Filters = new[]
{
new Netbox.Inputs.GetModuleBayTemplatesFilterInputArgs
{
Name = "name",
Value = "test-module_bay_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.GetModuleBayTemplatesArgs;
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.getModuleBayTemplates(GetModuleBayTemplatesArgs.builder()
.filters(GetModuleBayTemplatesFilterArgs.builder()
.name("name")
.value("test-module_bay_template")
.build())
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getModuleBayTemplates
arguments:
filters:
- name: name
value: test-module_bay_template
Example coming soon!
Using getModuleBayTemplates
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 getModuleBayTemplates(args: GetModuleBayTemplatesArgs, opts?: InvokeOptions): Promise<GetModuleBayTemplatesResult>
function getModuleBayTemplatesOutput(args: GetModuleBayTemplatesOutputArgs, opts?: InvokeOutputOptions): Output<GetModuleBayTemplatesResult>def get_module_bay_templates(filters: Optional[Sequence[GetModuleBayTemplatesFilter]] = None,
limit: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetModuleBayTemplatesResult
def get_module_bay_templates_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetModuleBayTemplatesFilterArgs]]]] = None,
limit: pulumi.Input[Optional[float]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetModuleBayTemplatesResult]func GetModuleBayTemplates(ctx *Context, args *GetModuleBayTemplatesArgs, opts ...InvokeOption) (*GetModuleBayTemplatesResult, error)
func GetModuleBayTemplatesOutput(ctx *Context, args *GetModuleBayTemplatesOutputArgs, opts ...InvokeOption) GetModuleBayTemplatesResultOutput> Note: This function is named GetModuleBayTemplates in the Go SDK.
public static class GetModuleBayTemplates
{
public static Task<GetModuleBayTemplatesResult> InvokeAsync(GetModuleBayTemplatesArgs args, InvokeOptions? opts = null)
public static Output<GetModuleBayTemplatesResult> Invoke(GetModuleBayTemplatesInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetModuleBayTemplatesResult> Invoke(GetModuleBayTemplatesInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetModuleBayTemplatesResult> getModuleBayTemplates(GetModuleBayTemplatesArgs args, InvokeOptions options)
public static Output<GetModuleBayTemplatesResult> getModuleBayTemplates(GetModuleBayTemplatesArgs args, InvokeOptions options)
public static Output<GetModuleBayTemplatesResult> getModuleBayTemplates(GetModuleBayTemplatesArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getModuleBayTemplates:getModuleBayTemplates
arguments:
# arguments dictionarydata "netbox_get_module_bay_templates" "name" {
# arguments
}The following arguments are supported:
- Filters
List<Get
Module Bay Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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
Module Bay Templates Filter - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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
Module Bay Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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
Module Bay Templates Filter[] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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
Module Bay Templates Filter] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
getModuleBayTemplates Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Module
Bay List<GetTemplates Module Bay Templates Module Bay Template> - The matching modulebaytemplates.
- Filters
List<Get
Module Bay Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
- Module
Bay []GetTemplates Module Bay Templates Module Bay Template - The matching modulebaytemplates.
- Filters
[]Get
Module Bay Templates Filter - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
- module_
bay_ list(object)templates - The matching modulebaytemplates.
- filters list(object)
- Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
- module
Bay List<GetTemplates Module Bay Templates Module Bay Template> - The matching modulebaytemplates.
- filters
List<Get
Module Bay Templates Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
- module
Bay GetTemplates Module Bay Templates Module Bay Template[] - The matching modulebaytemplates.
- filters
Get
Module Bay Templates Filter[] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
- module_
bay_ Sequence[Gettemplates Module Bay Templates Module Bay Template] - The matching modulebaytemplates.
- filters
Sequence[Get
Module Bay Templates Filter] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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.
- module
Bay List<Property Map>Templates - The matching modulebaytemplates.
- filters List<Property Map>
- Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex. 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
GetModuleBayTemplatesFilter
GetModuleBayTemplatesModuleBayTemplate
- Created string
- Description string
- Device
Type doubleId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- Enabled bool
- Whether the module bay is enabled.
- 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
- Position string
- Identifier of the bay's position, substituted into the names of the module's components.
- Url string
- Created string
- Description string
- Device
Type float64Id - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- Enabled bool
- Whether the module bay is enabled.
- 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
- Position string
- Identifier of the bay's position, substituted into the names of the module's components.
- Url string
- created string
- description string
- device_
type_ numberid - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- enabled bool
- Whether the module bay is enabled.
- 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
- position string
- Identifier of the bay's position, substituted into the names of the module's components.
- url string
- created String
- description String
- device
Type DoubleId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- enabled Boolean
- Whether the module bay is enabled.
- 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
- position String
- Identifier of the bay's position, substituted into the names of the module's components.
- url String
- created string
- description string
- device
Type numberId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- enabled boolean
- Whether the module bay is enabled.
- 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
- position string
- Identifier of the bay's position, substituted into the names of the module's components.
- url string
- created str
- description str
- device_
type_ floatid - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- enabled bool
- Whether the module bay is enabled.
- 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
- position str
- Identifier of the bay's position, substituted into the names of the module's components.
- url str
- created String
- description String
- device
Type NumberId - Id of the device type. Set exactly one of devicetypeid and moduletypeid; NetBox rejects both and neither.
- enabled Boolean
- Whether the module bay is enabled.
- 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
- position String
- Identifier of the bay's position, substituted into the names of the module's components.
- 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