Files
terraform-provider-unifi/docs/resources/user.md
Mateusz Filipowicz 325d7b7f20 feat: initialize Terraform Plugin Framework (#23)
* feat: initialize Terraform Plugin Framework

* fix docker-compose path for tests

* fix: ensure documentation can be generated with old provider SDK and new plugin framework

* lint
2025-02-24 00:11:41 +01:00

2.1 KiB

page_title, subcategory, description
page_title subcategory description
unifi_user Resource - terraform-provider-unifi unifi_user manages a user (or "client" in the UI) of the network, these are identified by unique MAC addresses. Users are created in the controller when observed on the network, so the resource defaults to allowing itself to just take over management of a MAC address, but this can be turned off.

unifi_user (Resource)

unifi_user manages a user (or "client" in the UI) of the network, these are identified by unique MAC addresses.

Users are created in the controller when observed on the network, so the resource defaults to allowing itself to just take over management of a MAC address, but this can be turned off.

Example Usage

resource "unifi_user" "test" {
  mac  = "01:23:45:67:89:AB"
  name = "some client"
  note = "my note"

  fixed_ip   = "10.0.0.50"
  network_id = unifi_network.my_vlan.id
}

Schema

Required

  • mac (String) The MAC address of the user.
  • name (String) The name of the user.

Optional

  • allow_existing (Boolean) Specifies whether this resource should just take over control of an existing user. Defaults to true.
  • blocked (Boolean) Specifies whether this user should be blocked from the network.
  • dev_id_override (Number) Override the device fingerprint.
  • fixed_ip (String) A fixed IPv4 address for this user.
  • local_dns_record (String) Specifies the local DNS record for this user.
  • network_id (String) The network ID for this user.
  • note (String) A note with additional information for the user.
  • site (String) The name of the site to associate the user with.
  • skip_forget_on_destroy (Boolean) Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to false.
  • user_group_id (String) The user group ID for the user.

Read-Only

  • hostname (String) The hostname of the user.
  • id (String) The ID of the user.
  • ip (String) The IP address of the user.