Difference between revisions of "CTWUG Naming Convention"
(→Broadcast Interface) |
|||
(3 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | This page forms part of [[Node Certification]] | ||
+ | |||
=Why= | =Why= | ||
− | + | Networks require standards when naming devices and resources. They make administration easier and allow for automated processing. Without standards automation is impossible, and the network will become confusing and discouraging to administrators trying to help maintain it. | |
+ | |||
+ | This convention consists of 4 parts: Routerboard Identity, SSID, Radio Name, and Interface Name. Please take a moment to understand all 4 below. | ||
+ | |||
+ | |||
+ | =Routerboard Identity= | ||
+ | '''Format''': rb<u>NR</u>.<u>HS</u><br /> | ||
+ | '''NR''': start at 1 and increase by 1 for every new routerboard<br /> | ||
+ | '''HS''': replace with the high site DNS name as seen in WiND ("Nameserver prefix"). | ||
+ | |||
+ | '''Examples:'''<br /> | ||
+ | ''rb1.mars''<br /> | ||
+ | ''rb3.diabolix'' | ||
+ | |||
+ | On a Mikrotik RouterBOARD this is set, for example, with: | ||
+ | |||
+ | <code> | ||
+ | /system identity set name="rb1.mars" | ||
+ | </code> | ||
+ | |||
=SSID= | =SSID= | ||
− | '''Format''': http://ctwug.za.net/ | + | '''Format''': <nowiki>http://ctwug.za.net/HS+NR</nowiki><br /> |
− | ''' | + | '''HS''': replace with the high site DNS name as seen in WiND ("Nameserver prefix")<br /> |
− | '''NR''': | + | '''NR''': start at 1 and increase by 1 for every interface |
− | ''' | + | |
− | ''http://ctwug.za.net/jupiter4<br>'' | + | '''Examples:'''<br /> |
− | ''http://ctwug.za.net/ | + | ''http://ctwug.za.net/jupiter4''<br /> |
+ | ''http://ctwug.za.net/mars9'' | ||
+ | |||
+ | On a Mikrotik RouterBOARD this is set, for example, with: | ||
+ | |||
+ | <code> | ||
+ | /interface wireless set 0 ssid="http://ctwug.za.net/jupiter4" | ||
+ | </code> | ||
+ | |||
+ | This SSID format serves as an unmistakable reference to a web resource. The web resource typically redirects to a wiki page that provides detailed information on the SSID and the high site. This helps both newcomers and admins, and promotes CTWUG at the same time. It is important to realise this SSID convention applies to all wireless links - Point-to-Points included. | ||
+ | |||
=Radio Name= | =Radio Name= | ||
+ | On a Mikrotik RouterBOARD this is set, for example, with: | ||
+ | |||
+ | <code> | ||
+ | /interface wireless set 0 radio-name="jupiter-neptune" | ||
+ | </code> | ||
+ | |||
+ | Please note the difference between point-to-point links and point-to-multipoint links below. | ||
+ | |||
+ | ==Point-to-Point Links== | ||
+ | '''Format''': <u>Local HS</u>-<u>Remote HS</u><br /> | ||
+ | '''HS''': the high site DNS name as seen in WiND ("Nameserver prefix")<br /> | ||
+ | '''Max length''': 16 characters | ||
+ | |||
+ | '''Examples:'''<br /> | ||
+ | ''jupiter-neptune''<br /> | ||
+ | ''saturn-jupiter'' | ||
+ | |||
+ | ==Point-to-Multipoint Links== | ||
+ | ===Access Point Interface=== | ||
+ | '''Format''': <u>Area</u>-<u>Type</u>-<u>Direction</u><br /> | ||
+ | '''Area''': Shorten to 11 characters max.<br /> | ||
+ | '''Type''': s, p, g, o or y (Sector, Panel, Grid, Omni*, Yagi)<br /> | ||
+ | '''Direction''': Use n,ne,e,se,s,sw,w or nw.<br /> | ||
+ | '''Note''': Do not add the high site name to the radio name, as it is already present in the SSID.<br /> | ||
+ | '''Max length''': 16 characters | ||
+ | |||
+ | '''Examples:'''<br/> | ||
+ | ''parow-s-nw'' - Sector at Mars covering Parow, pointing North West<br> | ||
+ | ''parow-s-ne'' - Sector at Mars covering Parow, pointing North East<br> | ||
+ | ''ssuburbs-s-s'' - Sector at Mars covering southern suburbs, pointing South<br> | ||
+ | ''kuilsriver-s-se'' - Sector at Saturn covering Kuils River, pointing South East<br> | ||
+ | ''rondebosch-s-ne'' - Sector at Uranus covering Rondebosch, pointing North East<br> | ||
+ | |||
+ | ===Station Interfaces=== | ||
+ | '''Format''': WiND DNS name of the node ("Nameserver prefix")<br/> | ||
+ | '''Max length''': 16 characters | ||
+ | |||
+ | '''Examples:'''<br/> | ||
+ | ''tfyre''<br/> | ||
+ | ''vash'' | ||
+ | |||
+ | |||
+ | =Interface Name= | ||
+ | On a Mikrotik RouterBOARD this is set, for example, with: | ||
+ | |||
+ | <code> | ||
+ | /interface set 0 name="link-neptune" | ||
+ | </code> | ||
+ | |||
+ | Please note the difference between point-to-point links and point-to-multipoint links below. | ||
+ | |||
+ | ==Point-to-Point Interfaces== | ||
+ | '''Format''': link-<u>Remote HS</u><br /> | ||
+ | '''HS''': the high site DNS name as seen in WiND ("Nameserver prefix")<br /> | ||
+ | |||
+ | '''Examples:'''<br /> | ||
+ | ''link-neptune''<br /> | ||
+ | ''link-jupiter'' | ||
− | ==Point | + | ==Point-to-Multipoint Links== |
− | '''Format''': | + | ===Access Point Interface=== |
− | + | '''Format''': Same as [[#Radio Name]]<br /> | |
− | |||
− | |||
− | + | '''Examples:'''<br/> | |
− | + | ''parow-s-nw'' - Sector at Mars covering Parow, pointing North West<br> | |
− | + | ''parow-s-ne'' - Sector at Mars covering Parow, pointing North East<br> | |
− | + | ''ssuburbs-s-s'' - Sector at Mars covering southern suburbs, pointing South<br> | |
− | + | ''kuilsriver-s-se'' - Sector at Saturn covering Kuils River, pointing South East<br> | |
− | + | ''rondebosch-s-ne'' - Sector at Uranus covering Rondebosch, pointing North East<br> | |
− | |||
− | |||
− | ''parow-s-nw'' - | ||
− | ''parow-s-ne'' - | ||
− | ''ssuburbs-s-s'' - | ||
− | ''kuilsriver-s-se'' - | ||
− | ''rondebosch-s-ne'' - | ||
− | + | ===Station Interfaces=== | |
+ | '''Format''': <u>High Site Name</u><br/> | ||
− | + | '''Examples:'''<br/> | |
− | + | ''Mars''<br/> | |
− | + | ''Mercury'' | |
− | '' | ||
− | '' |
Latest revision as of 19:55, 6 January 2013
This page forms part of Node Certification
Contents
Why
Networks require standards when naming devices and resources. They make administration easier and allow for automated processing. Without standards automation is impossible, and the network will become confusing and discouraging to administrators trying to help maintain it.
This convention consists of 4 parts: Routerboard Identity, SSID, Radio Name, and Interface Name. Please take a moment to understand all 4 below.
Routerboard Identity
Format: rbNR.HS
NR: start at 1 and increase by 1 for every new routerboard
HS: replace with the high site DNS name as seen in WiND ("Nameserver prefix").
Examples:
rb1.mars
rb3.diabolix
On a Mikrotik RouterBOARD this is set, for example, with:
/system identity set name="rb1.mars"
SSID
Format: http://ctwug.za.net/HS+NR
HS: replace with the high site DNS name as seen in WiND ("Nameserver prefix")
NR: start at 1 and increase by 1 for every interface
Examples:
http://ctwug.za.net/jupiter4
http://ctwug.za.net/mars9
On a Mikrotik RouterBOARD this is set, for example, with:
/interface wireless set 0 ssid="http://ctwug.za.net/jupiter4"
This SSID format serves as an unmistakable reference to a web resource. The web resource typically redirects to a wiki page that provides detailed information on the SSID and the high site. This helps both newcomers and admins, and promotes CTWUG at the same time. It is important to realise this SSID convention applies to all wireless links - Point-to-Points included.
Radio Name
On a Mikrotik RouterBOARD this is set, for example, with:
/interface wireless set 0 radio-name="jupiter-neptune"
Please note the difference between point-to-point links and point-to-multipoint links below.
Point-to-Point Links
Format: Local HS-Remote HS
HS: the high site DNS name as seen in WiND ("Nameserver prefix")
Max length: 16 characters
Examples:
jupiter-neptune
saturn-jupiter
Point-to-Multipoint Links
Access Point Interface
Format: Area-Type-Direction
Area: Shorten to 11 characters max.
Type: s, p, g, o or y (Sector, Panel, Grid, Omni*, Yagi)
Direction: Use n,ne,e,se,s,sw,w or nw.
Note: Do not add the high site name to the radio name, as it is already present in the SSID.
Max length: 16 characters
Examples:
parow-s-nw - Sector at Mars covering Parow, pointing North West
parow-s-ne - Sector at Mars covering Parow, pointing North East
ssuburbs-s-s - Sector at Mars covering southern suburbs, pointing South
kuilsriver-s-se - Sector at Saturn covering Kuils River, pointing South East
rondebosch-s-ne - Sector at Uranus covering Rondebosch, pointing North East
Station Interfaces
Format: WiND DNS name of the node ("Nameserver prefix")
Max length: 16 characters
Examples:
tfyre
vash
Interface Name
On a Mikrotik RouterBOARD this is set, for example, with:
/interface set 0 name="link-neptune"
Please note the difference between point-to-point links and point-to-multipoint links below.
Point-to-Point Interfaces
Format: link-Remote HS
HS: the high site DNS name as seen in WiND ("Nameserver prefix")
Examples:
link-neptune
link-jupiter
Point-to-Multipoint Links
Access Point Interface
Format: Same as #Radio Name
Examples:
parow-s-nw - Sector at Mars covering Parow, pointing North West
parow-s-ne - Sector at Mars covering Parow, pointing North East
ssuburbs-s-s - Sector at Mars covering southern suburbs, pointing South
kuilsriver-s-se - Sector at Saturn covering Kuils River, pointing South East
rondebosch-s-ne - Sector at Uranus covering Rondebosch, pointing North East
Station Interfaces
Format: High Site Name
Examples:
Mars
Mercury