Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. CircuitTermination
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.CircuitTermination

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    From the official documentation:

    The association of a circuit with a particular site and/or device is modeled separately as a circuit termination. A circuit may have up to two terminations, labeled A and Z. A single-termination circuit can be used when you don’t know (or care) about the far end of a circuit (for example, an Internet access circuit which connects to a transit provider). A dual-termination circuit is useful for tracking circuits which connect two sites.

    Each circuit termination is attached to either a site or to a provider network. Site terminations may optionally be connected via a cable to a specific device interface or port within that site. Each termination must be assigned a port speed, and can optionally be assigned an upstream speed if it differs from the downstream speed (a common scenario with e.g. DOCSIS cable modems). Fields are also available to track cross-connect and patch panel details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const testSite = new netbox.Site("testSite", {status: "active"});
const testCircuitProvider = new netbox.CircuitProvider("testCircuitProvider", {});
const testCircuitType = new netbox.CircuitType("testCircuitType", {});
const testCircuit = new netbox.Circuit("testCircuit", {
    cid: "%[1]s",
    status: "active",
    providerId: testCircuitProvider.circuitProviderId,
    typeId: testCircuitType.circuitTypeId,
});
const testCircuitTermination = new netbox.CircuitTermination("testCircuitTermination", {
    circuitId: testCircuit.circuitId,
    termSide: "A",
    siteId: testSite.siteId,
    portSpeed: 100000,
    upstreamSpeed: 50000,
});

    import pulumi
import pulumi_netbox as netbox

test_site = netbox.Site("testSite", status="active")
test_circuit_provider = netbox.CircuitProvider("testCircuitProvider")
test_circuit_type = netbox.CircuitType("testCircuitType")
test_circuit = netbox.Circuit("testCircuit",
    cid="%[1]s",
    status="active",
    provider_id=test_circuit_provider.circuit_provider_id,
    type_id=test_circuit_type.circuit_type_id)
test_circuit_termination = netbox.CircuitTermination("testCircuitTermination",
    circuit_id=test_circuit.circuit_id,
    term_side="A",
    site_id=test_site.site_id,
    port_speed=100000,
    upstream_speed=50000)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testSite, err := netbox.NewSite(ctx, "testSite", &netbox.SiteArgs{
			Status: pulumi.String("active"),
		})
		if err != nil {
			return err
		}
		testCircuitProvider, err := netbox.NewCircuitProvider(ctx, "testCircuitProvider", nil)
		if err != nil {
			return err
		}
		testCircuitType, err := netbox.NewCircuitType(ctx, "testCircuitType", nil)
		if err != nil {
			return err
		}
		testCircuit, err := netbox.NewCircuit(ctx, "testCircuit", &netbox.CircuitArgs{
			Cid:        pulumi.String("%[1]s"),
			Status:     pulumi.String("active"),
			ProviderId: testCircuitProvider.CircuitProviderId,
			TypeId:     testCircuitType.CircuitTypeId,
		})
		if err != nil {
			return err
		}
		_, err = netbox.NewCircuitTermination(ctx, "testCircuitTermination", &netbox.CircuitTerminationArgs{
			CircuitId:     testCircuit.CircuitId,
			TermSide:      pulumi.String("A"),
			SiteId:        testSite.SiteId,
			PortSpeed:     pulumi.Float64(100000),
			UpstreamSpeed: pulumi.Float64(50000),
		})
		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 testSite = new Netbox.Site("testSite", new()
    {
        Status = "active",
    });

    var testCircuitProvider = new Netbox.CircuitProvider("testCircuitProvider");

    var testCircuitType = new Netbox.CircuitType("testCircuitType");

    var testCircuit = new Netbox.Circuit("testCircuit", new()
    {
        Cid = "%[1]s",
        Status = "active",
        ProviderId = testCircuitProvider.CircuitProviderId,
        TypeId = testCircuitType.CircuitTypeId,
    });

    var testCircuitTermination = new Netbox.CircuitTermination("testCircuitTermination", new()
    {
        CircuitId = testCircuit.CircuitId,
        TermSide = "A",
        SiteId = testSite.SiteId,
        PortSpeed = 100000,
        UpstreamSpeed = 50000,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.Site;
import com.pulumi.netbox.SiteArgs;
import com.pulumi.netbox.CircuitProvider;
import com.pulumi.netbox.CircuitType;
import com.pulumi.netbox.Circuit;
import com.pulumi.netbox.CircuitArgs;
import com.pulumi.netbox.CircuitTermination;
import com.pulumi.netbox.CircuitTerminationArgs;
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) {
        var testSite = new Site("testSite", SiteArgs.builder()
            .status("active")
            .build());

        var testCircuitProvider = new CircuitProvider("testCircuitProvider");

        var testCircuitType = new CircuitType("testCircuitType");

        var testCircuit = new Circuit("testCircuit", CircuitArgs.builder()
            .cid("%[1]s")
            .status("active")
            .providerId(testCircuitProvider.circuitProviderId())
            .typeId(testCircuitType.circuitTypeId())
            .build());

        var testCircuitTermination = new CircuitTermination("testCircuitTermination", CircuitTerminationArgs.builder()
            .circuitId(testCircuit.circuitId())
            .termSide("A")
            .siteId(testSite.siteId())
            .portSpeed(100000)
            .upstreamSpeed(50000)
            .build());

    }
}

    resources:
  testSite:
    type: netbox:Site
    properties:
      status: active
  testCircuitProvider:
    type: netbox:CircuitProvider
  testCircuitType:
    type: netbox:CircuitType
  testCircuit:
    type: netbox:Circuit
    properties:
      cid: '%[1]s'
      status: active
      providerId: ${testCircuitProvider.circuitProviderId}
      typeId: ${testCircuitType.circuitTypeId}
  testCircuitTermination:
    type: netbox:CircuitTermination
    properties:
      circuitId: ${testCircuit.circuitId}
      termSide: A
      siteId: ${testSite.siteId}
      portSpeed: 100000
      upstreamSpeed: 50000

    Create CircuitTermination Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CircuitTermination(name: string, args: CircuitTerminationArgs, opts?: CustomResourceOptions);
    @overload
