software_version¶

Collection Note

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

ansible-galaxy collection install networktocode.nautobot

Added in version 5.7.0.

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	Defaults / Choices	Comments
alias str		Optional alternative label for this version
api_version str		API Version Nautobot REST API Version Added: 4.1.0
contacts dict		Associate contacts Version Added: 6.3.0
contacts.objects		List of contacts to associate.
contacts.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
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
id str		The UUID of the object to operate on Version Added: 5.13.0
long_term_support bool		Whether the software is long term support
notes dict		Manage notes on the object Version Added: 6.3.0
notes.objects		List of notes to manage.
notes.state	Default: merge Choices: merge, replace, delete	C(merge) adds notes without removing existing ones. C(replace) enforces exactly the listed notes, removing any extras. C(delete) removes the listed notes.
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 / elements=str		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	Default: present Choices: absent, present	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 / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams dict		Associate teams Version Added: 6.3.0
teams.objects		List of teams to associate.
teams.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url str required		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	Default: True	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 str		The version of the software Required if I(state=present) and the software version does not exist yet

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

- name: Delete a software version by id
  networktocode.nautobot.software_version:
    url: http://nautobot.local
    token: thisIsMyToken
    id: 00000000-0000-0000-0000-000000000000
    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)