From 1b58f4b0195b866b5d322c314ce66dcf72f8a9af Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Fri, 31 Jul 2020 17:53:09 -0400 Subject: Update docs (#73) vyos: Update docs Reviewed-by: GomathiselviS https://github.com/GomathiselviS --- README.md | 54 ++--- changelogs/fragments/73-update-docs.yaml | 3 + docs/vyos.vyos.vyos_banner_module.rst | 14 +- docs/vyos.vyos.vyos_command_module.rst | 23 +-- docs/vyos.vyos.vyos_config_module.rst | 22 +- docs/vyos.vyos.vyos_facts_module.rst | 16 +- docs/vyos.vyos.vyos_firewall_global_module.rst | 2 +- docs/vyos.vyos.vyos_interface_module.rst | 274 +++++++++++++++++++++---- docs/vyos.vyos.vyos_interfaces_module.rst | 4 +- docs/vyos.vyos.vyos_l3_interface_module.rst | 89 +++++++- docs/vyos.vyos.vyos_lag_interfaces_module.rst | 6 +- docs/vyos.vyos.vyos_linkagg_module.rst | 99 ++++++++- docs/vyos.vyos.vyos_lldp_global_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_interface_module.rst | 49 ++++- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 8 +- docs/vyos.vyos.vyos_lldp_module.rst | 10 +- docs/vyos.vyos.vyos_logging_module.rst | 114 ++++++++-- docs/vyos.vyos.vyos_ospfv2_module.rst | 6 +- docs/vyos.vyos.vyos_ping_module.rst | 14 +- docs/vyos.vyos.vyos_static_route_module.rst | 95 ++++++++- docs/vyos.vyos.vyos_system_module.rst | 26 ++- docs/vyos.vyos.vyos_user_module.rst | 130 ++++++++++-- docs/vyos.vyos.vyos_vlan_module.rst | 149 ++++++++++++-- 23 files changed, 984 insertions(+), 225 deletions(-) create mode 100644 changelogs/fragments/73-update-docs.yaml diff --git a/README.md b/README.md index 3e33513c..a1f2373f 100644 --- a/README.md +++ b/README.md @@ -27,37 +27,37 @@ The VyOS collection supports ``network_cli`` connections. ### Cliconf plugins Name | Description --- | --- -[vyos.vyos.vyos](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_cliconf.rst)|Use vyos cliconf to run command on VyOS platform +[vyos.vyos.vyos](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_cliconf.rst)|Use vyos cliconf to run command on VyOS platform ### Modules Name | Description --- | --- -[vyos.vyos.vyos_banner](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_banner_module.rst)|Manage multiline banners on VyOS devices -[vyos.vyos.vyos_command](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_command_module.rst)|Run one or more commands on VyOS devices -[vyos.vyos.vyos_config](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_config_module.rst)|Manage VyOS configuration on remote device -[vyos.vyos.vyos_facts](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_facts_module.rst)|Get facts about vyos devices. -[vyos.vyos.vyos_firewall_global](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_firewall_global_module.rst)|FIREWALL global resource module -[vyos.vyos.vyos_firewall_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_firewall_interfaces_module.rst)|FIREWALL interfaces resource module -[vyos.vyos.vyos_firewall_rules](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_firewall_rules_module.rst)|FIREWALL rules resource module -[vyos.vyos.vyos_interface](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_interface_module.rst)|(deprecated, removed after 2022-06-01) Manage Interface on VyOS network devices -[vyos.vyos.vyos_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_interfaces_module.rst)|Interfaces resource module -[vyos.vyos.vyos_l3_interface](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_l3_interface_module.rst)|(deprecated, removed after 2022-06-01) Manage L3 interfaces on VyOS network devices -[vyos.vyos.vyos_l3_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_l3_interfaces_module.rst)|L3 interfaces resource module -[vyos.vyos.vyos_lag_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_lag_interfaces_module.rst)|LAG interfaces resource module -[vyos.vyos.vyos_linkagg](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_linkagg_module.rst)|(deprecated, removed after 2022-06-01) Manage link aggregation groups on VyOS network devices -[vyos.vyos.vyos_lldp](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_lldp_module.rst)|(deprecated, removed after 2022-06-01) Manage LLDP configuration on VyOS network devices -[vyos.vyos.vyos_lldp_global](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_lldp_global_module.rst)|LLDP global resource module -[vyos.vyos.vyos_lldp_interface](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_lldp_interface_module.rst)|(deprecated, removed after 2022-06-01) Manage LLDP interfaces configuration on VyOS network devices -[vyos.vyos.vyos_lldp_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_lldp_interfaces_module.rst)|LLDP interfaces resource module -[vyos.vyos.vyos_logging](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_logging_module.rst)|Manage logging on network devices -[vyos.vyos.vyos_ospfv2](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_ospfv2_module.rst)|OSPFv2 resource module -[vyos.vyos.vyos_ospfv3](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_ospfv3_module.rst)|OSPFV3 resource module -[vyos.vyos.vyos_ping](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_ping_module.rst)|Tests reachability using ping from VyOS network devices -[vyos.vyos.vyos_static_route](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_static_route_module.rst)|(deprecated, removed after 2022-06-01) Manage static IP routes on Vyatta VyOS network devices -[vyos.vyos.vyos_static_routes](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_static_routes_module.rst)|Static routes resource module -[vyos.vyos.vyos_system](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_system_module.rst)|Run `set system` commands on VyOS devices -[vyos.vyos.vyos_user](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_user_module.rst)|Manage the collection of local users on VyOS device -[vyos.vyos.vyos_vlan](https://github.com/ansible-collections/vyos.vyos/blob/master/docs/vyos.vyos.vyos_vlan_module.rst)|Manage VLANs on VyOS network devices +[vyos.vyos.vyos_banner](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_banner_module.rst)|Manage multiline banners on VyOS devices +[vyos.vyos.vyos_command](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_command_module.rst)|Run one or more commands on VyOS devices +[vyos.vyos.vyos_config](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_config_module.rst)|Manage VyOS configuration on remote device +[vyos.vyos.vyos_facts](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_facts_module.rst)|Get facts about vyos devices. +[vyos.vyos.vyos_firewall_global](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_firewall_global_module.rst)|FIREWALL global resource module +[vyos.vyos.vyos_firewall_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_firewall_interfaces_module.rst)|FIREWALL interfaces resource module +[vyos.vyos.vyos_firewall_rules](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_firewall_rules_module.rst)|FIREWALL rules resource module +[vyos.vyos.vyos_interface](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_interface_module.rst)|(deprecated, removed after 2022-06-01) Manage Interface on VyOS network devices +[vyos.vyos.vyos_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_interfaces_module.rst)|Interfaces resource module +[vyos.vyos.vyos_l3_interface](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_l3_interface_module.rst)|(deprecated, removed after 2022-06-01) Manage L3 interfaces on VyOS network devices +[vyos.vyos.vyos_l3_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_l3_interfaces_module.rst)|L3 interfaces resource module +[vyos.vyos.vyos_lag_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_lag_interfaces_module.rst)|LAG interfaces resource module +[vyos.vyos.vyos_linkagg](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_linkagg_module.rst)|(deprecated, removed after 2022-06-01) Manage link aggregation groups on VyOS network devices +[vyos.vyos.vyos_lldp](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_lldp_module.rst)|(deprecated, removed after 2022-06-01) Manage LLDP configuration on VyOS network devices +[vyos.vyos.vyos_lldp_global](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_lldp_global_module.rst)|LLDP global resource module +[vyos.vyos.vyos_lldp_interface](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_lldp_interface_module.rst)|(deprecated, removed after 2022-06-01) Manage LLDP interfaces configuration on VyOS network devices +[vyos.vyos.vyos_lldp_interfaces](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_lldp_interfaces_module.rst)|LLDP interfaces resource module +[vyos.vyos.vyos_logging](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_logging_module.rst)|Manage logging on network devices +[vyos.vyos.vyos_ospfv2](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_ospfv2_module.rst)|OSPFv2 resource module +[vyos.vyos.vyos_ospfv3](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_ospfv3_module.rst)|OSPFV3 resource module +[vyos.vyos.vyos_ping](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_ping_module.rst)|Tests reachability using ping from VyOS network devices +[vyos.vyos.vyos_static_route](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_static_route_module.rst)|(deprecated, removed after 2022-06-01) Manage static IP routes on Vyatta VyOS network devices +[vyos.vyos.vyos_static_routes](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_static_routes_module.rst)|Static routes resource module +[vyos.vyos.vyos_system](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_system_module.rst)|Run `set system` commands on VyOS devices +[vyos.vyos.vyos_user](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_user_module.rst)|Manage the collection of local users on VyOS device +[vyos.vyos.vyos_vlan](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_vlan_module.rst)|Manage VLANs on VyOS network devices diff --git a/changelogs/fragments/73-update-docs.yaml b/changelogs/fragments/73-update-docs.yaml new file mode 100644 index 00000000..dde45f6b --- /dev/null +++ b/changelogs/fragments/73-update-docs.yaml @@ -0,0 +1,3 @@ +--- +minor_changes: + - Updated docs. diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index 61946399..dd26e377 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -39,7 +39,7 @@ Parameters banner
- - + string / required
@@ -79,7 +79,7 @@ Parameters
string - / required
+ @@ -114,8 +114,7 @@ Parameters - Default:
22
- +
Specifies the port to use when building the connection to the remote device.
@@ -147,8 +146,7 @@ Parameters - Default:
10
- +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
@@ -176,7 +174,7 @@ Parameters state
- - + string
@@ -195,7 +193,7 @@ Parameters text
- - + string
diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index dd7e2994..bd3d5e69 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -40,13 +40,14 @@ Parameters commands
- - - / required
+ list + / elements=raw / required
The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded.
+
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). Refer below examples.
@@ -55,7 +56,7 @@ Parameters interval
- - + integer
@@ -71,7 +72,7 @@ Parameters match
- - + string
@@ -111,7 +112,7 @@ Parameters
string - / required
+ @@ -146,8 +147,7 @@ Parameters - Default:
22
- +
Specifies the port to use when building the connection to the remote device.
@@ -179,8 +179,7 @@ Parameters - Default:
10
- +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
@@ -208,7 +207,7 @@ Parameters retries
- - + integer
@@ -224,8 +223,8 @@ Parameters wait_for
- - -
+ list + / elements=string diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index 44946bc5..c3031f35 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -90,7 +90,7 @@ Parameters filename
- - + string
@@ -106,7 +106,7 @@ Parameters comment
- - + string
@@ -122,7 +122,7 @@ Parameters config
- - + string
@@ -137,8 +137,8 @@ Parameters lines
- - -
+ list + / elements=string @@ -152,7 +152,7 @@ Parameters match
- - + string
@@ -192,7 +192,7 @@ Parameters
string - / required
+ @@ -227,8 +227,7 @@ Parameters - Default:
22
- +
Specifies the port to use when building the connection to the remote device.
@@ -260,8 +259,7 @@ Parameters - Default:
10
- +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
@@ -308,7 +306,7 @@ Parameters src
- - + path
diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index a0057373..f609b9e8 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -39,8 +39,8 @@ Parameters gather_network_resources
- - -
+ list + / elements=string @@ -54,8 +54,8 @@ Parameters gather_subset
- - -
+ list + / elements=string Default:
"!config"
@@ -91,7 +91,7 @@ Parameters
string - / required
+ @@ -126,8 +126,7 @@ Parameters - Default:
22
- +
Specifies the port to use when building the connection to the remote device.
@@ -159,8 +158,7 @@ Parameters - Default:
10
- +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index dda270d5..f7e64628 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -704,7 +704,7 @@ Parameters diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index b01595a1..c00b430f 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -36,18 +36,18 @@ Parameters - + - @@ -55,29 +55,30 @@ Parameters
List of Interfaces definitions.
- - + + + - + - + - + - + - + - + @@ -173,12 +179,13 @@ Parameters + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - @@ -241,7 +437,7 @@ Parameters - - + - - + - - - @@ -174,7 +174,7 @@ Parameters
list -
+ / elements=dictionary diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index dbf89a06..8745ffda 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -46,22 +46,91 @@ Parameters aggregate
- - -
+ list + / elements=dictionary + + + + + + + + + + + + + + + + + + + + + + + + + @@ -162,8 +231,7 @@ Parameters + @@ -195,8 +263,7 @@ Parameters + @@ -224,7 +291,7 @@ Parameters state
- - + string
@@ -90,7 +90,7 @@ Parameters
list -
+ / elements=string @@ -128,7 +128,7 @@ Parameters
list -
+ / elements=dictionary diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index a97a1c24..471de9b1 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -47,22 +47,103 @@ Parameters
list -
+ / elements=dictionary + + + + + + + + + + + + + + + + + + + + + + + + + @@ -81,14 +162,14 @@ Parameters @@ -137,7 +218,7 @@ Parameters
string - / required
+ @@ -172,8 +253,7 @@ Parameters + @@ -205,8 +285,7 @@ Parameters + diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index 1fc23bc0..bf803ff6 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -92,7 +92,7 @@ Parameters
list -
+ / elements=string + + + + + + + + + + + + + @@ -132,8 +171,7 @@ Parameters + @@ -165,8 +203,7 @@ Parameters + diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index a52251a4..d64b20c7 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -40,7 +40,7 @@ Parameters
list -
+ / elements=dictionary @@ -111,7 +111,7 @@ Parameters
list -
+ / elements=dictionary @@ -130,7 +130,7 @@ Parameters
integer - / required
+ @@ -149,7 +149,7 @@ Parameters
string - / required
+ diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index bcb1625e..30dae36f 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -47,7 +47,7 @@ Parameters
list -
+ / elements=string @@ -82,7 +82,7 @@ Parameters
string - / required
+ @@ -117,8 +117,7 @@ Parameters + @@ -150,8 +149,7 @@ Parameters + diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index 37d9a34e..c54f6361 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -39,22 +39,114 @@ Parameters aggregate
- - -
+ list + / elements=dictionary + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -177,8 +269,7 @@ Parameters + @@ -210,8 +301,7 @@ Parameters + @@ -239,7 +329,7 @@ Parameters state
- - + string
@@ -1318,7 +1318,7 @@ Parameters
list -
+ / elements=string @@ -1426,7 +1426,7 @@ Parameters
list -
+ / elements=string diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index 098a76d3..69bc4181 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -59,7 +59,7 @@ Parameters dest
- - + string / required
@@ -145,8 +145,7 @@ Parameters + @@ -178,8 +177,7 @@ Parameters + @@ -222,7 +220,7 @@ Parameters source
- - + string
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -177,8 +262,7 @@ Parameters + @@ -210,8 +294,7 @@ Parameters + diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index abe75657..acca3667 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -39,7 +39,7 @@ Parameters domain_name
- - + string
@@ -69,7 +69,7 @@ Parameters host_name
- - + string
@@ -121,7 +121,7 @@ Parameters
string - / required
+ @@ -156,8 +156,7 @@ Parameters + @@ -189,8 +188,7 @@ Parameters + @@ -218,7 +216,7 @@ Parameters state
- - + string
@@ -48,14 +48,120 @@ Parameters
The set of username objects to be configured on the remote VyOS device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.

