Plugin Commands: APS Link Key Authorization
Application Framework CLI Command Reference

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ADD_CLUSTER_EXEMPTED
plugin aps-link-key-auth add-cluster-exempted [cluster:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_CLEAR_EXEMPT_LIST
plugin aps-link-key-auth clear-exempt-list
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ENABLE
plugin aps-link-key-auth enable [enable:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ENABLE_WITH_EXEMPT_LIST
plugin aps-link-key-auth enable-with-exempt-list [enable:1] [exemptClusterList:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_INFO
plugin aps-link-key-auth info

Detailed Description

This plugin provides a set of APIs and CLI commands for managing APS link key authorization

Macro Definition Documentation

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ADD_CLUSTER_EXEMPTED

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ADD_CLUSTER_EXEMPTED

plugin aps-link-key-auth add-cluster-exempted [cluster:2]

  • Adds an entry to the cluster exempt list.
    • cluster - INT16U - Cluster to be added to the exempt list.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_CLEAR_EXEMPT_LIST

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_CLEAR_EXEMPT_LIST

plugin aps-link-key-auth clear-exempt-list

  • Clears the exempt list.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ENABLE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ENABLE

plugin aps-link-key-auth enable [enable:1]

  • Enable or disable APS link key authorization for all clusters.
    • enable - INT8U - Set the enable state of the APS link key security.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ENABLE_WITH_EXEMPT_LIST

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_ENABLE_WITH_EXEMPT_LIST

plugin aps-link-key-auth enable-with-exempt-list [enable:1] [exemptClusterList:2]

  • Enables or disables APS link key authorization and setup the exempt list.
    • enable - INT8U - Set the enable state of the APS link key security.
    • exemptClusterList - INT16U - List of exempted clusters.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_INFO

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_APS_LINK_KEY_AUTHORIZATION_PLUGIN_APS_LINK_KEY_AUTH_INFO

plugin aps-link-key-auth info

  • List information on the current state of APS link key authorization.