en10mb_opts.def 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. flag = {
  2. name = enet-dmac;
  3. arg-type = string;
  4. max = 1;
  5. descrip = "Override destination ethernet MAC addresses";
  6. doc = <<- EOText
  7. Takes a pair of comma deliminated ethernet MAC addresses which
  8. will replace the destination MAC address of outbound packets.
  9. The first MAC address will be used for the server to client traffic
  10. and the optional second MAC address will be used for the client
  11. to server traffic.
  12. Example:
  13. @example
  14. --enet-dmac=00:12:13:14:15:16,00:22:33:44:55:66
  15. @end example
  16. EOText;
  17. };
  18. flag = {
  19. name = enet-smac;
  20. arg-type = string;
  21. max = 1;
  22. descrip = "Override source ethernet MAC addresses";
  23. doc = <<- EOText
  24. Takes a pair of comma deliminated ethernet MAC addresses which
  25. will replace the source MAC address of outbound packets.
  26. The first MAC address will be used for the server to client traffic
  27. and the optional second MAC address will be used for the client
  28. to server traffic.
  29. Example:
  30. @example
  31. --enet-smac=00:12:13:14:15:16,00:22:33:44:55:66
  32. @end example
  33. EOText;
  34. };
  35. flag = {
  36. name = enet-subsmac;
  37. arg-type = string;
  38. max = 9999;
  39. stack-arg;
  40. descrip = "Substitute MAC addresses";
  41. doc = <<- EOText
  42. Allows you to rewrite ethernet MAC addresses of packets. It takes
  43. comma delimited pair or MACs address and rewrites all occurrences of
  44. the first MAC with the value of the second MAC.
  45. Example:
  46. @example
  47. --enet-subsmac=00:12:13:14:15:16,00:22:33:44:55:66
  48. @end example
  49. EOText;
  50. };
  51. flag = {
  52. name = enet-mac-seed;
  53. arg-type = number;
  54. max = 1;
  55. flags-cant = enet-smac;
  56. flags-cant = enet-dmac;
  57. flags-cant = enet-subsmac;
  58. descrip = "Randomize MAC addresses";
  59. doc = <<- EOText
  60. Allows you to randomize ethernet MAC addresses of packets, mostly
  61. like what @var{--seed} option does for IPv4/IPv6 addresses.
  62. EOText;
  63. };
  64. flag = {
  65. name = enet-mac-seed-keep-bytes;
  66. arg-type = number;
  67. arg-range = "1->6";
  68. flags-must = enet-mac-seed;
  69. max = 1;
  70. descrip = "Randomize MAC addresses";
  71. doc = <<- EOText
  72. Keep some bytes untouched when usinging @var{--enet-mac-seed} option.
  73. EOText;
  74. };
  75. /* rewrite 802.1q vlan tags */
  76. flag = {
  77. name = enet-vlan;
  78. max = 1;
  79. descrip = "Specify ethernet 802.1q VLAN tag mode";
  80. arg-type = string;
  81. doc = <<- EOText
  82. Allows you to rewrite ethernet frames to add a 802.1q header to standard 802.3
  83. ethernet headers or remove the 802.1q VLAN tag information.
  84. @table @bullet
  85. @item
  86. @var{add}
  87. Adds an 802.1q VLAN header to the existing 802.3 ethernet header. If
  88. a VLAN header already exists, a new VLAN header is added outside of the
  89. existing header.
  90. Note that you will be allowed to run this option multiple times to create
  91. more than 2 VLAN headers, however those packets will be valid. At most
  92. you should have 2 X 802.1q VLAN tags, or outer an 802.1ad and an inner 802.1q
  93. VLAN tag.
  94. @item
  95. @var{del}
  96. Rewrites the existing 802.1q VLAN header as an 802.3 ethernet header
  97. EOText;
  98. };
  99. flag = {
  100. name = enet-vlan-tag;
  101. max = 1;
  102. descrip = "Specify the new ethernet 802.1q VLAN tag value";
  103. arg-type = number;
  104. flags-must = enet-vlan;
  105. arg-range = "0->4095"; /* VID's are 12bit unsigned int's */
  106. doc = "";
  107. };
  108. flag = {
  109. name = enet-vlan-cfi;
  110. max = 1;
  111. descrip = "Specify the ethernet 802.1q VLAN CFI value";
  112. arg-type = number;
  113. flags-must = enet-vlan;
  114. arg-range = "0->1"; /* one bit */
  115. doc = "";
  116. };
  117. flag = {
  118. name = enet-vlan-pri;
  119. max = 1;
  120. descrip = "Specify the ethernet 802.1q VLAN priority";
  121. flags-must = enet-vlan;
  122. arg-type = number;
  123. arg-range = "0->7"; /* one byte */
  124. doc = "";
  125. };
  126. flag = {
  127. name = enet-vlan-proto;
  128. max = 1;
  129. flag-must = enet-vlan;
  130. descrip = "Specify VLAN tag protocol 802.1q or 802.1ad";
  131. arg-type = string;
  132. doc = <<- EOText
  133. Allows you to specify the protocol of the added VLAN tags.
  134. @table @bullet
  135. @item
  136. @var{802.1q}
  137. Specifies that 802.1q VLAN headers are to be added. This is the default.
  138. @item
  139. @var{802.1ad}
  140. Specifies that 802.1ad Q-in-Q VLAN headers are to be added. To make valid packets,
  141. input packets must already have 802.1q VLAN headers.
  142. EOText;
  143. };