networktocode / networktocode.nautobot / 4.5.0 / module / vlan Create, update or delete vlans within Nautobot | "added in version" 1.0.0 of networktocode.nautobot" Authors: Mikhail Yohman (@FragmentedPacket)networktocode.nautobot.vlan (4.5.0) — module
Install with ansible-galaxy collection install networktocode.nautobot:==4.5.0
collections: - name: networktocode.nautobot version: 4.5.0
Creates, updates or removes vlans from Nautobot
- name: "Test Nautobot modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create vlan within Nautobot with only required information networktocode.nautobot.vlan: url: http://nautobot.local token: thisIsMyToken name: Test VLAN vid: 400 status: active state: present - name: Delete vlan within nautobot networktocode.nautobot.vlan: url: http://nautobot.local token: thisIsMyToken name: Test VLAN vid: 400 status: active state: absent - name: Create vlan with all information networktocode.nautobot.vlan: url: http://nautobot.local token: thisIsMyToken name: Test VLAN vid: 400 site: Test Site group: Test VLAN Group tenant: Test Tenant status: Deprecated vlan_role: Test VLAN Role description: Just a test tags: - Schnozzberry state: present
url: description: - 'The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)' required: true type: str vid: description: - The VLAN ID required: false type: int version_added: 3.0.0 version_added_collection: networktocode.nautobot name: description: - The name of the vlan required: true type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot site: description: - The site the VLAN will be associated to required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot tags: description: - Any tags that this item may need to be associated with elements: raw required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot state: choices: - absent - present default: present description: - Use C(present) or C(absent) for adding or removing. type: str token: description: - The token created within Nautobot to authorize API access required: true type: str status: description: - The status of the vlan - Required if I(state=present) and does not exist yet required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot tenant: description: - The tenant that the vlan will be assigned to required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot vlan_role: description: - The role of the VLAN. required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot vlan_group: description: - The VLAN group the VLAN will be associated to required: false type: raw version_added: 3.0.0 version_added_collection: networktocode.nautobot api_version: description: - API Version Nautobot REST API required: false type: str version_added: 4.1.0 version_added_collection: networktocode.nautobot description: description: - The description of the vlan required: false type: str version_added: 3.0.0 version_added_collection: networktocode.nautobot query_params: description: - This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined - in plugins/module_utils/utils.py and provides control to users on what may make - an object unique in their environment. elements: str required: false type: list version_added: 3.0.0 version_added_collection: networktocode.nautobot custom_fields: description: - Must exist in Nautobot and in key/value format required: false type: dict version_added: 3.0.0 version_added_collection: networktocode.nautobot validate_certs: default: true description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false type: raw
msg: description: Message indicating failure or info about what has been achieved returned: always type: str vlan: description: Serialized object as created or already existent within Nautobot returned: success (when I(state=present)) type: dict