diff options
Diffstat (limited to 'ansible_collections/arista/eos/docs/arista.eos.eos_cliconf.rst')
-rw-r--r-- | ansible_collections/arista/eos/docs/arista.eos.eos_cliconf.rst | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/ansible_collections/arista/eos/docs/arista.eos.eos_cliconf.rst b/ansible_collections/arista/eos/docs/arista.eos.eos_cliconf.rst new file mode 100644 index 000000000..c7ddd270d --- /dev/null +++ b/ansible_collections/arista/eos/docs/arista.eos.eos_cliconf.rst @@ -0,0 +1,100 @@ +.. _arista.eos.eos_cliconf: + + +************** +arista.eos.eos +************** + +**Use eos cliconf to run command on Arista EOS platform** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This eos plugin provides low level abstraction apis for sending and receiving CLI commands from Arista EOS network devices. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th>Configuration</th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>config_commands</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> + </div> + <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.0.0</div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">[]</div> + </td> + <td> + <div>var: ansible_eos_config_commands</div> + </td> + <td> + <div>Specifies a list of commands that can make configuration changes to the target device.</div> + <div>When `ansible_network_single_user_mode` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>eos_use_sessions</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">boolean</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">"yes"</div> + </td> + <td> + <div>env:ANSIBLE_EOS_USE_SESSIONS</div> + <div>var: ansible_eos_use_sessions</div> + </td> + <td> + <div>Specifies if sessions should be used on remote host or not</div> + </td> + </tr> + </table> + <br/> + + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- Ansible Networking Team (@ansible-network) + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. |