PatchCableMgr User Guide

There are 2 different ways to get started with an PatchCableMgr account:

1. Hosted Account

   A hosted account is hosted on PCM servers. Everything related to server maintenance and support (server configuration, OS updates, app upgrades, SSL certificates, etc.) is handled by PCM. Upon registration, a tenant is created with a unique domain name (ie. acme.patchcablemgr.com) and database creating an isolated environment.

   Register for a hosted account here.

   A hosted account stores information on servers not owned by you or your organization. This may violate the security policies of your organization. Consult your organization before entering any information in a hosted account. Consider using a self-hosted account if you are unsure.

2. Self-Hosted Account

   A self-hosted account runs on a virtual machine hosted on your server and is maintained by you.

   Download the PCM virtual appliance here. Import and run the OVA in your hypervisor and navigate to https://<SERVER_IP> where you will be able to create an account. Please note that it could take 5 to 10 minutes for the application to become available after booting.

   If you don't know your <SERVER_IP>, follow the instructions in the FAQ below.

The Dashboard provides a quick overview of your organization's environment.

The Port Utilization table displays all devices deployed in your PCM environment and can help identify patch panel availability issues before they become a problem.

The Build menu group contains pages where your environment is modeled by creating object templates and racking those templates into cabinets.

Templates - #back to top

Use the Template page to create and edit custom templates which represent objects in your environment. The template page is separated into 4 cards:

1. Properties - Sets the properties of the custom template.
2. Preview - Displays the custom template as you build it.
3. Template Details - Displays details about a template selected from the list of available templates.
4. Templates - Displays existing templates.

• Properties:

  The "Properties" card contains all the configuration properties needed to create a template.

  • Name - Defines the name of the template.
  • Category - A category is user created and applies a color to the template as well as the ability to group similar templates together for easier access.
  • Template Type - A stanadard template is one that can be installed in a cabinet by itself. An insert is a template is installed in an existing object's enclosure partition.
  • Template Size - Defines the Rack Unit size of the template. Max is 25.
  • Template Function - Defines the template as an endpoint or passive.
    1. An endpoint template will always terminate a cable path (switch, router, server, etc.).
    2. A passive template is part of the physical cable infrastructure (patch panel, fiber insert, etc.).
  • Mounting Configuration - A 2-post template will only be visible on one side of the installed cabinet and can have another 2-post template installed behind it. A 4-post template will have a front and a back which occupy both sides of the cabinet it is installed in.
  • Partition Type - Generic partitions have no properties and can be used as spacers or containers for other partitions. Connectable partitions contain ports or interfaces. Enclosure partitions can contain insert templates.
  • Add/Remove Partition - Partitions allow for the template layout to accurately reflect the object it is modeling. A horizontal partition spans the entire width of the partition it is created in and can grow vertically. A vertical partition spance the full height of the partition it is created in and can grow horizontally.
  • Partition Size - Horizontal partitions grow vertically in 0.5 RU increments. Vertical partitions grow horizontally in increments equal to 1/24th of the entire template width.
  • Port ID - The format describing how the template ports will be identified. Clicking the edit button will open a window allowing you to add/change/delete fields that will be used to compile each port ID (ie "Port-1a"). You can configure up to 5 fields of 3 possible field types.
    1. A "Static" field will be compiled into the port ID as it is defined by the user.
    2. An "Incremental" field accepts a single alphanumeric character and will increment with the port numbers.
    3. A "Series" field accepts a comma separated list of strings that will be cycled through when compiling the port ID.
  • Port Layout - Number of port columns and rows in the selected connectable partition.
  • Port Orientation - Determines the direction in which port numbers are incremented. Switches are typically ordered top to bottom while most RJ45 patch panels are ordered left to right.
  • Port Type - The type of port for the selected connectable partition. When connecting a cable end to an object port, the cable end type and port type must match. The exception to this rule are SFP ports, which can accept any cable end type.
  • Media Type - This configuration is exclusive to passive templates. This refers to the cabling behind the passive object. When trunking two passive objects, the media type must match.
  • Enclosure Layout - This configuration is exclusive to enclosure partition types. Enclosure layout columns and rows determine the slots available to install insert objects.

• Preview:

  The "Preview" card displays the template as it is created.

  The "Sticky" switch determines if the preview box scrolls with the page keeping the template visible even when working at the end of the long list of properties. The "Front" and "Back" radio buttons toggle the face of the template being displayed. A yellow highlight appears around the selected partition and indicates that any partition specific configuration will be applied to it.

• Template Details:

  The "Template Details" card displays information about the template selected in the "Templates" card.

  It also allows for some configuration as well as the ability to delete a selected template.

• Templates:

  The "Templates" card lists all templates grouped by category.

  "Front" and "Back" radio buttons toggle the face of all available templates. Clicking on an object will highlight the selected partition and display information in the "Template Details" card.
  The "Filter" field allows you to display only templates containing one or more strings of text.

Environment - #back to top

The "Environment" page allows you to create a hierarchical representation of your environment's locations, pods, cabinets, floorplans, and objects as well as their relationship to each other. The "Environment" page is separated into multiple cards depending on location tree selection:

