Plugin Commands: IAS Zone Server#
This plugin provides a set of CLI commands for managing the local IAS Zone server.
Macros#
plugin ias-zone-server change-backoff-config [firstBackoff:1] [commonRatio:1] [maxBackoff:4] [unlimitedRetries:1] [maxRetryAttempts:2]
plugin ias-zone-server changeStatus [newStatus:2] [timeSinceOccurredSeconds:1] [endpoint:1]
plugin ias-zone-server info [endpoint:1]
plugin ias-zone-server print-queue
plugin ias-zone-server print-queue-config
plugin ias-zone-server set-enrollment-mode [endpoint:1] [enrollmentMode:1]
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_CHANGE_BACKOFF_CONFIG#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_CHANGE_BACKOFF_CONFIG
plugin ias-zone-server change-backoff-config [firstBackoff:1] [commonRatio:1] [maxBackoff:4] [unlimitedRetries:1] [maxRetryAttempts:2]
Update the IAS Zone server's backoff configuration parameters.
firstBackoff - INT8U - First backoff time in seconds.
commonRatio - INT8U - Backoff increase common ratio.
maxBackoff - INT32U - Maximum backoff time in seconds.
unlimitedRetries - BOOLEAN - Unlimited retires.
maxRetryAttempts - INT16U - Maximum retry attempts.
3628 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_CHANGE_STATUS#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_CHANGE_STATUS
plugin ias-zone-server changeStatus [newStatus:2] [timeSinceOccurredSeconds:1] [endpoint:1]
Update the zone status attribute of a given endpoint's IAS Zone cluster to the given value
newStatus - INT16U - The new status to be written
timeSinceOccurredSeconds - INT8U - The amount time that has passed since the last update occurred (seconds)
endpoint - INT8U - The endpoint whose zone status attribute is to be updated
3636 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_INFO#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_INFO
plugin ias-zone-server info [endpoint:1]
Print current value of the following cluster attributes: zone type, zone state, zone status, zone id
endpoint - INT8U - The endpoint whose IAS Zone Cluster information is to be printed
3642 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_PRINT_QUEUE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_PRINT_QUEUE
plugin ias-zone-server print-queue
Prints information on the status queue.
3647 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_PRINT_QUEUE_CONFIG#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_PRINT_QUEUE_CONFIG
plugin ias-zone-server print-queue-config
Prints the status queue config.
3652 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_SET_ENROLLMENT_MODE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_IAS_ZONE_SERVER_PLUGIN_IAS_ZONE_SERVER_SET_ENROLLMENT_MODE
plugin ias-zone-server set-enrollment-mode [endpoint:1] [enrollmentMode:1]
Update the IAS Zone server's enrollment method to the specified value
endpoint - INT8U - The endpoint whose enrollment mode is to be updated
enrollmentMode - INT8U - The new enrollment mode
3659 of file ./app/framework/test/headers/cli.doc