plugin¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates, removes or updates various plugin objects in Nautobot

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Data Type	Comments
api_version	str	API Version Nautobot REST API Version Added: 4.1.0
attrs	dict	Object attributes other than identifier to create or update an object, like description, etc. Version Added: 4.4.0
endpoint required	str	Plugin object API endpoint Version Added: 4.4.0
identifiers required	dict	Plugin object identifier(s) like name, model, etc. Version Added: 4.4.0
plugin required	str	Plugin API base url Version Added: 4.4.0
query_params	list	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. Version Added: 3.0.0
state	str	Use C(present) or C(absent) for adding or removing.
token required	str	The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url required	str	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs	raw	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes¶

Note

Task must have defined plugin base api url and object endpoint

Examples¶

- name: &#34;Test Nautobot Plugin Module&#34;
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create LCM CVE
      networktocode.nautobot.plugin:
        url: http://nautobot.local
        token: thisIsMyToken
        plugin: nautobot-device-lifecycle-mgmt
        endpoint: cve
        identifiers:
          name: CVE-2020-7777
        attrs:
          published_date: 2020-09-25
          link: https://tools.cisco.com/security/center/content/CiscoSecurityAdvisory
        state: present

    - name: Modify LCM CVE
      networktocode.nautobot.plugin:
        url: http://nautobot.local
        token: thisIsMyToken
        plugin: nautobot-device-lifecycle-mgmt
        endpoint: cve
        identifiers:
          name: CVE-2020-7777
        attrs:
          published_date: 2020-09-25
          link: https://tools.cisco.com/security/center/content/CiscoSecurityAdvisory/12345678
        state: present

    - name: Delete LCM CVE
      networktocode.nautobot.plugin:
        url: http://nautobot.local
        token: thisIsMyToken
        plugin: nautobot-device-lifecycle-mgmt
        endpoint: cve
        identifiers:
          name: CVE-2020-7777
        state: absent

    - name: Create GC compliance-feature
      networktocode.nautobot.plugin:
        url: http://nautobot.local
        token: thisIsMyToken
        plugin: golden-config
        endpoint: compliance-feature
        ids:
          name: AAA
        attrs:
          description: &#34;Authentication Administration Accounting&#34;
        state: present

    - name: Create FW address-object
      networktocode.nautobot.plugin:
        url: http://nautobot.local
        token: thisIsMyToken
        plugin: firewall
        endpoint: address-object
        ids:
          name: access-point
        attrs:
          ip_address:
            address: 10.0.0.0/32
        state: present

    - name: Delete FW address-object
      networktocode.nautobot.plugin:
        url: http://nautobot.local
        token: thisIsMyToken
        plugin: firewall
        endpoint: address-object
        ids:
          name: access-point
        state: absent

Return Values¶

Key	Data Type	Description	Returned
endpoint	dict	Serialized object as created/existent/updated/deleted within Nautobot	always
msg	str	Message indicating failure or info about what has been achieved	always

Authors¶

Network To Code (@networktocode)
Patryk Szulczewski (@pszulczewski)