Equipment Notes

There is a new feature in the Inventory system that will display a link to web page in the Equipment Notes folder of eDocs. We currently have three categories:

1. Machines - basically computers, named based on the "Name:" field in inventory. Links to that name can be created based on Cnames in DNS
2. Printers - any printers we manage. Named based on the "Name:" field in inventory. Links to that name can be created based on queue names in print.cs and Samba
3. Other - any other network-addressable equipment - network switches, KVMs, sensors, etc.

For information on where these files are kept, and required permissions, please see EDocs

Machines

To create a new machine page, copy the folder '00template.cs' to a new folder with the same name as the machine using the FQDN, **as entered in Inventory**, including machine name and domain, eg: pilatus.cs.uwaterloo.ca

For Cnames, create a soft-link from the spool name to the actual server name, eg:

  machines% ln -s se.math.uwaterloo.ca softbase.cs.uwaterloo.ca

where the machine notes are actually created for "softbase.cs.uwaterloo.ca", and "se.math.uwaterloo.ca" is one of the related Cnames

Update the file index.shtml with relevant notes. Replace all occurrences of 'XXXX.cs.uwaterloo.ca' with the appropriate machine name (eg: 'softbase.cs.uwaterloo.ca')

These files are not RCS'ed to provide ease of use when working via the Samba share of the eDocs folder.

Virtual machines

How to handle virtual machines is up for discussion. We could make an original file for a virtual machine and, within it, reference the host machine. Alternatively, we can simply put details about the virtual machine on the page for the host machine. The downside of the latter would be maintaining that structure if the host machine gets changed.

Accessing the machine notes

Machine web pages are accessible via the web from here:

• https://www.cs.uwaterloo.ca/cscf/internal/edocs/EquipmentNotes/machines/

They are accessible via Samba from here:

• \\smb-files.cs.uwaterloo.ca\edocs\EquipmentNotes\machines

They are accessible in unix on www.cs, here:

• /software/wwwdata_cs.uwaterloo.ca/data/www/cscf/internal/edocs/EquipmentNotes/machines

Printers

To create a new printer record page, copy the folder '00template.cs' to a new folder with the same name as the printer, **as entered in Inventory**.

For spool names, create a soft-link from the spool name to the actual printer name, eg:

  printers% ln -s lj_cs ljp-cs-1.cs

where the printer notes are actually created for "ljp-cs-1.cs.uwaterloo.ca", and "lj_cs" is one of the related queue names

Update the file index.shtml with relevant notes. Replace all occurrences of 'XXXX.cs.uwaterloo.ca' with the appropriate machine name (eg: 'ljp-cs-1.cs.uwaterloo.ca')

These files are not RCS'ed to provide ease of use when working via the Samba share of the eDocs folder.

Accessing the printer notes

Printer equipment notes web pages are accessible via the web from here:

• https://www.cs.uwaterloo.ca/cscf/internal/edocs/EquipmentNotes/printers/

They are accessible via Samba from here:

• \\smb-files.cs.uwaterloo.ca\edocs\EquipmentNotes\printers

They are accessible in unix on www.cs, here:

• /software/wwwdata_cs.uwaterloo.ca/data/www/cscf/internal/edocs/EquipmentNotes/printers

Other

To create a new equipment record page, copy the folder '00template.cs' to a new folder with the same name as the equipment, **as entered in Inventory**.

Update the file index.shtml with relevant notes. Replace all occurrences of 'XXXX.cs.uwaterloo.ca' with the appropriate machine name (eg: 'esensor04.cs.uwaterloo.ca')

These files are not RCS'ed to provide ease of use when working via the Samba share of the eDocs folder.

Accessing the other equipment notes

Other equipment notes web pages are accessible via the web from here:

• https://www.cs.uwaterloo.ca/cscf/internal/edocs/EquipmentNotes/other/

They are accessible via Samba from here:

• \\smb-files.cs.uwaterloo.ca\edocs\EquipmentNotes\other

They are accessible in unix on www.cs, here:

• /software/wwwdata_cs.uwaterloo.ca/data/www/cscf/internal/edocs/EquipmentNotes/other