docs: add note about hostnames and nested commands (#16)

* docs: add note about hostnames and nested commands * docs: clarify command nesting * Update README.md Co-authored-by: Felix Fontein <[email protected]> Co-authored-by: Felix Fontein <[email protected]>
ansible-collections · Dec 18, 2020 · b322351 · b322351
1 parent fbc47fb
commit b322351
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -31,6 +31,17 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_gui
 
 There are two approaches for using this collection. The `command` and `facts` modules use the `network_cli` connection and connect with SSH. The `api` module connects with the HTTP/HTTPS API.
 
+### Prerequisites
+
+The terminal-based modules in this collection (`community.routeros.command` and `community.routeros.facts`) do not support arbitrary symbols in router's identity. If you are having trouble connecting to your device, please make sure that your MikroTik's identity contains only alphanumeric characters and dashes. Also, the `community.routeros.command` module does not support nesting commands and expects every command to start with a forward slash (`/`). Running the following command will produce an error.
+
+```yaml
+- community.routeros.command:
+    commands:
+      - /ip
+      - print
+```
+
 ### Connecting with `network_cli`
 
 Example inventory `hosts` file: