Commit Graph

101 Commits

Author SHA1 Message Date
4d398ca3a4 docs - Use code-block to format examples in Network Guide (#75850)
Fixes #75676
2021-10-04 10:29:14 -07:00
747789787b added a caveat to say check individual module documentation for compatibility (#75582) 2021-08-27 20:33:31 +05:30
1dc495405f Added missing colon in note (#75465)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-08-20 11:49:28 -04:00
d016499dcd Update network user guide to point to ansible.utils.cli_parse module and add docs for validate plugin (#75104)
* Update network user guide to point to ansible.utils.cli_parse module as ansible.netcommon.cli_parse is deprecated from ansible.netcommon 2.0.0 release
2021-07-21 10:04:45 -04:00
9af0d91676 fix option name for parsed (#75229) 2021-07-14 18:38:26 +05:30
ea0ba7bf30 update terminology based on recent IBM Style Guide word list (#75089) 2021-06-23 15:52:38 -05:00
91212b2008 Add JC filter plugin example (#74563)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-14 11:37:29 -04:00
dcb807dea7 Update cli_parsing.rst (#74555)
Bad indent in an example
2021-05-06 09:34:07 +05:30
7ca5dede97 Add weos4 network platform to documentation (#74088)
* Add weos4 network platform to documentation

* Fix small format issues
2021-04-23 23:52:14 +02:00
fa05af8321 Fixing ad-hoc commands #73636 (#73646) 2021-02-18 16:48:22 -06:00
fce22529c4 fix typo (#73434) 2021-02-03 09:17:02 -06:00
45240c1871 Update NX-OS platform guide with MDS information (#73315)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2021-01-21 12:03:50 -05:00
a5eb788578 Minor Edit: Fix typo in platform_index.rst (#72564)
Fix Dell OS 10 dellemc.os10.0s10 to dellemc.os10.os10 in platform_index.rst
2020-11-10 16:22:07 -06:00
0e5911d650 add cli parser documentation (#71497)
* with native network example, linux example
2020-09-22 11:54:24 -05:00
7bfeed3e24 Docsite: replace Latin phrases to English (#71588)
Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases. 

* Update docs/docsite/rst/community/committer_guidelines.rst
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
* Update docs/docsite/rst/dev_guide/module_lifecycle.rst
* Update docs/docsite/rst/user_guide/intro_inventory.rst
* Update docs/docsite/rst/user_guide/playbooks_loops.rst
* Update docs/docsite/rst/user_guide/playbooks_reuse.rst
* Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
* Update docs/docsite/rst/dev_guide/testing.rst
* Update docs/docsite/rst/dev_guide/testing_integration.rst
* Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst
* Update docs/docsite/rst/reference_appendices/faq.rst
2020-09-03 14:47:57 -05:00
b6f10b9b52 update Network Advanced Topics for FQCN (#71325)
* update Network Advanced Topics for FQCN
2020-08-26 12:33:59 -05:00
a1257d75aa network: Correct documentation (#71246)
ini-style inventory does not support Ansible Vault password.
This fixes network_best_practices_2.5 doc.
Fixes: #69039

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-18 15:34:25 -05:00
f79a7c5585 Update Network Getting Started for FQCN/collection world (#71188)
* pull out network roles, cleanup, update first playbook examples, update gather facts section, some inventory conversion to .yml, update inventory and roles, simplify the navigation titles, fix tocs, feedback comments
2020-08-18 14:14:32 -05:00
172230d7b8 update Ansible-maintained platform guides with FQCN (#70369)
* update platform guides with FQCN
* implemented feedback
* fix remainin fqcn
* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-08-10 15:09:35 -05:00
f4388de14d add another resource module example (#71162)
* Update docs/docsite/rst/network/user_guide/network_resource_modules.rst
Co-authored-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
2020-08-10 11:18:43 -05:00
79f7104556 Update platform_index.rst (#70927) 2020-08-04 14:31:37 -04:00
54bee7152b Update network platform guides with FQCN (#70699)
* fqcn all the docs things!
2020-07-31 15:57:57 -05:00
69e5c6c14a Update network_best_practices_2.5.rst (#70962)
Fix a small typo in the playbook tasks sample section
2020-07-29 11:41:18 +05:30
db354c0300 Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
aa59c23aed update platform table with links to collections (#70373) 2020-07-02 10:20:11 -05:00
5a7f2f9d5d Add platform guide for FRR (#69773)
* Add platform guide for FRR

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Add entry in index

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2020-06-09 10:22:30 +05:30
887263c315 fix indents of EOS Platform Options (#67564) 2020-02-19 13:26:49 -05:00
7ef7c1b5d7 add note on write access to socket_path (#67060)
* Change socket_path error messages to not directly refer to socket_path
* Apply suggestions from code review

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
2020-02-11 09:49:20 -06:00
68ab8c23be Network prompts (#66584)
* add network prompt examples and module examples

* Update docs/docsite/rst/network/user_guide/network_working_with_command_output.rst

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
2020-01-23 18:02:16 -06:00
2ad6055efd Document network resource modules (#66226)
* add network resource module details to docs

(cherry picked from commit 3e35d2d63ce17fb694e645785ad855f01420f7d8)

* network resource module page, with example output
2020-01-10 14:12:26 -06:00
41472ee387 Describe different ways to set connection timeout options (#65126)
* add timeout option examples, link to new section, implement feedback
2019-12-02 10:42:45 -06:00
b2fc12a29f clean up network toc (#65264) 2019-11-25 15:17:49 -06:00
f3575c5025 docs: add solution to timeout errors to docs (#65140) 2019-11-21 15:05:07 -05:00
09aebf33e4 Add doc to ce for user guide. (#63982) 2019-11-19 09:45:07 -05:00
b33ae14949 doc: fix typos (#62852) 2019-09-26 10:18:29 -04:00
6952295114 explicited RouterOS does not support connection: local (#62203) 2019-09-12 13:45:28 -04:00
54906a68fe Docs - Add Meraki to platform option list (#61651) 2019-09-03 11:04:39 -04:00
d3d9c5c273 Fix doc for network_cli connection retry timer (#61509) 2019-08-29 10:24:43 -04:00
768dbe5490 Add support for network_cli connection retry (#61103)
* Add support for network_cli connection retry

*  Add network_cli connection configuration option
   to allow retrying the connection initialization
   with remote host.

* Add docs

* Fix test failures

* Fix review comments
2019-08-28 09:46:42 +05:30
11ba2a965d platform guide updates (#61121)
* platform guide updates

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2019-08-23 20:23:50 +05:30
d06930d6f6 Add iosxr platform guide (#60936)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2019-08-22 14:05:15 -04:00
c1547f10d6 Fix table headers and width (#60549) 2019-08-21 16:55:16 -04:00
49736b6b27 Add support to configure network_cli terminal related options (#60086)
* Add support for configurable terminal plugin options

Fixes #59404

*  Add terminal options to support platform specific login menu
*  Add terminal options to support configurable options for stdout
   and stderr regex list

* Fix CI failures

* Fix CI issues

* Fix review comments and add integration test

* Fix sanity test failures

* Fix review comments

* Fix integration test case

* Fix integration test failure

* Add support to configure terminal related options

Fixes https://github.com/ansible/ansible/issues/59404

*  Add network_cli configurable options to support platform specific login menu
*  Add network_cli configurable options to support configurable options for stdout
   and stderr regex list

* Fix review comment

* Fix review comment
2019-08-19 18:56:20 +05:30
3f784caed1 Table fixing (#60177)
* Change formatting of the network/user_guide tables

* Tables had hardcoded line breaks to workaround a bug in the
  read-the-docs theme.  Change those so that they now flow according to
  the browser size.

* Also switch away from grid tables to the simpler to create and read
  simple tables

* Changes to table stylesheet

* valign all content, not just the first column.  This becomes important
  with more than two columns
* Set the font-weight to the first <p> element inside of the first
  column.  This allows us to simplify the first column when everything
  there is the attribute name

* Change platform_index footnote from numbered to dagger symbol

The footnote notation was very odd to read.  Try using a symbol for the
footnote instead of a number to see if that will clarify it.  We can't
manually specify symbolled footnotes, though, so we have to emulate a
footnote with an internal link.  This loses the backref to each place
that the footnote was used but since that was the portion which was hard
to read, perhaps that's for the best.
2019-08-13 18:23:32 -05:00
eea46a0d1b Support Ericsson device management (#59277)
* Support Ericsson device management

* modify code

* modify error

* delete redundant file

* delete file

* modified error

* modify additional file name

* delete code

* add blank line

* delete redundant code

* add platform_eric_eccli.rst

* modify syntaxError

* modify document

* modify error

* modify maintaners

* modify document

* add end_string
2019-08-01 16:55:10 +05:30
f2cb44633a Modules to manage ICX devices (#58969)
* new module

* new terminal

* new terminal

* new cliconf

* cliconf

* icx cliconf

* icx_cliconf

* icx test units module

* icx units module

* icx banner unit test

* PR changes resolved

* changes resolved

* Changes Resolved

* check_running_config changes resolved

* added notes

* removed icx rst

* new commit

* new changes

* deleted icx rst

* icx .rst

* modified platform_index.rst

* modified platform_index.rst

* changes resolved

* PR comments resolved

* Update platform_index.rst

PR comment resolved
2019-07-31 20:01:41 +05:30
8d1b82a26e Typo in the Warning block eneabled -> enabled (#59524)
* Typo in the Warning block eneabled -> enabled
2019-07-24 11:59:13 -04:00
43872d6b88 Fix netconf guess_network_os to use ssh_config if supplied. (#55199)
* feature: use network_os=auto to trigger network os guessing

* doc: add debug messages

* fix linting

* fix test_netconf_init default network_os is auto

* add documentation

* fix rst errors

* use init lexer

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update lib/ansible/plugins/connection/netconf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update lib/ansible/plugins/connection/netconf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update lib/ansible/plugins/connection/netconf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-06-21 09:04:13 +05:30
7a1e2ef746 Clarify platform EOS and NXOS table settings (#55096) 2019-04-11 10:32:50 -05:00
c0e7b643bf Fixed typo of Ethernet interface number (#54877)
Fixed typo of Ethernet interface number in second wait_for argument

+label: docsite_pr
2019-04-05 10:42:01 -04:00