aliases: users, collection
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -172,8 +278,7 @@ Parameters + @@ -205,8 +310,7 @@ Parameters + @@ -253,7 +357,7 @@ Parameters state
- - + string
+ + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -115,7 +232,7 @@ Parameters name
- - + string
@@ -186,8 +303,7 @@ Parameters + @@ -219,8 +335,7 @@ Parameters + @@ -267,7 +382,7 @@ Parameters state
- - + string
-- cgit v1.2.3
ParameterParameter Choices/Defaults Comments
+
aggregate
- - -
+ list + / elements=dictionary
+
delay
- - + integer
- Default:
10
-
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
+
description
- - + string
@@ -87,19 +88,20 @@ Parameters
+
duplex
- - + string
    Choices:
  • full
  • half
    • -
  • auto ←
    • +
  • auto
 @@ -107,7 +109,8 @@ Parameters
+
enabled @@ -126,12 +129,13 @@ Parameters
+
mtu
- - + integer
@@ -141,12 +145,13 @@ Parameters
+
name
- - + string / required
@@ -156,13 +161,14 @@ Parameters
+
neighbors
- - -
+ list + / elements=dictionary
host
- - + string
@@ -189,12 +196,13 @@ Parameters
port
- - + string
@@ -205,7 +213,195 @@ Parameters
+ +
+ speed + +
+ string +
+ 		+ +
Interface link speed.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ 		+
State of the Interface configuration, up means present and operationally up and down means present and operationally down
+
+
+ delay + +
+ integer +
+ 		+ Default:
10
+ 		+
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
+
+
+ description + +
+ string +
+ 		+ +
Description of Interface.
+
+
+ duplex + +
+ string +
+ 		+
    Choices: +
  • full
    • +
  • half
    • +
  • auto
    • +
