supported_data_rate

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.13.0.

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

Synopsis

• Manage supported data rates in Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Defaults / Choices	Comments
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
id str		The UUID of the object to operate on Version Added: 5.13.0
mcs_index int		The Modulation and Coding Scheme (MCS) index is a value used in wireless communications to define the modulation type, coding rate, and number of spatial streams used in a transmission.
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.
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
rate int		The rate in Kbps Required if I(state=present) and the supported data rate does not exist yet
standard str	Choices: 802.11a, 802.11b, 802.11g, 802.11n, 802.11ac, 802.11ax, 802.11be	The standard of the supported data rate Required if I(state=present) and the supported data rate does not exist yet
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
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.

Notes

Note

• Tags should be defined as a YAML list
• This should be ran with connection C(local) and hosts C(localhost)

Examples

---
- name: Create a supported data rate
  networktocode.nautobot.supported_data_rate:
    url: http://nautobot.local
    token: thisIsMyToken
    standard: "802.11a"
    rate: 1000000
    state: present

- name: Delete a supported data rate
  networktocode.nautobot.supported_data_rate:
    url: http://nautobot.local
    token: thisIsMyToken
    standard: "802.11a"
    rate: 1000000
    state: absent

- name: Delete a supported data rate by id
  networktocode.nautobot.supported_data_rate:
    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 successful operation	success
supported_data_rate	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors

• Joe Wesch (@joewesch)