networktocode.nautobot.device module – Create, update or delete devices within Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install networktocode.nautobot
.
To use it in a playbook, specify: networktocode.nautobot.device
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates, updates or removes devices from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
Asset tag that is associated to the device |
|
Cluster that the device will be assigned to |
|
Comments that may include additional information in regards to the device |
|
must exist in Nautobot |
|
Required if state=present and the device does not exist yet |
|
Required if state=present and the device does not exist yet |
|
Required if rack is defined Choices:
|
|
Arbitrary JSON data to define the devices configuration variables. |
|
The name of the device |
|
The platform of the device |
|
The position of the device in the rack defined above |
|
Primary IPv4 address assigned to the device |
|
Primary IPv6 address assigned to the device |
|
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. |
|
The name of the rack to assign the device to |
|
Serial number of the device |
|
Required if state=present and the device does not exist yet |
|
Use Choices:
|
|
The status of the device Required if state=present and the device does not exist yet |
|
Any tags that the device may need to be associated with |
|
The tenant that the device will be assigned to |
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
If Default: “yes” |
|
Position in the assigned virtual chassis |
|
Priority in the assigned virtual chassis |
|
Virtual chassis the device will be assigned to |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test Nautobot modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create device within Nautobot with only required information
networktocode.nautobot.device:
url: http://nautobot.local
token: thisIsMyToken
name: Test Device
device_type: C9410R
device_role: Core Switch
site: Main
status: active
state: present
- name: Create device within Nautobot with empty string name to generate UUID
networktocode.nautobot.device:
url: http://nautobot.local
token: thisIsMyToken
name: ""
device_type: C9410R
device_role: Core Switch
site: Main
status: active
state: present
- name: Delete device within nautobot
networktocode.nautobot.device:
url: http://nautobot.local
token: thisIsMyToken
name: Test Device
state: absent
- name: Create device with tags
networktocode.nautobot.device:
url: http://nautobot.local
token: thisIsMyToken
name: Another Test Device
device_type: C9410R
device_role: Core Switch
site: Main
status: active
local_context_data:
bgp: "65000"
tags:
- Schnozzberry
state: present
- name: Update the rack and position of an existing device
networktocode.nautobot.device:
url: http://nautobot.local
token: thisIsMyToken
name: Test Device
rack: Test Rack
position: 10
face: Front
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within Nautobot Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |