1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getCableBundle
Viewing docs for netbox 6.0.0
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

    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(custom_field_filters: Optional[Mapping[str, str]] = None,
                         id: Optional[float] = None,
                         name: Optional[str] = None,
                         owner_id: Optional[float] = None,
                         tag_slug: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCableBundleResult
    def get_cable_bundle_output(custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                         id: pulumi.Input[Optional[float]] = None,
                         name: pulumi.Input[Optional[str]] = None,
                         owner_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 dictionary
    data "netbox_get_cable_bundle" "name" {
        # arguments
    }

    The following arguments are supported:

    CustomFieldFilters Dictionary<string, string>
    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.
    Id double
    NetBox id.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    TagSlug string
    Slug of a tag the object carries.
    CustomFieldFilters map[string]string
    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.
    Id float64
    NetBox id.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    TagSlug string
    Slug of a tag the object carries.
    custom_field_filters map(string)
    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.
    id number
    NetBox id.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    tag_slug string
    Slug of a tag the object carries.
    customFieldFilters Map<String,String>
    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.
    id Double
    NetBox id.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    tagSlug String
    Slug of a tag the object carries.
    customFieldFilters {[key: string]: string}
    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.
    id number
    NetBox id.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    tagSlug string
    Slug of a tag the object carries.
    custom_field_filters Mapping[str, str]
    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.
    id float
    NetBox id.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    tag_slug str
    Slug of a tag the object carries.
    customFieldFilters Map<String>
    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.
    id Number
    NetBox id.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    tagSlug String
    Slug of a tag the object carries.

    getCableBundle Result

    The following output properties are available:

    CableCount double
    Number of cables in the bundle.
    Comments string
    Created string
    CustomFields 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.
    LastUpdated string
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    Tags List<string>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls List<string>
    Slugs of all tags on the object, including the provider's default_tags.
    Url string
    CustomFieldFilters Dictionary<string, string>
    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.
    TagSlug string
    Slug of a tag the object carries.
    CableCount float64
    Number of cables in the bundle.
    Comments string
    Created string
    CustomFields 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.
    LastUpdated string
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    Tags []string
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls []string
    Slugs of all tags on the object, including the provider's default_tags.
    Url string
    CustomFieldFilters map[string]string
    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.
    TagSlug 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.
    tags list(string)
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls list(string)
    Slugs of all tags on the object, including the provider's default_tags.
    url string
    custom_field_filters map(string)
    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.
    tag_slug string
    Slug of a tag the object carries.
    cableCount Double
    Number of cables in the bundle.
    comments String
    created String
    customFields 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.
    lastUpdated String
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    url String
    customFieldFilters Map<String,String>
    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.
    tagSlug String
    Slug of a tag the object carries.
    cableCount number
    Number of cables in the bundle.
    comments string
    created string
    customFields {[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.
    lastUpdated string
    name string
    ownerId number
    Id of the owner the object is assigned to.
    tags string[]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls string[]
    Slugs of all tags on the object, including the provider's default_tags.
    url string
    customFieldFilters {[key: string]: string}
    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.
    tagSlug 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.
    tags Sequence[str]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls Sequence[str]
    Slugs of all tags on the object, including the provider's default_tags.
    url str
    custom_field_filters Mapping[str, str]
    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.
    tag_slug str
    Slug of a tag the object carries.
    cableCount Number
    Number of cables in the bundle.
    comments String
    created String
    customFields 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.
    lastUpdated String
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    url String
    customFieldFilters Map<String>
    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.
    tagSlug 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 netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial