software_version¶

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, updates or removes software versions from Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Data Type	Comments
alias	str	Optional alternative label for this version
api_version	str	API Version Nautobot REST API Version Added: 4.1.0
custom_fields	dict	Must exist in Nautobot and in key/value format Version Added: 3.0.0
documentation_url	str	URL to the software documentation
end_of_support_date	str	The date the software will no longer be supported
long_term_support	bool	Whether the software is long term support
platform	raw	The platform the software will be applied to Required if I(state=present) and does not exist yet
pre_release	bool	Whether the software is pre-release
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
release_date	str	The date the software was released
state	str	Use C(present) or C(absent) for adding or removing.
status	str	The status of the software Required if I(state=present) and does not exist yet
tags	list	Any tags that this item may need to be associated with Version Added: 3.0.0
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.
version required	str	The version of the software

Notes¶

Note

This module requires Nautobot v2.2+
This should be ran with connection C(local) and hosts C(localhost)
Tags should be defined as a YAML list

Examples¶

---
- name: Create a software version
  networktocode.nautobot.software_version:
    url: http://nautobot.local
    token: thisIsMyToken
    version: 1.0.0
    platform: Cisco IOS
    status: Active
    alias: My Alias
    release_date: 2024-01-01
    end_of_support_date: 2024-12-31
    documentation_url: https://example.com
    long_term_support: true
    pre_release: false
    state: present

- name: Update a software version
  networktocode.nautobot.software_version:
    url: http://nautobot.local
    token: thisIsMyToken
    version: 1.0.0
    state: present

- name: Delete a software version
  networktocode.nautobot.software_version:
    url: http://nautobot.local
    token: thisIsMyToken
    version: 1.0.0
    state: absent

Return Values¶

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
software_version	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors¶

Joe Wesch (@joewesch)