published on Monday, Nov 16, 2026 by e-breuninger
published on Monday, Nov 16, 2026 by e-breuninger
A NetBox cable bundle (dcim.cablebundle): a named group of cables that run together.
From the official documentation:
A cable bundle is a logical grouping of individual cables. Bundles are useful for organizing cables that share a common purpose, route, or physical grouping such as a conduit, trunk, or wiring harness.
Assigning cables to a bundle is optional and does not affect cable tracing or connectivity. Bundles persist independently of their member cables: deleting a cable clears its bundle assignment but does not delete the bundle itself, allowing the bundle to be reused for replacement cables.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = netbox.getCableBundle({
name: "test-cable_bundle",
});
import pulumi
import pulumi_netbox as netbox
test = netbox.get_cable_bundle(name="test-cable_bundle")
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.LookupCableBundle(ctx, &netbox.LookupCableBundleArgs{
Name: pulumi.StringRef("test-cable_bundle"),
}, 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.GetCableBundle.Invoke(new()
{
Name = "test-cable_bundle",
});
});
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.GetCableBundleArgs;
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.getCableBundle(GetCableBundleArgs.builder()
.name("test-cable_bundle")
.build());
}
}
variables:
test:
fn::invoke:
function: netbox:getCableBundle
arguments:
name: test-cable_bundle
Example coming soon!
Using getCableBundle
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 getCableBundle(args: GetCableBundleArgs, opts?: InvokeOptions): Promise<GetCableBundleResult>
function getCableBundleOutput(args: GetCableBundleOutputArgs, opts?: InvokeOutputOptions): Output<GetCableBundleResult>def get_cable_bundle(created: Optional[str] = None,
custom_field_filters: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
id: Optional[float] = None,
last_updated: Optional[str] = None,
name: Optional[str] = None,
owner_group_id: Optional[float] = None,
owner_group_name: Optional[str] = None,
owner_id: Optional[float] = None,
owner_name: Optional[str] = None,
q: Optional[str] = None,
tag_id: Optional[float] = None,
tag_slug: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCableBundleResult
def get_cable_bundle_output(created: pulumi.Input[Optional[str]] = None,
custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
description: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[float]] = None,
last_updated: pulumi.Input[Optional[str]] = None,
name: pulumi.Input[Optional[str]] = None,
owner_group_id: pulumi.Input[Optional[float]] = None,
owner_group_name: pulumi.Input[Optional[str]] = None,
owner_id: pulumi.Input[Optional[float]] = None,
owner_name: pulumi.Input[Optional[str]] = None,
q: pulumi.Input[Optional[str]] = None,
tag_id: pulumi.Input[Optional[float]] = None,
tag_slug: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetCableBundleResult]func LookupCableBundle(ctx *Context, args *LookupCableBundleArgs, opts ...InvokeOption) (*LookupCableBundleResult, error)
func LookupCableBundleOutput(ctx *Context, args *LookupCableBundleOutputArgs, opts ...InvokeOption) LookupCableBundleResultOutput> Note: This function is named LookupCableBundle in the Go SDK.
public static class GetCableBundle
{
public static Task<GetCableBundleResult> InvokeAsync(GetCableBundleArgs args, InvokeOptions? opts = null)
public static Output<GetCableBundleResult> Invoke(GetCableBundleInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetCableBundleResult> Invoke(GetCableBundleInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetCableBundleResult> getCableBundle(GetCableBundleArgs args, InvokeOptions options)
public static Output<GetCableBundleResult> getCableBundle(GetCableBundleArgs args, InvokeOptions options)
public static Output<GetCableBundleResult> getCableBundle(GetCableBundleArgs args, InvokeOutputOptions options)
fn::invoke:
function: netbox:index/getCableBundle:getCableBundle
arguments:
# arguments dictionarydata "netbox_get_cable_bundle" "name" {
# arguments
}The following arguments are supported:
- Created string
- Custom
Field Dictionary<string, string>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Description string
- Id double
- NetBox id.
- Last
Updated string - Name string
- Owner
Group doubleId - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Id double - Id of the owner the object is assigned to.
- Owner
Name string - Name of the owner.
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Tag
Id double - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- Created string
- Custom
Field map[string]stringFilters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Description string
- Id float64
- NetBox id.
- Last
Updated string - Name string
- Owner
Group float64Id - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Id float64 - Id of the owner the object is assigned to.
- Owner
Name string - Name of the owner.
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Tag
Id float64 - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- created string
- custom_
field_ map(string)filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description string
- id number
- NetBox id.
- last_
updated string - name string
- owner_
group_ numberid - Id of the owner group.
- owner_
group_ stringname - Name of the owner group.
- owner_
id number - Id of the owner the object is assigned to.
- owner_
name string - Name of the owner.
- q string
- Search term, matched against the fields NetBox searches for this object type.
- tag_
id number - Id of a tag the object carries.
- tag_
slug string - Slug of a tag the object carries.
- created String
- custom
Field Map<String,String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description String
- id Double
- NetBox id.
- last
Updated String - name String
- owner
Group DoubleId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Id Double - Id of the owner the object is assigned to.
- owner
Name String - Name of the owner.
- q String
- Search term, matched against the fields NetBox searches for this object type.
- tag
Id Double - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
- created string
- custom
Field {[key: string]: string}Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description string
- id number
- NetBox id.
- last
Updated string - name string
- owner
Group numberId - Id of the owner group.
- owner
Group stringName - Name of the owner group.
- owner
Id number - Id of the owner the object is assigned to.
- owner
Name string - Name of the owner.
- q string
- Search term, matched against the fields NetBox searches for this object type.
- tag
Id number - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- created str
- custom_
field_ Mapping[str, str]filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description str
- id float
- NetBox id.
- last_
updated str - name str
- owner_
group_ floatid - Id of the owner group.
- owner_
group_ strname - Name of the owner group.
- owner_
id float - Id of the owner the object is assigned to.
- owner_
name str - Name of the owner.
- q str
- Search term, matched against the fields NetBox searches for this object type.
- tag_
id float - Id of a tag the object carries.
- tag_
slug str - Slug of a tag the object carries.
- created String
- custom
Field Map<String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- description String
- id Number
- NetBox id.
- last
Updated String - name String
- owner
Group NumberId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Id Number - Id of the owner the object is assigned to.
- owner
Name String - Name of the owner.
- q String
- Search term, matched against the fields NetBox searches for this object type.
- tag
Id Number - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
getCableBundle Result
The following output properties are available:
- Cable
Count double - Number of cables in the bundle.
- 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.
- 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
- Custom
Field Dictionary<string, string>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Owner
Group doubleId - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Name string - Name of the owner.
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Tag
Id double - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- Cable
Count float64 - Number of cables in the bundle.
- 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.
- []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
- Custom
Field map[string]stringFilters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- Owner
Group float64Id - Id of the owner group.
- Owner
Group stringName - Name of the owner group.
- Owner
Name string - Name of the owner.
- Q string
- Search term, matched against the fields NetBox searches for this object type.
- Tag
Id float64 - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- cable_
count number - Number of cables in the bundle.
- 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.
- 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
- custom_
field_ map(string)filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- owner_
group_ numberid - Id of the owner group.
- owner_
group_ stringname - Name of the owner group.
- owner_
name string - Name of the owner.
- q string
- Search term, matched against the fields NetBox searches for this object type.
- tag_
id number - Id of a tag the object carries.
- tag_
slug string - Slug of a tag the object carries.
- cable
Count Double - Number of cables in the bundle.
- 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.
- 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
- custom
Field Map<String,String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- owner
Group DoubleId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Name String - Name of the owner.
- q String
- Search term, matched against the fields NetBox searches for this object type.
- tag
Id Double - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
- cable
Count number - Number of cables in the bundle.
- 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.
- 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
- custom
Field {[key: string]: string}Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- owner
Group numberId - Id of the owner group.
- owner
Group stringName - Name of the owner group.
- owner
Name string - Name of the owner.
- q string
- Search term, matched against the fields NetBox searches for this object type.
- tag
Id number - Id of a tag the object carries.
- string
- Slug of a tag the object carries.
- cable_
count float - Number of cables in the bundle.
- 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.
- 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
- custom_
field_ Mapping[str, str]filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- owner_
group_ floatid - Id of the owner group.
- owner_
group_ strname - Name of the owner group.
- owner_
name str - Name of the owner.
- q str
- Search term, matched against the fields NetBox searches for this object type.
- tag_
id float - Id of a tag the object carries.
- tag_
slug str - Slug of a tag the object carries.
- cable
Count Number - Number of cables in the bundle.
- 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.
- 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
- custom
Field Map<String>Filters - Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
- owner
Group NumberId - Id of the owner group.
- owner
Group StringName - Name of the owner group.
- owner
Name String - Name of the owner.
- q String
- Search term, matched against the fields NetBox searches for this object type.
- tag
Id Number - Id of a tag the object carries.
- String
- Slug of a tag the object carries.
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
published on Monday, Nov 16, 2026 by e-breuninger