mirror.MikroTik/ansible-collections.community.routeros
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.routeros.git synced 2025-07-04 23:34:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
ansible-collections.communi.../branch/main/routeros_cliconf.html

215 lines
13 KiB
HTML
Raw Normal View History

deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<!DOCTYPE html>
deploy: dac3b79a17e35d1e89b1429f73a83d446dc5fe74
2023-11-28 05:20:48 +00:00
<html class="writer-html5" lang="en" data-content_root="./">
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<head>
deploy: 3d737d679d6ce99888fb9085720a3f935903a118
2024-03-13 05:21:13 +00:00
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
deploy: 3862d1cea7cadd3a4a862e64f9b94bde59d29a17
2024-05-07 05:21:54 +00:00
<meta content="2.11.0" name="antsibull-docs" />
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
deploy: 8e3b19759d436f0bece8a7e52bc82ada25d0ac4e
2022-12-18 21:18:26 +00:00
<title>community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform &mdash; Community.Routeros Collection documentation</title>
deploy: dac3b79a17e35d1e89b1429f73a83d446dc5fe74
2023-11-28 05:20:48 +00:00
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
deploy: ac89aa0ab7f37f498dbc5a811e59504cab42c5e2
2023-12-08 05:20:47 +00:00
<link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=c5b67dd2" />
deploy: dac3b79a17e35d1e89b1429f73a83d446dc5fe74
2023-11-28 05:20:48 +00:00
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb
2023-08-21 20:13:03 +00:00
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=7f41d439"></script>
deploy: 8351bff0e9793d9c7d6c78ee6cdf64e7667c5de5
2024-04-17 05:20:22 +00:00
<script src="_static/doctools.js?v=9a2dae69"></script>
deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb
2023-08-21 20:13:03 +00:00
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="community.routeros.join filter – Join a list of arguments to a command" href="join_filter.html" />
deploy: d37ec11ac507f545fefda3380c69080b8ac7a569
2022-12-17 19:14:16 +00:00
<link rel="prev" title="community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS" href="facts_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</head>
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
<div class="DocSite-globalNav ansibleNav">
<ul>
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
deploy: ac89aa0ab7f37f498dbc5a811e59504cab42c5e2
2023-12-08 05:20:47 +00:00
<li><a href="https://forum.ansible.com/" target="_blank">Ansible community forum</a></li>
<li><a href="https://docs.ansible.com/" target="_blank">Documentation</a></li>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</ul>
</div>
deploy: 8e3b19759d436f0bece8a7e52bc82ada25d0ac4e
2022-12-18 21:18:26 +00:00
<a class="DocSite-nav" href="https://ansible-collections.github.io/community.routeros/branch/main/" style="padding-bottom: 30px;">
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<img class="DocSiteNav-logo"
src="_static/images/Ansible-Mark-RGB_White.png"
alt="Ansible Logo">
deploy: 8e3b19759d436f0bece8a7e52bc82ada25d0ac4e
2022-12-18 21:18:26 +00:00
<div class="DocSiteNav-title">Community.Routeros Collection Docs</div>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</a>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
deploy: 622680fe3f35c052f1d92c497bfc2f45de15eb52
2023-02-08 05:27:47 +00:00
<a href="index.html" class="icon icon-home">
Community.Routeros Collection
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
<div class="version">
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<label class="sr-only" for="q">Search docs:</label>
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
deploy: c6be3918ec9f3cb6229e42c9721170a1a05991eb
2024-04-18 10:40:32 +00:00
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Community.Routeros Release Notes</a></li>
</ul>
<ul>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<li class="toctree-l1"><a class="reference internal" href="docsite/api-guide.html">How to connect to RouterOS devices with the RouterOS API</a></li>
<li class="toctree-l1"><a class="reference internal" href="docsite/ssh-guide.html">How to connect to RouterOS devices with SSH</a></li>
<li class="toctree-l1"><a class="reference internal" href="docsite/quoting.html">How to quote and unquote commands and arguments</a></li>
</ul>
deploy: d37ec11ac507f545fefda3380c69080b8ac7a569
2022-12-17 19:14:16 +00:00
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_module.html">community.routeros.api module – Ansible module for RouterOS API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_facts_module.html">community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_find_and_modify_module.html">community.routeros.api_find_and_modify module – Find and modify information using the API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_info_module.html">community.routeros.api_info module – Retrieve information from API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_modify_module.html">community.routeros.api_modify module – Modify data at paths with API</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_module.html">community.routeros.command module – Run commands on remote devices running MikroTik RouterOS</a></li>
<li class="toctree-l1"><a class="reference internal" href="facts_module.html">community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS</a></li>
</ul>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a></li>
<li class="toctree-l3"><a class="reference internal" href="#collection-links">Collection links</a></li>
</ul>
</li>
</ul>
</li>
deploy: d37ec11ac507f545fefda3380c69080b8ac7a569
2022-12-17 19:14:16 +00:00
</ul>
<ul>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<li class="toctree-l1"><a class="reference internal" href="join_filter.html">community.routeros.join filter – Join a list of arguments to a command</a></li>
<li class="toctree-l1"><a class="reference internal" href="list_to_dict_filter.html">community.routeros.list_to_dict filter – Convert a list of arguments to a dictionary</a></li>
<li class="toctree-l1"><a class="reference internal" href="quote_argument_filter.html">community.routeros.quote_argument filter – Quote an argument</a></li>
<li class="toctree-l1"><a class="reference internal" href="quote_argument_value_filter.html">community.routeros.quote_argument_value filter – Quote an argument value</a></li>
<li class="toctree-l1"><a class="reference internal" href="split_filter.html">community.routeros.split filter – Split a command into arguments</a></li>
</ul>
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
deploy: 8e3b19759d436f0bece8a7e52bc82ada25d0ac4e
2022-12-18 21:18:26 +00:00
<a href="index.html">Community.Routeros Collection</a>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
deploy: 622680fe3f35c052f1d92c497bfc2f45de15eb52
2023-02-08 05:27:47 +00:00
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<li class="breadcrumb-item active">community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/ansible-collections/community.routeros/edit/main/plugins/cliconf/routeros.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="ansible-collections-community-routeros-routeros-cliconf"></span><section id="community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform">
deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb
2023-08-21 20:13:03 +00:00
<h1>community.routeros.routeros cliconf – Use routeros cliconf to run command on MikroTik RouterOS platform<a class="headerlink" href="#community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform" title="Link to this heading"></a></h1>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<div class="admonition note">
<p class="admonition-title">Note</p>
deploy: f5e8213498e31696a2336cba661890a3b597c314
2024-05-18 14:47:21 +00:00
<p>This cliconf plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/routeros/">community.routeros collection</a> (version 2.16.0).</p>
deploy: dc110500db0824ef73995ca29164497760f6b78a
2023-09-28 05:31:43 +00:00
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.routeros</span></code>.</p>
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.routeros.routeros</span></code>.</p>
</div>
deploy: 622680fe3f35c052f1d92c497bfc2f45de15eb52
2023-02-08 05:27:47 +00:00
<nav class="contents local" id="contents">
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<ul class="simple">
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
</ul>
deploy: 622680fe3f35c052f1d92c497bfc2f45de15eb52
2023-02-08 05:27:47 +00:00
</nav>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<section id="synopsis">
deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb
2023-08-21 20:13:03 +00:00
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<ul class="simple">
<li><p>This routeros plugin provides low level abstraction apis for sending and receiving CLI commands from MikroTik RouterOS network devices.</p></li>
</ul>
<section id="authors">
deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb
2023-08-21 20:13:03 +00:00
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<ul class="simple">
<li><p>Egor Zaitsev (&#64;heuels)</p></li>
</ul>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>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.</p>
</div>
</section>
<section id="collection-links">
deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb
2023-08-21 20:13:03 +00:00
<h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
deploy: dc110500db0824ef73995ca29164497760f6b78a
2023-09-28 05:31:43 +00:00
<ul class="ansible-links">
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.routeros/issues" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.routeros" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.routeros/issues/new?assignees=&amp;labels=&amp;template=bug_report.md" rel="noopener external" target="_blank">Submit a bug report</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.routeros/issues/new?assignees=&amp;labels=&amp;template=feature_request.md" rel="noopener external" target="_blank">Request a feature</a></span></li>
<li><span><a class="reference internal" href="index.html#communication-for-community-routeros"><span class="std std-ref">Communication</span></a></span></li>
</ul>
</section>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
deploy: d37ec11ac507f545fefda3380c69080b8ac7a569
2022-12-17 19:14:16 +00:00
<a href="facts_module.html" class="btn btn-neutral float-left" title="community.routeros.facts module – Collect facts from remote devices running MikroTik RouterOS" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
<a href="join_filter.html" class="btn btn-neutral float-right" title="community.routeros.join filter – Join a list of arguments to a command" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
deploy: 8e3b19759d436f0bece8a7e52bc82ada25d0ac4e
2022-12-18 21:18:26 +00:00
<p>&#169; Copyright Community.Routeros Contributors.</p>
deploy: 0f5ac3f061d60648ba582f7257ad5492cfd30664
2022-11-26 09:11:24 +00:00
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
</body>
</html>
Reference in a new issue Copy permalink