rename_device
rename_device
Section titled “rename_device”Rename an adopted UniFi device (AP, switch, or gateway).
Side effects:
- Cosmetic only: changes the display name in the controller and in tool output. No RF or traffic impact, no client disconnects.
- Mutates controller state. Use dry_run=True to preview the change without applying.
Example
Section titled “Example”rename_device(device_mac="aa:bb:cc:00:00:02", name="Bedroom AP")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
device_mac |
string |
yes | — | Device MAC address (from list_devices). |
name |
string |
yes | — | New display name. Must be non-empty. |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |
dry_run |
boolean |
no | false | Preview the change without applying it. Returns the predicted change set. |