netbox.DeviceFrontPort
Explore with Pulumi AI
From the official documentation:
Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
// Note that some terraform code is not included in the example for brevity
const testDevice = new netbox.Device("testDevice", {
deviceTypeId: netbox_device_type.test.id,
roleId: netbox_device_role.test.id,
siteId: netbox_site.test.id,
});
const testDeviceRearPort = new netbox.DeviceRearPort("testDeviceRearPort", {
deviceId: testDevice.deviceId,
type: "8p8c",
positions: 2,
markConnected: true,
});
const testDeviceFrontPort = new netbox.DeviceFrontPort("testDeviceFrontPort", {
deviceId: testDevice.deviceId,
type: "8p8c",
rearPortId: testDeviceRearPort.deviceRearPortId,
rearPortPosition: 2,
});
import pulumi
import pulumi_netbox as netbox
# Note that some terraform code is not included in the example for brevity
test_device = netbox.Device("testDevice",
device_type_id=netbox_device_type["test"]["id"],
role_id=netbox_device_role["test"]["id"],
site_id=netbox_site["test"]["id"])
test_device_rear_port = netbox.DeviceRearPort("testDeviceRearPort",
device_id=test_device.device_id,
type="8p8c",
positions=2,
mark_connected=True)
test_device_front_port = netbox.DeviceFrontPort("testDeviceFrontPort",
device_id=test_device.device_id,
type="8p8c",
rear_port_id=test_device_rear_port.device_rear_port_id,
rear_port_position=2)
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 {
// Note that some terraform code is not included in the example for brevity
testDevice, err := netbox.NewDevice(ctx, "testDevice", &netbox.DeviceArgs{
DeviceTypeId: pulumi.Any(netbox_device_type.Test.Id),
RoleId: pulumi.Any(netbox_device_role.Test.Id),
SiteId: pulumi.Any(netbox_site.Test.Id),
})
if err != nil {
return err
}
testDeviceRearPort, err := netbox.NewDeviceRearPort(ctx, "testDeviceRearPort", &netbox.DeviceRearPortArgs{
DeviceId: testDevice.DeviceId,
Type: pulumi.String("8p8c"),
Positions: pulumi.Float64(2),
MarkConnected: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = netbox.NewDeviceFrontPort(ctx, "testDeviceFrontPort", &netbox.DeviceFrontPortArgs{
DeviceId: testDevice.DeviceId,
Type: pulumi.String("8p8c"),
RearPortId: testDeviceRearPort.DeviceRearPortId,
RearPortPosition: pulumi.Float64(2),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;
return await Deployment.RunAsync(() =>
{
// Note that some terraform code is not included in the example for brevity
var testDevice = new Netbox.Device("testDevice", new()
{
DeviceTypeId = netbox_device_type.Test.Id,
RoleId = netbox_device_role.Test.Id,
SiteId = netbox_site.Test.Id,
});
var testDeviceRearPort = new Netbox.DeviceRearPort("testDeviceRearPort", new()
{
DeviceId = testDevice.DeviceId,
Type = "8p8c",
Positions = 2,
MarkConnected = true,
});
var testDeviceFrontPort = new Netbox.DeviceFrontPort("testDeviceFrontPort", new()
{
DeviceId = testDevice.DeviceId,
Type = "8p8c",
RearPortId = testDeviceRearPort.DeviceRearPortId,
RearPortPosition = 2,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.Device;
import com.pulumi.netbox.DeviceArgs;
import com.pulumi.netbox.DeviceRearPort;
import com.pulumi.netbox.DeviceRearPortArgs;
import com.pulumi.netbox.DeviceFrontPort;
import com.pulumi.netbox.DeviceFrontPortArgs;
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) {
// Note that some terraform code is not included in the example for brevity
var testDevice = new Device("testDevice", DeviceArgs.builder()
.deviceTypeId(netbox_device_type.test().id())
.roleId(netbox_device_role.test().id())
.siteId(netbox_site.test().id())
.build());
var testDeviceRearPort = new DeviceRearPort("testDeviceRearPort", DeviceRearPortArgs.builder()
.deviceId(testDevice.deviceId())
.type("8p8c")
.positions(2)
.markConnected(true)
.build());
var testDeviceFrontPort = new DeviceFrontPort("testDeviceFrontPort", DeviceFrontPortArgs.builder()
.deviceId(testDevice.deviceId())
.type("8p8c")
.rearPortId(testDeviceRearPort.deviceRearPortId())
.rearPortPosition(2)
.build());
}
}
resources:
# Note that some terraform code is not included in the example for brevity
testDevice:
type: netbox:Device
properties:
deviceTypeId: ${netbox_device_type.test.id}
roleId: ${netbox_device_role.test.id}
siteId: ${netbox_site.test.id}
testDeviceRearPort:
type: netbox:DeviceRearPort
properties:
deviceId: ${testDevice.deviceId}
type: 8p8c
positions: 2
markConnected: true
testDeviceFrontPort:
type: netbox:DeviceFrontPort
properties:
deviceId: ${testDevice.deviceId}
type: 8p8c
rearPortId: ${testDeviceRearPort.deviceRearPortId}
rearPortPosition: 2
Create DeviceFrontPort Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DeviceFrontPort(name: string, args: DeviceFrontPortArgs, opts?: CustomResourceOptions);
@overload
def DeviceFrontPort(resource_name: str,
args: DeviceFrontPortArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DeviceFrontPort(resource_name: str,
opts: Optional[ResourceOptions] = None,
device_id: Optional[float] = None,
type: Optional[str] = None,
rear_port_position: Optional[float] = None,
rear_port_id: Optional[float] = None,
device_front_port_id: Optional[str] = None,
label: Optional[str] = None,
mark_connected: Optional[bool] = None,
module_id: Optional[float] = None,
name: Optional[str] = None,
color_hex: Optional[str] = None,
description: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
custom_fields: Optional[Mapping[str, str]] = None)
func NewDeviceFrontPort(ctx *Context, name string, args DeviceFrontPortArgs, opts ...ResourceOption) (*DeviceFrontPort, error)
public DeviceFrontPort(string name, DeviceFrontPortArgs args, CustomResourceOptions? opts = null)
public DeviceFrontPort(String name, DeviceFrontPortArgs args)
public DeviceFrontPort(String name, DeviceFrontPortArgs args, CustomResourceOptions options)
type: netbox:DeviceFrontPort
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 DeviceFrontPortArgs
- 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 DeviceFrontPortArgs
- 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 DeviceFrontPortArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeviceFrontPortArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeviceFrontPortArgs
- 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 deviceFrontPortResource = new Netbox.DeviceFrontPort("deviceFrontPortResource", new()
{
DeviceId = 0,
Type = "string",
RearPortPosition = 0,
RearPortId = 0,
DeviceFrontPortId = "string",
Label = "string",
MarkConnected = false,
ModuleId = 0,
Name = "string",
ColorHex = "string",
Description = "string",
Tags = new[]
{
"string",
},
CustomFields =
{
{ "string", "string" },
},
});
example, err := netbox.NewDeviceFrontPort(ctx, "deviceFrontPortResource", &netbox.DeviceFrontPortArgs{
DeviceId: pulumi.Float64(0),
Type: pulumi.String("string"),
RearPortPosition: pulumi.Float64(0),
RearPortId: pulumi.Float64(0),
DeviceFrontPortId: pulumi.String("string"),
Label: pulumi.String("string"),
MarkConnected: pulumi.Bool(false),
ModuleId: pulumi.Float64(0),
Name: pulumi.String("string"),
ColorHex: pulumi.String("string"),
Description: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
CustomFields: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var deviceFrontPortResource = new DeviceFrontPort("deviceFrontPortResource", DeviceFrontPortArgs.builder()
.deviceId(0)
.type("string")
.rearPortPosition(0)
.rearPortId(0)
.deviceFrontPortId("string")
.label("string")
.markConnected(false)
.moduleId(0)
.name("string")
.colorHex("string")
.description("string")
.tags("string")
.customFields(Map.of("string", "string"))
.build());
device_front_port_resource = netbox.DeviceFrontPort("deviceFrontPortResource",
device_id=0,
type="string",
rear_port_position=0,
rear_port_id=0,
device_front_port_id="string",
label="string",
mark_connected=False,
module_id=0,
name="string",
color_hex="string",
description="string",
tags=["string"],
custom_fields={
"string": "string",
})
const deviceFrontPortResource = new netbox.DeviceFrontPort("deviceFrontPortResource", {
deviceId: 0,
type: "string",
rearPortPosition: 0,
rearPortId: 0,
deviceFrontPortId: "string",
label: "string",
markConnected: false,
moduleId: 0,
name: "string",
colorHex: "string",
description: "string",
tags: ["string"],
customFields: {
string: "string",
},
});
type: netbox:DeviceFrontPort
properties:
colorHex: string
customFields:
string: string
description: string
deviceFrontPortId: string
deviceId: 0
label: string
markConnected: false
moduleId: 0
name: string
rearPortId: 0
rearPortPosition: 0
tags:
- string
type: string
DeviceFrontPort 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 DeviceFrontPort resource accepts the following input properties:
- Device
Id double - Rear
Port doubleId - Rear
Port doublePosition - Type string
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- Color
Hex string - Custom
Fields Dictionary<string, string> - Description string
- Device
Front stringPort Id - The ID of this resource.
- Label string
- Mark
Connected bool - Defaults to
false
. - Module
Id double - Name string
- List<string>
- Device
Id float64 - Rear
Port float64Id - Rear
Port float64Position - Type string
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- Color
Hex string - Custom
Fields map[string]string - Description string
- Device
Front stringPort Id - The ID of this resource.
- Label string
- Mark
Connected bool - Defaults to
false
. - Module
Id float64 - Name string
- []string
- device
Id Double - rear
Port DoubleId - rear
Port DoublePosition - type String
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color
Hex String - custom
Fields Map<String,String> - description String
- device
Front StringPort Id - The ID of this resource.
- label String
- mark
Connected Boolean - Defaults to
false
. - module
Id Double - name String
- List<String>
- device
Id number - rear
Port numberId - rear
Port numberPosition - type string
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color
Hex string - custom
Fields {[key: string]: string} - description string
- device
Front stringPort Id - The ID of this resource.
- label string
- mark
Connected boolean - Defaults to
false
. - module
Id number - name string
- string[]
- device_
id float - rear_
port_ floatid - rear_
port_ floatposition - type str
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color_
hex str - custom_
fields Mapping[str, str] - description str
- device_
front_ strport_ id - The ID of this resource.
- label str
- mark_
connected bool - Defaults to
false
. - module_
id float - name str
- Sequence[str]
- device
Id Number - rear
Port NumberId - rear
Port NumberPosition - type String
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color
Hex String - custom
Fields Map<String> - description String
- device
Front StringPort Id - The ID of this resource.
- label String
- mark
Connected Boolean - Defaults to
false
. - module
Id Number - name String
- List<String>
Outputs
All input properties are implicitly available as output properties. Additionally, the DeviceFrontPort 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 DeviceFrontPort Resource
Get an existing DeviceFrontPort 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?: DeviceFrontPortState, opts?: CustomResourceOptions): DeviceFrontPort
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
color_hex: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
device_front_port_id: Optional[str] = None,
device_id: Optional[float] = None,
label: Optional[str] = None,
mark_connected: Optional[bool] = None,
module_id: Optional[float] = None,
name: Optional[str] = None,
rear_port_id: Optional[float] = None,
rear_port_position: Optional[float] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None) -> DeviceFrontPort
func GetDeviceFrontPort(ctx *Context, name string, id IDInput, state *DeviceFrontPortState, opts ...ResourceOption) (*DeviceFrontPort, error)
public static DeviceFrontPort Get(string name, Input<string> id, DeviceFrontPortState? state, CustomResourceOptions? opts = null)
public static DeviceFrontPort get(String name, Output<String> id, DeviceFrontPortState state, CustomResourceOptions options)
resources: _: type: netbox:DeviceFrontPort 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.
- Color
Hex string - Custom
Fields Dictionary<string, string> - Description string
- Device
Front stringPort Id - The ID of this resource.
- Device
Id double - Label string
- Mark
Connected bool - Defaults to
false
. - Module
Id double - Name string
- Rear
Port doubleId - Rear
Port doublePosition - List<string>
- Type string
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- Color
Hex string - Custom
Fields map[string]string - Description string
- Device
Front stringPort Id - The ID of this resource.
- Device
Id float64 - Label string
- Mark
Connected bool - Defaults to
false
. - Module
Id float64 - Name string
- Rear
Port float64Id - Rear
Port float64Position - []string
- Type string
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color
Hex String - custom
Fields Map<String,String> - description String
- device
Front StringPort Id - The ID of this resource.
- device
Id Double - label String
- mark
Connected Boolean - Defaults to
false
. - module
Id Double - name String
- rear
Port DoubleId - rear
Port DoublePosition - List<String>
- type String
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color
Hex string - custom
Fields {[key: string]: string} - description string
- device
Front stringPort Id - The ID of this resource.
- device
Id number - label string
- mark
Connected boolean - Defaults to
false
. - module
Id number - name string
- rear
Port numberId - rear
Port numberPosition - string[]
- type string
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color_
hex str - custom_
fields Mapping[str, str] - description str
- device_
front_ strport_ id - The ID of this resource.
- device_
id float - label str
- mark_
connected bool - Defaults to
false
. - module_
id float - name str
- rear_
port_ floatid - rear_
port_ floatposition - Sequence[str]
- type str
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
- color
Hex String - custom
Fields Map<String> - description String
- device
Front StringPort Id - The ID of this resource.
- device
Id Number - label String
- mark
Connected Boolean - Defaults to
false
. - module
Id Number - name String
- rear
Port NumberId - rear
Port NumberPosition - List<String>
- type String
- One of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other].
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netbox
Terraform Provider.