+ 		+
Interface link status.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Interface link status.
+
+
+ mtu + +
+ integer +
+ 		+ +
Maximum size of transmit packet.
+
+
+ name + +
+ string +
+ 		+ +
Name of the Interface.
+
+
+ neighbors + +
+ list + / elements=dictionary
+ 		+ +
Check the operational state of given interface name for LLDP neighbor.
+
The following suboptions are available.
+
+
+ host + +
+ string +
+ 		+ +
LLDP neighbor host for given interface name.
+
+
+ port + +
+ string +
+ 		+ +
LLDP neighbor port to which given interface name is connected.
+
provider @@ -225,13 +421,13 @@ Parameters
+
host
string - / required
+
+
password @@ -257,7 +453,7 @@ Parameters
+
port @@ -266,15 +462,14 @@ Parameters 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
+
ssh_keyfile @@ -290,7 +485,7 @@ Parameters
+
timeout @@ -299,15 +494,14 @@ Parameters 		- Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
username @@ -323,12 +517,12 @@ Parameters
+
speed
- - + string
@@ -338,12 +532,12 @@ Parameters
+
state
- - + string
diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 4e35ea9b..67c71de7 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -41,7 +41,7 @@ Parameters
list -
+ / elements=dictionary
List of L3 interfaces definitions
+
+ ipv4 + +
+ string +
+ 		+ +
IPv4 of the L3 interface.
+
+
+ ipv6 + +
+ string +
+ 		+ +
IPv6 of the L3 interface.
+
+
+ name + +
+ string + / required
+ 		+ +
Name of the L3 interface.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
State of the L3 interface configuration.
+
ipv4
- - + string
@@ -76,7 +145,7 @@ Parameters ipv6
- - + string
@@ -91,7 +160,7 @@ Parameters name
- - + string
@@ -127,7 +196,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index 83a7094c..b09a846c 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -40,7 +40,7 @@ Parameters
list -
+ / elements=dictionary
List of link aggregation definitions.
+
+ members + +
+ list + / elements=string
+ 		+ +
List of members of the link aggregation group.
+
+
+ mode + +
+ string +
+ 		+
    Choices: +
  • 802.3ad
    • +
  • active-backup
    • +
  • broadcast
    • +
  • round-robin
    • +
  • transmit-load-balance
    • +
  • adaptive-load-balance
    • +
  • xor-hash
    • +
  • on
    • +
