summaryrefslogtreecommitdiffstats
path: root/src/plugins/yang/openconfig/openconfig-wifi-types.yang
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/yang/openconfig/openconfig-wifi-types.yang')
-rw-r--r--src/plugins/yang/openconfig/openconfig-wifi-types.yang295
1 files changed, 295 insertions, 0 deletions
diff --git a/src/plugins/yang/openconfig/openconfig-wifi-types.yang b/src/plugins/yang/openconfig/openconfig-wifi-types.yang
new file mode 100644
index 0000000..01bf89c
--- /dev/null
+++ b/src/plugins/yang/openconfig/openconfig-wifi-types.yang
@@ -0,0 +1,295 @@
+module openconfig-wifi-types {
+
+ yang-version "1";
+
+ // namespace
+ namespace "http://openconfig.net/yang/wifi/types";
+
+ // Assign this module a prefix to be used by other modules, when imported.
+ prefix "oc-wifi-types";
+
+ import openconfig-extensions { prefix oc-ext; }
+
+ // Some required meta
+ organization "OpenConfig working group";
+
+ contact
+ "OpenConfig working group
+ www.openconfig.net";
+
+ description
+ "This module contains a set of WiFi-specific type definitions
+ that are used in the openconfig-wifi modules. It can be
+ imported by any module to make use of these types.";
+
+ oc-ext:openconfig-version "0.1.0";
+
+ revision "2017-07-25" {
+ description
+ "Initial revision";
+ reference "0.1.0";
+ }
+
+ //typdef statements
+ typedef channels-type {
+ type uint8 {
+ range "1..14 | 36 | 40 | 44| 48 | 52 | 56 | 60 | 64 | 100 | 104 | 108 | 112 | 116 | 120 | 124 | 128 | 132 | 136 | 140 | 144 | 149 | 153 | 157 | 161 | 165";
+ }
+ description
+ "Type to specify all the WiFi channels available for use. This is
+ a superset of what may be allowed by any one particular regulatory
+ domain.";
+ }
+
+ // identity statements
+ identity CLIENT_STATE {
+ description
+ "Base type to specify the current state of a Client.";
+ }
+
+ identity ASSOCIATED {
+ base CLIENT_STATE;
+ description
+ "Client has finished 802.11 Association phase. This implies 'Open' system,
+ or 802.11 Authentication complete.";
+ }
+
+ identity L2AUTH_REQD {
+ base CLIENT_STATE;
+ description
+ "Client has Assocated, but not L2 Authenticated (e.g. 802.1X)";
+ }
+
+ identity L3AUTH_REQD {
+ base CLIENT_STATE;
+ description
+ "Client has Assocated, but not L3 Authenticated (e.g. Captive Portal)";
+ }
+
+ identity DHCP_REQD {
+ base CLIENT_STATE;
+ description
+ "Client has Associated & Authenticated, but has not obtained IP address.";
+ }
+
+ identity AUTHENTICATED {
+ base CLIENT_STATE;
+ description
+ "Client has fully Authenticated & permitted to access network resources.";
+ }
+
+ identity L2AUTH_FAILURE_REJECT {
+ base CLIENT_STATE;
+ description
+ "L2 failure, due to RADIUS Access-Reject.";
+ }
+
+ identity L2AUTH_FAILURE_TIMEOUT {
+ base CLIENT_STATE;
+ description
+ "L2 failure, due to RADIUS timeout.";
+ }
+
+ identity L3AUTH_FAILURE {
+ base CLIENT_STATE;
+ description
+ "L3 failure. Could be incorrect CP credentials or higher layer
+ Captive Portal issues.";
+ }
+
+ identity DHCP_FAILURE {
+ base CLIENT_STATE;
+ description
+ "Client has Associated & Authenticated but has failed to recieve an IP
+ address, utilizing DHCP.";
+ }
+
+ identity POWERSAVE {
+ base CLIENT_STATE;
+ description
+ "AP has recieved a PS frame, indicating the client is currently in a
+ powersave state.";
+ }
+
+ identity BLACKLISTED {
+ base CLIENT_STATE;
+ description
+ "This client has been blacklisted, through either L2 (MAC) or higher-level
+ (signature) mechanisms.";
+ }
+
+ identity AP_STATE {
+ description "The Up/Down state of an AP.";
+ }
+
+ identity UP {
+ base AP_STATE;
+ description
+ "The AP is in the up state.";
+ }
+
+ identity DOWN {
+ base AP_STATE;
+ description
+ "The AP is in the down state.";
+ }
+
+ identity UPGRADING {
+ base AP_STATE;
+ description
+ "The AP is in the Downgrading firmware state.";
+ }
+
+ // Possible basic-rates are: 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54 //
+ identity DATA_RATE {
+ description "base type to specify available Data-rates.";
+ }
+
+ identity RATE_1MB {
+ base DATA_RATE;
+ description "1 Mbps DSSS PHY";
+ }
+
+ identity RATE_2MB {
+ base DATA_RATE;
+ description "2 Mbps DSSS PHY";
+ }
+
+ identity RATE_5.5MB {
+ base DATA_RATE;
+ description "5.5 Mbps DSSS PHY";
+ }
+
+ identity RATE_6MB {
+ base DATA_RATE;
+ description "6 Mbps OFDM PHY";
+ }
+
+ identity RATE_9MB {
+ base DATA_RATE;
+ description "9 Mbps OFDM PHY";
+ }
+
+ identity RATE_11MB {
+ base DATA_RATE;
+ description "11 Mbps DSSS PHY";
+ }
+
+ identity RATE_12MB {
+ base DATA_RATE;
+ description "12 Mbps OFDM PHY";
+ }
+
+ identity RATE_18MB {
+ base DATA_RATE;
+ description "18 Mbps OFDM PHY";
+ }
+
+ identity RATE_24MB {
+ base DATA_RATE;
+ description "24 Mbps OFDM PHY";
+ }
+
+ identity RATE_36MB {
+ base DATA_RATE;
+ description "36 Mbps OFDM PHY";
+ }
+
+ identity RATE_48MB {
+ base DATA_RATE;
+ description "48 Mbps OFDM PHY";
+ }
+
+ identity RATE_54MB {
+ base DATA_RATE;
+ description "54 Mbps OFDM PHY";
+ }
+
+ identity OPERATING_FREQUENCY {
+ description "Operating frequency of a Radio or SSID.";
+ }
+
+ identity FREQ_2GHZ {
+ base OPERATING_FREQUENCY;
+ description "The Radio or SSID will operate at 2.4GHz only.";
+ }
+
+ identity FREQ_5GHZ {
+ base OPERATING_FREQUENCY;
+ description "The Radio or SSID will operate at 5GHz only.";
+ }
+
+ identity FREQ_2_5_GHZ {
+ base OPERATING_FREQUENCY;
+ description
+ "The Radio or SSID will be dual-band; operating in
+ both 2.4 & 5GHz frequencies.
+
+ Dual-band Radio typically refers to a Monitor-mode radio, hopping
+ between frequencies, dwelling for a configurable amount of time on
+ each frequency.";
+ }
+
+ identity CLIENT_CAPABILITIES {
+ description
+ "Client capabilities, as reported by Assoc. Req. or
+ Probe Req. frames.";
+ }
+
+ identity MU_BEAMFORMER {
+ base CLIENT_CAPABILITIES;
+ description "Whether this STA can MU-MIMO Beamform.";
+ }
+
+ identity MU_BEAMFORMEE {
+ base CLIENT_CAPABILITIES;
+ description "Whether this STA can Rx MU-MIMO Beamformed frames.";
+ }
+
+ identity DOT_11R {
+ base CLIENT_CAPABILITIES;
+ description
+ "Whether this STA supports 802.11r. Note, must be
+ enabled on BSS for this to be accurate.";
+ }
+
+ identity DOT_11V {
+ base CLIENT_CAPABILITIES;
+ description
+ "Whether this STA supports 802.11v BSS Transition. Note, must
+ be enabled on BSS for this to be accurate; unless Probe Req.
+ are observied in addition to Assoc. Req.";
+ }
+
+ identity CHANGE_REASON_TYPE {
+ description
+ "Base type to specify the reason an Access Point
+ has changed channels.";
+ }
+ identity DFS {
+ base CHANGE_REASON_TYPE;
+ description
+ "DFS hit occured.";
+ }
+
+ identity NOISE {
+ base CHANGE_REASON_TYPE;
+ description
+ "Excessive amounts of non-802.11 Noise occured.";
+ }
+
+ identity ERRORS {
+ base CHANGE_REASON_TYPE;
+ description
+ "Excessive reception of frames which
+ failed the FCS occured.";
+ }
+
+ identity BETTER-CHANNEL {
+ base CHANGE_REASON_TYPE;
+ description
+ "A less utilized channel exists. eg CCI avoidance
+ led to this channel-change.";
+ }
+ // Extend channel-change reasons here, when applicable.
+} \ No newline at end of file