networktocode.nautobot.platform – Create or delete platforms within Nautobot

Note

This plugin is part of the networktocode.nautobot collection (version 1.0.4).

To install it use: ansible-galaxy collection install networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.platform.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes platforms from Nautobot

Requirements

The below requirements are needed on the host that executes this module.

  • pynautobot

Parameters

Parameter Choices/Defaults Comments
data
dictionary / required
Defines the platform configuration
description
string
The description of the platform
manufacturer
raw
The manufacturer the platform will be tied to
name
string / required
The name of the platform
napalm_args
dictionary
The optional arguments used for NAPALM connections
napalm_driver
string
The name of the NAPALM driver to be used when using the NAPALM plugin
slug
string
The slugified version of the name or custom slug.
This is auto-generated following Nautobot rules if not provided
query_params
list / elements=string
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.
state
string
    Choices:
  • absent
  • present ←
Use present or absent for adding or removing.
token
string / required
The token created within Nautobot to authorize API access
url
string / required
URL of the Nautobot instance resolvable by Ansible control host
validate_certs
raw
Default:
"yes"
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create platform within Nautobot with only required information
      networktocode.nautobot.platform:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          name: Test Platform
        state: present

    - name: Create platform within Nautobot with only required information
      networktocode.nautobot.platform:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          name: Test Platform All
          manufacturer: Test Manufacturer
          napalm_driver: ios
          napalm_args:
            global_delay_factor: 2
        state: present

    - name: Delete platform within nautobot
      networktocode.nautobot.platform:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          name: Test Platform
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
msg
string
always
Message indicating failure or info about what has been achieved

platform
dictionary
success (when state=present)
Serialized object as created or already existent within Nautobot



Authors

  • Network to Code (@networktocode)