Trouble using compose #27

ipsecguy · 2024-04-03T09:16:00Z

ipsecguy
Apr 3, 2024

Hi, I am using ansible core 2.16.5 on debian 12 and pulled this netbird plugin via ansible-galaxy collection install dominion_solutions.netbird

After some trouble getting it running (mostly due to me getting started with dynamic inventories) I am now getting a proper list of netbird devices out of the inventory.

Additionally, the error message about invalid characters does not seem correct, there are no curly braces in.

inventory.netbird.yml

---
plugin: dominion_solutions.netbird.netbird
api_key: nbp_*redacted*
api_url: https://api.netbird.io/api/
#netbird_connected: True
netbird_groups:
- "APU Probes"

ansible-inventory --list -i inventory.netbird.yml -vvvv

ansible-inventory [core 2.16.5]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/ansible/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/ansible/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible-inventory
  python version = 3.11.2 (main, Mar 13 2023, 12:18:29) [GCC 12.2.0] (/usr/bin/python3)
  jinja version = 3.1.2
  libyaml = True
Using /etc/ansible/ansible.cfg as config file
setting up inventory plugins
Loading collection ansible.builtin from
host_list declined parsing /home/ansible/ansible/inventory.netbird.yml as it did not pass its verify_file() method
script declined parsing /home/ansible/ansible/inventory.netbird.yml as it did not pass its verify_file() method
Loading collection dominion_solutions.netbird from /home/ansible/.ansible/collections/ansible_collections/dominion_solutions/netbird
Using inventory plugin 'ansible_collections.dominion_solutions.netbird.plugins.inventory.netbird' to process inventory source '/home/ansible/ansible/inventory.netbird.yml'
Building the Netbird API Client.
Set up the Netbird API Client with the URL: https://api.netbird.io/api/
Not replacing invalid character(s) "{' '}" in group name (APU Probes)
[WARNING]: Invalid characters were found in group names but not replaced, use -vvvv to see details
Parsed /home/ansible/ansible/inventory.netbird.yml inventory source with auto plugin
{
    "APU Probes": {
        "hosts": [
            "netbird2.netbird.cloud",
            "netbird3.netbird.cloud"
        ]
    },
    "All": {
        "hosts": [
            "netbird2.netbird.cloud",
            "netbird3.netbird.cloud"
        ]
    },
    "_meta": {
        "hostvars": {
            "netbird2.netbird.cloud": {
                "accessible_peers_count": 11,
                "approval_required": false,
                "city_name": "Frankfurt am Main",
                "connected": true,
                "connection_ip": "2a02:8071:50d1:6ce0:78bc:16ff:feb1:17ff",
                "country_code": "DE",
                "dns_label": "netbird2.netbird.cloud",
                "geoname_id": 2925533,
                "hostname": "vm-b117ff",
                "id": "cnr0sr3l0ubs73bek1o0",
                "ip": "100.88.192.148",
                "kernel_version": "6.1.0-18-amd64",
                "last_login": "2024-03-16T21:26:04.384004993Z",
                "last_seen": "2024-04-03T07:15:16.19041215Z",
                "login_expiration_enabled": false,
                "login_expired": false,
                "name": "netbird2",
                "os": "Debian GNU/Linux 12",
                "ssh_enabled": false,
                "ui_version": "",
                "user_id": "",
                "version": "0.26.7"
            },
            "netbird3.netbird.cloud": {
                "accessible_peers_count": 11,
                "approval_required": false,
                "city_name": "Frankfurt am Main",
                "connected": true,
                "connection_ip": "2a02:8071:50d1:6ce0:78bc:16ff:fe59:7586",
                "country_code": "DE",
                "dns_label": "netbird3.netbird.cloud",
                "geoname_id": 2925533,
                "hostname": "vm-597586",
                "id": "cnrbe53l0ubs73bek9tg",
                "ip": "100.88.155.178",
                "kernel_version": "6.1.0-18-amd64",
                "last_login": "2024-03-17T09:25:40.498995934Z",
                "last_seen": "2024-04-03T07:16:46.855499107Z",
                "login_expiration_enabled": false,
                "login_expired": false,
                "name": "netbird3",
                "os": "Debian GNU/Linux 12",
                "ssh_enabled": false,
                "ui_version": "",
                "user_id": "",
                "version": "0.26.7"
            }
        }
    },
    "all": {
        "children": [
            "ungrouped",
            "All",
            "APU Probes"
        ]
    }
}

