Set guest Wi-Fi password

Use this action to set a new password for the guest Wi-Fi on your FRITZ!Box. This is handy when you want to rotate the guest password on a schedule, for example to generate a fresh password each week for visitors.

You can provide your own password, or let the FRITZ!Box generate one for you.

Only users with administrator rights can run this action.

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 guest Wi-Fi password 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 list of actions, search for and select Set guest Wi-Fi password.
  6. Select the FRITZ!Box device to configure, and set any other options you want to use.
  7. Select Save.

Options in the UI

FRITZ!Box device

The FRITZ!Box to configure.

Password (Optional)

The new password for the guest Wi-Fi, between 8 and 63 characters. If you don’t set one, a password is generated for you.

Password length (Optional)

The length of the generated password, between 8 and 63 characters. Only used when you don’t provide a password. Defaults to 12.

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 fritz.set_guest_wifi_password. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: fritz.set_guest_wifi_password
data:
  device_id: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

This generates a new password of 12 characters. To set your own password, add it to the data:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: fritz.set_guest_wifi_password
data:
  device_id: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
  password: "MyGuestPassword"

Options in YAML

device_id string Required

The FRITZ!Box to configure.

password string

The new password for the guest Wi-Fi, between 8 and 63 characters. If you don’t set one, a password is generated for you.

length integer

The length of the generated password, between 8 and 63 characters. Only used when you don’t provide a password. Defaults to 12.

Good to know

  • If you don’t provide a password, the FRITZ!Box generates one of 12 characters by default. Use the password length option to change that length.
  • The password must be between 8 and 63 characters long.

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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: