update_port_profile
update_port_profile
Section titled “update_port_profile”Patch fields on an existing port profile.
Side effects:
- Modifies the named profile in place. Every switch port currently using the profile picks up the new behaviour on the next provision (typically within seconds).
- Changing
native_networkconf_idmay move powered devices to a different VLAN. - Mutates controller state. Use dry_run=True to preview the change without applying.
Example
Section titled “Example”update_port_profile(profile_id="65f...", updates={"poe_mode": "off"})Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profile_id |
string |
yes | — | The _id from list_port_profiles. |
updates |
object |
yes | — | Partial profile record. Common keys: name, forward, poe_mode, native_networkconf_id, tagged_networkconf_ids. |
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. |