diff options
| author | Gaige B Paulsen <gaige@cluetrust.com> | 2024-11-25 16:08:54 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-25 16:08:54 -0500 |
| commit | bf38875af0a7e5166ce0330f16441b7d8b434e6a (patch) | |
| tree | a01b371d37ae88136eec0d50868da6aebcea1414 /docs/vyos.vyos.vyos_ntp_global_module.rst | |
| parent | 04c837af1cf89ff42adc42062df48a0dd209a0e1 (diff) | |
| download | vyos.vyos-bf38875af0a7e5166ce0330f16441b7d8b434e6a.tar.gz vyos.vyos-bf38875af0a7e5166ce0330f16441b7d8b434e6a.zip | |
T6910: fix documentation and argspecs are out of alignment (#358)
chore: update firewall_rules from module
fix: update firewall_global from resource model
chore: update to sync with resource module
chore: update README
fix: comment and formatting
fix: formatting issues
fix: missing imports
fix: import and metadata violations
fix: interface fixes
fix: move the arg spec comment
fix: update interface docs
fix: remove comments for non-RM versions
* T6910: fix documentation and argspecs
* T6910: docs: update per review
* T6910: docs: fix missing pipe
Diffstat (limited to 'docs/vyos.vyos.vyos_ntp_global_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_ntp_global_module.rst | 129 |
1 files changed, 65 insertions, 64 deletions
diff --git a/docs/vyos.vyos.vyos_ntp_global_module.rst b/docs/vyos.vyos.vyos_ntp_global_module.rst index 8bfa05a3..582aa17f 100644 --- a/docs/vyos.vyos.vyos_ntp_global_module.rst +++ b/docs/vyos.vyos.vyos_ntp_global_module.rst @@ -5,10 +5,10 @@ vyos.vyos.vyos_ntp_global ************************* -**Manages ntp modules of Vyos network devices** +**NTP global resource module** -Version added: 2.4.0 +Version added: 1.0.0 .. contents:: :local: @@ -114,14 +114,15 @@ Parameters <td> <ul style="margin: 0; padding: 0"><b>Choices:</b> <li>noselect</li> - <li>dynamic (v1.2)</li> - <li>pool (v1.3+))</li> + <li>dynamic</li> + <li>pool</li> <li>preempt</li> <li>prefer</li> </ul> </td> <td> <div>server options for NTP</div> + <div>`dynamic` changed to `pool` after v1.3</div> </td> </tr> <tr> @@ -195,7 +196,7 @@ Notes .. note:: - Tested against vyos 1.3 - This module works with connection ``network_cli``. - - VyOS v.1.4+ uses chronyd, and path changes from ``system`` to ``service`` + - VyOS v.1.4+ uses chronyd, and path changes from `system` to `service` @@ -212,8 +213,8 @@ Examples # # ------------- # vyos@vyos:~$ show configuration commands | grep ntp # set service ntp server time1.vyos.net - # set system/service ntp server time2.vyos.net - # set system/service ntp server time3.vyos.net + # set service ntp server time2.vyos.net + # set service ntp server time3.vyos.net # vyos@vyos:~$ # # Task @@ -262,20 +263,20 @@ Examples # }, # "changed": true, # "commands": [ - # "set system/service ntp allow-clients address 10.6.6.0/24", - # "set system/service ntp listen-address 10.1.3.1", - # "set system/service ntp server 203.0.113.0 prefer" + # "set service ntp allow-clients address 10.6.6.0/24", + # "set service ntp listen-address 10.1.3.1", + # "set service ntp server 203.0.113.0 prefer" # ] # After state: # # ------------- # vyos@vyos:~$ show configuration commands | grep ntp - # set system/service ntp allow-clients address '10.6.6.0/24' - # set system/service ntp listen-address '10.1.3.1' - # set system/service ntp server 203.0.113.0 prefer, - # set system/service ntp server time1.vyos.net - # set system/service ntp server time2.vyos.net - # set system/service ntp server time3.vyos.net + # set service ntp allow-clients address '10.6.6.0/24' + # set service ntp listen-address '10.1.3.1' + # set service ntp server 203.0.113.0 prefer, + # set service ntp server time1.vyos.net + # set service ntp server time2.vyos.net + # set service ntp server time3.vyos.net # vyos@vyos:~$ @@ -286,25 +287,25 @@ Examples # # Before state: # # ------------- # vyos@vyos:~$ show configuration commands | grep ntp - # set system/service ntp allow-clients address '10.4.9.0/24' - # set system/service ntp allow-clients address '10.4.7.0/24' - # set system/service ntp allow-clients address '10.1.2.0/24' - # set system/service ntp allow-clients address '10.2.3.0/24' - # set system/service ntp listen-address '10.1.9.16' - # set system/service ntp listen-address '10.5.3.2' - # set system/service ntp listen-address '10.7.9.21' - # set system/service ntp listen-address '10.8.9.4' - # set system/service ntp listen-address '10.4.5.1' - # set system/service ntp server 10.3.6.5 noselect - # set system/service ntp server 10.3.6.5 dynamic - # set system/service ntp server 10.3.6.5 preempt - # set system/service ntp server 10.3.6.5 prefer - # set system/service ntp server server4 noselect - # set system/service ntp server server4 dynamic - # set system/service ntp server server5 - # set system/service ntp server time1.vyos.net - # set system/service ntp server time2.vyos.net - # set system/service ntp server time3.vyos.net + # set service ntp allow-clients address '10.4.9.0/24' + # set service ntp allow-clients address '10.4.7.0/24' + # set service ntp allow-clients address '10.1.2.0/24' + # set service ntp allow-clients address '10.2.3.0/24' + # set service ntp listen-address '10.1.9.16' + # set service ntp listen-address '10.5.3.2' + # set service ntp listen-address '10.7.9.21' + # set service ntp listen-address '10.8.9.4' + # set service ntp listen-address '10.4.5.1' + # set service ntp server 10.3.6.5 noselect + # set service ntp server 10.3.6.5 dynamic + # set service ntp server 10.3.6.5 preempt + # set service ntp server 10.3.6.5 prefer + # set service ntp server server4 noselect + # set service ntp server server4 dynamic + # set service ntp server server5 + # set service ntp server time1.vyos.net + # set service ntp server time2.vyos.net + # set service ntp server time3.vyos.net # vyos@vyos:~$ # # Task @@ -397,32 +398,32 @@ Examples # }, # "changed": true, # "commands": [ - # "delete system/service ntp allow-clients address 10.4.7.0/24", - # "delete system/service ntp allow-clients address 10.2.3.0/24", - # "delete system/service ntp allow-clients address 10.1.2.0/24", - # "delete system/service ntp allow-clients address 10.4.9.0/24", - # "delete system/service ntp listen-address 10.7.9.21", - # "delete system/service ntp listen-address 10.4.5.1", - # "delete system/service ntp listen-address 10.5.3.2", - # "delete system/service ntp listen-address 10.8.9.4", - # "delete system/service ntp listen-address 10.1.9.16", - # "delete system/service ntp server 10.3.6.5", - # "delete system/service ntp server server4", - # "delete system/service ntp server server5", - # "set system/service ntp allow-clients address 10.6.6.0/24", - # "set system/service ntp listen-address 10.1.3.1", - # "set system/service ntp server 203.0.113.0 prefer" + # "delete service ntp allow-clients address 10.4.7.0/24", + # "delete service ntp allow-clients address 10.2.3.0/24", + # "delete service ntp allow-clients address 10.1.2.0/24", + # "delete service ntp allow-clients address 10.4.9.0/24", + # "delete service ntp listen-address 10.7.9.21", + # "delete service ntp listen-address 10.4.5.1", + # "delete service ntp listen-address 10.5.3.2", + # "delete service ntp listen-address 10.8.9.4", + # "delete service ntp listen-address 10.1.9.16", + # "delete service ntp server 10.3.6.5", + # "delete service ntp server server4", + # "delete service ntp server server5", + # "set service ntp allow-clients address 10.6.6.0/24", + # "set service ntp listen-address 10.1.3.1", + # "set service ntp server 203.0.113.0 prefer" # ] # After state: # # ------------- # vyos@vyos:~$ show configuration commands | grep ntp - # set system/service ntp allow-clients address '10.6.6.0/24' - # set system/service ntp listen-address '10.1.3.1' - # set system/service ntp server 203.0.113.0 prefer, - # set system/service ntp server time1.vyos.net - # set system/service ntp server time2.vyos.net - # set system/service ntp server time3.vyos.net + # set service ntp allow-clients address '10.6.6.0/24' + # set service ntp listen-address '10.1.3.1' + # set service ntp server 203.0.113.0 prefer, + # set service ntp server time1.vyos.net + # set service ntp server time2.vyos.net + # set service ntp server time3.vyos.net # vyos@vyos:~$ # # ------------------- @@ -432,12 +433,12 @@ Examples # # Before state: # # ------------- # vyos@vyos:~$ show configuration commands | grep ntp - # set system/service ntp allow-clients address '10.6.6.0/24' - # set system/service ntp listen-address '10.1.3.1' - # set system/service ntp server 203.0.113.0 prefer, - # set system/service ntp server time1.vyos.net - # set system/service ntp server time2.vyos.net - # set system/service ntp server time3.vyos.net + # set service ntp allow-clients address '10.6.6.0/24' + # set service ntp listen-address '10.1.3.1' + # set service ntp server 203.0.113.0 prefer, + # set service ntp server time1.vyos.net + # set service ntp server time2.vyos.net + # set service ntp server time3.vyos.net # vyos@vyos:~$ # Task @@ -898,7 +899,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div>The set of commands pushed to the remote device.</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['set service ntp server server1 dynamic', 'set service ntp server server1 prefer', 'set service ntp server server2 noselect', 'set service ntp server server2 preempt', 'set service ntp server server_add preempt']</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['set system ntp server server1 dynamic', 'set system ntp server server1 prefer', 'set system ntp server server2 noselect', 'set system ntp server server2 preempt', 'set system ntp server server_add preempt']</div> </td> </tr> <tr> @@ -949,7 +950,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <div>The provided configuration in the task rendered in device-native format (offline).</div> <br/> <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['set service ntp server server1 dynamic', 'set service ntp server server1 prefer', 'set service ntp server server2 noselect', 'set service ntp server server2 preempt', 'set service ntp server server_add preempt']</div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['set system ntp server server1 dynamic', 'set system ntp server server1 prefer', 'set system ntp server server2 noselect', 'set system ntp server server2 preempt', 'set system ntp server server_add preempt']</div> </td> </tr> </table> |