Enums
Overview
Enums represent a fixed set of allowed values for a field or argument.
AlertTargetType
An enumeration of possible alert target types.
| Value | Description |
|---|---|
EMAIL | Alert target type indicating an email address. |
SALESFORCE | Alert target type indicating a salesforce instance. |
SLACK | Alert target type indicating a slack channel. |
WEBHOOK | Alert target type indicating a webhook endpoint. |
CaptivePortalEntryAction
| Value | Description |
|---|---|
APPROVE | Approve the captive portal entry. |
DELETE_DATA | Delete the collected data of the captive portal entry |
DENY | Deny the captive portal entry. |
ClientAssignmentProtocol
ClientAssignmentProtocol defines the method used to assign IP addresses to clients.
| Value | Description |
|---|---|
DHCP | DHCP protocol assigns IP addresses dynamically to clients. |
STATIC | Static protocol assigns fixed IP addresses to clients. |
DeviceModel
DeviceModel enumerates the different model names of devices that Meter deploys.
| Value | Description |
|---|---|
A1 | |
A2 | |
F1 | |
F2 | |
F3 | |
G1 | |
MC01 | |
MC05 | |
MC06 | |
MC11 | |
MP01 | |
MS07 | |
MS10 | |
MS11 | |
MS12 | |
MW02 | |
MW03 | |
MW04 | |
MW05 | |
MW06 | |
MW07 | |
MW08 | |
MW09 | |
P1 | |
PSGS1518AF | |
PSGS1526F | |
PSGS1626GF | |
PSGS2326KF | |
PSGS2852BF | |
PSGS2852XBF | |
PSGS2852XBL | |
S1 | |
S2 | |
S3 | |
S4 |
DeviceType
DeviceType enumerates the different types of hardware devices that Meter deploys.
| Value | Description |
|---|---|
ACCESS_POINT | Represents an Access Point device type. |
CELLULAR_GATEWAY | Represents a Cellular Gateway device type. |
CONTROLLER | Represents a Controller device type. |
POWER_DISTRIBUTION_UNIT | Represents a Power Distribution Unit device type. |
SWITCH | Represents a Switch device type. |
EventType
Enumerate the known event types that exist in the event log.
| Value | Description |
|---|---|
ACCESS_POINT_CONNECTION | Event indicating a wireless connection event on an access point. |
ACCESS_POINT_DFS_CHANNEL_RESET | Event indicating that a DFS channel reset occurred on an access point. |
ACCESS_POINT_INVALID_VLAN_CONNECTION | Event indicating a connection on an invalid (unknown or disabled) VLAN |
ACCESS_POINT_RADAR_HIT_DETECTED | Event indicating that a DFS radar hit was detected by an access point. |
CALIBRATION_JOB_CHANNEL_RESET_FAILED | Event indicating that APs failed to return to their configured channel after a wireless calibration job. |
CALIBRATION_JOB_COMPLETED | Event indicating that a wireless calibration job completed. |
COS_HA_FAILOVER | Event indicating that a High Availability failover event occurred. |
COS_HA_MULTIPLE_ACTIVE | Event indicating that multiple Security Appliances are active in a High Availability setup. |
COS_HA_RECOVERY | Event indicating that a High Availability recovery event occurred. |
DEVICE_BOOT | Event indicating that a device booted with a specific version of the firmware. |
DEVICE_OFFLINE | Event indicating that a device has gone offline. |
DEVICE_ONLINE | Event indicating that a device has come online. |
FIRMWARE_UPGRADE_CANCELLED | Event indicating that a firmware upgrade was cancelled on a network. |
FIRMWARE_UPGRADE_COMPLETED | Event indicating that a firmware upgrade is completed on a network. |
FIRMWARE_UPGRADE_PENDING | Event indicating that a firmware upgrade is pending on a network. An upgrade has been applied to the respective device configs and should immediately take affect, given that these devices are online. |
FIRMWARE_UPGRADE_SCHEDULED | Event indicating that a firmware upgrade is scheduled on a network. An upgrade is scheduled for sometime in the future when and no device config change has been made, but will at the scheduled time. |
HONEYPOT_ACCESS_POINT_DETECTED | Event indicating that a honeypot access point was detected. |
HONEYPOT_ACCESS_POINT_NO_LONGER_DETECTED | Event indicating that a honeypot access point is no longer detected. |
IPSEC_TUNNEL_STATUS_CHANGE | Event indicating that an IPSec tunnel had a status change. |
MANAGEMENT_CONNECTION_STATUS_CHANGED | Event indicating that a management connection status changed. |
PDU_OUTLET_STATUS_CHANGED | Event indicating that a PDU outlet event occurred. |
PORT_BLOCKED | Event indicating that a port was blocked due to flap link intervention protocol (FLIP). |
PORT_UNBLOCKED | Event indicating that a port was unblocked due to flap link intervention protocol (FLIP). |
RADIUS_POLLER_OK | Event indicating that RADIUS servers are reachable. |
RADIUS_POLLER_UNREACHABLE | Event indicating that RADIUS server are unreachable. |
ROGUE_ACCESS_POINT_DETECTED | Event indicating that a rogue access point was detected. |
ROGUE_ACCESS_POINT_NO_LONGER_DETECTED | Event indicating that a rogue access point is no longer detected. |
STP_ERROR_PORT_BLOCKED | Event indicating that a Spanning Tree Protocol (STP) error caused a port to be blocked. |
STP_ERROR_PORT_UNBLOCKED | Event indicating that a Spanning Tree Protocol (STP) error on a port has been unblocked. |
UNSPECIFIED | The event type is unspecified. |
WAN_DOWN | Event indicating that the WAN connection is down. |
WAN_STATUS_CHANGE | Event indicating a change in WAN status. |
WAN_UP | Event indicating that the WAN connection is up. |
FirewallRuleAction
Possible actions for a firewall rule.
| Value | Description |
|---|---|
DENY | Deny the traffic. |
PERMIT | Permit the traffic. |
FloorPlanDocumentCategory
| Value | Description |
|---|---|
FLOOR_PLAN | A floor plan |
SITE_DOCUMENTATION | Any non-floor plan documentation relevant to the site. |
IDSEventAlertAction
| Value | Description |
|---|---|
ALLOWED | Action is allowed. |
BLOCKED | Action is blocked. |
UNSPECIFIED | Action is unknown. |
IDSEventDirection
| Value | Description |
|---|---|
TO_CLIENT | Direction is to client. |
TO_SERVER | Direction is to server. |
UNSPECIFIED | Direction is unknown. |
IDSEventProtocol
| Value | Description |
|---|---|
AH | Protocol is AH. |
ANY | Protocol is ANY. |
ESP | Protocol is ESP. |
ICMP | Protocol is ICMP. |
TCP | Protocol is TCP. |
UDP | Protocol is UDP. |
UNSPECIFIED | Protocol is unknown. |
IDSEventType
| Value | Description |
|---|---|
DETECT | Detect |
IB_PROTECT | Inline IPS. |
OOB_PROTECT | Out-of-band firewall rule. |
UNSPECIFIED | Unknown |
IDSIPSMode
| Value | Description |
|---|---|
IDS | Intrusion Detection System mode |
IPS | Intrusion Prevention System mode |
IDSIPSSuppressedRuleDirection
| Value | Description |
|---|---|
DESTINATION | Destination |
EITHER | Either |
SOURCE | Source |
IPProtocol
Supported IP protocols for firewall rules.
| Value | Description |
|---|---|
ALL | All protocols. |
ICMP | Internet Control Message Protocol. |
TCP | Transmission Control Protocol. |
UDP | User Datagram Protocol. |
ImageType
An enumeration of supported image types.
| Value | Description |
|---|---|
GIF | Graphics Interchange Format. |
JPEG | Joint Photographic Experts Group format. |
PNG | Portable Network Graphics format. |
SVG | Scalable Vector Graphics format. |
NetworkClientHWMode
Represents the hardware mode of a device the client is connected to.
| Value | Description |
|---|---|
NA | Represents no HW mode. |
WIFI_2 | Represents WiFi 2 HW mode. |
WIFI_3 | Represents WiFi 3 HW mode. |
WIFI_4 | Represents WiFi 4 HW mode. |
WIFI_5 | Represents WiFi 5 HW mode. |
WIFI_6 | Represents WiFi 6 HW mode. |
WIFI_7 | Represents WiFi 7 HW mode. |
RadioBand
An enumeration of radio bands.
| Value | Description |
|---|---|
BAND_2_4G | Represents the 2.4 GHz radio band. |
BAND_5G | Represents the 5 GHz radio band. |
BAND_6G | Represents the 6 GHz radio band. |
SSIDEncryptionProtocol
| Value | Description |
|---|---|
OPEN_MAC_AUTH_RADIUS | Open network with MAC address authentication via RADIUS. |
WPA2 | Wi-Fi Protected Access II (WPA2) Personal. |
WPA2_ENTERPRISE | WPA2 Enterprise with 802.1X authentication. |
WPA2_IPSK | SSID with multiple WPA2 passwords (iPSKs) |
WPA2_MPSK | SSID with MPSK (Radius-based iPSK solution in partnership with RoamingIQ) |
WPA3 | WPA3 Personal. |
WPA3_ENTERPRISE | WPA3 Enterprise with 802.1X authentication. |
WPA3_OWE | WPA3 OWE (Open). |
WPA3_TRANSITION | Supports clients that use WPA2 or WPA3. |
TrafficDirection
Represents the direction of network traffic.
| Value | Description |
|---|---|
RX | Incoming traffic direction (Received traffic). |
TX | Outgoing traffic direction (Transmitted traffic). |
VirtualDeviceType
VirtualDeviceType enumerates the different types of virtual devices that Meter deploys.
| Value | Description |
|---|---|
ACCESS_POINT | Represents an Access Point virtual device type. |
CELLULAR_GATEWAY | Represents an Cellular Gateway virtual device type. |
CONTROLLER | Represents a Controller virtual device type. |
OBSERVER | Represents an Observer virtual device type. |
POWER_DISTRIBUTION_UNIT | Represents a Power Distribution Unit virtual device type. |
SWITCH | Represents a Switch virtual device type. |
WirelessClientConnectionEventType
| Value | Description |
|---|---|
ARP_FAILED | The client failed to connect to the AP due to an ARP failure. |
ARP_LATE | The client failed to connect to the AP due to ARP taking too long. |
CONNECTED | The client successfully connected to the AP. |
DHCP_FAILED | The client failed to receive an IP address from the DHCP server. |
DHCP_OK | The client successfully received an IP address from the DHCP server. |
DISASSOCIATED | The client disassociated from the AP. |
FAILED | The client attempted to connect to the AP but failed. |
Need help?
If you run into any issues or have questions, please reach out to our Support Engineering team by opening a ticket via the Dashboard: https://dashboard.meter.com/support