+ 		+
Mode of the link aggregation group.
+
+
+ name + +
+ string + / required
+ 		+ +
Name of the link aggregation group.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ 		+
State of the link aggregation group.
+
members
list -
+ / elements=string
    Choices: -
  • 802.3ad
    • +
  • 802.3ad ←
  • active-backup
  • broadcast
  • round-robin
  • transmit-load-balance
  • adaptive-load-balance
  • xor-hash
    • -
  • yes
    • +
  • on
 @@ -102,7 +183,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
    Choices: diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 187ad8fd..98d5c704 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -47,15 +47,54 @@ Parameters
    list -
    + / elements=dictionary
List of interfaces LLDP should be configured on.
+
+ name + +
+ string + / required
+ 		+ +
Name of the interface LLDP should be configured on.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
  • enabled
    • +
  • disabled
    • +
+ 		+
State of the LLDP configuration.
+
name @@ -97,7 +136,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 - Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
List of logging definitions.
+
+ dest + +
+ string +
+ 		+
    Choices: +
  • console
    • +
  • file
    • +
  • global
    • +
  • host
    • +
  • user
    • +
+ 		+
Destination of the logs.
+
+
+ facility + +
+ string +
+ 		+ +
Set logging facility.
+
+
+ level + +
+ string +
+ 		+ +
Set logging severity levels.
+
+
+ name + +
+ string +
+ 		+ +
If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
State of the logging configuration.
+
dest
- - + string
@@ -76,7 +168,7 @@ Parameters facility
- - + string
@@ -91,7 +183,7 @@ Parameters level
- - + string
@@ -106,7 +198,7 @@ Parameters name
- - + string
@@ -142,7 +234,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 796e421b..1d233051 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1302,7 +1302,7 @@ Parameters
list -
+ / elements=string 		@@ -110,7 +110,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 @@ -237,7 +235,7 @@ Parameters state
- - + string
diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 854cc7f5..848d5a0d 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -62,15 +62,100 @@ Parameters
list -
+ / elements=dictionary
List of static route definitions
+
+ admin_distance + +
+ integer +
+ 		+ +
Admin distance of the static route.
+
+
+ mask + +
+ string +
+ 		+ +
Network prefix mask of the static route.
+
+
+ next_hop + +
+ string +
+ 		+ +
Next hop IP of the static route.
+
+
+ prefix + +
+ string + / required
+ 		+ +
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
State of the static route configuration.
+
mask @@ -142,7 +227,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 @@ -54,8 +54,8 @@ Parameters domain_search
- - -
+ list + / elements=string 		@@ -81,17 +81,17 @@ Parameters
- name_servers + name_server
- - -
+ list + / elements=string
A list of name servers to use with the device. Mutually exclusive with domain_search
-

