radio_profile¶

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 radio profiles in Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
allowed_channel_list list / elements=int		The allowed channel list of the radio profile
api_version str		API Version Nautobot REST API Version Added: 4.1.0
channel_width list / elements=int	Choices: 20, 40, 80, 160	The channel width of the radio profile
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
frequency str	Choices: 2.4GHz, 5GHz, 6GHz	The frequency of the radio profile
id str		The UUID of the object to operate on Version Added: 5.13.0
name str		The name of the radio profile Required if I(state=present) and the radio profile does not exist yet
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
regulatory_domain str		The regulatory domain of the radio profile Required if I(state=present) and the radio profile does not exist yet
rx_power_min int		The minimum receive power of the radio profile in dBm
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
supported_data_rates list / elements=raw		The supported data rates of the radio profile
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
tx_power_max int		The maximum transmit power of the radio profile in dBm
tx_power_min int		The minimum transmit power of the radio profile in dBm
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 radio profile with required fields
  networktocode.nautobot.radio_profile:
    url: http://nautobot.local
    token: thisIsMyToken
    name: "My Radio Profile"
    regulatory_domain: "US"
    state: present

- name: Create a radio profile with all fields
  networktocode.nautobot.radio_profile:
    url: http://nautobot.local
    token: thisIsMyToken
    name: "My Radio Profile"
    regulatory_domain: "US"
    channel_width: 20
    allowed_channel_list:
      - 1
      - 6
      - 11
    frequency: "2.4GHz"
    tx_power_min: 10
    tx_power_max: 20
    rx_power_min: 10
    supported_data_rates:
      - standard: "802.11a"
        rate: 1000000
        mcs_index: 10
    state: present

- name: Delete a radio profile
  networktocode.nautobot.radio_profile:
    url: http://nautobot.local
    token: thisIsMyToken
    name: "My Radio Profile"
    state: absent

- name: Delete a radio profile by id
  networktocode.nautobot.radio_profile:
    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
radio_profile	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors¶

Joe Wesch (@joewesch)