diff options
author | Sagar Paul <sagpaul@redhat.com> | 2021-08-04 10:08:22 +0530 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-04 04:38:22 +0000 |
commit | 83bc2db8cd723266eec243ca9330940a553e57a2 (patch) | |
tree | 0c5e4c96e98a153b51e6ce2c88b86778b07db453 | |
parent | d1ebc5a6e65eda8cb7c39625afdf0fb5918da5dd (diff) | |
download | vyos.vyos-83bc2db8cd723266eec243ca9330940a553e57a2.tar.gz vyos.vyos-83bc2db8cd723266eec243ca9330940a553e57a2.zip |
Docs fixed - wrong platform mentioned (#189)
Docs fixed - wrong platform mentioned
SUMMARY
updated docs corrected wrong platform mentioned
ISSUE TYPE
Docs Pull Request
COMPONENT NAME
bgp_address_family
ospf_interfaces
ADDITIONAL INFORMATION
Reviewed-by: GomathiselviS <None>
Reviewed-by: None <None>
-rw-r--r-- | changelogs/fragments/doc_updated_correct_platform.yaml | 3 | ||||
-rw-r--r-- | docs/vyos.vyos.vyos_bgp_address_family_module.rst | 2 | ||||
-rw-r--r-- | docs/vyos.vyos.vyos_ospf_interfaces_module.rst | 2 | ||||
-rw-r--r-- | plugins/modules/vyos_bgp_address_family.py | 2 | ||||
-rw-r--r-- | plugins/modules/vyos_ospf_interfaces.py | 4 |
5 files changed, 8 insertions, 5 deletions
diff --git a/changelogs/fragments/doc_updated_correct_platform.yaml b/changelogs/fragments/doc_updated_correct_platform.yaml new file mode 100644 index 0000000..d16f673 --- /dev/null +++ b/changelogs/fragments/doc_updated_correct_platform.yaml @@ -0,0 +1,3 @@ +--- +trivial: + - Documentation update with correct platform name. diff --git a/docs/vyos.vyos.vyos_bgp_address_family_module.rst b/docs/vyos.vyos.vyos_bgp_address_family_module.rst index 0c463d0..a213ff0 100644 --- a/docs/vyos.vyos.vyos_bgp_address_family_module.rst +++ b/docs/vyos.vyos.vyos_bgp_address_family_module.rst @@ -1132,7 +1132,7 @@ Parameters </td> <td> <div>This option is used only with state <em>parsed</em>.</div> - <div>The value of this option should be the output received from the IOS device by executing the command <b>show configuration command | match bgp</b>.</div> + <div>The value of this option should be the output received from the VYOS device by executing the command <b>show configuration command | match bgp</b>.</div> <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> </td> </tr> diff --git a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst index 0417088..c2c5db6 100644 --- a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst @@ -424,7 +424,7 @@ Parameters </td> <td> <div>This option is used only with state <em>parsed</em>.</div> - <div>The value of this option should be the output received from the IOS device by executing the command <b>sh running-config | section ^interface</b>.</div> + <div>The value of this option should be the output received from the VYOS device by executing the command <b>show configuration commands | match "set interfaces"</b>.</div> <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> </td> </tr> diff --git a/plugins/modules/vyos_bgp_address_family.py b/plugins/modules/vyos_bgp_address_family.py index 782669f..ab98e3b 100644 --- a/plugins/modules/vyos_bgp_address_family.py +++ b/plugins/modules/vyos_bgp_address_family.py @@ -238,7 +238,7 @@ options: type: str description: - This option is used only with state I(parsed). - - The value of this option should be the output received from the IOS device by + - The value of this option should be the output received from the VYOS device by executing the command B(show configuration command | match bgp). - The state I(parsed) reads the configuration from C(running_config) option and transforms it into Ansible structured data as per the resource module's argspec diff --git a/plugins/modules/vyos_ospf_interfaces.py b/plugins/modules/vyos_ospf_interfaces.py index 732a5e7..61ef32e 100644 --- a/plugins/modules/vyos_ospf_interfaces.py +++ b/plugins/modules/vyos_ospf_interfaces.py @@ -132,8 +132,8 @@ options: running_config: description: - This option is used only with state I(parsed). - - The value of this option should be the output received from the IOS device by - executing the command B(sh running-config | section ^interface). + - The value of this option should be the output received from the VYOS device by + executing the command B(show configuration commands | match "set interfaces"). - The state I(parsed) reads the configuration from C(running_config) option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the I(parsed) key within the result. |