However, when I add any compose: to add variables (I started with adding a static value)

---
plugin: dominion_solutions.netbird.netbird
api_key: nbp_*redacted*
api_url: https://api.netbird.io/api/
#netbird_connected: True
netbird_groups:
- "APU Probes"

compose:
  ansible_port: 22

However, when I add this and run

ansible-inventory --list -i inventory.netbird.yml -vvvv

ansible-inventory [core 2.16.5]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/ansible/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/ansible/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible-inventory
  python version = 3.11.2 (main, Mar 13 2023, 12:18:29) [GCC 12.2.0] (/usr/bin/python3)
  jinja version = 3.1.2
  libyaml = True
Using /etc/ansible/ansible.cfg as config file
setting up inventory plugins
Loading collection ansible.builtin from
host_list declined parsing /home/ansible/ansible/inventory.netbird.yml as it did not pass its verify_file() method
script declined parsing /home/ansible/ansible/inventory.netbird.yml as it did not pass its verify_file() method
Loading collection dominion_solutions.netbird from /home/ansible/.ansible/collections/ansible_collections/dominion_solutions/netbird
Using inventory plugin 'ansible_collections.dominion_solutions.netbird.plugins.inventory.netbird' to process inventory source '/home/ansible/ansible/inventory.netbird.yml'
toml declined parsing /home/ansible/ansible/inventory.netbird.yml as it did not pass its verify_file() method
[WARNING]:  * Failed to parse /home/ansible/ansible/inventory.netbird.yml with auto plugin: Unhandled exception when retrieving compose: unhashable type: 'AnsibleMapping'. unhashable type: 'AnsibleMapping'
  File "/usr/lib/python3/dist-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/usr/lib/python3/dist-packages/ansible/plugins/inventory/auto.py", line 59, in parse
    plugin.parse(inventory, loader, path, cache=cache)
  File "/home/ansible/.ansible/collections/ansible_collections/dominion_solutions/netbird/plugins/inventory/netbird.py", line 217, in parse
    self._options = self._read_config_data(path)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/ansible/plugins/inventory/__init__.py", line 240, in _read_config_data
    self.set_options(direct=config, var_options=self._vars)
  File "/usr/lib/python3/dist-packages/ansible/plugins/__init__.py", line 106, in set_options
    self._options = C.config.get_plugin_options(self.plugin_type, self._load_name, keys=task_keys, variables=var_options, direct=direct)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/ansible/config/manager.py", line 354, in get_plugin_options
    options[option] = self.get_config_value(option, plugin_type=plugin_type, plugin_name=name, keys=keys, variables=variables, direct=direct)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/ansible/config/manager.py", line 450, in get_config_value
    raise AnsibleError("Unhandled exception when retrieving %s:\n%s" % (config, to_native(e)), orig_exc=e)
[WARNING]:  * Failed to parse /home/ansible/ansible/inventory.netbird.yml with yaml plugin: Plugin configuration YAML file, not YAML inventory
  File "/usr/lib/python3/dist-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/usr/lib/python3/dist-packages/ansible/plugins/inventory/yaml.py", line 114, in parse
    raise AnsibleParserError('Plugin configuration YAML file, not YAML inventory')
[WARNING]:  * Failed to parse /home/ansible/ansible/inventory.netbird.yml with ini plugin: Invalid host pattern '---' supplied, '---' is normally a sign this is a YAML file.
  File "/usr/lib/python3/dist-packages/ansible/inventory/manager.py", line 293, in parse_source
    plugin.parse(self._inventory, self._loader, source, cache=cache)
  File "/usr/lib/python3/dist-packages/ansible/plugins/inventory/ini.py", line 138, in parse
    raise AnsibleParserError(e)
[WARNING]: Unable to parse /home/ansible/ansible/inventory.netbird.yml as an inventory source
[WARNING]: No inventory was parsed, only implicit localhost is available
{
    "_meta": {
        "hostvars": {}
    },
    "all": {
        "children": [
            "ungrouped"
        ]
    }
}

I am using the hosted test version of netbird, if that makes a difference.

Answered by spam-n-eggs

Apr 3, 2024

Please upgrade to use version 0.2.0:

- name: dominion_solutions.netbird.netbird
  version: 0.2.0

The issue has been resolved. Thanks again for pointing it out!

View full answer

spam-n-eggs · 2024-04-03T10:45:12Z

spam-n-eggs
Apr 3, 2024
Maintainer

Good Morning @ipsecguy,

First, thanks for using our Ansible Collection. Knowing that we've provided some sort of value to someone makes it worth it for us.

I think I understand the problem. I missed an edge case where the groups could have spaces in the names. You may need to escape it with a backslash such as - "APU\ Probes". If that does not work, we can log a bug and get it resolved.

Please let us know if that helps.

0 replies

spam-n-eggs · 2024-04-03T11:50:43Z

spam-n-eggs
Apr 3, 2024
Maintainer

After looking, this appears to definitely be a bug in the code. In the DOCUMENTATION block the compose is defined as follows:

 compose:
        description: compose variables for Ansible based on jinja2 expression and inventory vars
        default: False
        required: False
        type: boolean

This is likely due to an earlier refactoring. Thank you for finding this bug.

3 replies

spam-n-eggs Apr 3, 2024
Maintainer

I have opened #28 in order to address this.

spam-n-eggs Apr 3, 2024
Maintainer

Please upgrade to use version 0.2.0:

- name: dominion_solutions.netbird.netbird
  version: 0.2.0

The issue has been resolved. Thanks again for pointing it out!

Answer selected by ipsecguy

spam-n-eggs Apr 4, 2024
Maintainer

@ipsecguy Does this resolve your issue?

ipsecguy · 2024-04-04T17:22:35Z

ipsecguy
Apr 4, 2024
Author

@spam-n-eggs Yes, it solves the compose: problem!

Yest, the error message on escapes is strange:

single quote, no backslash to escape the space, error message but: works!
single quote, backslash to escape the space: fails with empty inventory (did not pass verify_file)
double quote, no backslash, error message but works!
double quote, backslash, error message but works!

---
plugin: dominion_solutions.netbird.netbird
api_key: nbp_*redacted*
api_url: https://api.netbird.io/api/
#netbird_connected: True
netbird_groups:
- 'APU Probes'

compose:
  ansible_port: 22
  ansible_host: ip

ansible -i inventory.netbird.yml -a uptime all
[WARNING]: Invalid characters were found in group names but not replaced, use -vvvv to see details
netbird3.netbird.cloud | CHANGED | rc=0 >>
 19:21:23 up 4 days, 20:44,  1 user,  load average: 0.00, 0.00, 0.00
netbird2.netbird.cloud | CHANGED | rc=0 >>
 19:21:23 up 1 day, 22:06,  1 user,  load average: 0.00, 0.00, 0.00
netbird5.netbird.cloud | CHANGED | rc=0 >>
 19:21:23 up 1 day,  2:58,  1 user,  load average: 0.08, 0.02, 0.00
netbird4.netbird.cloud | CHANGED | rc=0 >>
 19:21:23 up 1 day,  5:17,  1 user,  load average: 0.01, 0.01, 0.00

1 reply

spam-n-eggs Apr 4, 2024
Maintainer

I suspect that the spaces in the group names are always going to show a warning. Ansible doesn't seem to like them. You could try without any quotes and it may or may not show a warning. YMMV / Deine Erfahrung mag anders sein.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Trouble using compose #27

Uh oh!

{{title}}

Uh oh!

Replies: 3 comments 4 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

Uh oh!

Trouble using compose #27

Uh oh!

ipsecguy Apr 3, 2024

Replies: 3 comments · 4 replies

Uh oh!

spam-n-eggs Apr 3, 2024 Maintainer

Uh oh!

spam-n-eggs Apr 3, 2024 Maintainer

Uh oh!

spam-n-eggs Apr 3, 2024 Maintainer

Uh oh!

spam-n-eggs Apr 3, 2024 Maintainer

Uh oh!

spam-n-eggs Apr 4, 2024 Maintainer

Uh oh!

ipsecguy Apr 4, 2024 Author

Uh oh!

Uh oh!

spam-n-eggs Apr 4, 2024 Maintainer

ipsecguy
Apr 3, 2024

Replies: 3 comments 4 replies

spam-n-eggs
Apr 3, 2024
Maintainer

spam-n-eggs
Apr 3, 2024
Maintainer

spam-n-eggs Apr 3, 2024
Maintainer

spam-n-eggs Apr 3, 2024
Maintainer

spam-n-eggs Apr 4, 2024
Maintainer

ipsecguy
Apr 4, 2024
Author

spam-n-eggs Apr 4, 2024
Maintainer