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 rack_reservation objects matching the given filters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getRackReservations({
limit: 10,
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_rack_reservations(limit=10)
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.GetRackReservations(ctx, &netbox.GetRackReservationsArgs{
Limit: pulumi.Float64Ref(10),
}, 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.GetRackReservations.Invoke(new()
{
Limit = 10,
});
});
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.GetRackReservationsArgs;
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.getRackReservations(GetRackReservationsArgs.builder()
.limit(10)
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getRackReservations
arguments:
limit: 10
Example coming soon!
Using getRackReservations
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 getRackReservations(args: GetRackReservationsArgs, opts?: InvokeOptions): Promise<GetRackReservationsResult>
function getRackReservationsOutput(args: GetRackReservationsOutputArgs, opts?: InvokeOutputOptions): Output<GetRackReservationsResult>def get_rack_reservations(filters: Optional[Sequence[GetRackReservationsFilter]] = None,
limit: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetRackReservationsResult
def get_rack_reservations_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetRackReservationsFilterArgs]]]] = None,
limit: pulumi.Input[Optional[float]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetRackReservationsResult]func GetRackReservations(ctx *Context, args *GetRackReservationsArgs, opts ...InvokeOption) (*GetRackReservationsResult, error)
func GetRackReservationsOutput(ctx *Context, args *GetRackReservationsOutputArgs, opts ...InvokeOption) GetRackReservationsResultOutput> Note: This function is named GetRackReservations in the Go SDK.
public static class GetRackReservations
{
public static Task<GetRackReservationsResult> InvokeAsync(GetRackReservationsArgs args, InvokeOptions? opts = null)
public static Output<GetRackReservationsResult> Invoke(GetRackReservationsInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetRackReservationsResult> Invoke(GetRackReservationsInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetRackReservationsResult> getRackReservations(GetRackReservationsArgs args, InvokeOptions options)
public static Output<GetRackReservationsResult> getRackReservations(GetRackReservationsArgs args, InvokeOptions options)
public static Output<GetRackReservationsResult> getRackReservations(GetRackReservationsArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getRackReservations:getRackReservations
arguments:
# arguments dictionarydata "netbox_get_rack_reservations" "name" {
# arguments
}The following arguments are supported:
- Filters
List<Get
Rack Reservations Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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
Rack Reservations Filter - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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
Rack Reservations Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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
Rack Reservations Filter[] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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
Rack Reservations Filter] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
getRackReservations Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Rack
Reservations List<GetRack Reservations Rack Reservation> - The matching rack*reservations.
- Filters
List<Get
Rack Reservations Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
- Rack
Reservations []GetRack Reservations Rack Reservation - The matching rack*reservations.
- Filters
[]Get
Rack Reservations Filter - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
- rack_
reservations list(object) - The matching rack*reservations.
- filters list(object)
- Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
- rack
Reservations List<GetRack Reservations Rack Reservation> - The matching rack*reservations.
- filters
List<Get
Rack Reservations Filter> - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
- rack
Reservations GetRack Reservations Rack Reservation[] - The matching rack*reservations.
- filters
Get
Rack Reservations Filter[] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
- rack_
reservations Sequence[GetRack Reservations Rack Reservation] - The matching rack*reservations.
- filters
Sequence[Get
Rack Reservations Filter] - Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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.
- rack
Reservations List<Property Map> - The matching rack*reservations.
- filters List<Property Map>
- Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, tag, tagany, tag_*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
GetRackReservationsFilter
GetRackReservationsRackReservation
- 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
- Purpose of the reservation.
- Id double
- NetBox id.
- Last
Updated string - Owner
Id double - Id of the owner the object is assigned to.
- Rack
Id double - Id of the rack.
- Status string
- Status of the reservation. One of: pending, active, stale.
- 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.
- Tenant
Id double - Id of the tenant.
- Unit
Count double - Number of rack units reserved.
- Units List<double>
- Rack unit numbers being reserved.
- Url string
- User
Id double - Id of the NetBox user holding the reservation.
- 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
- Purpose of the reservation.
- Id float64
- NetBox id.
- Last
Updated string - Owner
Id float64 - Id of the owner the object is assigned to.
- Rack
Id float64 - Id of the rack.
- Status string
- Status of the reservation. One of: pending, active, stale.
- []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.
- Tenant
Id float64 - Id of the tenant.
- Unit
Count float64 - Number of rack units reserved.
- Units []float64
- Rack unit numbers being reserved.
- Url string
- User
Id float64 - Id of the NetBox user holding the reservation.
- 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
- Purpose of the reservation.
- id number
- NetBox id.
- last_
updated string - owner_
id number - Id of the owner the object is assigned to.
- rack_
id number - Id of the rack.
- status string
- Status of the reservation. One of: pending, active, stale.
- 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.
- tenant_
id number - Id of the tenant.
- unit_
count number - Number of rack units reserved.
- units list(number)
- Rack unit numbers being reserved.
- url string
- user_
id number - Id of the NetBox user holding the reservation.
- 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
- Purpose of the reservation.
- id Double
- NetBox id.
- last
Updated String - owner
Id Double - Id of the owner the object is assigned to.
- rack
Id Double - Id of the rack.
- status String
- Status of the reservation. One of: pending, active, stale.
- 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.
- tenant
Id Double - Id of the tenant.
- unit
Count Double - Number of rack units reserved.
- units List<Double>
- Rack unit numbers being reserved.
- url String
- user
Id Double - Id of the NetBox user holding the reservation.
- 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
- Purpose of the reservation.
- id number
- NetBox id.
- last
Updated string - owner
Id number - Id of the owner the object is assigned to.
- rack
Id number - Id of the rack.
- status string
- Status of the reservation. One of: pending, active, stale.
- 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.
- tenant
Id number - Id of the tenant.
- unit
Count number - Number of rack units reserved.
- units number[]
- Rack unit numbers being reserved.
- url string
- user
Id number - Id of the NetBox user holding the reservation.
- 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
- Purpose of the reservation.
- id float
- NetBox id.
- last_
updated str - owner_
id float - Id of the owner the object is assigned to.
- rack_
id float - Id of the rack.
- status str
- Status of the reservation. One of: pending, active, stale.
- 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.
- tenant_
id float - Id of the tenant.
- unit_
count float - Number of rack units reserved.
- units Sequence[float]
- Rack unit numbers being reserved.
- url str
- user_
id float - Id of the NetBox user holding the reservation.
- 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
- Purpose of the reservation.
- id Number
- NetBox id.
- last
Updated String - owner
Id Number - Id of the owner the object is assigned to.
- rack
Id Number - Id of the rack.
- status String
- Status of the reservation. One of: pending, active, stale.
- 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.
- tenant
Id Number - Id of the tenant.
- unit
Count Number - Number of rack units reserved.
- units List<Number>
- Rack unit numbers being reserved.
- url String
- user
Id Number - Id of the NetBox user holding the reservation.
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