1.. _vyos.vyos.vyos_cliconf: 2 3 4************** 5vyos.vyos.vyos 6************** 7 8**Use vyos cliconf to run command on VyOS platform** 9 10 11Version added: 1.0.0 12 13.. contents:: 14 :local: 15 :depth: 1 16 17 18Synopsis 19-------- 20- This vyos plugin provides low level abstraction apis for sending and receiving CLI commands from VyOS network devices. 21 22 23 24 25Parameters 26---------- 27 28.. raw:: html 29 30 <table border=0 cellpadding=0 class="documentation-table"> 31 <tr> 32 <th colspan="1">Parameter</th> 33 <th>Choices/<font color="blue">Defaults</font></th> 34 <th>Configuration</th> 35 <th width="100%">Comments</th> 36 </tr> 37 <tr> 38 <td colspan="1"> 39 <div class="ansibleOptionAnchor" id="parameter-"></div> 40 <b>config_commands</b> 41 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 42 <div style="font-size: small"> 43 <span style="color: purple">list</span> 44 </div> 45 <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.0.0</div> 46 </td> 47 <td> 48 <b>Default:</b><br/><div style="color: blue">[]</div> 49 </td> 50 <td> 51 <div>var: ansible_vyos_config_commands</div> 52 </td> 53 <td> 54 <div>Specifies a list of commands that can make configuration changes to the target device.</div> 55 <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> 56 </td> 57 </tr> 58 </table> 59 <br/> 60 61 62 63 64 65 66 67 68Status 69------ 70 71 72Authors 73~~~~~~~ 74 75- Ansible Networking Team 76 77 78.. hint:: 79 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. 80