ansible-collections.community.routeros/branch/main/searchindex.js

Search.setIndex({"alltitles": {"Attributes": [[0, "attributes"], [1, "attributes"], [2, "attributes"], [3, "attributes"], [4, "attributes"], [5, "attributes"], [10, "attributes"]], "Authors": [[0, "authors"], [1, "authors"], [2, "authors"], [3, "authors"], [4, "authors"], [5, "authors"], [10, "authors"], [12, "authors"], [13, "authors"], [14, "authors"], [15, "authors"], [16, "authors"], [17, "authors"]], "Cliconf Plugins": [[11, "cliconf-plugins"]], "Collection links": [[0, "collection-links"], [1, "collection-links"], [2, "collection-links"], [3, "collection-links"], [4, "collection-links"], [5, "collection-links"], [10, "collection-links"], [12, "collection-links"], [13, "collection-links"], [14, "collection-links"], [15, "collection-links"], [16, "collection-links"], [17, "collection-links"]], "Communication": [[11, "communication"]], "Community.Routeros": [[11, "community-routeros"]], "Connecting to the device": [[8, "connecting-to-the-device"]], "Description": [[11, "description"]], "Examples": [[0, "examples"], [1, "examples"], [2, "examples"], [3, "examples"], [4, "examples"], [5, "examples"], [10, "examples"], [12, "examples"], [13, "examples"], [14, "examples"], [15, "examples"], [17, "examples"]], "Filter Plugins": [[11, "filter-plugins"]], "Guides": [[11, "guides"]], "How to connect to RouterOS devices with SSH": [[8, "how-to-connect-to-routeros-devices-with-ssh"]], "How to connect to RouterOS devices with the RouterOS API": [[6, "how-to-connect-to-routeros-devices-with-the-routeros-api"]], "How to quote and unquote commands and arguments": [[7, "how-to-quote-and-unquote-commands-and-arguments"]], "Important notes": [[8, "important-notes"]], "Index of all Collection Environment Variables": [[9, "index-of-all-collection-environment-variables"]], "Input": [[12, "input"], [13, "input"], [14, "input"], [15, "input"], [17, "input"]], "Installing a certificate on a MikroTik router": [[6, "installing-a-certificate-on-a-mikrotik-router"]], "Keyword parameters": [[13, "keyword-parameters"]], "Modules": [[11, "modules"]], "Notes": [[1, "notes"], [3, "notes"], [4, "notes"], [5, "notes"]], "Parameters": [[0, "parameters"], [1, "parameters"], [2, "parameters"], [3, "parameters"], [4, "parameters"], [5, "parameters"], [10, "parameters"]], "Plugin Index": [[11, "plugin-index"]], "Requirements": [[0, "requirements"], [1, "requirements"], [2, "requirements"], [3, "requirements"], [4, "requirements"]], "Return Value": [[12, "return-value"], [13, "return-value"], [14, "return-value"], [15, "return-value"], [17, "return-value"]], "Return Values": [[1, "return-values"], [2, "return-values"], [3, "return-values"], [4, "return-values"], [5, "return-values"]], "Returned Facts": [[0, "returned-facts"], [10, "returned-facts"]], "See Also": [[0, "see-also"], [1, "see-also"], [2, "see-also"], [3, "see-also"], [4, "see-also"], [5, "see-also"], [10, "see-also"]], "Setting up a PKI": [[6, "setting-up-a-pki"]], "Setting up an inventory": [[8, "setting-up-an-inventory"]], "Setting up encryption": [[6, "setting-up-encryption"]], "Synopsis": [[0, "synopsis"], [1, "synopsis"], [2, "synopsis"], [3, "synopsis"], [4, "synopsis"], [5, "synopsis"], [10, "synopsis"], [12, "synopsis"], [13, "synopsis"], [14, "synopsis"], [15, "synopsis"], [16, "synopsis"], [17, "synopsis"]], "Using the community.routeros.api module defaults group": [[6, "using-the-community-routeros-api-module-defaults-group"]], "community.routeros.api module \u2013 Ansible module for RouterOS API": [[4, "community-routeros-api-module-ansible-module-for-routeros-api"]], "community.routeros.api_facts module \u2013 Collect facts from remote devices running MikroTik RouterOS using the API": [[0, "community-routeros-api-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros-using-the-api"]], "community.routeros.api_find_and_modify module \u2013 Find and modify information using the API": [[1, "community-routeros-api-find-and-modify-module-find-and-modify-information-using-the-api"]], "community.routeros.api_info module \u2013 Retrieve information from API": [[2, "community-routeros-api-info-module-retrieve-information-from-api"]], "community.routeros.api_modify module \u2013 Modify data at paths with API": [[3, "community-routeros-api-modify-module-modify-data-at-paths-with-api"]], "community.routeros.command module \u2013 Run commands on remote devices running MikroTik RouterOS": [[5, "community-routeros-command-module-run-commands-on-remote-devices-running-mikrotik-routeros"]], "community.routeros.facts module \u2013 Collect facts from remote devices running MikroTik RouterOS": [[10, "community-routeros-facts-module-collect-facts-from-remote-devices-running-mikrotik-routeros"]], "community.routeros.join filter \u2013 Join a list of arguments to a command": [[12, "community-routeros-join-filter-join-a-list-of-arguments-to-a-command"]], "community.routeros.list_to_dict filter \u2013 Convert a list of arguments to a dictionary": [[13, "community-routeros-list-to-dict-filter-convert-a-list-of-arguments-to-a-dictionary"]], "community.routeros.quote_argument filter \u2013 Quote an argument": [[14, "community-routeros-quote-argument-filter-quote-an-argument"]], "community.routeros.quote_argument_value filter \u2013 Quote an argument value": [[15, "community-routeros-quote-argument-value-filter-quote-an-argument-value"]], "community.routeros.routeros cliconf \u2013 Use routeros cliconf to run command on MikroTik RouterOS platform": [[16, "community-routeros-routeros-cliconf-use-routeros-cliconf-to-run-command-on-mikrotik-routeros-platform"]], "community.routeros.split filter \u2013 Split a command into arguments": [[17, "community-routeros-split-filter-split-a-command-into-arguments"]]}, "docnames": ["api_facts_module", "api_find_and_modify_module", "api_info_module", "api_modify_module", "api_module", "command_module", "docsite/api-guide", "docsite/quoting", "docsite/ssh-guide", "environment_variables", "facts_module", "index", "join_filter", "list_to_dict_filter", "quote_argument_filter", "quote_argument_value_filter", "routeros_cliconf", "split_filter"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api_facts_module.rst", "api_find_and_modify_module.rst", "api_info_module.rst", "api_modify_module.rst", "api_module.rst", "command_module.rst", "docsite/api-guide.rst", "docsite/quoting.rst", "docsite/ssh-guide.rst", "environment_variables.rst", "facts_module.rst", "index.rst", "join_filter.rst", "list_to_dict_filter.rst", "quote_argument_filter.rst", "quote_argument_value_filter.rst", "routeros_cliconf.rst", "split_filter.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [6, 8, 10, 15], "0": [0, 1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17], "0123456789abcdefghijklmnopqrstuvwxyz": 6, "03": 4, "06": 8, "0600": 6, "09": 8, "0mib": 8, "1": [0, 1, 2, 3, 4, 5, 6, 8, 10], "10": [0, 1, 2, 3, 4, 5, 11], "12": 6, "128": 8, "14": 4, "1400": 4, "15": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "168": [0, 1, 2, 3, 4, 6, 8], "19": 8, "192": [0, 1, 2, 3, 4, 6, 8], "2": [0, 1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17], "20": 4, "2021": 8, "24": [1, 2, 3, 4, 6], "24kc": 8, "25": 8, "255": 4, "2mib": 8, "3": [0, 1, 2, 3, 4, 5, 8], "31": 8, "32": [4, 6], "36": 4, "3d10h28m51": 8, "4": [0, 1, 2, 3, 4, 8], "400mhz": 8, "45": 8, "48": 8, "5": 4, "512": 8, "51572981": 8, "54": 8, "6": [0, 1, 2, 3, 4, 8], "64": 8, "8": [0, 1, 2, 3, 4], "8728": [0, 1, 2, 3, 4], "8729": [0, 1, 2, 3, 4], "88": [0, 1, 2, 3], "9": 11, "927": 8, "A": [0, 1, 2, 3, 4, 10, 12, 13, 17], "As": 0, "By": 2, "For": [3, 4, 12, 13, 14, 15, 16, 17], "If": [0, 1, 2, 3, 4, 5, 6, 8], "In": 4, "It": [0, 1, 2, 3, 4, 5, 6, 7, 10, 12, 13, 14, 15, 16, 17], "No": [6, 9], "On": 1, "That": 6, "The": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 17], "These": [11, 13], "To": [0, 1, 2, 3, 4, 5, 6, 10, 12, 13, 14, 15, 16, 17], "Will": [0, 1, 2, 3, 4, 5, 10], "With": 8, "aaa": [2, 3], "abl": [0, 1, 2, 3, 4, 6], "about": [0, 1, 2, 3, 4, 8], "abov": 8, "abstract": 16, "accept": [2, 3, 7, 13], "access": [2, 3, 6], "account": [2, 3], "achiev": 10, "action": [0, 1, 2, 3, 4, 5, 10], "action_group": [0, 1, 2, 3, 4], "activ": 10, "actual": [1, 2, 3, 5], "ad": [0, 1, 2, 3, 4, 8, 10], "add": [4, 6, 8], "addit": [0, 10], "address": [0, 1, 2, 3, 4, 6, 7, 8, 10], "adh": [0, 1, 2, 3, 4], "adjust": 3, "admin": [0, 3, 6, 8], "admin_network": 6, "advanc": [2, 3], "advertis": [2, 3], "after": [1, 3, 4], "again": 5, "against": [0, 1, 2, 3, 4, 5, 10], "aip": 4, "alias": [0, 1, 2, 3, 4], "align": [2, 3], "all": [0, 1, 2, 3, 4, 5, 6, 10], "allow": [1, 2, 3, 4, 6, 7, 8, 13], "allow_no_match": 1, "alphanumer": 8, "also": [6, 8], "altern": [6, 8], "alwai": [0, 2, 3, 4, 5, 6, 10], "always_upd": 3, "an": [0, 1, 2, 3, 4, 5, 6, 7, 10, 11], "ani": [0, 4, 5, 6, 10], "anonym": [0, 1, 2, 3, 4], "ansibl": [0, 1, 2, 3, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "ansible_connect": 8, "ansible_fact": [0, 10], "ansible_host": 8, "ansible_net_": [0, 10], "ansible_net_all_ipv4_address": [0, 8, 10], "ansible_net_all_ipv6_address": [0, 10], "ansible_net_arch": [0, 10], "ansible_net_bgp_inst": [0, 10], "ansible_net_bgp_p": [0, 10], "ansible_net_bgp_vpnv4_rout": [0, 10], "ansible_net_config": 10, "ansible_net_config_nonverbos": 10, "ansible_net_cpu_load": [0, 10], "ansible_net_gather_subset": [0, 10], "ansible_net_hostnam": [0, 10], "ansible_net_interfac": [0, 10], "ansible_net_memfree_mb": [0, 10], "ansible_net_memtotal_mb": [0, 10], "ansible_net_model": [0, 10], "ansible_net_neighbor": [0, 10], "ansible_net_ospf_inst": [0, 10], "ansible_net_ospf_neighbor": [0, 10], "ansible_net_rout": [0, 10], "ansible_net_serialnum": [0, 10], "ansible_net_spacefree_mb": [0, 10], "ansible_net_spacetotal_mb": [0, 10], "ansible_net_uptim": [0, 10], "ansible_net_vers": [0, 10], "ansible_network_o": 8, "ansible_ssh_pass": 8, "ansible_us": 8, "anyth": 1, "apart": 5, "api": [7, 11, 16], "api_fact": [1, 2, 3, 4, 6, 11], "api_find_and_modifi": [0, 2, 3, 4, 6, 11], "api_info": [0, 1, 3, 4, 6, 11], "api_modifi": [0, 1, 2, 4, 6, 11], "appear": 3, "appli": [0, 1, 2, 3, 4], "ar": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13], "arbitrari": [4, 5, 8], "arbitraryout": 4, "architectur": [0, 8, 10], "area": [2, 3], "argument": [0, 4, 5, 10, 11], "argument_list": 17, "arp": [2, 3], "ascii": [0, 1, 2, 3, 4], "assign": 13, "assum": [1, 3, 6], "attack": [0, 1, 2, 3, 4, 6], "authent": [0, 1, 2, 3, 4], "author": 11, "avail": [0, 6, 10], "avoid": 6, "awesom": [1, 3], "backup": [2, 3], "backward": 6, "bad": 8, "bandwidth": [2, 3], "bar": [1, 7, 12, 13, 17], "base": [0, 1, 6, 8, 10], "baz": 17, "becaus": [0, 1, 2, 3, 4], "been": [1, 6, 9], "befor": [1, 3, 5, 8, 12, 13, 14, 15, 17], "behavior": 3, "below": [0, 1, 2, 3, 4], "best": 6, "between": [5, 10], "bgp": [0, 2, 3, 10], "bigger": 4, "bind": 8, "block": [6, 8], "board": 8, "bond": [2, 3], "boolean": [0, 1, 2, 3, 4, 13], "bridg": [1, 2, 3, 6], "browser": 6, "bug": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "build": 8, "builtin": [2, 3, 4, 6, 12, 13, 14, 15, 17], "bundl": 6, "ca": [0, 1, 2, 3, 4, 6], "ca_path": [0, 1, 2, 3, 4, 6], "call": 8, "can": [0, 1, 2, 3, 4, 5, 6, 8, 10, 13], "cannot": 3, "cap": [2, 3], "capsman": [2, 3], "case": [1, 4, 6, 7], "caus": 5, "certain": 6, "certif": [0, 1, 2, 3, 4], "certificate_path": 6, "cet512w": 8, "chain": 3, "chang": [0, 1, 2, 3, 4, 5, 6, 8, 10], "changed_when": [5, 6], "channel": [2, 3, 11], "charact": 8, "check": [0, 1, 2, 3, 4, 5, 6, 10, 12, 13, 14, 15, 16, 17], "check_mod": [0, 1, 2, 3, 4, 5, 10], "choic": [0, 1, 2, 3, 4, 5, 13], "chosen": 6, "cipher": [0, 1, 2, 3, 4], "claim": 5, "claus": 4, "clean": 6, "cli": [1, 2, 3, 4, 12, 14, 15, 16], "cliconf": 8, "client": [2, 3], "clock": [2, 3], "cloud": [2, 3], "cmd": 4, "collect": [7, 8, 11], "com": 11, "command": [3, 4, 6, 8, 11, 14, 15], "comment": [0, 1, 2, 3, 4, 5, 7, 10, 12, 13, 14, 15, 17], "commerci": 6, "common": [1, 2, 3, 4, 5, 6], "commun": [7, 8], "compar": [3, 4], "compat": 6, "complet": 6, "condit": [1, 3, 4, 5], "config": [2, 3, 4, 10], "configur": [0, 1, 2, 3, 5, 6, 9, 10, 12, 13, 14, 15, 16, 17], "conjunct": [4, 5], "connect": [0, 1, 2, 3, 4, 5, 10, 11], "consid": [0, 1, 2, 3, 4, 5], "contain": [0, 1, 2, 3, 4, 5, 7, 8, 10], "control": [2, 3, 4, 6], "convert": [6, 11], "copi": 6, "core": [0, 1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14, 15, 16, 17], "correct": 6, "correctli": 6, "count": 8, "counter": 2, "cpu": [0, 8, 10], "creat": [0, 1, 2, 3, 4, 6], "create_onli": 3, "creation": 3, "credenti": 8, "criteria": 1, "crypto": 6, "current": [0, 1, 2, 3, 10], "custom": 3, "dachev": [0, 4, 11], "dash": 8, "data": [0, 1, 2, 4, 6, 7, 11, 13], "datapath": [2, 3], "deactiv": [0, 1, 2, 3, 4], "debug": [2, 4, 6, 8], "declar": [5, 9], "default": [0, 1, 2, 3, 4, 5, 7, 8, 10, 13], "defconf": [1, 2, 3], "defin": 9, "delegate_to": 6, "depend": [3, 6], "describ": [3, 6, 12, 13, 14, 15, 17], "descript": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 17], "dest": 6, "detail": [0, 1, 2, 3, 4, 5, 6, 8, 10], "detect": [2, 3], "determin": 5, "develop": [2, 3], "devi": 8, "devic": [1, 2, 3, 4, 11, 16], "dhcp": [2, 3], "dictionari": [0, 1, 2, 3, 4, 7, 10, 11], "diff": [0, 1, 2, 3, 4, 5, 10], "diff_mod": [0, 1, 2, 3, 4, 5, 10], "differ": [1, 3, 4, 6], "diffi": [0, 1, 2, 3, 4], "disabl": [0, 1, 2, 3, 6, 10], "discourag": 6, "discoveri": [2, 3], "disk": [0, 10], "dn": [2, 3, 6], "do": [0, 3, 6, 8, 10], "document": [1, 2, 3, 4, 5, 6, 8, 9], "doe": [0, 2, 5, 8, 10], "done": 6, "dump": 4, "dure": 6, "dynam": [1, 2, 3], "e": [2, 3], "each": [5, 12, 13, 14, 15, 16, 17], "easier": 6, "egor": [0, 5, 10, 11, 16], "either": [4, 6], "element": [0, 1, 2, 3, 4, 5, 10, 12, 13, 17], "empti": [1, 3, 4, 7, 13], "enabl": [0, 6, 10], "encod": [0, 1, 2, 3, 4], "ensur": 3, "ensure_ord": 3, "entri": [1, 2, 3, 4, 6, 12, 13, 14, 15, 16, 17], "eoip": [2, 3], "eq": 4, "equal": 4, "equival": [1, 2, 3, 4, 6], "error": [3, 5, 8], "ether1": [4, 5], "ether2": 4, "ethernet": [2, 3, 5], "evalu": 5, "even": 6, "everi": [1, 4, 5, 6, 8], "exactli": [1, 3], "exampl": [6, 7, 8, 16], "exchang": [0, 1, 2, 3, 4], "exclam": 2, "exclus": 4, "execut": [0, 1, 2, 3, 4, 5, 8], "exist": [0, 2, 3, 4, 10], "expect": [1, 8], "expir": 5, "export": 10, "extend": [2, 3, 4], "extended_queri": 4, "extended_queryout": 4, "fact": [1, 2, 3, 4, 6, 8, 11], "fail": [1, 3, 5, 6, 8], "failed_condit": 5, "fals": [0, 1, 2, 3, 4, 6, 7, 8, 13], "famili": [0, 1, 2, 3, 4, 5, 10], "featur": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "felix": [0, 1, 2, 3, 11, 12, 13, 14, 15, 17], "felixfontein": [0, 1, 2, 3, 11, 12, 13, 14, 15, 17], "few": 6, "field": [1, 2, 3, 4, 5], "file": [0, 1, 2, 3, 4, 6, 8], "filter": [2, 3, 7], "find": [0, 2, 3, 4, 6, 11], "firewal": [2, 3], "firmwar": [2, 3], "first": [2, 3, 6, 8, 10], "flow": [2, 3], "follow": [1, 2, 3, 4, 5, 6, 8, 9, 13], "fontein": [0, 1, 2, 3, 11, 12, 13, 14, 15, 17], "foo": [1, 7, 12, 13, 17], "forc": [0, 1, 2, 3, 4], "force_no_cert": [0, 1, 2, 3, 4, 6], "form": [7, 10], "format": [0, 1, 2, 3, 4], "forward": [5, 8], "found": [1, 2, 3], "free": [0, 8, 10], "frequenc": 8, "friendly_nam": 6, "from": [1, 3, 4, 5, 6, 11, 16], "full": [0, 1, 2, 3, 10], "fulli": 6, "further": [0, 1, 2, 3, 4], "galaxi": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "gatewai": 3, "gather": [6, 8], "gather_fact": [6, 8], "gather_subset": [0, 10], "gener": [2, 3, 6, 11], "get": [2, 4, 6], "github": 11, "given": [0, 1, 4, 10], "graph": [2, 3], "gre": [2, 3], "gre6": [2, 3], "group": [0, 1, 2, 3, 4], "guid": 6, "ha": [0, 1, 2, 3, 4, 5, 6, 7, 10], "handl": [2, 3], "handle_absent_entri": 3, "handle_dis": 2, "handle_entries_cont": 3, "handle_read_onli": 3, "handle_write_onli": 3, "happen": 8, "hardwar": [0, 10], "hash": [0, 10], "have": [0, 1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 14, 15, 16, 17], "hdd": 8, "heavili": [2, 3], "hellman": [0, 1, 2, 3, 4], "help": 7, "here": [1, 2, 3, 4, 5, 6], "heuel": [0, 5, 10, 11, 16], "hide": 2, "hide_default": 2, "high": [12, 13, 14, 15, 16, 17], "higher": [12, 13, 14, 15, 16, 17], "host": [0, 1, 2, 3, 4, 6, 8, 10], "hostnam": [0, 1, 2, 3, 4, 6, 10], "hostvar": [0, 10], "hotspot": [2, 3], "how": [0, 1, 2, 3, 4, 5, 10, 11], "http": [0, 1, 2, 3, 4, 6], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 14, 15, 16, 17], "id": [1, 2, 3, 4], "idempot": [1, 3, 10], "ident": [2, 3, 4, 5, 8, 10], "ignor": [3, 6, 8], "im": 11, "import": 6, "includ": [0, 1, 2, 3, 4, 5, 6, 10, 12, 13, 14, 15, 16, 17], "include_builtin": 2, "include_dynam": 2, "include_read_onli": 2, "incom": [2, 3], "indic": 5, "induc": 1, "inform": [0, 3, 4, 6, 10, 11], "initi": [0, 10], "input": [2, 4, 6], "insert": 6, "instal": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "instanc": [0, 2, 3, 10], "instead": [0, 1, 2, 3, 4, 6, 8], "instruct": 6, "integ": [0, 1, 2, 3, 4, 5, 10], "interfac": [0, 1, 2, 3, 4, 5, 6, 10], "internet": [2, 3], "interv": 5, "interwork": [2, 3], "invalid": [1, 2, 3], "inventory_hostnam": 6, "iot": [2, 3], "ip": [1, 2, 3, 4, 6, 7, 8], "ip2": 4, "ip_address": 2, "ipaddrd_printout": 4, "ipfix": [2, 3], "ipsec": [2, 3], "ipv4": [0, 10], "ipv6": [0, 2, 3, 10], "irc": 11, "issu": [0, 1, 2, 3, 4, 5, 8, 10, 11, 12, 13, 14, 15, 16, 17], "item": 4, "its": [4, 6, 8], "jinja2": 7, "join": [7, 11], "json": 6, "just": [0, 2, 10], "kei": [0, 1, 2, 3, 4, 5, 6, 8, 10, 12, 13, 14, 15, 17], "kept": 3, "key1": 13, "key2": 13, "l2tp": [2, 3], "larger": [0, 1, 10], "latter": 1, "layer7": [2, 3], "ldp": [2, 3], "leas": [2, 3], "least": [1, 3, 4], "led": [2, 3], "length": 6, "less": [1, 4, 6], "level": [5, 16], "libera": 11, "librari": 4, "libroutero": [0, 1, 2, 3, 4], "libssh": 8, "like": [0, 1, 7, 8, 10], "limit": 1, "line": [8, 10], "list": [0, 1, 2, 3, 4, 5, 7, 10, 11, 14, 15, 16, 17], "list_to_dict": [7, 11], "load": [0, 8, 10], "local": 6, "localhost": 6, "log": [2, 3], "login": [0, 1, 2, 3, 4, 8], "long": [5, 8], "longer": 8, "look": [0, 1, 2, 3, 4], "lookup": 6, "low": [5, 12, 13, 14, 15, 16, 17], "lower": [12, 13, 14, 15, 16, 17], "mac": [2, 3], "made": [1, 3], "mai": 8, "mail": [2, 3, 11], "main": 4, "make": [0, 1, 2, 3, 4, 8], "man": [0, 1, 2, 3, 4, 6], "manag": [2, 3], "mangl": [2, 3], "manual": [2, 3], "masquerad": 3, "match": [1, 4, 5, 6], "match_count": 1, "matrix": 11, "mean": 3, "member": [2, 3], "memori": [0, 8, 10], "mention": 3, "messag": 4, "met": 5, "mib": [0, 10], "middl": [0, 1, 2, 3, 4, 6], "might": 6, "mikrotik": [1, 2, 3, 4, 8, 11], "minim": 10, "mip": 8, "mipsb": 8, "mirror": [2, 3], "mlag": [2, 3], "mme": [2, 3], "modbu": [2, 3], "mode": [0, 1, 2, 3, 4, 5, 6, 10], "model": [0, 10], "modern": 8, "modif": [3, 4], "modifi": [0, 2, 4, 5, 6, 10, 11], "modify__count": 1, "modul": [7, 8], "module_default": [0, 1, 2, 3, 4, 6], "more": [1, 4, 6], "most": 6, "move": 5, "mpl": [2, 3], "msg": [4, 6, 8], "mtu": 4, "multipl": [1, 3, 5], "must": [4, 5], "mut": 4, "mutual": 4, "my": 1, "n": [0, 1, 2, 10], "name": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 14, 15, 17], "nat": [2, 3], "nd": [2, 3], "need": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10], "neighbor": [0, 2, 3, 10], "nest": 8, "net_put": 6, "netcommon": [6, 8], "netmask": 3, "netwatch": [2, 3], "network": [0, 1, 2, 3, 4, 6, 10, 11, 16], "network_cli": 8, "new": [0, 1, 2, 3, 12, 13, 14, 15, 17], "new_data": [1, 3], "newer": [0, 1, 2, 3, 4, 11], "nikolai": [0, 4, 11], "nikolaydachev": [0, 4, 11], "node": 5, "none": [3, 4, 5], "normal": 2, "note": [0, 2], "noth": 3, "ntp": [2, 3], "null": [2, 3], "number": [0, 1, 4, 5, 10], "o": [0, 1, 2, 3, 4, 5, 10], "object": [3, 4, 6], "offer": 8, "ok": [6, 8], "old": 1, "old_data": [1, 3], "older": 6, "omit": 2, "onc": [1, 6], "one": [1, 3, 4, 5, 7], "ones": [2, 3], "onli": [0, 1, 2, 3, 4, 5, 6, 8, 10], "onto": 6, "openssl_pkcs12": 6, "oper": [0, 1, 2, 3, 4, 5, 10], "oppos": 0, "option": [0, 1, 2, 3, 4, 6, 7, 8], "order": [0, 3, 10, 12, 13, 14, 15, 16, 17], "ordereddict": 3, "ospf": [0, 2, 3, 10], "other": [0, 2, 4, 7, 10], "out": [3, 5, 6], "output": [2, 4, 5, 6, 8], "over": 5, "overrid": [12, 13, 14, 15, 16, 17], "override_al": 6, "ovpn": [2, 3], "own": [0, 1, 2, 3, 4, 6], "p12": 6, "packag": [2, 3], "paramet": [6, 12, 14, 15, 17], "paramiko": 8, "pars": 6, "part": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "partial": 5, "pass": [3, 5, 7], "passphras": 6, "password": [0, 1, 2, 3, 4, 6, 8], "path": [0, 1, 2, 4, 6, 11], "peer": [0, 2, 3, 10], "pem": [0, 1, 2, 3, 4, 6], "pimsm": [2, 3], "ping": [2, 3], "pkc": 6, "pkcs12": 6, "plai": [6, 8], "platform": [0, 1, 2, 3, 4, 5, 8, 10, 11], "playbook": [0, 1, 2, 3, 4, 5, 6, 8, 10, 12, 13, 14, 15, 16, 17], "pleas": [0, 1, 2, 3, 4, 6, 8], "plugin": [5, 7, 8, 9, 12, 13, 14, 15, 16, 17], "poe": [2, 3], "point": 6, "polici": [2, 3, 5], "pool": [2, 3], "port": [0, 1, 2, 3, 4], "possibl": [0, 10], "possibli": [0, 1, 2, 3, 4, 5, 10], "ppp": [2, 3], "pppoe": [2, 3], "pptp": [2, 3], "predefin": 6, "predict": [0, 1, 2, 3, 4, 5, 10], "prefix": [2, 3], "prepend": [0, 1, 2, 3, 10], "present": 3, "print": [2, 4, 5, 6, 8], "print_path": 6, "prioriti": [12, 13, 14, 15, 16, 17], "privat": 6, "privatekey_path": 6, "problem": [2, 3, 6, 8], "produc": 8, "product": 6, "profil": [2, 3], "project": 11, "properti": 5, "propos": [2, 3], "protect": 6, "protocol": [0, 1, 2, 3, 4], "provid": [1, 3, 5, 7, 16], "provis": [2, 3], "proxi": [2, 3], "pylibssh": 8, "python": [0, 1, 2, 3, 4, 6, 8], "queri": [1, 2, 3, 4], "queryout": 4, "question": 11, "queue": [2, 3], "quit": 6, "quot": [4, 5, 11, 12], "quote_argu": [7, 11], "quote_argument_valu": [4, 7, 11], "radiu": [2, 3], "random": 6, "random_password": 6, "random_str": 6, "rang": [2, 3], "raw": [2, 3], "rb750gl": 8, "reachabl": 6, "read": [2, 3, 5], "reboot": 8, "recap": [6, 8], "receiv": 16, "recommend": 6, "referenc": [0, 10], "regist": [0, 2, 4, 6, 8, 10], "regular": 2, "remot": [1, 2, 3, 4, 11], "remov": [3, 4, 6], "remove_as_much_as_poss": 3, "renam": 1, "replac": [4, 8], "report": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "repositori": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "represent": 13, "request": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "requir": [5, 7, 12, 13, 14, 15, 17], "require_assign": [7, 13], "require_matches_max": 1, "require_matches_min": 1, "rescu": [6, 8], "resourc": [2, 3, 5, 8], "resp": 2, "respons": 5, "restor": [2, 3], "restrict": [0, 4, 10], "result": [2, 3, 5, 6, 8, 12, 13, 14, 15, 17], "retri": 5, "retriev": [0, 1, 3, 4, 6, 11], "return": 6, "rip": [2, 3], "ripng": [2, 3], "romon": [2, 3], "room": 11, "rout": [0, 2, 3, 10], "router": [0, 1, 2, 3, 4, 8], "routerboard": [2, 3, 5], "routero": 7, "rule": [2, 3], "run": [1, 2, 3, 4, 6, 8, 11, 12, 13, 14, 15, 17], "same": 3, "sampl": [1, 2, 3, 4, 5], "satisfi": 5, "schedul": [2, 3], "script": [2, 3, 4], "search": [1, 3], "second": 5, "sect": 8, "secur": [2, 3], "see": [6, 8], "select": [2, 3, 4], "send": [5, 16], "sens": [3, 10], "serial": [0, 10], "server": [2, 3], "servic": [2, 3, 6], "set": [0, 1, 2, 3, 4, 5, 7, 9, 10, 13], "set_fact": [6, 12, 13, 14, 15, 17], "setup": [3, 6], "should": [0, 1, 3, 5, 6, 8, 10, 12, 14, 15, 17], "show": [6, 8], "sign": [0, 1, 2, 3, 4, 6], "similar": [0, 8], "simpl": [2, 3], "simpli": [0, 1, 2, 3, 4, 5], "sinc": [3, 6, 8], "singl": 3, "skip": [0, 1, 2, 3, 4, 6, 7, 8, 13], "skip_empty_valu": [7, 13], "slash": 8, "sm": [2, 3], "small": 6, "smb": [2, 3], "sniffer": [2, 3], "snmp": [2, 3], "snooper": [2, 3], "so": [4, 13], "sock": [2, 3], "some": [2, 3, 7], "someth": 8, "sourc": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "space": [0, 4, 7, 8, 10], "special": 6, "specif": [0, 1, 4, 5, 6, 10], "specifi": [0, 1, 2, 3, 4, 5, 6, 8, 10, 12, 13, 14, 15, 16, 17], "split": [5, 7, 11, 13], "src": 6, "srcnat": 3, "ssh": [2, 3, 5, 6, 10, 11], "ssh_type": 8, "ssl": [0, 1, 2, 3, 4, 6], "sstp": [2, 3], "stabl": 8, "start": 8, "state": [0, 2, 10], "static": [2, 3], "statu": [0, 1, 2, 3, 4, 5, 10], "stdout": 5, "stdout_lin": [5, 6, 8], "steer": [2, 3], "step": 1, "still": [2, 3], "store": 8, "strict": 3, "string": [0, 1, 2, 3, 4, 5, 7, 8, 10, 12, 13, 14, 15, 17], "strip": 10, "subject": 6, "submit": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "subscrib": 11, "subset": [0, 10], "success": [1, 12, 13, 14, 15, 17], "successfulli": 6, "suppli": [0, 10], "support": [0, 1, 2, 3, 4, 5, 8, 10, 11], "sure": [1, 6, 8], "suscept": [0, 1, 2, 3, 4, 6], "switch": [2, 3], "symbol": 8, "system": [0, 2, 3, 4, 5, 8, 10], "system_resource_print": 8, "tabl": [0, 2, 3, 10], "talk": 6, "target": [0, 1, 2, 3, 4, 5, 10], "task": [1, 5, 6, 7, 8], "tell": [0, 1, 2, 3, 4, 8], "templat": [2, 3], "test": [6, 8], "test1234": [6, 8], "text": [6, 7], "tftp": [2, 3], "than": [1, 4, 8], "thei": [0, 2, 3, 10], "them": [0, 3, 4, 7, 10], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 14, 15, 16, 17], "thing": [0, 1, 2, 3, 4], "think": [2, 3], "three": [3, 6], "through": 6, "time": [5, 8], "timeout": [0, 1, 2, 3, 4], "timestamp": 10, "tl": [0, 1, 2, 3, 4, 6], "togeth": [1, 8], "too": 8, "tool": [2, 3], "total": [0, 8, 10], "track": [2, 3], "tracker": [0, 1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 15, 16, 17], "traffic": [2, 3], "tree": [2, 3], "tri": 5, "troubl": 8, "true": [0, 1, 2, 3, 4, 5, 6, 7, 13], "trust": 6, "truststor": 6, "try": 5, "twice": 10, "two": [3, 7, 8], "type": [2, 3, 12, 13, 14, 15, 16, 17], "unfilt": 2, "uniqu": [1, 2, 3, 4, 5], "unquot": [4, 5, 11], "unreach": [6, 8], "unset": [1, 2, 3], "unsupport": 8, "until": 5, "up": [2, 3, 12, 13, 14, 15, 16, 17], "updat": [0, 2, 3, 4, 10], "upgrad": [2, 3], "upnp": [2, 3], "upper": 1, "uptim": [0, 8, 10], "us": [2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "usag": 11, "user": [0, 1, 2, 3, 4, 8, 11], "usernam": [0, 1, 2, 3, 4, 6, 8], "usual": 6, "utf": [0, 1, 2, 3, 4], "v7": 8, "valid": [0, 1, 2, 3, 4, 5, 6], "validate_cert": [0, 1, 2, 3, 4, 6], "validate_cert_hostnam": [0, 1, 2, 3, 4, 6], "valu": [0, 6, 7, 10, 11], "value1": 13, "value2": 13, "var": [2, 6, 8], "variabl": [12, 13, 14, 15, 16, 17], "verif": 6, "verifi": 3, "version": [0, 1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17], "via": [4, 8], "vlan": [2, 3], "vpnv4": [0, 10], "vrf": [2, 3], "vrrp": [2, 3], "wa": [1, 3, 10], "wai": [1, 3, 4, 6], "wait": 5, "wait_for": 5, "wan": 3, "want": [1, 2, 3], "watchdog": [2, 3], "we": [1, 3, 4, 6], "web": [2, 3], "well": [2, 6], "were": 1, "what": [0, 1, 2, 3, 4, 5, 10], "when": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 13], "where": 4, "whether": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "which": [4, 6, 7, 8], "while": 7, "whose": [7, 13], "wifi": [2, 3], "wifiwave2": [2, 3], "winbox": [2, 3], "wipe": 6, "wireguard": [2, 3], "wireless": [2, 3], "within": 5, "without": [0, 1, 2, 3, 4, 5, 6, 7, 10, 13], "word": 4, "work": [0, 1, 2, 3, 4, 6], "wrap": 8, "write": [3, 8], "www": 6, "x86": 5, "yaml": 1, "you": [0, 1, 2, 3, 4, 5, 6, 7, 8], "your": [0, 1, 2, 3, 4, 6, 8], "zaitsev": [0, 5, 10, 11, 16], "zero": 1}, "titles": ["community.routeros.api_facts module \u2013 Collect facts from remote devices running MikroTik RouterOS using the API", "community.routeros.api_find_and_modify module \u2013 Find and modify information using the API", "community.routeros.api_info module \u2013 Retrieve information from API", "community.routeros.api_modify module \u2013 Modify data at paths with API", "community.routeros.api module \u2013 Ansible module for RouterOS API", "community.routeros.command module \u2013 Run commands on remote devices running MikroTik RouterOS", "How to connect to RouterOS devices with the RouterOS API", "How to quote and unquote commands and arguments", "How to connect to RouterOS devices with SSH", "Index of all Collection Environment Variables", "community.routeros.facts module \u2013 Collect facts from remote devices running MikroTik RouterOS", "Community.Routeros", "community.routeros.join filter \u2013 Join a list of arguments to a command", "community.routeros.list_to_dict filter \u2013 Convert a list of arguments to a dictionary", "community.routeros.quote_argument filter \u2013 Quote an argument", "community.routeros.quote_argument_value filter \u2013 Quote an argument value", "community.routeros.routeros cliconf \u2013 Use routeros cliconf to run command on MikroTik RouterOS platform", "community.routeros.split filter \u2013 Split a command into arguments"], "titleterms": {"all": 9, "also": [0, 1, 2, 3, 4, 5, 10], "an": [8, 14, 15], "ansibl": 4, "api": [0, 1, 2, 3, 4, 6], "api_fact": 0, "api_find_and_modifi": 1, "api_info": 2, "api_modifi": 3, "argument": [7, 12, 13, 14, 15, 17], "attribut": [0, 1, 2, 3, 4, 5, 10], "author": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "certif": 6, "cliconf": [11, 16], "collect": [0, 1, 2, 3, 4, 5, 9, 10, 12, 13, 14, 15, 16, 17], "command": [5, 7, 12, 16, 17], "commun": [0, 1, 2, 3, 4, 5, 6, 10, 11, 12, 13, 14, 15, 16, 17], "connect": [6, 8], "convert": 13, "data": 3, "default": 6, "descript": 11, "devic": [0, 5, 6, 8, 10], "dictionari": 13, "encrypt": 6, "environ": 9, "exampl": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 17], "fact": [0, 10], "filter": [11, 12, 13, 14, 15, 17], "find": 1, "from": [0, 2, 10], "group": 6, "guid": 11, "how": [6, 7, 8], "import": 8, "index": [9, 11], "inform": [1, 2], "input": [12, 13, 14, 15, 17], "instal": 6, "inventori": 8, "join": 12, "keyword": 13, "link": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "list": [12, 13], "list_to_dict": 13, "mikrotik": [0, 5, 6, 10, 16], "modifi": [1, 3], "modul": [0, 1, 2, 3, 4, 5, 6, 10, 11], "note": [1, 3, 4, 5, 8], "paramet": [0, 1, 2, 3, 4, 5, 10, 13], "path": 3, "pki": 6, "platform": 16, "plugin": 11, "quot": [7, 14, 15], "quote_argu": 14, "quote_argument_valu": 15, "remot": [0, 5, 10], "requir": [0, 1, 2, 3, 4], "retriev": 2, "return": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 17], "router": 6, "routero": [0, 1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17], "run": [0, 5, 10, 16], "see": [0, 1, 2, 3, 4, 5, 10], "set": [6, 8], "split": 17, "ssh": 8, "synopsi": [0, 1, 2, 3, 4, 5, 10, 12, 13, 14, 15, 16, 17], "unquot": 7, "up": [6, 8], "us": [0, 1, 6, 16], "valu": [1, 2, 3, 4, 5, 12, 13, 14, 15, 17], "variabl": 9}})