Set client name

The Set client name action sets the name of a network client on your Omada controller. The name is shown in the Omada client list. Home Assistant uses the client name when creating device tracker entities for the device, which is useful for clients that only identify themselves by their MAC address or a generic hostname.

This action does not target an entity. Instead, you select the Omada device of the client and enter the new name. The client’s MAC address is taken from the device’s registered network connection.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To set the name of a network client from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select TP-Link Omada: Set client name.
6. Select the Device of the client you want to rename, and the Omada controller to use.
7. Enter the new Name for the client.
8. Select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as tplink_omada.set_client_name. A basic example looks like this:

action: tplink_omada.set_client_name
data:
  config_entry_id: "01HXYZ..."
  device_id: "d5f2a4f9f0e54f8e9b1e2a3b4c5d6e7f"
  name: "Ting sensor"

This renames the client with the given device ID to “Ting sensor” on the Omada controller.

Options in YAML

Try it yourself

Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: Name a newly discovered client

This automation renames a client to a friendly name the first time it connects to your network.

• Trigger: the client’s device tracker entity comes online
• Action: TP-Link Omada: Set client name, with the device and the new name

alias: "Name newly connected Omada client"
triggers:
  - trigger: state
    entity_id: device_tracker.my_device
    to: "home"
actions:
  - action: tplink_omada.set_client_name
    data:
      config_entry_id: "01HXYZ..."
      device_id: "{{ device_id('device_tracker.my_device') }}"
      name: "Ting sensor"

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.