terraform-provider-netbird/docs/resources/peer.md

page_title, subcategory, description

page_title	subcategory	description
netbird_peer Resource - netbird		NetBird peer is a machine that runs the NetBird agent and is connected to the network. This resource doesn't create the Peer itself but manages it.

netbird_peer (Resource)

NetBird peer is a machine that runs the NetBird agent and is connected to the network. This resource doesn't create the Peer itself but manages it.

Example Usage

resource "netbird_group" "example" {
  name = "Test"
}

resource "netbird_peer" "example" {
  id                            = "d057h0jl0ubs73cftnp0"
  ssh_enabled                   = false
  name                          = "Production"
  inactivity_expiration_enabled = false
  approval_required             = false
  login_expiration_enabled      = false
}

Schema

Required

• id (String) Peer ID

Optional

• approval_required (Boolean) Indicates whether peer needs approval
• inactivity_expiration_enabled (Boolean) Enable inactivity expiration for peer
• login_expiration_enabled (Boolean) Indicates whether login expiration is enabled for peer
• name (String) Peer Name
• ssh_enabled (Boolean) Enable SSH to Peer

Read-Only

• city_name (String) Peer city name
• connected (Boolean) Peer Connection Status
• connection_ip (String) Peer Public IP
• country_code (String) Peer country code
• dns_label (String) Peer DNS Label
• extra_dns_labels (List of String) Peer extra DNS Labels
• geoname_id (Number) Peer Location ID
• groups (List of String) Peer groups
• hostname (String) Peer's HOSTNAME
• ip (String) Peer IP
• kernel_version (String) Peer Kernel Version
• last_login (String) Time of peer last login
• last_seen (String) Peer Last Seen timedate
• login_expired (Boolean) Indicates whether peer login is expired
• os (String) Peer OS
• serial_number (String) Peer device serial number
• ui_version (String) Peer UI Version
• user_id (String) User ID of peer
• version (String) Peer Version