terraform-provider-netbird/docs/data-sources/peer.md

page_title, subcategory, description

page_title	subcategory	description
netbird_peer Data Source - netbird		Read Peer information.

netbird_peer (Data Source)

Read Peer information.

Example Usage

# Retrieve by IP
data "netbird_peer" "example" {
  ip = "1.2.3.4"
}

# Retrieve by Name
data "netbird_peer" "example" {
  name = "Production"
}

# Retrieve by ID
data "netbird_peer" "example" {
  id = "d057h0jl0ubs73cftnp0"
}

Schema

Optional

• id (String) Peer ID
• ip (String) Peer IP
• name (String) Peer Name

Read-Only

• approval_required (Boolean) Indicates whether peer needs approval
• 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
• inactivity_expiration_enabled (Boolean) Enable inactivity expiration for peer
• kernel_version (String) Peer Kernel Version
• last_login (String) Time of peer last login
• last_seen (String) Peer Last Seen timedate
• login_expiration_enabled (Boolean) Indicates whether login expiration is enabled for peer
• login_expired (Boolean) Indicates whether peer login is expired
• os (String) Peer OS
• serial_number (String) Peer device serial number
• ssh_enabled (Boolean) Enable SSH to Peer
• ui_version (String) Peer UI Version
• user_id (String) User ID of peer
• version (String) Peer Version