diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_swap.txt | 10 | ||||
| -rw-r--r-- | docs/configuration/firewall/md-global-options.md | 11 | ||||
| -rw-r--r-- | docs/configuration/firewall/md-groups.md | 1 | ||||
| -rw-r--r-- | docs/configuration/policy/md-as-path-list.md | 29 | ||||
| -rw-r--r-- | docs/configuration/policy/md-community-list.md | 29 | ||||
| -rw-r--r-- | docs/configuration/policy/md-extcommunity-list.md | 32 | ||||
| -rw-r--r-- | docs/configuration/policy/md-large-community-list.md | 29 | ||||
| -rw-r--r-- | docs/configuration/policy/md-local-route.md | 99 | ||||
| -rw-r--r-- | docs/configuration/policy/md-prefix-list.md | 145 | ||||
| -rw-r--r-- | docs/configuration/policy/md-route.md | 1 | ||||
| -rw-r--r-- | docs/configuration/service/md-salt-minion.md | 50 | ||||
| -rw-r--r-- | docs/configuration/system/md-updates.md | 35 |
12 files changed, 471 insertions, 0 deletions
diff --git a/docs/_swap.txt b/docs/_swap.txt index b4d95536..cee6841e 100644 --- a/docs/_swap.txt +++ b/docs/_swap.txt @@ -112,3 +112,13 @@ configuration/protocols/index installation/virtual/eve-ng configexamples/site-2-site-cisco contributing/upstream-packages + +# Newly added 2026-04-29 (post cfgcmd/opcmd single-line body fix, BackstopJS <5%) +configuration/policy/as-path-list +configuration/policy/community-list +configuration/policy/extcommunity-list +configuration/policy/large-community-list +configuration/policy/local-route +configuration/policy/prefix-list +configuration/service/salt-minion +configuration/system/updates diff --git a/docs/configuration/firewall/md-global-options.md b/docs/configuration/firewall/md-global-options.md index adff2d5a..3a480472 100644 --- a/docs/configuration/firewall/md-global-options.md +++ b/docs/configuration/firewall/md-global-options.md @@ -153,46 +153,57 @@ VyOS supports setting timeouts for connections by connection type. You can set timeout values for generic connections, ICMP connections, UDP connections, or TCP connections in various states. ```{cfgcmd} set firewall global-options timeout icmp \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout other \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp close \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp close-wait \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp established \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp fin-wait \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp last-ack \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp syn-recv \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp syn-sent \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout tcp time-wait \<1-21474836\> + :defaultvalue: ``` ```{cfgcmd} set firewall global-options timeout udp other \<1-21474836\> + :defaultvalue: ``` diff --git a/docs/configuration/firewall/md-groups.md b/docs/configuration/firewall/md-groups.md index ceb1783f..2e4bdec1 100644 --- a/docs/configuration/firewall/md-groups.md +++ b/docs/configuration/firewall/md-groups.md @@ -18,6 +18,7 @@ as inbound or outbound in the case of interface groups. An **address group** contains a single IP address or IP address range. ```{cfgcmd} set firewall group address-group \<name\> address [address | address range] + ``` ```{cfgcmd} set firewall group ipv6-address-group \<name\> address \<address\> diff --git a/docs/configuration/policy/md-as-path-list.md b/docs/configuration/policy/md-as-path-list.md new file mode 100644 index 00000000..1fcece91 --- /dev/null +++ b/docs/configuration/policy/md-as-path-list.md @@ -0,0 +1,29 @@ +# BGP - AS Path Policy + +VyOS provides policies commands exclusively for BGP traffic filtering and +manipulation: **as-path-list** is one of them. + +## Configuration + +### policy as-path-list + +```{cfgcmd} set policy as-path-list \<text\> + +Create as-path-policy identified by name `<text>`. +``` +```{cfgcmd} set policy as-path-list \<text\> description \<text\> + +Set description for as-path-list policy. +``` +```{cfgcmd} set policy as-path-list \<text\> rule \<1-65535\> action \<permit|deny\> + +Set action to take on entries matching this rule. +``` +```{cfgcmd} set policy as-path-list \<text\> rule \<1-65535\> description \<text\> + +Set description for rule. +``` +```{cfgcmd} set policy as-path-list \<text\> rule \<1-65535\> regex \<text\> + +Regular expression to match against an AS path. For example "64501 64502". +```
\ No newline at end of file diff --git a/docs/configuration/policy/md-community-list.md b/docs/configuration/policy/md-community-list.md new file mode 100644 index 00000000..bdcf4140 --- /dev/null +++ b/docs/configuration/policy/md-community-list.md @@ -0,0 +1,29 @@ +# BGP - Community List + +VyOS provides policies commands exclusively for BGP traffic filtering and +manipulation: **community-list** is one of them. + +## Configuration + +### policy community-list + +```{cfgcmd} set policy community-list \<text\> + +Creat community-list policy identified by name `<text>`. +``` +```{cfgcmd} set policy community-list \<text\> description \<text\> + +Set description for community-list policy. +``` +```{cfgcmd} set policy community-list \<text\> rule \<1-65535\> action \<permit|deny\> + +Set action to take on entries matching this rule. +``` +```{cfgcmd} set policy community-list \<text\> rule \<1-65535\> description \<text\> + +Set description for rule. +``` +```{cfgcmd} set policy community-list \<text\> rule \<1-65535\> regex \<aa:nn|local-AS|no-advertise|no-export|additive\> + +Regular expression to match against a community-list. +```
\ No newline at end of file diff --git a/docs/configuration/policy/md-extcommunity-list.md b/docs/configuration/policy/md-extcommunity-list.md new file mode 100644 index 00000000..fdfe6210 --- /dev/null +++ b/docs/configuration/policy/md-extcommunity-list.md @@ -0,0 +1,32 @@ +# BGP - Extended Community List + +VyOS provides policies commands exclusively for BGP traffic filtering and +manipulation: **extcommunity-list** is one of them. + +## Configuration + +### policy extcommunity-list + +```{cfgcmd} set policy extcommunity-list \<text\> + +Creat extcommunity-list policy identified by name \<text\>. +``` +```{cfgcmd} set policy extcommunity-list \<text\> description \<text\> + +Set description for extcommunity-list policy. +``` +```{cfgcmd} set policy extcommunity-list \<text\> rule \<1-65535\> action \<permit|deny\> + +Set action to take on entries matching this rule. +``` +```{cfgcmd} set policy extcommunity-list \<text\> rule \<1-65535\> description \<text\> + +Set description for rule. +``` +```{cfgcmd} set policy extcommunity-list \<text\> rule \<1-65535\> regex \<text\> +Regular expression to match against an extended community list, where text +could be: +* \<aa:nn:nn\>: Extended community list regular expression. +* \<rt aa:nn:nn\>: Route Target regular expression. +* \<soo aa:nn:nn\>: Site of Origin regular expression. +```
\ No newline at end of file diff --git a/docs/configuration/policy/md-large-community-list.md b/docs/configuration/policy/md-large-community-list.md new file mode 100644 index 00000000..23b9a85a --- /dev/null +++ b/docs/configuration/policy/md-large-community-list.md @@ -0,0 +1,29 @@ +# BGP - Large Community List + +VyOS provides policies commands exclusively for BGP traffic filtering and +manipulation: **large-community-list** is one of them. + +## Configuration + +### policy large-community-list + +```{cfgcmd} set policy large-community-list \<text\> + +Create large-community-list policy identified by name `<text>`. +``` +```{cfgcmd} set policy large-community-list \<text\> description \<text\> + +Set description for large-community-list policy. +``` +```{cfgcmd} set policy large-community-list \<text\> rule \<1-65535\> action \<permit|deny\> + +Set action to take on entries matching this rule. +``` +```{cfgcmd} set policy large-community-list \<text\> rule \<1-65535\> description \<text\> + +Set description for rule. +``` +```{cfgcmd} set policy large-community-list \<text\> rule \<1-65535\> regex \<aa:nn:nn\> + +Regular expression to match against a large community list. +```
\ No newline at end of file diff --git a/docs/configuration/policy/md-local-route.md b/docs/configuration/policy/md-local-route.md new file mode 100644 index 00000000..5b2297f7 --- /dev/null +++ b/docs/configuration/policy/md-local-route.md @@ -0,0 +1,99 @@ +# Local Route Policy + +Policies for local traffic are defined in this section. + +## Configuration + +### Local Route IPv4 + +```{cfgcmd} set policy local-route rule \<1-32765\> set table \<1-200|main\> + +Set the routing table to use for forwarding matching packets. +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> set vrf \<vrf|default\> + +Set the VRF to use for forwarding matching packets. +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> protocol \<protocol\> + +Match specified protocol (name or number). +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> fwmark \<1-2147483647\> + +Match specified firewall mark (fwmark). +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> source address \<x.x.x.x|x.x.x.x/x\> + +Match specified source address or prefix. +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> source port \<1-65535\> + +Match specified source port. +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> destination address \<x.x.x.x|x.x.x.x/x\> + +Match specified destination address or prefix. +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> destination port \<1-65535\> + +Match specified destination port. +``` + +```{cfgcmd} set policy local-route rule \<1-32765\> inbound-interface \<interface\> + +Match specified inbound interface. +``` + +### Local Route IPv6 + +```{cfgcmd} set policy local-route6 rule \<1-32765\> set table \<1-200|main\> + +Set the routing table to use for forwarding matching packets. +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> set vrf \<vrf|default\> + +Set the VRF to use for forwarding matching packets. +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> protocol \<protocol\> + +Match specified protocol (name or number). +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> fwmark \<1-2147483647\> + +Match specified firewall mark (fwmark). +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> source address \<h:h:h:h:h:h:h:h|h:h:h:h:h:h:h:h/x\> + +Match specified source address or prefix. +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> source port \<1-65535\> + +Match specified source port. +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> destination address \<h:h:h:h:h:h:h:h|h:h:h:h:h:h:h:h/x\> + +Match specified destination address or prefix. +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> destination port \<1-65535\> + +Match specified destination port. +``` + +```{cfgcmd} set policy local-route6 rule \<1-32765\> inbound-interface \<interface\> + +Match specified inbound interface. +```
\ No newline at end of file diff --git a/docs/configuration/policy/md-prefix-list.md b/docs/configuration/policy/md-prefix-list.md new file mode 100644 index 00000000..6a3e66e6 --- /dev/null +++ b/docs/configuration/policy/md-prefix-list.md @@ -0,0 +1,145 @@ +# Prefix List Policy + +Prefix lists provides the most powerful prefix based filtering mechanism. In +addition to access-list functionality, ip prefix-list has prefix length range +specification. + +If no ip prefix list is specified, it acts as permit. If ip prefix list is +defined, and no match is found, default deny is applied. + +Prefix filtering can be done using prefix-list and prefix-list6. + +## Configuration + +### IPv4 Prefix Lists (prefix-list) + +```{cfgcmd} set policy prefix-list \<text\> + +This command creates the new prefix-list policy, identified by `<text>`. +``` + +```{cfgcmd} set policy prefix-list \<text\> description \<text\> + +Set description for the prefix-list policy. +``` + +```{cfgcmd} set policy prefix-list \<text\> rule \<1-65535\> action \<permit|deny\> + +This command creates a new rule in the prefix-list and defines an action. +``` + +```{cfgcmd} set policy prefix-list \<text\> rule \<1-65535\> description \<text\> + +Set description for rule in the prefix-list. +``` + +```{cfgcmd} set policy prefix-list \<text\> rule \<1-65535\> prefix \<x.x.x.x/x\> + +Prefix to match against. +``` + +```{cfgcmd} set policy prefix-list \<text\> rule \<1-65535\> ge \<0-32\> + +Netmask greater than length. +``` + +```{cfgcmd} set policy prefix-list \<text\> rule \<1-65535\> le \<0-32\> + +Netmask less than length +``` + +### Example: IPv4 Prefix Lists (prefix-list) +This example creates an IPv4 prefix-list named PL4-EXAMPLE-NAME, defines 3 +rules each with 1 prefix, and matches le (less than/equal to) /32. + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 10 action 'permit' + +``` +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 10 le '32' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 10 prefix '192.0.2.0/24' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 20 action 'permit' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 20 le '32' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 20 prefix '198.51.100.0/24' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 30 action 'permit' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 30 le '32' +``` + +```{cfgcmd} set policy prefix-list PL4-EXAMPLE-NAME rule 30 prefix '203.0.113.0/24' +``` +### IPv6 Prefix Lists (prefix-list6) +```{cfgcmd} set policy prefix-list6 \<text\> + +This command creates the new IPv6 prefix-list policy, identified by `<text>`. +``` + +```{cfgcmd} set policy prefix-list6 \<text\> description \<text\> + +Set description for the IPv6 prefix-list policy. +``` + +```{cfgcmd} set policy prefix-list6 \<text\> rule \<1-65535\> action \<permit|deny\> + +This command creates a new rule in the IPv6 prefix-list and defines an +action. +``` + +```{cfgcmd} set policy prefix-list6 \<text\> rule \<1-65535\> description \<text\> + +Set description for rule in IPv6 prefix-list. +``` + +```{cfgcmd} set policy prefix-list6 \<text\> rule \<1-65535\> prefix \<h:h:h:h:h:h:h:h/x\> + +IPv6 prefix. +``` + +```{cfgcmd} set policy prefix-list6 \<text\> rule \<1-65535\> ge \<0-128\> + +Netmask greater than length. +``` + +```{cfgcmd} set policy prefix-list6 \<text\> rule \<1-65535\> le \<0-128\> + +Netmask less than length +``` +### Example: IPv6 Prefix Lists (prefix-list6) +This example creates an IPv6 prefix-list6 named PL6-EXAMPLE-NAME, defines 3 +rules each with 1 prefix, and matches le (less than/equal to) /128. +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 10 action 'permit' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 10 le '128' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 10 prefix '2001:db8:0:0::/64' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 20 action 'permit' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 20 le '128' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 20 prefix '2001:db8:0:1::/64' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 30 action 'permit' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 30 le '128' +``` + +```{cfgcmd} set policy prefix-list6 PL6-EXAMPLE-NAME rule 30 prefix '2001:db8:0:2::/64' +```
\ No newline at end of file diff --git a/docs/configuration/policy/md-route.md b/docs/configuration/policy/md-route.md index bf5e552e..6db28683 100644 --- a/docs/configuration/policy/md-route.md +++ b/docs/configuration/policy/md-route.md @@ -11,6 +11,7 @@ ability to specify the criteria to match. Data packets go through the rules from 1 - 999999, at the first match the action of the rule will be executed. ```{cfgcmd} set policy route \<name\> description \<text\> + ``` ```{cfgcmd} set policy route6 \<name\> description \<text\> diff --git a/docs/configuration/service/md-salt-minion.md b/docs/configuration/service/md-salt-minion.md new file mode 100644 index 00000000..d7aa7664 --- /dev/null +++ b/docs/configuration/service/md-salt-minion.md @@ -0,0 +1,50 @@ +(saltminion)= + +# Salt-Minion + +[SaltStack] is Python-based, open-source +software for event-driven IT automation, remote task execution, and +configuration management. Supporting the "infrastructure as code" +approach to data center system and network deployment and management, +configuration automation, SecOps orchestration, vulnerability remediation, +and hybrid cloud control. + +## Requirements + +To use the Salt-Minion, a running Salt-Master is required. You can find more +in the [Salt Project Documentation](https://docs.saltproject.io/en/latest/contents.html) + +## Configuration + +```{cfgcmd} set service salt-minion hash \<type\> + + The hash type used when discovering file on master server (default: sha256) +``` + + +```{cfgcmd} set service salt-minion id \<id\> + +Explicitly declare ID for this minion to use (default: hostname) +``` + + +```{cfgcmd} set service salt-minion interval \<1-1440\> + +Interval in minutes between updates (default: 60) +``` + + +```{cfgcmd} set service salt-minion master \<hostname | IP\> + +The hostname or IP address of the master +``` + + +```{cfgcmd} set service salt-minion master-key \<key\> + +URL with signature of master for auth reply verification +``` +Please take a look in the Automation section to find some usefull +Examples. + +[saltstack]: https://saltproject.io/ diff --git a/docs/configuration/system/md-updates.md b/docs/configuration/system/md-updates.md new file mode 100644 index 00000000..8734788f --- /dev/null +++ b/docs/configuration/system/md-updates.md @@ -0,0 +1,35 @@ +# Updates + +VyOS supports online checking for updates + +## Configuration + +```{cfgcmd} set system update-check auto-check + +Configure auto-checking for new images +``` + +```{cfgcmd} set system update-check url \<url\> + +Configure a URL that contains information about images. +``` + +## Example + +```none +set system update-check auto-check +set system update-check url 'https://raw.githubusercontent.com/vyos/vyos-rolling-nightly-builds/main/version.json' +``` + +Check: + +```none +vyos@r4:~$ show system updates +Current version: 1.5-rolling-202312220023 + +Update available: 1.5-rolling-202312250024 +Update URL: https://github.com/vyos/vyos-rolling-nightly-builds/releases/download/1.5-rolling-202312250024/1.5-rolling-202312250024-amd64.iso +vyos@r4:~$ + +vyos@r4:~$ add system image latest +``` |