1. Locations and Cabinets - Display and manage environment tree.
2. Cabinet - Display selected cabinet and installed objects.
3. Cabinet Details - Display and manage details about selected cabinet
4. Object Details - Display and manage details about selected object and their partitions.
5. Templates - Display templates available to be installed into a cabinet.
6. Floorplan - Display selected floorplan and deployed objects.
7. Floorplan Object Details - Display details about the selected floorplan object.
8. Floorplan Objects - List objects deployed in the selected floorplan.

• Locations and Cabinets:

  The "Location Tree" card contains an editable tree of locations and cabinets.

  Right click on a location to rename, delete, or create a new location, pod, or cabinet nested within it.
  A location can represent a physical region, building, floor, or room. Locations can only be nested under other locations.
  A pod represents a group of cabinets within a location. Pods are assumed to have cable path between adjacent cabinets. Pods can only be nested under locations.
  A cabinet represents a physical rack or cabinet that can contain objects. Cabinets can be nested under locations or pods.
  A floorplan represents the floor of a building. Floor plans can be nested under locations.

• Cabinet:

  The "Cabinet" card displays the selected cabinet and all of the objects it contains.

  The "Sticky" switch determines if the preview box scrolls with the page keeping the template visible even when working at the end of the long list of properties. The "Front" and "Back" radio buttons toggle the face of the template being displayed. To install an object in the cabinet displayed, drag and drop a template from the "Templates" card.

• Cabinet Details:

  The "Cabinet Details" card displays information about the selected cabinet.

  The "RU Size" and "RU Orientation" properties are editable.
  The "Cable Paths" table lists other cabinets which the selected cabinet has cable path to. This information is used by path finder for calculating cable paths.
  The "Cabinet Adjacencies" table lists cabinets which are adjacent to the selected cabinet. This information is used by path finder for calculating cable paths. Path finder assumes that there is cable path to adjacent cabinets.

• Object Details:

  The "Object Details" card displays information about the selected object and partition.

  The "Object Name" and "Trunked To" properties are editable. Connectable object partitions can be trunked to other connectable object partitions. When trunking a passive object partition to another passive object partition, the number of ports must be equal and the media type must match. When trunking a passive object partition to an endpoint object partition, the number of ports must be equal and the endpoint object partition port type must be RJ45. An endpoint object partition cannot be trunked to another endpoint object partition. The "Actions" dropdown contains a delete button which will remove the selected object from the cabinet after confirmation. The "Templates" section displays a list of templates available to install in the cabinet grouped by category. Drag and drop a template into the cabinet to install it as an object. An insert template can only be installed in an enclosure partition.

The "Explore" page allows you to navigate the environment and display information about objects and how they are connected. The "Explore" page is separated into multiple cards depending on location tree selection:

1. Locations and Cabinets - Navigate environment locations and select cabinets. Locations and cabinets are not editable from the Explore page.
2. Cabinet - Displays the selected cabinet and objects installed. Objects cannot be added, moved, or deleted from the Explore page.
3. Object Details - Display details about selected objects and their partitions. Object details are not editable from the Explore page.
4. Port Details - Display details about selected object port. Contains a dropdown as an alternative method of port selection. The "Actions" dropdown contains a "Connect" option which is used to connect 1 port to another.
5. Connection Path - Display the cable path of a selected object port.
6. Floorplan - Display selected floorplan and deployed objects.
7. Floorplan Object Details - Display details about the selected floorplan object.
8. Floorplan Objects - List objects deployed in the selected floorplan.

Locations and Cabinets:

The "Locations and Cabinets" card contains a tree of locations and cabinets.

A location can represent a physical region, building, floor, or room.
A pod represents a group of cabinets within a location.
A cabinet represents a physical rack or cabinet that can contain objects.
A floorplan represents the floor of a building.

Cabinet:

The "Cabinet" card displays the selected cabinet and all of the objects it contains.

The "Sticky" switch determines if the preview box scrolls with the page keeping the top of the cabinet visible when scrolling. The "Front" and "Back" radio buttons toggle the face of the template being displayed.

Object Details:

The "Object Details" card displays information about the selected object.

Object details are not editable in the "Explore" page.

Port Details:

The "Port Details" card displays information about the selected object port.

The "Actions" dropdown contains an option to connect the selected port to any other compatible port. Use the "Selection" select box as an alternative method of choosing a specific port within the currently selected partition. Use the "Description" field to add a short note about the port. Use the "Populated" checkbox to mark the port as populated when the actual cable path is unknown.

Connection Path:

The "Connection Path" card displays the cable path of the selected object port.

Trunks are indicated by lines connecting object boxes while patch cables are indicated by lines connecting port icons.

The "Admin" page allows organization administrators to perform privileged functions and is separated into 5 cards.

1. Users - Displays all users.
2. App Control - Displays current app version.
3. Licensing - Displays current licensing information.
4. SSL Config - Manage server SSL certificates.
5. Network Config - Manage server network configuration.

• Self-hosted Virtual Appliance: How do I find the server IP address?
  Access your PCM virtual appliance by using your VM hypervisor console and login. At the server command line enter ipconfig eth0 to display the current server IP address.
• Self-hosted Virtual Appliance: What are the default credentials?
  pcmuser / [email protected]
  Upon first login, you will be required to change your password.