get_network_details
get_network_details
Section titled “get_network_details”Show one network’s full record, grouped into readable sections.
Side effects: None (read-only). This is the deep view that complements
list_networks (the summary). Use it to inspect a network’s DHCP
scope, IPv6 configuration, and VPN fields before editing with
update_vlan / set_lan_ipv6.
Resolve the network by network_id (preferred, from
list_networks) or by name (case-insensitive; errors if the name
is ambiguous). Returns:
network: identity fields (_id,name,purpose,vlan,vlan_enabled,ip_subnet,enabled,networkgroup).dhcp: everydhcpd_*key (lease window, gateway/DNS toggles, lease time, NTP/WINS) plus the IPv6 DHCP (dhcpdv6_*) keys.ipv6: the LAN IPv6 view:ipv6_interface_type,ipv6_ra_enabled,ipv6_client_address_assignment,ipv6_pd_start/ipv6_pd_stop(the delegated-prefix window), and the RA tuning keys. Empty section on a network with no IPv6.vpn: VPN-related keys (vpn_type,*_vpn_*,remote_vpn_*) when the network is a VPN; empty otherwise.raw: the complete unfiltered record, so nothing is hidden.
Example
Section titled “Example”get_network_details(name="Default")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
network_id | string | no | "" | The _id from list_networks. Wins over name when both are given. |
name | string | no | "" | Network display name (case-insensitive) as an alternative to network_id. Errors if more than one network matches. |
controller | string | no | ”default” | Name of the UniFi controller to target. Defaults to "default". |