Document toolboxDocument toolbox

(2024.2) Ports/Pins/Lens Imports

Owned by David Engblom
Apr 16, 2024
3 min read

Capability

The Ports/Pins/Lens Import will INSERT and UPDATE Ports/Pins/Lens on Equipment records.

Matches On

To find an existing Ports/Pins/Lens record, you can use the Ports/Pins/Lens RECID, or you can identify the Equipment and Port.

To identify the Equipment, you can use any of these fields:

  1. Equipment RECID

  2. Asset Tag

  3. Equipment ID and Equipment Location

  4. Serial Number

  5. MAC Address

To Identify the Port you need the Port Name and Port Side.

Fields

Equipment RECID

Datatype is Number.
If this is provided, then the Equipment with that RECID must exist.

Asset Tag

Datatype is String.

Equipment ID

Required

Datatype is String.

Equipment Location

Datatype is String.

Serial Number

Datatype is String.

MAC Address

Datatype is String.

Port/Pin/Len

Required

Datatype is String.

Port Side

Required

Datatype is String.

Permitted values are from the PORT_SIDE List Values : Front, Back, Cross-Connect, and N/A.

Any values added by a User to the PORT_SIDE list can also be used.

Port Alias

Datatype is String.

Pair Status

Required

Datatype is String.

Permitted values are from the PAIR_STATUS List Values : Left In, Spare, Assigned, Reserved, PDPC, Pending Disconnect, Pending Connect, Bad, and Unknown.

Any values added by a User to the PAIR_STATUS list can also be used.

Equipment Location

Datatype is Hierarchical String.

The Equipment Location is only used to find the correct Equipment. It is only needed if there are more than one Equipment with the same Equipment ID in different Locations.

Equipment Location Type

Datatype is String.

Permitted values are from List Values of type LOCATION_TYPE: Site, Building, Floor, Room, Cube, Truck, Closet, Rack, Elevation, or Manhole.

The Location Type is only used to find the correct Location. It is only needed if there are more than one Location with the same Name with different Location Types.

User entered values to the LOCATION_TYPE list may also be used.

Multiple Paths

Datatype is Boolean.

Default value = False [0].

Port Tx Rx

Datatype is String.

Permitted values are from the PORT_TX_RX List Values : TX, TX/RX, RX, and N/A.

Any values added by a User to the PORT_TX_RX list can also be used.

Port Type

Datatype is String.

Permitted values are from the PORT_TYPE List Values : BNC, FC, SC, LC, WW, RJ11, RJ45, and N/A.

Any values added by a User to the PORT_TYPE list can also be used.

Port Speed

Datatype is List.

Default value is blank.

Permitted values are from the PORT_SPEED List Values : 10 Mbps, 100 Mbps, 1 Gbps, Auto, Auto-10, and Auto-10-100.

New Port/Pin/Len

Datatype is String.

This field is used to rename a Port.

New Port Side

Datatype is String.

This field is used to change the Side of a Port.

VLAN

Datatype is String.

Default value is blank.

Attaches a VLAN to the port.

If the provided VLAN does not exist, it is created.

VLAN Description

Datatype is String.

Default value is blank.

Only used on new VLAN creation.

If the VLAN already exists, this is ignored. It will not update.

Flags

REPLACE_VLANS

Default value is False

  • True: when a new Vlan value is provided to a Port, all of the existing Vlans on that port will be removed.

  • False: when a new Vlan value is provided to a Port, all of the existing Vlans on that port will be appended.

Errors

When an Import Line fails, it is usually because the Line falls into one of the following categories:

  1. A blank value was provided, for a field with a required value





  2. The value provided was not found in the database





  3. The System was unable to save the record





Notes

The Ports/Pins/Lens Import does not create the Equipment. Equipment MUST already exist to associate Ports/Pins/Lens to be associated with it.

UDF Associations

User Defined Fields on any given Import are all handled the same way with Conditional Logic. For more information about adding a UDF to the Import, see the User Defined Fields section of the Imports main page.