Przeglądaj źródła

Refreshed wireless model documentation

jeremystretch 3 lat temu
rodzic
commit
d4f976ac8d

+ 33 - 6
docs/models/wireless/wirelesslan.md

@@ -1,11 +1,38 @@
 # Wireless LANs
 
-A wireless LAN is a set of interfaces connected via a common wireless channel. Each instance must have an SSID, and may optionally be correlated to a VLAN. Wireless LANs can be arranged into hierarchical groups, and each may be associated with a particular tenant.
+A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless [interfaces](../dcim/interface.md) can be associated with wireless LANs to model multi-acess wireless segments.
 
-An interface may be attached to multiple wireless LANs, provided they are all operating on the same channel. Only wireless interfaces may be attached to wireless LANs.
+## Fields
 
-Each wireless LAN may have authentication attributes associated with it, including:
+### SSID
 
-* Authentication type
-* Cipher
-* Pre-shared key
+The service set identifier (SSID) for the wireless network.
+
+### Group
+
+The [wireless LAN group](./wirelesslangroup.md) to which this wireless LAN is assigned (if any).
+
+### VLAN
+
+Each wireless LAN can optionally be mapped to a [VLAN](../ipam/vlan.md), to model a bridge between wired and wireless segments.
+
+### Authentication Type
+
+The type of wireless authentication in use. Options include:
+
+* Open
+* WEP
+* WPA Personal (PSK)
+* WPA Enterprise
+
+### Authentication Cipher
+
+The security cipher used to apply wireless authentication. Options include:
+
+* Auto (automatic)
+* TKIP
+* AES
+
+### Pre-Shared Key
+
+The security key configured on each client to grant access to the secured wireless LAN. This applies only to certain authentication types.

+ 15 - 1
docs/models/wireless/wirelesslangroup.md

@@ -1,3 +1,17 @@
 # Wireless LAN Groups
 
-Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, each wireless LAN may assigned only to one group.
+Wireless LAN groups can be used to organize and classify [wireless LANs](./wirelesslan.md). These groups are hierarchical: groups can be nested within parent groups. However, each wireless LAN may be assigned only to one group.
+
+## Fields
+
+### Parent
+
+The parent wireless LAN group (if any).
+
+### Name
+
+A unique human-friendly name.
+
+### Slug
+
+A unique URL-friendly identifier. (This value can be used for filtering.)

+ 38 - 5
docs/models/wireless/wirelesslink.md

@@ -1,9 +1,42 @@
 # Wireless Links
 
-A wireless link represents a connection between exactly two wireless interfaces. It may optionally be assigned an SSID and a description. It may also have a status assigned to it, similar to the cable model. Each wireless link may also be assigned to a particular tenant.
+A wireless link represents a connection between exactly two wireless interfaces. Unlike a [wireless LAN](./wirelesslan.md), which permit an arbitrary number of client associations, wireless links are used to model point-to-point wireless connections.
 
-Each wireless link may have authentication attributes associated with it, including:
+## Fields
 
-* Authentication type
-* Cipher
-* Pre-shared key
+### Interfaces
+
+Select two interfaces: One for side A and one for side B. (Both must be wireless interfaces.)
+
+### Status
+
+The operational status of the link. Options include:
+
+* Connected
+* Planned
+* Decommissioning
+
+### SSID
+
+The service set identifier (SSID) for the wireless link (optional).
+
+### Authentication Type
+
+The type of wireless authentication in use. Options include:
+
+* Open
+* WEP
+* WPA Personal (PSK)
+* WPA Enterprise
+
+### Authentication Cipher
+
+The security cipher used to apply wireless authentication. Options include:
+
+* Auto (automatic)
+* TKIP
+* AES
+
+### Pre-Shared Key
+
+The security key configured on each client to grant access to the secured wireless LAN. This applies only to certain authentication types.