8021Q - Revision history

Infrastation: /* VLAN switch templates */ fixup PCRE pattern delimiters

2016-07-13T16:46:48Z

VLAN switch templates: fixup PCRE pattern delimiters

Infrastation: /* adding and removing 802.1Q ports offline */ more minor nits

2016-07-13T14:03:34Z

adding and removing 802.1Q ports offline: more minor nits

Infrastation: /* known bugs and limitations */ more nits

2016-07-13T14:02:01Z

known bugs and limitations: more nits

Infrastation: /* vendor-specific switch setup */ which/that

2016-07-13T14:00:14Z

vendor-specific switch setup: which/that

Infrastation: /* RackTables objects setup */ which/that

2016-07-13T13:59:02Z

RackTables objects setup: which/that

Grin: link to gateway page

2013-09-19T13:48:33Z

link to gateway page

Infrastation: /* editing 802.1Q configuration offline */ add text based on my LinkedIn comment

2012-12-27T08:47:03Z

editing 802.1Q configuration offline: add text based on my LinkedIn comment

Infrastation: add new section

2012-12-27T08:23:33Z

add new section

Infrastation: /* VLAN switch templates */ explain PCRE in more details

2012-08-27T11:36:22Z

VLAN switch templates: explain PCRE in more details

Infrastation: /* VLAN switch templates */ add some real text

2011-07-03T22:17:35Z

VLAN switch templates: add some real text

@@ Line 124: / Line 124: @@
 * <tt>()</tt> (subpattern)
 * <tt>.</tt> (any symbol)
-For example, matching a single interface is done with a PCRE like this: <tt>/^fa0/1$/</tt>. Note the delimiters around the PCRE (<tt>//</tt>) and the start/end metasymbols. The end anchor (<tt>$</tt>) makes sense in most VST rules to distinguish 1 from 10, 11, 12, 13, 14, 120 and any other number starting with the same digit (same applies for 2, 3 etc). The need for the start anchor (<tt>^</tt>) depends on the naming pattern of the remote software. With all interfaces named like <tt>e0/1/20</tt> the purpose of the start anchor boils down to keeping the PCREs consistent. However, some software (such as XOS) does not prefix interface names with anything and ports are named 1, 2, 3, 4 and so on. In this case <tt>/1$/</tt> and <tt>/^1$/</tt> will produce differerent results.
+For example, matching a single interface is done with a PCRE like this: <tt>#^fa0/1$#</tt>. Note the delimiters around the PCRE (<tt>##</tt>) and the start/end metasymbols. The end anchor (<tt>$</tt>) makes sense in most VST rules to distinguish 1 from 10, 11, 12, 13, 14, 120 and any other number starting with the same digit (same applies for 2, 3 etc). The need for the start anchor (<tt>^</tt>) depends on the naming pattern of the remote software. With all interfaces named like <tt>e0/1/20</tt> the purpose of the start anchor boils down to keeping the PCREs consistent. However, some software (such as XOS) does not prefix interface names with anything and ports are named 1, 2, 3, 4 and so on. In this case <tt>/1$/</tt> and <tt>/^1$/</tt> will produce differerent results.
 There are multiple ways of matching several ports in one rule, for example:
-* <tt>/^gi0/[1-8]$/</tt> matches 8 ports of the same slot
+* <tt>#^gi0/[1-8]$#</tt> matches 8 ports of the same slot
-* <tt>/^gi1/[13579]$/</tt> matches 5 ports of the same slot
+* <tt>#^gi1/[13579]$#</tt> matches 5 ports of the same slot
-* <tt>/^gi2/(12|23|34|45)$/</tt> matches 4 ports of the same slot
+* <tt>#^gi2/(12|23|34|45)$#</tt> matches 4 ports of the same slot
-* <tt>/^gi[0-9]/1$/</tt> matches first ports of all slots
+* <tt>#^gi[0-9]/1$#</tt> matches first ports of all slots
 = adding and removing 802.1Q ports offline =

@@ Line 135: / Line 135: @@
 .1Q ports are normally created and deleted on "802.1Q sync" tab during a live session with the remote switch. Static editor can also create and delete 802.1Q ports, but offline. '''''Before you proceed with the manual editing, note that the existing automatic procedure creates new 802.1Q ports much faster and very accurately.'''''
-To turn the manual editor on, change the "List source: objects with extended 802.1Q sync" config option to RackCode matching the objects, which should have it on. For example, if you had such switches tagged with "manual 802.1Q", the RackCode would be:
+To turn the manual editor on, change the "8021Q_EXTSYNC_LISTSRC" config option to RackCode matching the objects that should have it on. For example, if you had such switches tagged with "manual 802.1Q", the RackCode would be:
 <pre>{manual 802.1Q}</pre>
-Make sure the switch of interest has a 802.1Q template associated, because "802.1Q sync" tab is only visible for an object with a 802.1Q template.
+Make sure the switch of interest has a 802.1Q template associated because "802.1Q sync" tab is only visible for an object with a 802.1Q template.

@@ Line 85: / Line 85: @@
 = known bugs and limitations =
 * port naming is fixed and cannot be changed
-* importing configuration for a port, which has VLANs 1~4094 allowed, is very slow
+* importing configuration for a port that has VLANs 1~4094 allowed, is very slow
 * for uplink-downlink reverb feature to work, both ports must have correct markup, have respective records on the Ports tab, and these records must be linked
 * there is no support for configuration templates like those in LiveVLANs
 * VLAN1 cannot be used on uplink or downlink ports
 * VLAN domains require a special setup procedure to work properly
-* unbinding of 802.1Q order hides existing 802.1Q ports config, blocking object deletion
+* unbinding of 802.1Q order hides existing 802.1Q ports config and blocks deletion of the object
 * not all hardware supports trunk ports w/o allowed VLANs, and this is not handled by RackTables
 * ExtemeOS requires a special VLAN naming scheme

@@ Line 61: / Line 61: @@
 =vendor-specific switch setup=
 * Cisco IOS
-** Every port, which is intended to perform switching, must have "switchport mode" and "switchport trunk encapsulation" explicitly set in its "interface" section.
+** Every port that is intended to perform switching must have "switchport mode" and "switchport trunk encapsulation" explicitly set in its "interface" section.
 ** VTP mode must be set to "transparent".
 ** 12.2(SXH) version has a broken telnet server

@@ Line 44: / Line 44: @@
 =RackTables objects setup=
-.1Q code needs to know, if an object is a managed Ethernet switch (a switch, which RackTables can manage, to be precise). This is decided based on certain records about an object (the object must belong to "network switch" type):
+.1Q code needs to know if an object is a managed Ethernet switch (a switch that RackTables can manage, to be precise). This is decided based on certain records about an object (the object must belong to "network switch" type):
 * "IOS 12.0", "IOS 12.1" or "IOS 12.2" SW type
 * "NX-OS 4.0" or "NX-OS 4.1" SW type
@@ Line 54: / Line 54: @@
 * <del>"Huawei Quidway S53xx" HW type</del> (not used since 0.18.4)
-For most hardware, which is supported by 802.1Q feature "SW type" is set automatically during "SNMP sync" execution round.
+For most hardware that is supported by 802.1Q feature "SW type" is set automatically during "SNMP sync" execution round.
 =side effects=

@@ Line 4: / Line 4: @@
 =RackTables server setup=
-RackTables has a special component named "deviceconfig" to deliver configuration from and to managed switches. This component is a set of executable scripts located in <tt>gateways/deviceconfig</tt> directory (which is probably located in the main RackTables directory). Description below is accurate for RackTables 0.18.x, but may change in future versions.
+RackTables has a special component named "deviceconfig" to deliver configuration from and to managed switches. This component is a set of executable scripts located in <tt>gateways/deviceconfig</tt> directory (which is probably located in the main RackTables directory). Description below is accurate for RackTables 0.18.x, but was changed in [[Gateways|future versions]].
 In <tt>deviceconfig</tt> directory one can see a sample file named <tt>switch.secrets.php-sample</tt>. The real file, which will be used by the system, is <tt>switch.secrets.php</tt>, and the simplest way to have it created properly is to copy it from the sample file. '''''Before you proceed and put real configuration into that file, please understand the following!'''''

← Older revision		Revision as of 08:47, 27 December 2012
Line 132:		Line 132:
	* <tt>/^gi[0-9]/1$/</tt> matches first ports of all slots		* <tt>/^gi[0-9]/1$/</tt> matches first ports of all slots

−	= ~~editing~~ 802.1Q ~~configuration~~ offline =	+	= adding and removing 802.1Q ports offline =
		+	802.1Q ports are normally created and deleted on "802.1Q sync" tab during a live session with the remote switch. Static editor can also create and delete 802.1Q ports, but offline. '''''Before you proceed with the manual editing, note that the existing automatic procedure creates new 802.1Q ports much faster and very accurately.'''''
		+
		+	To turn the manual editor on, change the "List source: objects with extended 802.1Q sync" config option to RackCode matching the objects, which should have it on. For example, if you had such switches tagged with "manual 802.1Q", the RackCode would be:
		+	<pre>{manual 802.1Q}</pre>
		+
		+	Make sure the switch of interest has a 802.1Q template associated, because "802.1Q sync" tab is only visible for an object with a 802.1Q template.

← Older revision		Revision as of 08:23, 27 December 2012
Line 131:		Line 131:
	* <tt>/^gi2/(12\|23\|34\|45)$/</tt> matches 4 ports of the same slot		* <tt>/^gi2/(12\|23\|34\|45)$/</tt> matches 4 ports of the same slot
	* <tt>/^gi[0-9]/1$/</tt> matches first ports of all slots		* <tt>/^gi[0-9]/1$/</tt> matches first ports of all slots
		+
		+	= editing 802.1Q configuration offline =

@@ Line 97: / Line 97: @@
 = VLAN switch templates =
-A VLAN switch template, or VST, is one of the key structures of RackTables 802.1Q feature. The purpose of VST is to decide, what configuration which port of a VLAN switch can have. VST consists of an ordered list of rules defined in the following format:
+A VLAN switch template, or VST, is one of the principal structures of RackTables 802.1Q feature. The purpose of VST is to decide, what configuration which port of a VLAN switch can have. VST consists of an ordered list of rules, each rule consisting of the following fields:
-* '''Sequence.''' An integer number defining the order of a rule on the list. Each rule must have a sequence number and it must be unique within the VST.
+;Sequence
-* '''Regexp.''' A PCRE regular expression.
+: An integer number defining the order of a rule on the list. Each rule must have a sequence number unique within the VST.
-* '''Role.''' Either "none", which means, that the port cannot switch any VLANs and cannot have 802.1Q configuration, or one of the roles below:
+;Regexp
-** <tt>user: access only</tt> -- switches 1 VLAN in access mode, configuration can be changed by a user
+: A PCRE regular expression (see the comment after this list).
-** <tt>user: trunk only</tt> --- switches 0 or more VLANs (with 0 or 1 of VLANs being native) in trunk mode, configuration can be changed by a user
+;Role
-** <tt>user: anymode</tt> -- switches VLANs in any of the two modes above
+: Either "none", which means, that the port cannot switch any VLANs and cannot have 802.1Q configuration, or one of the roles below:
-** <tt>system: uplink trunk</tt> -- switches any number of tagged VLANs and its configuration is built automatically as a superset of all VLANs of all ports of the current switch
+:* <tt>user: access only</tt> -- switches 1 VLAN in access mode, configuration can be changed by a user
-** <tt>system: downlink trunk</tt> -- switches any number of tagged VLANs and reflects the configuration of an "uplink" port, when is linked with one
+:* <tt>user: trunk only</tt> --- switches 0 or more VLANs (with 0 or 1 of VLANs being native) in trunk mode, configuration can be changed by a user
-* '''VLAN IDs.''' A comma-delimited list of permitted VLANs or VLAN ranges (that is, two VLANs delimited with dash), for example: 10-20, 30, 40-50, 60. Regardless of the port mode (user or system) its configuration will never include the VLANs, which are not present on the configured list. A default empty value stands for "1-4094".
+:* <tt>user: anymode</tt> -- switches VLANs in any of the two modes above
-* '''Comment.'''
+:* <tt>system: uplink trunk</tt> -- switches any number of tagged VLANs and its configuration is built automatically as a superset of all VLANs of all ports of the current switch
-For a given VLAN switch a VST is executed as many times as there are ports in its configuration. Within each port VST rules are evaluated in the order of the sequence numbers. When port name matches the PCRE, the port is assigned the specified role and VLAN ID filter. A port, which had no matching rules, is assigned "none" role.
+----

← Older revision		Revision as of 22:17, 3 July 2011
Line 97:		Line 97:

	= VLAN switch templates =		= VLAN switch templates =
		+	A VLAN switch template, or VST, is one of the key structures of RackTables 802.1Q feature. The purpose of VST is to decide, what configuration which port of a VLAN switch can have. VST consists of an ordered list of rules defined in the following format:
		+	* '''Sequence.''' An integer number defining the order of a rule on the list. Each rule must have a sequence number and it must be unique within the VST.
		+	* '''Regexp.''' A PCRE regular expression.
		+	* '''Role.''' Either "none", which means, that the port cannot switch any VLANs and cannot have 802.1Q configuration, or one of the roles below:
		+	** <tt>user: access only</tt> -- switches 1 VLAN in access mode, configuration can be changed by a user
		+	** <tt>user: trunk only</tt> --- switches 0 or more VLANs (with 0 or 1 of VLANs being native) in trunk mode, configuration can be changed by a user
		+	** <tt>user: anymode</tt> -- switches VLANs in any of the two modes above
		+	** <tt>system: uplink trunk</tt> -- switches any number of tagged VLANs and its configuration is built automatically as a superset of all VLANs of all ports of the current switch
		+	** <tt>system: downlink trunk</tt> -- switches any number of tagged VLANs and reflects the configuration of an "uplink" port, when is linked with one
		+	* '''VLAN IDs.''' A comma-delimited list of permitted VLANs or VLAN ranges (that is, two VLANs delimited with dash), for example: 10-20, 30, 40-50, 60. Regardless of the port mode (user or system) its configuration will never include the VLANs, which are not present on the configured list. A default empty value stands for "1-4094".
		+	* '''Comment.'''
		+
		+	For a given VLAN switch a VST is executed as many times as there are ports in its configuration. Within each port VST rules are evaluated in the order of the sequence numbers. When port name matches the PCRE, the port is assigned the specified role and VLAN ID filter. A port, which had no matching rules, is assigned "none" role.