aliases: name_server
+

aliases: name_servers
- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 016208d1..30114480 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -39,8 +39,8 @@ Parameters aggregate
- - -
+ list + / elements=dictionary
+
+ configured_password + +
+ string +
+ 		+ +
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
+
+
+ full_name + +
+ string +
+ 		+ +
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
+
+
+ level + +
+ string +
+ 		+ +
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
+

aliases: role
+
+
+ name + +
+ string + / required
+ 		+ +
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+
+
+ update_password + +
+ string +
+ 		+
    Choices: +
  • on_create
    • +
  • always
    • +
+ 		+
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+
configured_password
- - + string
@@ -70,7 +176,7 @@ Parameters full_name
- - + string
@@ -85,7 +191,7 @@ Parameters level
- - + string
@@ -101,7 +207,7 @@ Parameters name
- - + string
@@ -137,7 +243,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 @@ -272,7 +376,7 @@ Parameters update_password
- - + string
diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index 3ec9d114..084649fb 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -39,7 +39,7 @@ Parameters address
- - + string
@@ -54,24 +54,141 @@ Parameters aggregate
- - -
+ list + / elements=dictionary
List of VLANs definitions.
+
+ address + +
+ string +
+ 		+ +
Configure Virtual interface address.
+
+
associated_interfaces
- - + list + / elements=string
+ 		+ +
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
+
+
+ delay + +
+ integer
+ +
Delay the play should wait to check for declarative intent params values.
+
+
+ interfaces + +
+ list + / elements=string / required
+ 		+ +
List of interfaces that should be associated to the VLAN.
+
+
+ name + +
+ string +
+ 		+ +
Name of the VLAN.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
State of the VLAN configuration.
+
+
+ vlan_id + +
+ integer + / required
+ 		+ +
ID of the VLAN. Range 0-4094.
+
+
+ associated_interfaces + +
+ list + / elements=string
+ 		@@ -84,7 +201,7 @@ Parameters delay
- - + integer
@@ -100,8 +217,8 @@ Parameters interfaces
- - - / required
+ list + / elements=string 		@@ -151,7 +268,7 @@ Parameters
string - / required
+ 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
 - Default:
10
-
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
 @@ -286,8 +401,8 @@ Parameters vlan_id
- - - / required
+ integer +