def CircuitTermination(resource_name: str,
                       args: CircuitTerminationArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def CircuitTermination(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       circuit_id: Optional[float] = None,
                       site_id: Optional[float] = None,
                       term_side: Optional[str] = None,
                       circuit_termination_id: Optional[str] = None,
                       custom_fields: Optional[Mapping[str, str]] = None,
                       port_speed: Optional[float] = None,
                       tags: Optional[Sequence[str]] = None,
                       upstream_speed: Optional[float] = None)
    func NewCircuitTermination(ctx *Context, name string, args CircuitTerminationArgs, opts ...ResourceOption) (*CircuitTermination, error)
    public CircuitTermination(string name, CircuitTerminationArgs args, CustomResourceOptions? opts = null)
    public CircuitTermination(String name, CircuitTerminationArgs args)
public CircuitTermination(String name, CircuitTerminationArgs args, CustomResourceOptions options)

    type: netbox:CircuitTermination
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CircuitTerminationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CircuitTerminationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CircuitTerminationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CircuitTerminationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CircuitTerminationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var circuitTerminationResource = new Netbox.CircuitTermination("circuitTerminationResource", new()
{
    CircuitId = 0,
    SiteId = 0,
    TermSide = "string",
    CircuitTerminationId = "string",
    CustomFields = 
    {
        { "string", "string" },
    },
    PortSpeed = 0,
    Tags = new[]
    {
        "string",
    },
    UpstreamSpeed = 0,
});

    example, err := netbox.NewCircuitTermination(ctx, "circuitTerminationResource", &netbox.CircuitTerminationArgs{
	CircuitId:            pulumi.Float64(0),
	SiteId:               pulumi.Float64(0),
	TermSide:             pulumi.String("string"),
	CircuitTerminationId: pulumi.String("string"),
	CustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PortSpeed: pulumi.Float64(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpstreamSpeed: pulumi.Float64(0),
})

    var circuitTerminationResource = new CircuitTermination("circuitTerminationResource", CircuitTerminationArgs.builder()
    .circuitId(0)
    .siteId(0)
    .termSide("string")
    .circuitTerminationId("string")
    .customFields(Map.of("string", "string"))
    .portSpeed(0)
    .tags("string")
    .upstreamSpeed(0)
    .build());

    circuit_termination_resource = netbox.CircuitTermination("circuitTerminationResource",
    circuit_id=0,
    site_id=0,
    term_side="string",
    circuit_termination_id="string",
    custom_fields={
        "string": "string",
    },
    port_speed=0,
    tags=["string"],
    upstream_speed=0)

    const circuitTerminationResource = new netbox.CircuitTermination("circuitTerminationResource", {
    circuitId: 0,
    siteId: 0,
    termSide: "string",
    circuitTerminationId: "string",
    customFields: {
        string: "string",
    },
    portSpeed: 0,
    tags: ["string"],
    upstreamSpeed: 0,
});

    type: netbox:CircuitTermination
properties:
    circuitId: 0
    circuitTerminationId: string
    customFields:
        string: string
    portSpeed: 0
    siteId: 0
    tags:
        - string
    termSide: string
    upstreamSpeed: 0

    CircuitTermination Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CircuitTermination resource accepts the following input properties:

    CircuitId double
    SiteId double
    TermSide string
    Valid values are A and Z.
    CircuitTerminationId string
    The ID of this resource.
    CustomFields Dictionary<string, string>
    PortSpeed double
    Tags List<string>
    UpstreamSpeed double
    CircuitId float64
    SiteId float64
    TermSide string
    Valid values are A and Z.
    CircuitTerminationId string
    The ID of this resource.
    CustomFields map[string]string
    PortSpeed float64
    Tags []string
    UpstreamSpeed float64
    circuitId Double
    siteId Double
    termSide String
    Valid values are A and Z.
    circuitTerminationId String
    The ID of this resource.
    customFields Map<String,String>
    portSpeed Double
    tags List<String>
    upstreamSpeed Double
    circuitId number
    siteId number
    termSide string
    Valid values are A and Z.
    circuitTerminationId string
    The ID of this resource.
    customFields {[key: string]: string}
    portSpeed number
    tags string[]
    upstreamSpeed number
    circuit_id float
    site_id float
    term_side str
    Valid values are A and Z.
    circuit_termination_id str
    The ID of this resource.
    custom_fields Mapping[str, str]
    port_speed float
    tags Sequence[str]
    upstream_speed float
    circuitId Number
    siteId Number
    termSide String
    Valid values are A and Z.
    circuitTerminationId String
    The ID of this resource.
    customFields Map<String>
    portSpeed Number
    tags List<String>
    upstreamSpeed Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CircuitTermination resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CircuitTermination Resource

    Get an existing CircuitTermination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CircuitTerminationState, opts?: CustomResourceOptions): CircuitTermination
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        circuit_id: Optional[float] = None,
        circuit_termination_id: Optional[str] = None,
        custom_fields: Optional[Mapping[str, str]] = None,
        port_speed: Optional[float] = None,
        site_id: Optional[float] = None,
        tags: Optional[Sequence[str]] = None,
        term_side: Optional[str] = None,
        upstream_speed: Optional[float] = None) -> CircuitTermination
    func GetCircuitTermination(ctx *Context, name string, id IDInput, state *CircuitTerminationState, opts ...ResourceOption) (*CircuitTermination, error)
    public static CircuitTermination Get(string name, Input<string> id, CircuitTerminationState? state, CustomResourceOptions? opts = null)
    public static CircuitTermination get(String name, Output<String> id, CircuitTerminationState state, CustomResourceOptions options)
    resources:  _:    type: netbox:CircuitTermination    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CircuitId double
    CircuitTerminationId string
    The ID of this resource.
    CustomFields Dictionary<string, string>
    PortSpeed double
    SiteId double
    Tags List<string>
    TermSide string
    Valid values are A and Z.
    UpstreamSpeed double
    CircuitId float64
    CircuitTerminationId string
    The ID of this resource.
    CustomFields map[string]string
    PortSpeed float64
    SiteId float64
    Tags []string
    TermSide string
    Valid values are A and Z.
    UpstreamSpeed float64
    circuitId Double
    circuitTerminationId String
    The ID of this resource.
    customFields Map<String,String>
    portSpeed Double
    siteId Double
    tags List<String>
    termSide String
    Valid values are A and Z.
    upstreamSpeed Double
    circuitId number
    circuitTerminationId string
    The ID of this resource.
    customFields {[key: string]: string}
    portSpeed number
    siteId number
    tags string[]
    termSide string
    Valid values are A and Z.
    upstreamSpeed number
    circuit_id float
    circuit_termination_id str
    The ID of this resource.
    custom_fields Mapping[str, str]
    port_speed float
    site_id float
    tags Sequence[str]
    term_side str
    Valid values are A and Z.
    upstream_speed float
    circuitId Number
    circuitTerminationId String
    The ID of this resource.
    customFields Map<String>
    portSpeed Number
    siteId Number
    tags List<String>
    termSide String
    Valid values are A and Z.
    upstreamSpeed Number

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox