How to set interface vlan mode to empty? #174

Phill93 · 2022-11-16T10:39:24Z

Phill93
Nov 16, 2022

Hello,

how can I reset the interface VLAN mode to empty?
An empty string does not work.

- name: "Set interface mode and vlan (empty)"
  networktocode.nautobot.device_interface:
    url: "{{ nautobot_api }}"
    token: "{{ nautobot_token }}"
    state: present
    device: "{{ nautbot_device[0].value.name }}"
    name: "{{ item }}"
    mode: ""
  when: interface_data.mode == "NotConfigured"
  delegate_to: localhost

TASK [nautobot : Set interface mode and vlan (empty)] ******************************************************************************************************************************************************************************************************************************************************************************************************************************
task path: /home/ansible-local/ansible_repo/roles/nautobot/tasks/update-empty-interface.yml:1
Mittwoch 16 November 2022  11:34:29 +0100 (0:00:00.616)       0:05:30.910 *****
<iai-sw-0445-l-6-1.mgmt.iai.kit.edu> Attempting python interpreter discovery
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: ansible-local
<localhost> EXEC /bin/sh -c 'echo PLATFORM; uname; echo FOUND; command -v '"'"'/usr/bin/python'"'"'; command -v '"'"'python3.9'"'"'; command -v '"'"'python3.8'"'"'; command -v '"'"'python3.7'"'"'; command -v '"'"'python3.6'"'"'; command -v '"'"'python3.5'"'"'; command -v '"'"'python2.7'"'"'; command -v '"'"'python2.6'"'"'; command -v '"'"'/usr/libexec/platform-python'"'
"'; command -v '"'"'/usr/bin/python3'"'"'; command -v '"'"'python'"'"'; echo ENDFOUND && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python && sleep 0'
Using module file /home/ansible-local/.ansible/collections/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py
Pipelining is enabled.
<localhost> EXEC /bin/sh -c '/usr/bin/python3 && sleep 0'
The full traceback is:
Traceback (most recent call last):
  File "<stdin>", line 100, in <module>
  File "<stdin>", line 92, in _ansiballz_main
  File "<stdin>", line 41, in invoke_module
  File "/usr/lib/python3.6/runpy.py", line 205, in run_module
    return _run_module_code(code, init_globals, run_name, mod_spec)
  File "/usr/lib/python3.6/runpy.py", line 96, in _run_module_code
    mod_name, mod_spec, pkg_name, script_name)
  File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
    exec(code, run_globals)
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py", line 306, in <module>
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py", line 302, in main
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/dcim.py", line 172, in run
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py", line 1011, in _ensure_object_exists
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py", line 990, in _update_object
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py", line 419, in update
    return self.save()
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py", line 391, in save
    if req.patch({i: serialized[i] for i in diff}):
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/query.py", line 365, in patch
    return self._make_call(verb="patch", data=data)
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/query.py", line 241, in _make_call
    raise RequestError(req)
pynautobot.core.query.RequestError: The request failed with code 400 Bad Request: {'untagged_vlan': ['Mode must be set when specifying untagged_vlan']}
fatal: [iai-sw-0445-l-6-1.mgmt.iai.kit.edu -> localhost]: FAILED! => {
    "changed": false,
    "module_stderr": "Traceback (most recent call last):\n  File \"<stdin>\", line 100, in <module>\n  File \"<stdin>\", line 92, in _ansiballz_main\n  File \"<stdin>\", line 41, in invoke_module\n  File \"/usr/lib/python3.6/runpy.py\", line 205, in run_module\n    return _run_module_code(code, init_globals, run_name, mod_spec)\n  File \"/usr/lib/python3.6/runpy.py\", $ine 96, in _run_module_code\n    mod_name, mod_spec, pkg_name, script_name)\n  File \"/usr/lib/python3.6/runpy.py\", line 85, in _run_code\n    exec(code, run_globals)\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/devi$e_interface.py\", line 306, in <module>\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py\", line 302, in main\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_net$orktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/dcim.py\", line 172, in run\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py\", line 1011, in _$nsure_object_exists\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_ij5ho1i5/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py\", line 990, in _update_object\n  File \"/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py\", line 419, in update\n    re$urn self.save()\n  File \"/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py\", line 391, in save\n    if req.patch({i: serialized[i] for i in diff}):\n  File \"/usr/local/lib/python3.6/dist-packages/pynautobot/core/query.py\", line 365, in patch\n    return self._make_call(verb=\"patch\", data=data)\n  File \"/usr/local/lib/python3.6/dist-packages/pyna$tobot/core/query.py\", line 241, in _make_call\n    raise RequestError(req)\npynautobot.core.query.RequestError: The request failed with code 400 Bad Request: {'untagged_vlan': ['Mode must be set when specifying untagged_vlan']}\n",
    "module_stdout": "",
    "msg": "MODULE FAILURE\nSee stdout/stderr for the exact error",
    "rc": 1
}

jvanderaa · 2022-11-17T18:37:59Z

jvanderaa
Nov 17, 2022
Maintainer

Have you set the untagged vlan to an empty string as well?

0 replies

jvanderaa · 2022-11-17T19:14:52Z

jvanderaa
Nov 17, 2022
Maintainer

I have recreated the error you are having. In the API exploration you need to send a JSON null object.

{
  "untagged_vlan": null
}

This may be something that we would need to do a URI module patch as a work around for the first step until a fix can be put in place.

0 replies

Phill93 · 2022-11-18T07:43:14Z

Phill93
Nov 18, 2022
Author

I have now tried both, each time I get an error.

##Attempt 1: untagged_vlan: ""

- name: "Set interface mode and vlan (empty)"
  networktocode.nautobot.device_interface:
    url: "{{ nautobot_api }}"
    token: "{{ nautobot_token }}"
    state: present
    device: "{{ nautbot_device[0].value.name }}"
    name: "{{ item }}"
    mode: ""
    untagged_vlan: ""
  when: interface_data.mode == "NotConfigured"
  delegate_to: localhost

TASK [nautobot : Set interface mode and vlan (empty)] *****************************************************************************************************************************************************************************
task path: /home/ansible-local/ansible_repo/roles/nautobot/tasks/update-empty-interface.yml:1
Freitag 18 November 2022  08:39:21 +0100 (0:00:00.642)       0:01:34.894 ******
<iai-sw-0445-l-6-1.mgmt.iai.kit.edu> Attempting python interpreter discovery
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: ansible-local
<localhost> EXEC /bin/sh -c 'echo PLATFORM; uname; echo FOUND; command -v '"'"'/usr/bin/python'"'"'; command -v '"'"'python3.9'"'"'; command -v '"'"'python3.8'"'"'; command -v '"'"'python3.7'"'"'; command -v '"'"'python3.6'"'"'
; command -v '"'"'python3.5'"'"'; command -v '"'"'python2.7'"'"'; command -v '"'"'python2.6'"'"'; command -v '"'"'/usr/libexec/platform-python'"'"'; command -v '"'"'/usr/bin/python3'"'"'; command -v '"'"'python'"'"'; echo ENDFO
UND && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python && sleep 0'
Using module file /home/ansible-local/.ansible/collections/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py
Pipelining is enabled.
<localhost> EXEC /bin/sh -c '/usr/bin/python3 && sleep 0'
The full traceback is:
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_lt5zrs8g/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py", line 530, in _
nb_endpoint_get
    response = nb_endpoint.get(**query_params)
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/endpoint.py", line 152, in get
    "get() returned more than one result. "
fatal: [iai-sw-0445-l-6-1.mgmt.iai.kit.edu -> localhost]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "api_version": null,
            "custom_fields": null,
            "description": null,
            "device": "iai-sw-0445-l-6-1",
            "enabled": null,
            "label": null,
            "lag": null,
            "mac_address": null,
            "mgmt_only": null,
            "mode": "",
            "mtu": null,
            "name": "swp8",
            "query_params": null,
            "state": "present",
            "tagged_vlans": null,
            "tags": null,
            "token": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
            "type": null,
            "untagged_vlan": "",
            "update_vc_child": false,
            "url": "https://iai-netdoc.iai.kit.edu",
            "validate_certs": true
        }
    },
    "msg": "More than one result returned for untagged_vlan"
}

##Attempt 2: untagged_vlan: null

- name: "Set interface mode and vlan (empty)"
  networktocode.nautobot.device_interface:
    url: "{{ nautobot_api }}"
    token: "{{ nautobot_token }}"
    state: present
    device: "{{ nautbot_device[0].value.name }}"
    name: "{{ item }}"
    mode: ""
    untagged_vlan: null
  when: interface_data.mode == "NotConfigured"
  delegate_to: localhost

TASK [nautobot : Set interface mode and vlan (empty)] ************************************************************************************************************************************************
task path: /home/ansible-local/ansible_repo/roles/nautobot/tasks/update-empty-interface.yml:1
Freitag 18 November 2022  08:36:46 +0100 (0:00:00.613)       0:05:30.651 ******
<iai-sw-0445-l-6-1.mgmt.iai.kit.edu> Attempting python interpreter discovery
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: ansible-local
<localhost> EXEC /bin/sh -c 'echo PLATFORM; uname; echo FOUND; command -v '"'"'/usr/bin/python'"'"'; command -v '"'"'python3.9'"'"'; command -v '"'"'python3.8'"'"'; command -v '"'"'python3.7'"'"'; command -v '"'"'python3.6'"'"'
; command -v '"'"'python3.5'"'"'; command -v '"'"'python2.7'"'"'; command -v '"'"'python2.6'"'"'; command -v '"'"'/usr/libexec/platform-python'"'"'; command -v '"'"'/usr/bin/python3'"'"'; command -v '"'"'python'"'"'; echo ENDFO
UND && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python && sleep 0'
Using module file /home/ansible-local/.ansible/collections/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py
Pipelining is enabled.
<localhost> EXEC /bin/sh -c '/usr/bin/python3 && sleep 0'
The full traceback is:
Traceback (most recent call last):
  File "<stdin>", line 100, in <module>
  File "<stdin>", line 92, in _ansiballz_main
  File "<stdin>", line 41, in invoke_module
  File "/usr/lib/python3.6/runpy.py", line 205, in run_module
    return _run_module_code(code, init_globals, run_name, mod_spec)
  File "/usr/lib/python3.6/runpy.py", line 96, in _run_module_code
    mod_name, mod_spec, pkg_name, script_name)
  File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
    exec(code, run_globals)
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py", line 306
, in <module>
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py", line 302
, in main
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/dcim.py", line 172, in ru
n
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py", line 1011, in
_ensure_object_exists
  File "/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py", line 990, in _
update_object
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py", line 419, in update
    return self.save()
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py", line 391, in save
    if req.patch({i: serialized[i] for i in diff}):
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/query.py", line 365, in patch
    return self._make_call(verb="patch", data=data)
  File "/usr/local/lib/python3.6/dist-packages/pynautobot/core/query.py", line 241, in _make_call
    raise RequestError(req)
pynautobot.core.query.RequestError: The request failed with code 400 Bad Request: {'untagged_vlan': ['Mode must be set when specifying untagged_vlan']}
fatal: [iai-sw-0445-l-6-1.mgmt.iai.kit.edu -> localhost]: FAILED! => {
    "changed": false,
    "module_stderr": "Traceback (most recent call last):\n  File \"<stdin>\", line 100, in <module>\n  File \"<stdin>\", line 92, in _ansiballz_main\n  File \"<stdin>\", line 41, in invoke_module\n  File \"/usr/lib/python3.6/ru
npy.py\", line 205, in run_module\n    return _run_module_code(code, init_globals, run_name, mod_spec)\n  File \"/usr/lib/python3.6/runpy.py\", line 96, in _run_module_code\n    mod_name, mod_spec, pkg_name, script_name)\n  Fil
e \"/usr/lib/python3.6/runpy.py\", line 85, in _run_code\n    exec(code, run_globals)\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interface_payload.zip/a
nsible_collections/networktocode/nautobot/plugins/modules/device_interface.py\", line 306, in <module>\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.device_interf
ace_payload.zip/ansible_collections/networktocode/nautobot/plugins/modules/device_interface.py\", line 302, in main\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.nautobot.
device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/dcim.py\", line 172, in run\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/ansible_networktocode.naut
obot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py\", line 1011, in _ensure_object_exists\n  File \"/tmp/ansible_networktocode.nautobot.device_interface_payload_92zs_hn2/a
nsible_networktocode.nautobot.device_interface_payload.zip/ansible_collections/networktocode/nautobot/plugins/module_utils/utils.py\", line 990, in _update_object\n  File \"/usr/local/lib/python3.6/dist-packages/pynautobot/core
/response.py\", line 419, in update\n    return self.save()\n  File \"/usr/local/lib/python3.6/dist-packages/pynautobot/core/response.py\", line 391, in save\n    if req.patch({i: serialized[i] for i in diff}):\n  File \"/usr/l
ocal/lib/python3.6/dist-packages/pynautobot/core/query.py\", line 365, in patch\n    return self._make_call(verb=\"patch\", data=data)\n  File \"/usr/local/lib/python3.6/dist-packages/pynautobot/core/query.py\", line 241, in _m
ake_call\n    raise RequestError(req)\npynautobot.core.query.RequestError: The request failed with code 400 Bad Request: {'untagged_vlan': ['Mode must be set when specifying untagged_vlan']}\n",
    "module_stdout": "",
    "msg": "MODULE FAILURE\nSee stdout/stderr for the exact error",
    "rc": 1
}

0 replies

jvanderaa · 2022-11-18T14:58:43Z

jvanderaa
Nov 18, 2022
Maintainer

---
- name: TEST ANSIBLE INTERFACE DETAILS
  connection: local
  gather_facts: false
  hosts: localhost
  vars:
    nautobot_api: "http://localhost:8080"
    nautobot_token: "apitokenhere"
    nautobot_headers:
      Content-Type: "application/json"
      Authorization: "Token {{ nautobot_token }}"
    interface_id: "fdf0ec35-56ea-434e-bc0d-25e534f442a9"
  tasks:
    - name: "TASK 10: Set to Null untagged VLAN"
      ansible.builtin.uri:
        url: "{{ nautobot_api }}/api/dcim/interfaces/{{ interface_id }}/"
        method: "PATCH"
        body:
          untagged_vlan: null
        body_format: "json"
        headers: "{{ nautobot_headers }}"

    - name: "TASK 20:Set interface mode and vlan (empty)"
      networktocode.nautobot.device_interface:
        url: "{{ nautobot_api }}"
        token: "{{ nautobot_token }}"
        state: present
        device: "atl01sw01"
        name: "GigabitEthernet1/0/3"
        mode: ""

Task 10 here uses the API and ability to send just JSON with null at the interface. After the untagged VLAN is removed, then we can address changing the mode. You can also just use TASK 10 and add mode: null as a key there as well.

0 replies

jvanderaa · 2022-11-18T14:59:12Z

jvanderaa
Nov 18, 2022
Maintainer

This is definitely a bug that we need to get addressed in the modules. But for now that is a workaround.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How to set interface vlan mode to empty? #174

{{title}}

Replies: 5 comments

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

How to set interface vlan mode to empty? #174

Phill93 Nov 16, 2022

Replies: 5 comments

jvanderaa Nov 17, 2022 Maintainer

jvanderaa Nov 17, 2022 Maintainer

Phill93 Nov 18, 2022 Author

jvanderaa Nov 18, 2022 Maintainer

jvanderaa Nov 18, 2022 Maintainer

Phill93
Nov 16, 2022

jvanderaa
Nov 17, 2022
Maintainer

jvanderaa
Nov 17, 2022
Maintainer

Phill93
Nov 18, 2022
Author

jvanderaa
Nov 18, 2022
Maintainer

jvanderaa
Nov 18, 2022
Maintainer