Overview
Enums represent a fixed set of allowed values for a field or argument.
APIKeyAccessLevel
The access level an API key is minted with.
| Value | Description |
|---|
READ_ONLY | The key may execute read-only query operations. |
READ_WRITE | The key may execute query and mutation operations. |
AlertEvaluationTriggerState
The severity of an alert trigger.
| Value | Description |
|---|
CRITICAL | The alert evaluation is triggered in critical state. |
LOW_PRIORITY | The alert evaluation is triggered at low priority during a deprioritization window. |
NOT_TRIGGERED | The alert evaluation is not triggered. |
TRIGGERED | The alert evaluation is triggered. Used for point-in-time alerts that aren't sustained. |
WARNING | The alert evaluation is triggered in warning (less-than-critical) state. |
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. |
AlertType
Enumerates all supported alert types.
| Value | Description |
|---|
ACCESS_POINT_CLIENT_COUNT | Monitor when AP(s) in a network exceed a threshold of connected clients. |
ACCESS_POINT_LINK_SPEED | Monitor when AP(s) in a network drop below their expected link speed. |
AP_RADAR_HIT | Monitor when an AP radar event is detected. |
AUDIT_LOG | Monitor when a mutation is performed on a network. |
BOOT_LOOP | Monitor when a device reboots repeatedly within a short window. |
CAPTIVE_PORTAL_ACCESS | Monitor when a client connects or requests access to a captive portal. |
CHANNEL_UTILIZATION_HIGH | Channel utilization crosses a threshold. |
CONFIG_FLAPS | Monitor when a network's devices' configs flap in short succession from version A to version B to version A to version B. |
DEVICE_BOOT | Monitor when a device boots. |
DEVICE_OFFLINE | Monitor when a device goes offline. |
DHCP_POOL_EXHAUSTION | Monitor when a DHCP pool is exhausted. |
FIRMWARE_UPGRADE_COMPLETED | Triggers when a firmware upgrade is completed. |
FIRMWARE_UPGRADE_FAILED | Triggers when a firmware upgrade fails. |
FIRMWARE_UPGRADE_PENDING | Triggers when a firmware upgrade is pending. |
FIRMWARE_UPGRADE_SCHEDULED | Triggers when a firmware upgrade is scheduled. |
HIGH_AVAILABILITY_FAILOVER | Monitor when a failover event occurs on a high availability pair. |
HIGH_CPU_USAGE | High CPU usage on a device. |
HONEYPOT_AP | Honeypot AP detected on a network. |
IPSEC_TUNNEL_STATUS_CHANGE | IPSec tunnel status changes. |
IP_CONFLICT | Monitor when the same IP address is assigned to more than one MAC address. |
ISP_DEGRADATION | Monitor when the WAN has experienced packet loss. |
ISP_OUTAGE | Monitor when an ISP experiences an outage. |
LOG_LINE_MATCH | Device log lines matching a filter are found. |
MASS_DEVICE_BOOT | Monitor when many devices on a network reboot within a short window. |
PORT_BLOCKED | Monitor when a port is blocked. |
RADIUS_UNREACHABLE | Monitor when RADIUS servers are unreachable. |
ROGUE_AP | Rogue AP detected on a network. |
ROGUE_DHCP_SERVER | Rogue DHCP server detected on a network. |
STP_ERROR | Spanning Tree Protocol error detected and port blocked. |
SUPPORT_EVENTS | Triggers when a support case or comment is created, updated, or deleted. |
TEMPERATURE | Monitor when temperature (C) is exceeded. |
VERIFICATION | Verification of an alert being configured correctly. |
WAN_DOWN | WAN goes down on firewall. |
WAN_FAILOVER | WAN failover on firewall. |
WAN_FLAP | WAN flaps on firewall. |
WAN_UP | WAN goes up on firewall. |
WIRELESS_DHCP_FAILURE | DHCP fails to resolve for a wireless client. |
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 | |
MC05 | |
MC06 | |
MC11 | |
MP01 | |
MS10 | |
MS11 | |
MW03 | |
MW04 | |
MW05 | |
MW06 | |
MW07 | |
MW08 | |
MW09 | |
S1 | |
S2 | |
S3 | |
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. |
EventPriority
The priority of an event. It's a static property of the event type. All events that share a type also share a priority.
| Value | Description |
|---|
HIGH | An event that likely warrants investigation. |
LOW | Routine events, often high-volume. |
MEDIUM | Notable event, which includes recoveries from high priority events. |
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_MAC_SPOOF_DETECTED | Event indicating that an access point detected spoofing of one of its BSSIDs. |
ACCESS_POINT_RADAR_HIT_DETECTED | Event indicating that a DFS radar hit was detected by an access point. |
AUTO_CHANNEL_SELECTION_JOB_COMPLETED | Event indicating that an auto channel selection job completed successfully. |
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. |
CLIENT_VPN_CONNECTED | Event indicating that a client connected to a Client VPN server. |
CLIENT_VPN_DISCONNECTED | Event indicating that a client disconnected from a Client VPN server. |
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. |
DNS_BLOCKED | Event indicating that the Security Appliance blocked a DNS query. |
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 effect, given that these devices are online. |
FIRMWARE_UPGRADE_SCHEDULED | Event indicating that a firmware upgrade is scheduled on a network. The upgrade will be applied to the device configs at the scheduled time; no device config change has been made yet. |
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_FAILOVER | Event indicating that access points failed over from a primary RADIUS auth server to a backup within a time window. |
RADIUS_POLLER_OK | Event indicating that RADIUS servers are reachable. |
RADIUS_POLLER_UNREACHABLE | Event indicating that RADIUS servers 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. |
ROGUE_DHCP_SERVER | Event indicating a rogue (unexpected) DHCP server was detected — multiple DHCP servers offered IPs for the same transaction on the same VLAN. |
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 port blocked by a Spanning Tree Protocol (STP) error has been unblocked. |
STP_ROOT_BRIDGE_CHANGED | Event indicating that the Spanning Tree Protocol (STP) root bridge observed by a switch has changed. |
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. |
FilterVariant
The variant of a filter, which determines how it is rendered and how its values are interpreted.
| Value | Description |
|---|
BOOL | A boolean toggle. |
DATE_RANGE | A date range defined by a start and end date. |
MULTI_SELECT | A multi-choice selection from a predefined set of options. |
NUMBER | A single numeric value. |
NUMBER_RANGE | A numeric range defined by a lower and upper bound. |
SELECT | A single-choice selection from a predefined set of options. |
TEXT | A free-form text input. |
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 |
HighAvailabilityControllerRole
Specifies the role of the high availability firewall.
| Value | Description |
|---|
BACKUP | The firewall is configured as backup. |
PRIMARY | The firewall is configured as primary. |
HighAvailabilityStatus
Possible status values for high availability firewalls.
| Value | Description |
|---|
ACTIVE | The firewall is currently active and serving traffic. |
READY | The firewall is ready but not currently serving traffic. |
UNSPECIFIED | The status is unspecified. |
HostMonitoringType
Defines the types of host monitoring available.
| Value | Description |
|---|
PING | Perform ICMP ping monitoring. |
TRACEROUTE | Perform traceroute monitoring. |
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. |
IPSecEventType
| Value | Description |
|---|
ALL_CHILD_SAS_LOST | All child SAs lost event type. |
IKE_FAILURES | IKE failures event type. |
IKE_SA_RENEGOTIATED | IKE SA renegotiated after tear down event type. |
TUNNEL_DOWN | Tunnel down event type. |
TUNNEL_FAILED_ESTABLISHMENT | Tunnel failed to establish event type. |
TUNNEL_FLAPPING | Tunnel flapping event type. |
TUNNEL_RECOVERED | Tunnel recovered event type. |
UNSPECIFIED | Unspecified event type. |
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. |
IssueType
The type of issue the customer is experiencing.
| Value | Description |
|---|
BROKEN_FEATURE | A feature is not working as expected. |
CHANGE_CONFIG | Change config or add config. |
INTERMITTEN_CONNECTIVITY | Spotty connection to the network. |
SLOW | The network is slower than expected. |
UNABLE_TO_CONNECT | Unable to connect to network. |
UNKNOWN | Unknown issue type. |
LogSeverity
Severity level of a device log entry.
| Value | Description |
|---|
DEBUG | Debug log. |
ERROR | Error log. |
INFORMATIONAL | Informational log. |
NOTICE | Notice log. |
WARNING | Warning log. |
NACPolicyEntryIdentityType
The kind of identity a NAC policy entry matches against.
| Value | Description |
|---|
LOCAL_CREDENTIAL | Match an identity by its stored credential: a user for the password methods, a device for MAB. |
NAC_GROUP | Match any user in a NAC group (used for EAP-GTC). |
NetworkClientHWMode
Represents the hardware mode of a device the client is connected to.
| Value | Description |
|---|
NA | Represents no HW mode. |
WIFI_2 | Represents Wi-Fi 2. |
WIFI_3 | Represents Wi-Fi 3. |
WIFI_4 | Represents Wi-Fi 4. |
WIFI_5 | Represents Wi-Fi 5. |
WIFI_6 | Represents Wi-Fi 6. |
WIFI_7 | Represents Wi-Fi 7. |
PhyInterfacePortSecurityMode
Specifies how a switch port allows hosts to connect to a port when port security is enabled.
| Value | Description |
|---|
DYNAMIC | Allows the switch port to dynamically learn and allow hosts on the port up to the max configured limit. |
STATIC | Allows the switch port to only permit the configured MACs to access the port. |
STICKY | Allows the switch port to dynamically learn and allow hosts on the port up to the max configured limit and the host's MACs are retained by the switch across reboots. |
RackElevationDeviceType
An enumeration of possible device types that can be attached to a rack elevation.
| Value | Description |
|---|
CABLE_MANAGEMENT | A cable management device. |
CELLULAR | A device to support a Cellular deployment (other than a Meter Cellular Gateway). |
FIBER | A fiber optic device. |
ISP | An Internet Service Provider (ISP) device. |
METER_ACCESS_POINT | A Meter access point device. |
METER_CONTROLLER | A Meter controller device. |
METER_PDU | A Meter PDU device. |
METER_SWITCH | A Meter switch device. |
NON_METER_SWITCH | A non-Meter switch device. |
OTHER | Other type of device. |
PATCH_PANEL | A patch panel. |
UNIVERSAL_POWER_SUPPLY | A universal power supply (UPS) device. |
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 |
|---|
METER_NAC_OPEN_MAC_AUTH | SSID with Meter NAC (Network Access Control, Meter RADIUS solution), Open MAC authentication. |
METER_NAC_WPA2 | SSID with Meter NAC (Network Access Control, Meter RADIUS solution), WPA2-Enterprise. |
METER_NAC_WPA3 | SSID with Meter NAC (Network Access Control, Meter RADIUS solution), WPA3-Enterprise. |
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_ENTERPRISE_TRANSITION | Supports clients that use WPA2 Enterprise or WPA3 Enterprise (802.1X). WPA3 Enterprise only on 6 GHz. |
WPA3_OWE | WPA3 OWE (Open). |
WPA3_TRANSITION | Supports clients that use WPA2 or WPA3. |
SSIDPasswordRotationCadence
| Value | Description |
|---|
DAILY | Rotate the password daily. |
MONTHLY | Rotate the password monthly. |
QUARTERLY | Rotate the password quarterly. |
WEEKLY | Rotate the password weekly. |
SortOrder
| Value | Description |
|---|
ASCENDING | Ascending sort order. |
DESCENDING | Descending sort order. |
SupportCaseCloseCode
The close code for a support case.
| Value | Description |
|---|
RESOLVED | The case was resolved. |
Represents the type of support case comment.
| Value | Description |
|---|
EMAIL | Case comment sourced from email. |
SALESFORCE | Case comment sourced from Salesforce. |
SupportCaseOrigin
| Value | Description |
|---|
ALERT | Case originating from an alert. |
EMAIL | Case originating from an email. |
LINEAGE_NOW | Lineage now integration sourced case. |
PHONE | Case originating from a phone call. |
SLACK | Case originating from a Slack message. |
UNKNOWN | Unknown case origin. |
WEB | Case originating from the Dashboard form. |
SupportCasePriority
Priority associated with the case.
| Value | Description |
|---|
SEV_1 | Critical: network is down. |
SEV_2 | Major: major functionality impacted. |
SEV_3 | Medium: partial, non-critical functionality impacted. |
SEV_4 | Low: no impact on network operation. |
SupportCaseStatus
Status of the support case.
| Value | Description |
|---|
CANCELLED | Case has been cancelled. |
IN_PROGRESS | Case is in progress. |
MERGED | Case has been merged. |
NEW | Case is new. |
ON_HOLD | Case has been put on hold. |
PENDING_CUSTOMER_UPDATE | Case is pending a customer update. |
PENDING_METER_UPDATE | Case is pending a Meter update. |
PENDING_THIRD_PARTY_UPDATE | Case is pending third party update. |
RESOLVED | Case has been resolved. |
SPAM | Case has been marked as spam. |
UNKNOWN | Status is unknown. |
SwitchProfileSwitchingTier
A categorization for the switch device(s) associated with a SwitchProfile, denoting the purpose of the devices in the network.
| Value | Description |
|---|
ACCESS | Switches that directly connect end devices, usually with a mix of Ethernet and SFP uplinks to distribution switches. |
CORE | MDF-based aggregation layer, typically SFP-only, serving as the central switching hub for the network. These switches connect to downstream distribution/access switches and uplinks to firewalls. |
DISTRIBUTION | MDF/IDF-based switches that aggregate multiple access switches and uplink to core switches. Can be SFP-only or a mix of Ethernet and SFP uplinks. |
ISP | The switches distribute an ISP connection between High Availability (HA) firewalls. |
SystemThermalZone
| Value | Description |
|---|
CPU | A CPU thermal zone. |
HUMIDITY | A humidity sensor thermal zone. |
POWER | A power sensor thermal zone. |
RADIO | A radio thermal zone. |
UNSPECIFIED | An unspecified/other thermal zone. |
TechnologyType
Technology customer is experiencing issue with.
| Value | Description |
|---|
BOTH | Both wired and wireless technology. |
DASHBOARD | Dashboard issue. |
UNSPECIFIED | Unspecified issue type. |
WIRED | Wired technology. |
WIRELESS | Wireless technology. |
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 a 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. |
Deprecated
The following are deprecated and may be removed in a future release. Use the suggested replacement and avoid them in new integrations.
| Value | Description |
|---|
FloorPlanDocumentCategory.SITE_DOCUMENTATION | Any non-floor plan documentation relevant to the site. Site documentation is no longer stored as floor plans. |
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