Cisco Connected Mobile Experiences Reference guide
Advertisement
Advertisement
Cisco CMX Command Reference Guide, Release 10.4
First Published: 2017-04-02
Last Modified: 2017-11-27
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
©
2017 Cisco Systems, Inc. All rights reserved.
C O N T E N T S
P r e f a c e
C H A P T E R 1
Obtaining Documentation and Submitting a Service Request viii
Using the Command-Line Interface 1
cmxctl config heatmaps summary 12
cmxctl config hyperlocation mixmode 13
Cisco CMX Command Reference Guide, Release 10.4 iii
Contents
cmxctl metrics notification 31
cmxos checkpostgresdatasize 59
iv
Cisco CMX Command Reference Guide, Release 10.4
Contents
C H A P T E R 2
Cisco CMX High Availability Commands 81
Cisco CMX Command Reference Guide, Release 10.4 v
Contents vi
Cisco CMX Command Reference Guide, Release 10.4
Preface
•
Preface
Audience
This document is for network administrators who configure Cisco Connected Mobile Experiences (Cisco
CMX) services.
Conventions
This document uses the following conventions:
Table 1: Conventions
Convention bold font italic font
[ ]
{x | y | z }
[ x | y | z ] string courier font
Indication
Commands and keywords and user-entered text appear in bold font.
Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.
Elements in square brackets are optional.
Required alternative keywords are grouped in braces and separated by vertical bars.
Optional alternative keywords are grouped in brackets and separated by vertical bars.
A nonquoted set of characters. Do not use quotation marks around the string.
Otherwise, the string will include the quotation marks.
Terminal sessions and information the system displays appear in courier font.
Cisco CMX Command Reference Guide, Release 10.4 vii
Preface
Related Documentation
Convention
<>
[]
!, #
Indication
Nonprinting characters such as passwords are in angle brackets.
Default responses to system prompts are in square brackets.
An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the manual.
Tip Means the following information will help you solve a problem.
Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.
Related Documentation
For more information about Cisco Mobility Services Engine and related products, see: http://www.cisco.com/c/en/us/support/wireless/mobility-services-engine/tsd-products-support-series-home.html
For more information about Cisco Connected Mobile Experiences (Cisco CMX), see: http://www.cisco.com/c/en/us/solutions/enterprise-networks/connected-mobile-experiences/index.html
For more information about Cisco CMX Cloud, see: https://support.cmxcisco.com/hc/en-us
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What's New in Cisco Product Documentation .
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's
New in Cisco Product Documentation RSS feed . RSS feeds are a free service.
viii
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
•
Using the Command-Line Interface, page 1
Using the Command-Line Interface
Starting from Cisco CMX 10.3.1, you can use the Tab key to auto complete any Cisco CMX command on the command line interface. If you enter cmxos and then click the Tab key, the CLI displays the available keywords. If you enter a partial string and then click the Tab key, the CLI then displays the complete string.
Cisco CMX Command Reference Guide, Release 10.4
1
Cisco CMX Commands cassandraexport
cassandraexport
To export Cisco CMX history data from Cassandra to a CSV file, use the cassandraexport command.
cassandraexport { --date <yyyy/mm/dd> } [ --table <tablename> | --file <filename> | --sql <sql statement> |
--rowsperfetch <rows per fetch> ]
Syntax Description
--date <yyyy/mm/dd>
--table <table name>
--file <filename>
--sql <sql statement>
--rowsperfetch <rows per fetch>
Date on which the export is to be performed. This is required.
(Optional) Name of the table to export.
(Optional) Name of the CSV file. The default is
/tmp/CassandraExport_sql.csv.
This option is not currently supported.
(Optional) The default is 1000 rows.
Command Default None.
Command Modes cmxadmin (non-root) user
Command History
Release
Cisco CMX Release 10.3.0
Modification
This command was introduced.
Usage Guidelines This command extracts a maximum of only one day of data, starting from midnight of the date given to the time when the command is issued.
You can use these methods to export Cisco CMX data from Cassandra:
• The method that we most recommend is through the Notifications feature ( Manage > Notifications>
New Notification ). For more information, see the “ Managing Notifications from Applications ” section in the Cisco Connected Mobile Experiences Configuration Guide for this release at: http://www.cisco.com/c/en/us/support/wireless/mobility-services-engine/products-installation-and-configuration-guides-list.html
• An alternative method is to use the cassandraexport command, and to export daily. We recommend that you schedule the export during a quiet period of the day, for example 2:00 A.M. If you use this method during a time when the system is continuously changing, a timeout can occur.
• Use the Cisco CMX History API only if your export does not exceed 2000 records, for example 100 floors.
2
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cassandraexport
Examples The following example shows how to export Cisco CMX data from Cassandra to a CSV file:
[cmxadmin]$ /opt/cmx/bin/cassandraexport --date 2017/06/14
Data exported into the file /tmp/CassandraExport_201706150220-02.csv
Cisco CMX Command Reference Guide, Release 10.4
3
Cisco CMX Commands cmxctl checkdb
cmxctl checkdb
To check the database for schema integrity, use the cmxctl checkdb command.
cmxctl checkdb { cassandra | postgres }
Syntax Description cassandra postgres
Checks the cassandra schema.
Checks the postgres schema.
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Examples
Modification
This command was introduced.
The following example shows how to the schemen integrity for cassandra and postgres database:
[root@server]# cmxctl checkdb cassandra
Schema passed analytics
Schema passed loc
Schema passed mse
Cassandra passed schema validation
[root@server]# cmxctl checkdb postgres
Schema passed analytics
Schema passed loc
Schema passed mse
Postgres passed schema validation
4
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl checklogs
cmxctl checklogs
To check logs and generate a report, use the cmxctl checklogs command.
cmxctl checklogs
Command Default None
Usage Guidelines After a report is generated, the specific log that shows the error can be viewed for additional details. For example, /opt/cmx.var.log.cmxjobs.log.3 has 108 errors, use the command more
/opt/cmx.var.log.cmxjobs.log.3
to view the corresponding file.
Examples The following example shows how to check logs and generate a report:
[root@server]# cmxctl checklogs
************************************************************************
Checking /opt/cmx/var/log/cmxjobs.log.3 for errors..
/opt/cmx/var/log/cmxjobs.log.3 has 108 errors
**********************************************************************
Checking /opt/cmx/var/log/system-cron.log for errors..
/opt/cmx/var/log/system-cron.log has 0 errors
************************************************************************
Checking /opt/cmx/var/log/cmxjobs.log for errors..
/opt/cmx/var/log/cmxjobs.log has 81 errors
************************************************************************
Checking /opt/cmx/var/log/collectd.log for errors..
/opt/cmx/var/log/collectd.log has 0 errors
***********************************************************************
Checking /opt/cmx/var/log/consul.log for errors..
/opt/cmx/var/log/consul.log has 0 errors
************************************************************************
Checking /opt/cmx/var/log/qless-py-worker.log for errors..
/opt/cmx/var/log/qless-py-worker.log has 0 errors
************************************************************************
Checking /opt/cmx/var/log/influxdb.log for errors..
/opt/cmx/var/log/influxdb.log has 0 errors
************************************************************************
Checking /opt/cmx/var/log/cmxjobs.log.4 for errors..
/opt/cmx/var/log/cmxjobs.log.4 has 108 errors
***********************************************************************
Cisco CMX Command Reference Guide, Release 10.4
5
Cisco CMX Commands cmxctl config aps delete
cmxctl config aps delete
To delete an access point from Cisco CMX, use the cmxctl config aps delete command.
cmxctl config aps delete MAC Address
Syntax Description
MAC Address Displays the MAC address of the access point.
Command Default None.
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
6
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl config authinfo get
cmxctl config authinfo get
To view the the SHA1 (keyHash) and SHA2(sha2KeyHash) strings, use the cmxctl config authinfo get command.
cmxctl config authinfo get
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command gets the authorization information for NMSP connections to the controllers.
Examples The following example shows how to get the authorization information:
[cmxadmin@cmx-nortech ~]$ cmxctl config authinfo get
+-------------------+------------------------------------------+------------------------------------------------------------------+
| macAddress | keyHashString | sha2KeyHashString
|
+-------------------+------------------------------------------+------------------------------------------------------------------+
| 00:0c:29:07:36:84 | e743ac54029ce36282c582f04bfb45ec187c824d |
560d69882adb90dda10227651da0c6a2850999620b50f83ed0d157fb87d1a920 |
+-------------------+------------------------------------------+------------------------------------------------------------------+
Cisco CMX Command Reference Guide, Release 10.4
7
Cisco CMX Commands cmxctl config controllers
cmxctl config controllers
To manage Cisco Wireless Controllers (Cisco WLC), use the cmxctl config controllers command.
cmxctl config controllers { activeaps | add | delete | floors wlc-ip-address | import | missingaps | show }
Syntax Description activeaps add delete
floors wlc-ip-address import missingaps show
Displays active access points.
Adds a Cisco WLC.
Deletes a Cisco WLC.
Displays floors managed by Cisco WLCs.
Imports a Cisco WLC from Cisco Prime Infrastructure by providing the corresponding credentials, or by placing an exported Cisco Prime Infrastructure MAP file in the /opt directory of the Cisco CMX server and providing the path to the exported MAP file.
Lists the access points from which Cisco CMX has received data, but the access points are not yet placed on a map.
Displays information pertaining to a Cisco WLC.
Command Default None.
Command History
Release
Cisco CMX Release 10.3.1
Cisco CMX Release 10.3.0
Modification
The missingaps and floors keywords were added.
This command was introduced.
Usage Guidelines The message "controller added successfully" after a Cisco WLC is added, refers only to the correct parsing of the command. You should issue a cmxctl controllers show command to ensure that the Cisco WLC is not active.
The missingaps keyword uses SNMP to retrieve the AP's MAC addresses from the access point ’ s configuration cache every six hours. If the AP MAC address is not present, it will be displayed as
NA on the CLI.
In addition, the AP MAC address will be displayed only if you have enabled the configuration.apimport
feature flag by using the cmxctl config featureflags configuration.apimport: true command. For example:
[root@server]# cmxctl config featureflags configuration.apimport true
+---------------------------------+-------+
8
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
Examples cmxctl config controllers
| location.compactlocationhistory | false |
+---------------------------------+-------+
| configuration.apimport
| true |
The AP MAC address import occurs every 6 hours, so for new APs added to the controller, the AP MAC value for missingap will be available only after the next job run.
Starting from Cisco CMX Release 10.3.1, you can specify SNMP settings when you use the cmxctl config controllers add command. For example:
[root@server]# cmxctl config controllers add
Please enter controller type [WLC / NGWC] [WLC]: WLC
Please enter controller ip: 0.0.0.0
Please enter the controller version [Optional]:
Please enter controller SNMP version [v1 / v2c / v3] [v2c]: v2c
Please enter controller SNMP write community [private]:
....................................................................
Controller Added 0.0.0.0
[root@server]#
The following example shows how to display the Cisco WLC information:
[root@server]# cmxctl config controllers show
+--------------+------+------------+----------------+------+--------+
| IP Address | Type | Version | Device Version | SHA2 | Status |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.65 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.44 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.46 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.70 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.93 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.97 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.35 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.58 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.82 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.84 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
| 30.30.30.53 | WLC | 8.0.72.141 | - | No | ACTIVE |
+--------------+------+------------+----------------+------+--------+
Cisco CMX Command Reference Guide, Release 10.4
9
Cisco CMX Commands cmxctl config featureflags
cmxctl config featureflags
To list and toggle feature flags, use the cmxctl config featureflags command.
cmxctl config featureflags { feature name } { true| false }
Syntax Description service.featurename
true false
Name of the Cisco CMX service and feature.
• analytics.areatransition
• configuration.apimport:
• monit
• container.influxdbreporter
• halo
• analytics.queuetime
Enables the feature of the service.
Disables the feature of the service
Command Default None
Command History
Examples
Release
Cisco CMX Release 10.2.2
Cisco CMX Release 10.2.0
Modification
This command was changed. The display default for analytics.sma was changed to false.
This command was introduced.
The following example shows how to list the feature flags:
[root@server]# cmxctl config featureflags
+---------------------------------+-------+
| location.compactlocationhistory | true |
+---------------------------------+-------+
| configuration.apimport
| true |
+---------------------------------+-------+
| location.rogueapclienthistory
| true |
+---------------------------------+-------+
| monit | true |
+---------------------------------+-------+
| container.influxdbreporter
| true |
+---------------------------------+-------+
| configuration.highendbypass
| false |
+---------------------------------+-------+
| apiserver.enabled
| true |
10
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
+---------------------------------+-------+
| analytics.queuetime
| false |
+---------------------------------+-------+ cmxctl config featureflags
Cisco CMX Command Reference Guide, Release 10.4
11
Cisco CMX Commands cmxctl config heatmaps summary
cmxctl config heatmaps summary
To show the details of the heapmap from the location service, use the cmxctl config heatmaps summary command.
cmxctl config heatmaps summary
Command Default None.
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
12
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl config hyperlocation mixmode
cmxctl config hyperlocation mixmode
To manage mixed mode for hyperlocation for a specified floor, use the cmxctl config hyperlocation mixmode command.
cmxctl config hyperlocation mixmode Floor ID { enable | disable }
Syntax Description
Floor ID enable disable
Provides the specific floor ID.
Enables mixed mode support for hyperlocation for the specified floor.
Disables mixed mode support for hyperlocation for the specified floor.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines We recommened that you use this command in a scenario where on a single floor there are both Hyperlocation enabled AP and non Hyperlocation APs. The improved location accuracy that comes from the use of
Hyperlocation AP will occur within the convex hull of the Hyperlocation APs. Outside of this convex, standard location accuracy results will occur. At the edges of the convex hull there may also be lower accuracy, when clients are at least 10M inside of the convex hull.
This command does not support the interspersion of Hyperlocation AP with non Hyperlocation AP. If this is type of deployment is used, then there will be no improvement in location over standard probe RSSI based location.
Cisco CMX Command Reference Guide, Release 10.4
13
cmxctl config hyperlocation mixmode
The following is an example of a supported deployment:
Figure 1: Supported Hyperlocation Mixed Mode Deployment
Cisco CMX Commands
14
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl config import
cmxctl config import
To import a map and Cisco Wireless Controller (Cisco WLC) from Cisco Prime Infrastructure,, use the cmxctl config import command.
cmxctl config import { prime | status }
Syntax Description prime status
Imports maps from Cisco Prime Infrastructure.
Shows import status.
Command Default None.
Examples The following example shows how to import a map and Cisco WLC from Cisco Prime Infrastructure:
[root@server]# cmxctl config import prime
Please enter PI ip address: x.x.x.x
Please enter PI username [root]: root
Please enter PI password [Public123]:
Import successfully started from PI x.x.x.x. Check import status using cmxctl config import status.
Cisco CMX Command Reference Guide, Release 10.4
15
Cisco CMX Commands cmxctl config maps
cmxctl config maps
To import and manage maps, use the cmxctl config maps command.
cmxctl config maps { address| buildings| campuses| delete | floors| import | reprocessimage| zones }
Syntax Description address buildings campuses delete floors import reprocessimage zones
Imports addresses for the maps.
Lists buildings in a campus or all buildings.
Lists all campuses.
Deletes the campus map.
Lists floors in a building or all floors.
Imports map from the Cisco Prime Infrastructure.
Sumits a job to reprocess floor image tiles.
Lists zones in a buliding or all floors.
Command Default None.
Usage Guidelines Starting from Cisco CMX Release 10.3.1, you must provide the full (absolute) path to the tar file when using the cmxctl config maps import command. For example:
[root@server]# cmxctl config maps import
Please specify import type [PI/FILE] [FILE]:
Delete & replace existing maps & analytics data. [yes/no] [no]: yes
Delete & replace existing zones & analytics data. [yes/no] [no]: yes
Please enter map import path: /opt/ImportExport_fdff57880aabd650.tar.gz
Command History
Release
Cisco CMX Release 10.3.1
Cisco CMX Release 10.3.0
Modification
The import keyword was modified.
This command was introduced.
Examples The following example shows how to import and manage maps:
[root@server]# cmxctl config maps import
Please specify import type [PI / FILE] [FILE]: PI
Please enter PI ip address: x.x.x.x
Please enter PI username [root]: root
16
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl config maps
Please enter PI password [Public123]:
Import successfully started from PI 173.37.206.3. Check import status using cmxctl config import status.
[root@server]# cmxctl config maps reprocessimage --imagename domain_0_1477533583241.PNG
[root@server]# cmxctl config maps campuses
+----------------+--------------------+---------------------+
| Campus Name | Location Campus ID | Analytics Campus ID |
+----------------+--------------------+---------------------+
| Nortech Campus | 727001546461544473 | 49 |
+----------------+--------------------+---------------------+
[root@server]# cmxctl config maps buildings
+---------------------------------+----------------------+-----------------------+
| Building Name | Location Building ID | Analytics Building ID |
+---------------------------------+----------------------+-----------------------+
| Nortech Campus>Nortech Building | 727001546461544629 | 48 |
+---------------------------------+----------------------+-----------------------+
[root@server]# cmxctl config maps floors
+------------------------------------------------+--------------------+--------------------+
| Floor Name | Location Floor ID | Analytics Floor ID
|
+------------------------------------------------+--------------------+--------------------+
| Nortech Campus>Nortech Building>Security Floor | 727001546461544650 | 47
|
+------------------------------------------------+--------------------+--------------------+
[root@server]# cmxctl config maps zones
+------------------------------------------------+-----------+-------------------+
| Floor Name | Zone Name | Analytics Zone ID |
+------------------------------------------------+-----------+-------------------+
| Nortech Campus>Nortech Building>Security Floor | zone1 | 53 |
+------------------------------------------------+-----------+-------------------+
| Nortech Campus>Nortech Building>Security Floor | zone2 | 54 |
+------------------------------------------------+-----------+-------------------+
| Nortech Campus>Nortech Building>Security Floor | zone3 | 55 |
+------------------------------------------------+-----------+-------------------+
Cisco CMX Command Reference Guide, Release 10.4
17
Cisco CMX Commands cmxctl config reload
cmxctl config reload
To forcefully generate a configuration file, use the cmxctl config reload command.
cmxctl config reload
Command Default None
Examples The following example shows how to forcefully generate a configuration file:
[root@server]# cmxctl config reload
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: WARNING Skipping confd config file.
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/analytics.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/cassandra/cassandra-env.sh in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/cassandra/cassandra.yaml in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/collectd.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/configuration.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/connect.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/halo.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/haproxy.cfg in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/influxdb.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/location.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/matlabengine.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/nmsplb.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/nmspproxy.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/postgresql.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/redis_6379.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/redis_6380.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: INFO Target config
/opt/cmx/etc/redis_6381.conf in sync
2015-03-10T17:45:50Z cmx-vmdev117 -verbose[17174]: ERROR template: redis.template.conf:15:20: executing "redis.template.conf" at <getv ($tag | printf ...>: error calling getv: key does not exist
18
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl config rfid timeout
cmxctl config rfid timeout
To set the timeout for maintaining RFID tags in Cisco CMX, use the cmxctl config rfid timeout command.
cmxctl config rfid timeout { get | set value }
Syntax Description get
set value
Displays the timeout value.
Sets the timeout value that Cisco CMX maintains RFID tags before expiring them.The time range is 600 to 10800 seconds. The default value is 900 seconds
Command Default None.
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3.1
Modification
This command was introduced.
Usage Guidelines
We recommend that the RFID tag timeout is as long as your longest RFID tag ’ s chirp interval. Otherwise, the tag will not be on the map or active clients because it timed out of the Cisco CMX cache.
Examples The following example shows how to set the timeout for RFID tags, and then verify the setting:
[root@server]# cmxctl config rfid timeout set need to include a timeout within 600 to 10800 seconds
[root@server]# cmxctl config rfid timeout set 600
[root@server]# cmxctl config rfid timeout get
600 seconds
Cisco CMX Command Reference Guide, Release 10.4
19
Cisco CMX Commands cmxctl config verify
cmxctl config verify
To verify the Cisco Connected Mobile Experiences (Cisco CMX) installation and configuration, use the cmxctl config verify command.
cmxctl config verify
Command Default None.
Command Modes
Examples The following example shows how to verify the Cisco CMX installation and configuration:
[root@server]# cmxctl config verify
Verifying node configuration...
NetworkManager: unrecognized service
Consul v0.4.1
Consul Protocol: 2 (Understands back to: 1) confd 0.6.0
+-----------------+--------------------------------+------------+-------------------------+
| module | check | passed | msg
|
+=================+================================+============+========================+
| netman_stopped | NetworkManager service is not | Success |
|
| | running | |
|
+-----------------+--------------------------------+------------+-------------------------
--+
| matlabengine | http://matlabengine.service.co | Failed | check the log files under |
| | nsul:5577/api/services/matlabe | | /opt/cmx/var/log
|
| | ngine/status | |
|
+-----------------+--------------------------------+------------+-------------------------+
| database | connect to database port:5432 | Success |
|
+-----------------+--------------------------------+------------+-------------------------+
| consul_dns | 127.0.0.1 (consul) is present | Success |
|
| | as dns server in | |
|
| | /etc/resolv.conf | |
|
+-----------------+--------------------------------+------------+-------------------------
--+
| etchost_hacks | consul service hostnames not | Success |
|
| | static in /etc/hosts | |
|
+-----------------+--------------------------------+------------+-------------------------+
| analytics | http://analytics.service.consu | Failed | check the log files under |
| | l:5556/api/services/analytics/ | | /opt/cmx/var/log
|
| | status | |
|
+-----------------+--------------------------------+------------+-------------------------+
| hostname_ping | ping to hostname:cmx-master-1 | Success |
|
+-----------------+--------------------------------+------------+-------------------------
--+
20
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl config verify
| location | http://location.service.consul | Failed | check the log files under |
| | :5555/api/services/location/st | | /opt/cmx/var/log
|
| | atus | |
|
+-----------------+--------------------------------+------------+-------------------------
--+
| confd_installed | Confd is installed | Success |
|
+-----------------+--------------------------------+------------+-------------------------+
| consul_installe | Consul is installed | Success |
|
| d | | |
|
+-----------------+--------------------------------+------------+-------------------------
--+
| nmsplb | http://nmsplb.service.consul:6 | Failed | check the log files under |
| | 001/api/services/nmsplb/status | | /opt/cmx/var/log
|
+-----------------+--------------------------------+------------+-------------------------+
| configuration | http://configuration.service.c | Failed | check the log files under |
| | onsul:6000/api/services/config | | /opt/cmx/var/log
|
| | uration/status | |
|
+-----------------+--------------------------------+------------+-------------------------+
| cassandra | connect to cassandra port:9042 | Success |
|
+-----------------+--------------------------------+------------+-------------------------+
Cisco CMX Command Reference Guide, Release 10.4
21
Cisco CMX Commands cmxctl debug
cmxctl debug
To create a debug tarball in the current directory, use the cmxctl debug command.
cmxctl debug
Command Default None.
Command History
Release
Cisco CMX Release 10.4
Modification
This command is depreciated.
Usage Guidelines The debug tarball that is created will be approximately 300 MB in size, and takes at 90 seconds to complete.
This command should to be run using the cmxadmin (non-root) account. This commnd is depreciated in Cisco
CMX release 10.4 and we recommend that you use cmxos techsupport command.
Examples The following example shows how to create a debug tarball in the current directory:
[[email protected]:~]$ cmxctl debug running locally
Dumping debug information...
[localhost] Executing task 'dump_config' cp: cannot stat `/opt/cmx/share/upgrade.answers': No such file or directory
[localhost] Executing task 'dump_state' running 'ps aux' running 'ifconfig -a' running 'cmxctl status' running 'ulimit -a' running 'ps -u root,postgres -o %cpu,%mem,cmd' running 'netstat -o -n -a' running 'df -h' running 'ntpdate -d 172.19.28.250' running 'consul members'
[localhost] Executing task 'dump_apis' getting /api/config/v1/clusters getting /api/config/v1/nodes
[localhost] Executing task 'dump_hosts' pinging configuration.service.consul
pinging location.service.consul
pinging 6379.cache.service.consul
pinging 6380.cache.service.consul
pinging 6381.cache.service.consul
pinging database.service.consul
pinging analytics.service.consul
pinging halo.service.consul
Done.
22
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl disable
cmxctl disable
To disable a service, use the cmxctl disable command.
cmxctl disable { consul| qlesspyworker | cassandra | iodocs | cache_6382| cache_6383| cache_6380| cache_6381 | cache_6384| cache_6385| influxdb | metrics | confd | cache_6379 | cache_6378 | haproxy | database | analytics | connect | gateway| location | configuration | matlabengine | hyperlocation| nmsplb
| agent }
Syntax Description analytics agent cache_6378 cache_6379 cache_6380 cache_6381 cache_6382 cache_6383 cache_6385 cassandra confd configuration connect consul database haproxy hyperlocation location
Performs analytics on calculated location data.
Manages Cisco CMX system lifecycle. starts, stops, and monitors all the services running in Cisco CMX.
Caches the service used by location service.
Caches the service used by location service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Enables cassandra database service used by the location service for historical data.
Internal service.
Configures nodes and clusters.
Enables connect services.
Internal service.
Enables the database service used by analytics and configuration service.
Enables the TCP or HTTP load balancer gateway to all service
APIs.
Enables hyperlocation.
Enables location service to compute location.
Cisco CMX Command Reference Guide, Release 10.4
23
Cisco CMX Commands cmxctl disable matlabengine metrics nmsplb influxdb iodocs qlesspyworker gateway
Provides access point heatmap for location service.
Collects system metrics.
Enables the load balancer service used for distributing Network
Mobility Services Protocol (NMSP) messages to location services.
Enables database services used for storing statistics from various services.
Enables online document service for REST API offered by various services.
Internal service.
Enables gateway services that establishes secure bidirectional communication with Cisco CMX Cloud applications.
Command Default None
Examples The following example shows how to disable the cassandra database service:
[root@server]# cmxctl disable cassandra
Done
The nodeagent service is currently running with PID: 31776
Stopping cassandra process...
Done
Successfully shutdown cassandra Process.
24
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
cmxctl dump
To create a configuration tarball in the current directory, use the cmxctl dump command.
cmxctl dump
Command Default None
Examples The following example shows how to create a configuration tarball in the current directory:
[root@server]# cmxctl dump running locally
Dumping configuration information...
[localhost] Executing task 'dump_config'
Done.
cmxctl dump
Cisco CMX Command Reference Guide, Release 10.4
25
Cisco CMX Commands cmxctl enable
cmxctl enable
To enable a service, use the cmxctl enable command.
cmxctl enable { consul| qlesspyworker | cassandra | iodocs | cache_6382| cache_6383| cache_6380| cache_6381 | cache_6384| cache_6385| influxdb | metrics | confd | cache_6379 | cache_6378 | haproxy | database | analytics | connect | gateway| location | configuration | matlabengine | hyperlocation| nmsplb
| agent }
Syntax Description analytics agent cache_6378 cache_6379 cache_6380 cache_6381 cache_6382 cache_6383 cache_6385 cassandra confd configuration connect consul database haproxy hyperlocation location
Performs analytics on calculated location data.
Manages Cisco CMX system lifecycle. starts, stops, and monitors all the services running in Cisco CMX.
Caches the service used by location service.
Caches the service used by location service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Enables cassandra database service used by the location service for historical data.
Internal service.
Configures nodes and clusters.
Enables connect services.
Internal service.
Enables the database service used by analytics and configuration service.
Enables the TCP or HTTP load balancer gateway to all service
APIs.
Enables hyperlocation.
Enables location service to compute location.
26
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl enable matlabengine metrics nmsplb influxdb iodocs qlesspyworker gateway
Provides access point heatmap for location service.
Collects system metrics.
Enables the load balancer service used for distributing Network
Mobility Services Protocol (NMSP) messages to location services.
Enables database services used for storing statistics from various services.
Enables online document service for REST API offered by various services.
Internal service.
Enables gateway services that establishes secure bidirectional communication with Cisco CMX Cloud applications.
Command Default None.
Examples The following example shows how to enable analytics service:
[root@server]# cmxctl enable analytics
The nodeagent service is not running.
Agent is not running, starting it now.
Starting nodeagent Process...
Retrying..
Done
Started nodeagent service with PID: 31027
Cisco CMX Command Reference Guide, Release 10.4
27
cmxctl heterarchy
cmxctl heterarchy
To manage the deployment hierarchy, use the cmxctl heterarchy command.
cmxctl heterarchy { backup| rebuild| repair| restore| retire | verify }
Syntax Description backup rebuild repair restore retire verify
Backs up the deployment hierarchy.
Rebuilds the deployment hierarchy.
Repairs the deployment hierarchy.
Restores the deployment hierarchy.
Retires the deployment hierarchy.
Verifies the deployment hierarchy.
Command Default None
Command History
Examples
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
The following example shows how to verify the heterarchy:
[root@server]# cmxctl heterarchy verify
Verifying heterarchy...
Checking user levels
Heterarchy is healthy.
Cisco CMX Commands
28
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl influxdb wipe
cmxctl influxdb wipe
To wipe the influx database, use the cmxctl influxdb wipe --silent command.
cmxctl influxdb wipe --silent
Syntax Description silent Silently wipe the influx database
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Examples The following example shows how to wipe the influx database:
[root@server]# cmxctl influxdb wipe
This command will wipe the Influx database. All system metric data will be erased.
Do you want to continue?: y
Stopping influxdb Process...
executing shutdown
Retrying..
Retrying...
Retrying....
Done
Successfully shutdown influxdb Process.
Cleaning Influx database directories
Configuring InfluxDB
Cisco CMX Command Reference Guide, Release 10.4
29
Cisco CMX Commands cmxctl jobs
cmxctl jobs
To configure recurring background jobs, use the cmxctl jobs command.
cmxctl jobs { cancel | jobname| list | run | jobname| runnow | jobname }
Syntax Description
cancel jobname list
run jobname
runnow jobname
Cancels a scheduled job.
Lists all the scheduled jobs.
Runs a job at a specified time.
Triggers a one-time run of the job.
Command Default None.
Usage Guidelines The Apache Cassandra database stores location history data. Pruning should be performed to maintain disk usage. Cisco CMX 10.2 introduces the option to prune database size. The default disk-pruning task runs at an interval of 90 days. You can also use the cmxctl jobs runnow cleanupcassandra command to run an on-demand job of cleaning up the Cassandra database, which is a normal scheduled task that runs once every two days.
Examples The following example shows how to run a background job:
[root@server]# cmxctl jobs run LocationIndexCleanup submitted the job, verify using cmxctl jobs list.
30
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl metrics notification
cmxctl metrics notification
To generate notification metrics for a Cisco Connected Mobile Experiences (Cisco CMX) file, use the cmxctl metrics notification command.
cmxctl metrics notification
Command Default None
Usage Guidelines The notification keyword provides metrics for notification.
Examples The following example shows how to generate metrics for a Cisco CMX file:
[root@server]# cmxctl metrics notification
+--------------------------------+------------+------------+-----------------+------------+
| EndPoint | Success | Failure | SuccessRate |
FailureRate |
+================================+============+============+=================+===========+
+--------------------------------+------------+------------+-----------------+------------+
Cisco CMX Command Reference Guide, Release 10.4
31
Cisco CMX Commands cmxctl node
cmxctl node
To manage node installation, use the cmxctl node command.
cmxctl node { sslmode | { enable | { --key key-file-location | --pem pem-file-location } | disable }}
Syntax Description sslmode enable
--key key-file-location
--pem pem-file-location disable
Enables or disables Secure Sockets Layer (SSL).
Enables Secure Sockets Layer (SSL).
Location of the SSL key file.
Location of the SSL pem file.
Disables Secure Sockets Layer (SSL).
Command Default None.
Usage Guidelines Before initiating the import process, ensure that you have a self-signed or a Certificate Authority (CA)-signed certificate and the key file. The certificate and the key file must have minimum global read permissions (0644).
Starting from Cisco CMX Release 10.3.1, you can install a new Cisco CMX certificate by using the key and pem keywords. For example:
[root@server]# cmxctl node sslmode enable --pem /home/cmxadmin/cert.pem --key
/home/cmxadmin/host.key
Command History
Release
Cisco CMX Release 10.3.1
Cisco CMX Release 10.3.0
Modification
This command was modified. The sslmode enable keyword was modified.
This command was introduced.
Examples The following example shows how to manage node installation:
[root@server]# cmxctl node sslmode enable --pem <pem-file-location> --key
<key-file-location> enabling ssl ssl enabled
32
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl restart
cmxctl restart
To restart a Cisco Connected Mobile Experiences (Cisco CMX) service, use the cmxctl restart command.
cmxctl restart { consul| qlesspyworker | cassandra | iodocs | cache_6382| cache_6383| cache_6380| cache_6381 | cache_6384| cache_6385| influxdb | metrics | confd | cache_6379 | cache_6378 | haproxy | database | analytics | connect | gateway| location | configuration | matlabengine | hyperlocation| nmsplb
| agent }
Syntax Description analytics agent cache_6378 cache_6379 cache_6380 cache_6381 cache_6382 cache_6383 cache_6385 cassandra confd configuration connect consul database haproxy hyperlocation location
Performs analytics on calculated location data.
Manages Cisco CMX system lifecycle. starts, stops, and monitors all the services running in Cisco CMX.
Caches the service used by location service.
Caches the service used by location service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Enables cassandra database service used by the location service for historical data.
Internal service.
Configures nodes and clusters.
Enables connect services.
Internal service.
Enables the database service used by analytics and configuration service.
Enables the TCP or HTTP load balancer gateway to all service
APIs.
Enables hyperlocation.
Enables location service to compute location.
Cisco CMX Command Reference Guide, Release 10.4
33
Cisco CMX Commands cmxctl restart matlabengine metrics nmsplb influxdb iodocs qlesspyworker gateway
Provides access point heatmap for location service.
Collects system metrics.
Enables the load balancer service used for distributing Network
Mobility Services Protocol (NMSP) messages to location services.
Enables database services used for storing statistics from various services.
Enables online document service for REST API offered by various services.
Internal service.
Enables gateway services that establishes secure bidirectional communication with Cisco CMX Cloud applications.
Command Default None
Examples The following example shows how to restart a Cisco CMX service:
[root@server bin]# cmxctl restart database
Done
The nodeagent service is currently running with PID: 16718
Stopping postgres Process...
Successfully shutdown postgres Process.
Starting postgres Process...
Done
Started postgres service with PID: 25702
Exception while notifying CE
34
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl stack
cmxctl stack
To generate the jstack for a java service, use the cmxctl stack command.
cmxctl stack { cmx_service }
Syntax Description cmx_service Lists all Cisco CMX services. The services include: location, analytics, configuration, matlabengine, and nmsplb.
Command Default None
Command History
Release
Cisco CMX Release 10.2
Examples
Modification
This command was introduced.
The following example shows how to generate jstack for location services:
Cisco CMX Command Reference Guide, Release 10.4
35
Cisco CMX Commands cmxctl start
cmxctl start
To start a Cisco Connected Mobile Experiences (Cisco CMX) service, use the cmxctl start command.
cmxctl start { consul| qlesspyworker | cassandra | iodocs | cache_6382| cache_6383| cache_6380| cache_6381
| cache_6384| cache_6385| influxdb | metrics | confd | cache_6379 | cache_6378 | haproxy | database | analytics | connect | gateway| location | configuration | matlabengine | hyperlocation| nmsplb | agent }
Syntax Description analytics agent cache_6378 cache_6379 cache_6380 cache_6381 cache_6382 cache_6383 cache_6385 cassandra confd configuration connect consul database haproxy hyperlocation location matlabengine
Performs analytics on calculated location data.
Manages Cisco CMX system lifecycle. starts, stops, and monitors all the services running in Cisco CMX.
Caches the service used by location service.
Caches the service used by location service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Enables cassandra database service used by the location service for historical data.
Internal service.
Configures nodes and clusters.
Enables connect services.
Internal service.
Enables the database service used by analytics and configuration service.
Enables the TCP or HTTP load balancer gateway to all service
APIs.
Enables hyperlocation.
Enables location service to compute location.
Provides access point heatmap for location service.
36
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl start metrics nmsplb influxdb iodocs qlesspyworker gateway
Collects system metrics.
Enables the load balancer service used for distributing Network
Mobility Services Protocol (NMSP) messages to location services.
Enables database services used for storing statistics from various services.
Enables online document service for REST API offered by various services.
Internal service.
Enables gateway services that establishes secure bidirectional communication with Cisco CMX Cloud applications.
Command Default None
Examples The following example shows how to display the status for the consul service:
[root@server]# cmxctl start consul
Done
The nodeagent service is currently running with PID: 16718
Done
The analytics service is already running with pid: 1099
Done
Exception while notifying CE
Done
The location service is already running with pid: 16005
Done
Exception while notifying CE
Done
The configuration service is already running with pid: 16165
Done
Exception while notifying CE
Done
The matlabengine service is already running with pid: 1251
Done
Exception while notifying CE
Done
The nmsplb service is already running with pid: 1377
Done
Exception while notifying CE
Cisco CMX Command Reference Guide, Release 10.4
37
Cisco CMX Commands cmxctl status
cmxctl status
To view the status of one or all Cisco Connected Mobile Experiences (Cisco CMX) services, use the cmxctl status command.
cmxctl status { analytics | agent | cache_6378 | cache_6379 | cache_6380| cache_6381 | cache_6382| cache_6383| cache_6385| cassandra | configuration | confd | consul | database | haproxy | location | matlabengine | metrics | nmsplb | influxdb | iodocs | qlesspyworker }
Syntax Description analytics agent cache_6378 cache_6379 cache_6380 cache_6381 cache_6382 cache_6383 cache_6385 cassandra confd configuration connect consul database haproxy hyperlocation location
Performs analytics on calculated location data.
Manages Cisco CMX system lifecycle. starts, stops, and monitors all the services running in Cisco CMX.
Caches the service used by location service.
Caches the service used by location service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Enables cassandra database service used by the location service for historical data.
Internal service.
Configures nodes and clusters.
Enables connect services.
Internal service.
Enables the database service used by analytics and configuration service.
Enables the TCP or HTTP load balancer gateway to all service
APIs.
Enables hyperlocation.
Enables location service to compute location.
38
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl status matlabengine metrics nmsplb influxdb iodocs qlesspyworker gateway
Provides access point heatmap for location service.
Collects system metrics.
Enables the load balancer service used for distributing Network
Mobility Services Protocol (NMSP) messages to location services.
Enables database services used for storing statistics from various services.
Enables online document service for REST API offered by various services.
Internal service.
Enables gateway services that establishes secure bidirectional communication with Cisco CMX Cloud applications.
Usage Guidelines After installing the ISO file on the Cisco MSE 3355 or 3365, use the cmxctl status command to check if the
CMX services are running. If they are not running, use the cmxctl start command.
Examples The following example shows how to display the status for the consul service:
[root@server]# cmxctl status consul
Done
The nodeagent service is currently running with PID: 6190
+----------------+---------------+---------+----------------+
| Host | Service | Status | Uptime (HH:mm) |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Analytics | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6378 | Running | 5 days, 05:52 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6379 | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6380 | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6381 | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6382 | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6383 | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cache_6385 | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Cassandra | Running | 5 days, 05:51 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Confd | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Configuration | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Connect | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Consul | Running | 5 days, 05:52 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Database | Running | 5 days, 05:52 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Haproxy | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
Cisco CMX Command Reference Guide, Release 10.4
39
cmxctl status
| CMX-LowEnd-200 | Hyperlocation | Running | 5 days, 05:47 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Influxdb | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Iodocs | Running | 5 days, 05:50 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Location | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Matlabengine | Running | 5 days, 05:48 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Metrics | Running | 5 days, 05:49 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Nmsplb | Running | 5 days, 05:47 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | Qlesspyworker | Running | 5 days, 05:50 |
+----------------+---------------+---------+----------------+
| CMX-LowEnd-200 | gateway | Running | 5 days, 05:50 |
+----------------+---------------+---------+----------------+
Cisco CMX Commands
40
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl stop
cmxctl stop
To shut down a Cisco Connected Mobile Experiences (Cisco CMX) service, use the cmxctl stop command.
cmxctl stop { analytics | agent | cache_6378 | cache_6379 | cache_6380| cache_6381 | cache_6382| cache_6383| cache_6385| cassandra | configuration | confd | consul | database | haproxy | location | matlabengine | metrics | nmsplb | influxdb | iodocs | qlesspyworker }
Syntax Description analytics agent cache_6378 cache_6379 cache_6380 cache_6381 cache_6382 cache_6383 cache_6385 cassandra confd configuration connect consul database haproxy hyperlocation location matlabengine
Performs analytics on calculated location data.
Manages Cisco CMX system lifecycle. starts, stops, and monitors all the services running in Cisco CMX.
Caches the service used by location service.
Caches the service used by location service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Caches the service used by analytics service.
Enables cassandra database service used by the location service for historical data.
Internal service.
Configures nodes and clusters.
Enables connect services.
Internal service.
Enables the database service used by analytics and configuration service.
Enables the TCP or HTTP load balancer gateway to all service
APIs.
Enables hyperlocation.
Enables location service to compute location.
Provides access point heatmap for location service.
Cisco CMX Command Reference Guide, Release 10.4
41
Cisco CMX Commands cmxctl stop metrics nmsplb influxdb iodocs qlesspyworker
Collects system metrics.
Enables the load balancer service used for distributing Network
Mobility Services Protocol (NMSP) messages to location services.
Enables database services used for storing statistics from various services.
Enables online document service for REST API offered by various services.
Internal service.
Command Default The services are running.
Usage Guidelines
Examples The following example shows how to stop the analytics service:
[root@server]# cmxctl stop analytics
Done
The nodeagent service is currently running with PID: 16987
Stopping analytics Process...
Service analytics with pid: 19095
Retrying..
Done
Successfully shutdown analytics Process.
42
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
cmxctl trace mac
To enable MAC address tracing, use the cmxctl trace mac command.
cmxctl trace mac { add | delete | status } mac mac-address
Syntax Description add delete status
mac mac-address
Add MAC address for tracing
Delete MAC address for tracing
Display MAC address tracing settings
MAC address to be configured
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines
Examples [cmxadmin@CMX-LowEnd-200 ~]$ cmxctl trace mac status
+-------------------+
| MAC Address |
+-------------------+
| 3c:a9:f4:6c:ee:44 |
+-------------------+
| ac:37:43:4b:cc:2f |
+-------------------+
| 3c:a9:f4:6c:5a:ac | cmxctl trace mac
Cisco CMX Command Reference Guide, Release 10.4
43
Cisco CMX Commands cmxctl trace status
cmxctl trace status
To display current trace levels of each CMX service, use the cmxctl trace status command.
cmxctl trace status
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Examples The following example shows how to display current tarce levels:
[root@server]# cmxctl trace mac status
+-------------------+
| MAC Address |
+-------------------+
| 00:01:02:03:04:05 |
+-------------------+
44
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl trace update
cmxctl trace update
To update the trace level of a CMX service, use the cmxctl trace update command.
cmxctl trace update
Syntax Description
service service-to-update
leval travelevel
Configure service to update
Configure trace level [INFO | DEBUG]
Command Default None.
Command History
Release Modification
This command was introduced.
Usage Guidelines
Examples
Related Commands
Command Description
Cisco CMX Command Reference Guide, Release 10.4
45
Cisco CMX Commands cmxctl users
cmxctl users
To list or to configure Cisco Connected Mobile Experiences (Cisco CMX) users using the CLI, use the cmxctl users command.
cmxctl users { list | passwd | username }
Syntax Description list passwd username
Lists all the current users.
Sets the password for a user.
Username of a user in Cisco CMX.
Command Default None.
Examples The following example shows how to list Cisco CMX users using the CLI:
[root@server]# cmxctl users list
+----------+--------------+-----------+
| Username | Full Name | Roles |
+==========+==============+===========+
| monitor | Monitor User | Read Only |
+----------+--------------+-----------+
| admin | Admin User | Admin |
+----------+--------------+-----------+
46
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxctl version
cmxctl version
To know the Cisco Connected Mobile Experiences (Cisco CMX) version, use the cmxctl version command.
cmxctl version
Command Default None.
Examples The following example shows how to display version information for Cisco CMX:
[root@server]# cmxctl version
Build Version : 10.1.0-27
Build Time : 2015-05-05 03:06:45.437430
----------------------------------------------------------------------
Name : cmx-ng-container
Commit Count : 17
Short Hash : bf20ec1
----------------------------------------------------------------------
Name : cmx-ng-location
Commit Count : 5
Short Hash : efc84fa
----------------------------------------------------------------------
Name : cmx-ng-ui
Commit Count : 5
Short Hash : d793df7
----------------------------------------------------------------------
Name : cmx-ova
Build Time : Fri Feb 20 06:34:38 UTC 2015
----------------------------------------------------------------------
Cisco CMX Command Reference Guide, Release 10.4
47
cmxloc delete
cmxloc delete
To delete a location accuracy test in Cisco CMX, use the cmxloc delete command.
cmxloc delete
Command Default None.
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Cisco CMX Commands
48
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxloc download
cmxloc download
To view the link to download the log files, use the cmxloc download command.
cmxloc download test name
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command will move the log files into a location and can be downloaded using a browser.
Cisco CMX Command Reference Guide, Release 10.4
49
Cisco CMX Commands cmxloc find
cmxloc find
To search for the MAC address provided and return all the current attributes for the device, use the cmxloc find command.
cmxloc find MAC address
Syntax Description
MAC Address MAC address of the device.
Command Default None.
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
50
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxloc list
cmxloc list
To list the accuracy tests in Cisco CMX, use the cmxloc list command.
cmxloc list
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Examples The following example shows how to list all Cisco CMX accuracy tests:
[cmxadmin@cmx-nortech ~]$ cmxloc list
+-------+----------+-------------------+---------------+---------------+---------+---------+-------------+
| Name | Status | MAC Address
| Test Points |
+-------+----------+-------------------+---------------+---------------+---------+---------+-------------+
| FB1
| 0
| PAUSED
|
| Comp Freq (s) | Avg Error (m) | 90% (m) | 50% (m)
| 98:07:2d:2a:11:fa | 0.0
| 0.0
| 0.0
| 0.0
+-------+----------+-------------------+---------------+---------------+---------+---------+-------------+
| Test1 | FINISHED | 98:07:2d:2a:11:fa | 61.0
| 2.45
| 3.23
| 1.93
| 1 |
+-------+----------+-------------------+---------------+---------------+---------+---------+-------------+
| Test2 | FINISHED | 98:07:2d:2a:11:fa | 33.25
| 4.36
| 6.27
| 3.44
| 4 |
+-------+----------+-------------------+---------------+---------------+---------+---------+-------------+
Cisco CMX Command Reference Guide, Release 10.4
51
Cisco CMX Commands cmxloc monitor
cmxloc monitor
To monitor the location accuracy test, use the cmxloc monitor command.
cmxloc monitor MAC Address
Syntax Description
MAC Address MAC address of the device.
Command Default None.
Command Modes Admin root userx
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command searches for a client and returns the attributes. The command monitors for any location changes and will update the screen for the new location attributes. Press the enter key to terminate the command execution.
52
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxloc start
cmxloc start
To start a location accuracy test, use the cmxloc start command.
cmxloc start MAC Address Test NameX, Y LocationsTime
Syntax Description
MAC Address
Test Name
X, Y Locations
Time
MAC address of the device to run the location accuracy test.
Name of the new location accuarcy test.
X and Y location information.
Estimated time to run the test.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Usage Guidelines This command triggers the location accuracy test.
Modification
This command was introduced.
Cisco CMX Command Reference Guide, Release 10.4
53
cmxos addswap
cmxos addswap
To add a 10 GB space to the operating system,, use the cmxos addswap command.
cmxos addswap
Command Default This command has no arguments or keywords.
Usage Guidelines This command should be run at the root user level.
Examples The following example shows how to increase disk space in the operating system:
[root@server]# cmxos addswap
10485760+0 records in
10485760+0 records out
10737418240 bytes (11 GB) copied, 29.6845 s, 362 MB/s
Setting up swapspace version 1, size = 10485756 KiB no label, UUID=2734f069-e687-4635-b2d6-9381241bc7ee swap added, run system info to verify
[root@cmx-vmdev146 ~]#
Cisco CMX Commands
54
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
cmxos adminui
To start, stop, and restart the administrator UI, use the cmxos adminui command.
cmxos adminui { start| stop| restart }
Syntax Description start stop restart
Starts the administrator UI.
Stops the administrator UI.
Restarts the administrator UI.
Command Default None
Command History
Release
Cisco CMX Release 10.2
Examples
Modification
This command was introduced.
The following example shows how to stop the administrator UI:
[root@server]# cmxos adminui stop
Stopping adminui...
cmxos adminui
Cisco CMX Command Reference Guide, Release 10.4
55
Cisco CMX Commands cmxos apiserver
cmxos apiserver
To manage Cisco CMX API server, use the cmxos apiserver command.
cmxos apiserver { start | stop | restart| enable| disable| status| user }
Syntax Description start stop restart enable disable status user
Starts the Cisco CMX API server.
Stops the Cisco CMX API server.
Restarts the Cisco CMX API server.
Enables the Cisco CMX API server.
Disables the Cisco CMX API server.
Displays the current status of the Cisco CMX API server.
Sets the userid and password for the CMX API Server.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
56
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos backup
cmxos backup
To back up a node, use the cmxos backup command.
cmxos backup { path| i| all| help }
Syntax Description
--path DIRECTORY
-i, --include_only TEXT
--all
--HELP
Path where the backup file will be created.
Backups selected parts only. Options are database, cache, cassandra, influxdb, consul, floormaps, licenses, setup, and connectimages.
Includes InfluxDB data in backup bundle. If specific options are not selected, only the following services are included in the backup bundle: confd, database, cache, cassandra, floormaps, licenses, setup, and connectimages.
Shows the help content.
Command Default None.
Usage Guidelines This command should to be run using the cmxadmin (non-root) account.
Examples The following example shows how to back up a node:
[[email protected]:~]$ cmxos backup
Please enter the path for backup file [/tmp]:
[17:43:50] Preparing for backup...
[17:43:50] Backup Database...
[17:43:51] Backup Cache...
[17:43:51] Backup Cassandra...
[17:43:53] Backup InfluxDb...
[17:43:53] Backup Consul...
[17:43:53] Backup Floormaps...
[17:43:53] Backup node configuration...
[17:43:59] Creating tar file..
[17:43:59] Done Backup. Created backup file
/tmp/cmx_backup_cmx-vmdev117_2015_03_10_17_43.tar.gz
Cisco CMX Command Reference Guide, Release 10.4
57
cmxos benchmark disk
cmxos benchmark disk
To benchmark disk performance, use the cmxos benchmark disk command.
cmxos benchmark disk [ --verbose ]
Syntax Description
--verbose Prints full output.
Command Default None.
Command History
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
Usage Guidelines You must manually stop all Cisco CMX services before executing this command.
Examples The following example shows how to verify the disk performance:
[root@server]# cmxos benchmark disk
This process will check disk performance on /opt/cmx/srv/
You must stop all CMX services manually before running this command
Do you want to continue?: yes
Running disk performance...this may take a while...please wait...
READ IOPS: 6085, WRITE IOPS: 2024
Cisco CMX Commands
58
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos checkpostgresdatasize
cmxos checkpostgresdatasize
To display postgres data size, use the cmxos checkpostgresdatasize command.
cmxos checkpostgresdatasize
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Examples [root@server]# cmxos checkpostgresdatasize
651488 /opt/cmx/srv/postgres
Cisco CMX Command Reference Guide, Release 10.4
59
Cisco CMX Commands cmxos clean
cmxos clean
To clean up files on CMX, use the cmxos clean command.
cmxos clean { find| normal | { delete }}
Syntax Description find normal delete
Find files over 1 Gigabyte in size.
List files which can be cleaned.
Remove the files listed.
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Examples
Modification
This command was introduced.
The following example shows how to search for large files:
[root@server]# cmxos clean find
Starting search for large files
Size: 1.96G File: /tmp/cmx_backup_CMX-LowEnd-200_2017_01_18_17_56.tar.gz
Size: 2.36G File: /tmp/cmx_backup_CMX-LowEnd-200_2017_03_14_11_16.tar.gz
Size: 2.43G File: /tmp/cmx_backup_CMX-LowEnd-200_2017_03_20_14_36.tar.gz
Size: 2.32G File: /tmp/cmx_backup_CMX-LowEnd-200_2017_01_18_18_00.tar.gz
Size: 1.45G File: /var/log/maillog-20170212.gz
Size: 2.63G File: /var/log/maillog-20170205.gz
Size: 6.84G File: /home/cmxadmin/cmx_backup_CMX-LAC-210_2017_03_23_22_09.tar.gz
Size: 1.17G File: /home/cmxadmin/CISCO_CMX-10.3.0-58.cmx
Completed search for large files
[root@server]# cmxos clean normal
Files which can be removed in: /opt/cmx/var/log
/opt/cmx/var/log/adminui/adminui.pid
/opt/cmx/var/log/adminui/webui.ans
/opt/cmx/var/log/agent/server.log.3
/opt/cmx/var/log/agent/server.log.1
/opt/cmx/var/log/agent/server.log.5
/opt/cmx/var/log/agent/server.log.2
/opt/cmx/var/log/agent/server.log.4
/opt/cmx/var/log/backup.log.2
/opt/cmx/var/log/backup.log.3
/opt/cmx/var/log/setup.log.8
/opt/cmx/var/log/setup.log.7
/opt/cmx/var/log/cmxjobs.log.1
/opt/cmx/var/log/cmxjobs.log.5
[root@server]# cmxos clean normal --delete
Are you sure you wish to remove files? [y/N]: y
Removing files in: /opt/cmx/var/log
Remove: /opt/cmx/var/log/agent/server.log.2
Remove: /opt/cmx/var/log/agent/server.log.1
Remove: /opt/cmx/var/log/cmxjobs.log.5
Remove: /opt/cmx/var/log/cmxjobs.log.2
60
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
Remove: /opt/cmx/var/log/cmxjobs.log.4
Remove: /opt/cmx/var/log/cmxjobs.log.1
Remove: /opt/cmx/var/log/cmxjobs.log.3
cmxos clean
Cisco CMX Command Reference Guide, Release 10.4
61
Cisco CMX Commands cmxos configure
cmxos configure
To configure the network and operating system parameter, use the cmxos configure command.
cmxos configure
Command Default None
Usage Guidelines This command should to be run at the root user level. You can use the --force option to force a fresh configuration if the device is already configured.
Examples The following example shows how to configure the network and operating system parameters:
[root@server]# cmxos configure --force
*** The system is already configured
********************************************************************************
Checking if the machine meets required specification...
********************************************************************************
+----------+------------------------+--------------+--------+
| Check | expected | actual | Result |
+==========+========================+==============+========+
| memory | 8GB | 25GB | ? |
+----------+------------------------+--------------+--------+
| cpu | 4 | 8 | ? |
+----------+------------------------+--------------+--------+
| disk | 50GB | 51GB | ? |
+----------+------------------------+--------------+--------+
| hostname | rfc compliant hostname | cmx-vmdev146 | ? |
+----------+------------------------+--------------+--------+
62
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
cmxos etchosts
To configure etc hosts, use the cmxos etchosts command.
cmxos etchosts
Syntax Description This command has no arguments or keywords.
Command Default None.
Command History
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
Usage Guidelines This command will run and returns no status.
Examples
[root@server]# cmxos etchosts
[root@cmx-vmdev185 cmxadmin]# cmxos etchosts --help
Usage: __main__.py etchosts [OPTIONS]
Configure /etc/hosts properly
Options:
--help Show this message and exit.
cmxos etchosts
Cisco CMX Command Reference Guide, Release 10.4
63
Cisco CMX Commands cmxos firstboot
cmxos firstboot
To set up the Cisco Connected Mobile Experiences (Cisco CMX) again, use the cmxos firstboot command.
cmxos firstboot
Command Default None.
Usage Guidelines This command should be run at the root user level. You can use the --force option to force a fresh configuration if the device is already configured.
Examples The following example shows how to set up Cisco CMX again:
[root@server]# cmxos firstboot
Not first boot....Exiting...
64
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos fixhaproxy
cmxos fixhaproxy
To verify the HA proxy permissions on Cisco Connected Mobile Experiences (Cisco CMX), use the cmxos fixhaproxy command.
cmxos fixhaproxy
Command Default None.
Usage Guidelines This command should be run at the root user level.
Examples The following example shows how to verify HA proxy permissions:
[root@server]# cmxos fixhaproxy
Raising haproxy setcap...
Cisco CMX Command Reference Guide, Release 10.4
65
cmxos health
cmxos health
To check health of Cisco CMX system, use the cmxos health command.
cmxos health filedescriptors
Syntax Description filedescriptors Checks file descriptors.
Command Default None.
Command History
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
Usage Guidelines This command returns the total number of file descriptors in open status.
Examples The following examples shows how to check health of Cisco CMX system:
[root@server]# cmxos health filedescriptors
2195 total file descriptors open
Cisco CMX Commands
66
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos inventory
cmxos inventory
To show full inventory of a node, use the cmxos inventory command.
cmxos inventory
Command Default None.
Command History
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
Examples The following example shows how to view the inventory details:
[root@server]# cmxos inventory
UDI: AIR-MSE-3365-K9 Serial Number FCH1904V055
State of the RAID array: Healthy and working normally
Capacity of the RAID array: 1.088 TB
Type of disks in RAID array: Spinning Disk Drive
All chassis fans operating normally
One of the power supplies in the chassis has failed or it has not been installed/connected
Disk Capacity: 1.0T
Disk space used: 33.2G
Memory installed: 63.00G
CPUs installed: 20
CPU Type: Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz
Server uptime: 6 Hours, 59 Minutes, 44 Seconds
Server boot time: Mon, 27 Mar 2017 16-44-36
Number of server reboots: 1
Cisco CMX Command Reference Guide, Release 10.4
67
cmxos kill
cmxos kill
To kill services, use the cmxos kill command.
cmxos kill silent
Syntax Description
--silent Slinetly kills services without confirmation.
Command Default None.
Command History
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
Usage Guidelines
Examples
[root@cmx-vmdev185 cmxadmin]# cmxos kill
This command will force kill all CMX processes, for dev use only
Do you want to continue?:
Cisco CMX Commands
68
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos monit
cmxos monit
To manage the monitoring of Cisco CMX services, use the cmxos monit command.
cmxos monit { configure| start| stop| wipe }
Syntax Description configure start stop wipe
Configures the default monitor settings.
Enables monitored services.
Enables monitored services.
Deletes the default monitoring settings.
Note To reset to the default monitoring settings, use the cmxos monit configure command
Command Default Disabled.
Command History
Release
Release 10.2.0
Examples
Modification
This command was introduced.
The following example shows how to display the monitoring settings:
[cmxadmin]$ cmxos monit configure
Deleting all monit configurations....
Configuring monit mail settings...
Configuring monit OS settings...
Configuring monit CMX services settings...
The following example shows how to enable monitoring of Cisco CMX services:
[cmxadmin]$ cmxos monit start
Starting monit:
Cisco CMX Command Reference Guide, Release 10.4
69
Cisco CMX Commands cmxos openports
cmxos openports
To open ports, based on a node rule, use the cmxos openports command.
cmxos openports { analytics | location | database }
Syntax Description analytics location database
Adds a 10-GB swap space to a node.
Configures the network and operating system parameters.
Sets up the Cisco Connected Mobile Experiences (Cisco CMX) database again.
Command Default None.
Usage Guidelines This command should be run at the root user level.
Examples The following example shows how to open ports based on a node:
[root@server]# cmxos openports analytics
Opened port 6541
Opened port 6542
Successfully opened all ports. Saving iptables info...
70
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos reconfigure
cmxos reconfigure
To change network configuration information after deployment, use the cmxos reconfigure command.
cmxos reconfigure
Command Default None
Usage Guidelines This command, which should be run at the root user level, also allows you to change the IP address, netmask, default gateway, and DNS server information. Changing the hostname through command line is not supported.
Use the cmxos reconfigure command to chnage a hostname, IP address, or any of the network parameters.
Note Do not execute the cmxos reconfigure command when Cisco CMX services are not installed. This will prevent execution failures.
Examples The following example shows how to reconfigure the network after Cisco CMX installation:
[root@server]# cmxos reconfigure
Note This command opens the Device Configuration window, where you can take the appropriate action, thatis reconfigure the device or the DNS.
Cisco CMX Command Reference Guide, Release 10.4
71
Cisco CMX Commands cmxos restore
cmxos restore
To restore a node, use the cmxos restore command.
cmxos restore { file| path| i| help }
Syntax Description
--file PATH
--path DIRECTORY
-i, --include_only TEXT
--HELP
Path where the restore file is located.
Path where the restore file will be created.
Restore selected parts only. Options are database, cache, cassandra, influxdb, consul, floormaps, licenses, setup, connectimages.
Shows the help content.
Command Default None.
Usage Guidelines By default, this command performs restoration of all services excluding the InfluxDB data service. If you want to restore InfluxDB data, explicitly enter the InfluxDB service name along with other services by using
--include_only while running the command.
Examples The following example shows how to restore a node:
[root@server]# cmxos restore
Please enter the backup file path: /tmp/cmx_backup_cmx-vmdev117_2015_03_10_17_43.tar.gz
[17:44:12] Preparing for restore...
[17:44:12] Untarring backup file...
[17:44:13] Stopping all services...
[17:44:16] Restoring Database...
Restarting database...
[17:44:26] Restoring Cache...
Stopping cache_6379...
Restarting cache_6379...
Stopping cache_6381...
Restarting cache_6381...
Stopping cache_6380...
Restarting cache_6380...
[17:44:55] Restoring Cassandra...
Stopping Cassandra...
Restarting Cassandra...
...............
[17:45:19] Restoring Influxdb...
[17:45:19] Restoring consul...
[17:45:19] Restoring floormaps...
[17:45:19] Running Post Restore Tasks...
[17:45:19] Migrating Schemas...
[17:45:19] Migrating Cassandra schemas...
[17:45:20] Restarting all services...
[17:45:23] Done
72
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands
cmxos sslcert
To replace default haproxy certificate, use the cmxos sslcert command.
cmxos sslcert
Command Default None.
Command History
Release
Cisco CMX Release 10.2
Modification
This command was introduced.
Examples cmxos sslcert
Cisco CMX Command Reference Guide, Release 10.4
73
Cisco CMX Commands cmxos sysproxy
cmxos sysproxy
To enable an outbound proxy on your Cisco CMX server, use the cmxos sysproxy command.
cmxos sysproxy { clear| disable| enable| no_proxy| proxy| show| ftp_proxy| http_proxy| https_proxy }
Syntax Description clear disable enable no_proxy proxy show ftp_proxy http_proxy https_proxy
Removes the proxy settings.
Disables the use of the proxy settings.
Enables the use of the proxy settings.
Sets the no_proxy environment variable.
Sets the proxy environment variables for http_proxy, https_proxy, ftp_or proxy.
Displays the proxy settings.
Sets the ftp proxy.
Sets the http proxy.
Sets the https proxy.
Command Default Proxy is disabled.
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3.1
Modification
This command was introduced.
Usage Guidelines This command supersedes the information from this post: https://communities.cisco.com/docs/DOC-70904 .
Use this command for environments where an outbound proxy is required on the Cisco CMX server. For example, if you happen to be in a secure internal network where even outbound traffic via HTTPS requires that it move through a proxy server.
If you set the proxy setting on the Cisco CMX server, make sure to use the no_proxy setting on the attached controllers to avoid interference with the NMSP Network Mobility Services Protocol (NMSP).
If you change the Cisco CMX proxy settings, you must restart Cisco CMX for the change to take effect. Use the cmxctl restart command to restart Cisco CMX.
74
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos sysproxy
Examples The following example shows how to set a proxy on the Cisco CMX server, and then verify the change and restart Cisco CMX:
[root@server]# cmxos sysproxy proxy https://proxy-wsa.esl.cisco.com:80
[root@server]# cmxos sysproxy show
USE_PROXY=1
PROXY_URL=http://proxy-wsa.esl.cisco.com:80
NO_PROXY_LIST=""
[root@server]# cmxctl restart
The following example shows how to enable a proxy on the Cisco CMX server, and then verify the change and restart Cisco CMX:
[root@server]# cmxos sysproxy enable
[root@server]# cmxos sysproxy show
USE_PROXY=1
PROXY_URL=http://proxy-wsa.esl.cisco.com:80
NO_PROXY_LIST=""
[root@server]# cmxctl restart
The following example shows how to disable a proxy on the Cisco CMX server, and then verify the change and restart Cisco CMX:
[root@server]# cmxos sysproxy disable
[root@server]# cmxos sysproxy show
USE_PROXY=0
PROXY_URL=http://proxy-wsa.esl.cisco.com:80
NO_PROXY_LIST=""
[root@server]# cmxctl restart
The following example shows how to clear proxy settings, and then verify the change and restart Cisco CMX:
[root@server]# cmxos sysproxy clear
[root@server]# cmxos sysproxy show
USE_PROXY=0
PROXY_URL=""
NO_PROXY_LIST=""
[root@server]# cmxctl restart
Cisco CMX Command Reference Guide, Release 10.4
75
cmxos techsupport
cmxos techsupport
To collect technical support information, use the cmxos techsupport command.
cmxos techsupport { all | cmx | location | map | network | services | system }
Syntax Description all cmx location map network services system silent
Collect all technical support information
Collect CMX information
Collect location support information
Collect map support information
Collect network information
Collect CMX services information.
Collect system information
Silently run with prompting
Command Default None.
Usage Guidelines This command will return all CLI command outputs helpful for debugging.
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Cisco CMX Commands
76
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos techsupport dump
cmxos techsupport dump
To dump all technical support information, use the cmxos techsupport dump command.
cmxos techsupport dump
Command Default None.
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Cisco CMX Command Reference Guide, Release 10.4
77
Cisco CMX Commands cmxos upgrade
cmxos upgrade
To upgrade Cisco Connected Mobile Experiences (Cisco CMX) with a new Red Hat Package Manager (RPM) or package, use the cmxos upgrade command.
cmxos upgrade
Command Default None.
Usage Guidelines This command should be run at the root user level. The CLI accepts either a local file or an HTTP URL. This command works only when you have a later version than the existing one to upgrade.
Examples The following example shows how to upgrade the Cisco CMX using RPM or package:
[root@server]# cmxos upgrade
The nodeagent service is not running.
Agent is not running, starting it now.
Starting nodeagent Process...
Stopping nodeagent Process...
Done
Successfully shutdown nodeagent Process.
Stopping consul Process...
Successfully shutdown consul Process.
Stopping qlesspyworker Process...
Successfully shutdown qlesspyworker Process.
Stopping cassandra Process...
Successfully shutdown cassandra Process.
Stopping iodocs Process...
The iodocs service is not running.
Stopping redis6383 Process...
Successfully shutdown redis6383 Process.
Stopping redis6380 Process...
Successfully shutdown redis6380 Process.
Stopping redis6381 Process...
Successfully shutdown redis6381 Process.
Stopping influxdb Process...
The influxdb service is not running.
Stopping collectd Process...
The collectd service is not running.
Stopping confd Process...
The confd service is not running.
Stopping redis6379 Process...
Successfully shutdown redis6379 Process.
Stopping redis6378 Process...
Successfully shutdown redis6378 Process.
Stopping haproxy Process...
Stopping postgres Process...
Successfully shutdown postgres Process.
Stopping analytics Process...
The analytics service is not running.
Stopping location Process...
The location service is not running.
Stopping configuration Process...
The configuration service is not running.
Stopping halo Process...
The halo service is not running.
Stopping matlabengine Process...
The matlabengine service is not running.
Stopping nmsplb Process...
The nmsplb service is not running.
Shutting down
78
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX Commands cmxos vacuumdb
cmxos vacuumdb
To run the full vacuum command on the postgres database running within Cisco CMX, use the cmxos vacuumdb command.
cmxos vacuumdb
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.4
Modification
This command was introduced.
Usage Guidelines This command internally runs the ‘ vacuumdb – vfa ’ on the postgres DB. This command is an advanced command and should not be regularly used by the customer. In case of the postgres DB taking up too much disk space, this command may be run to compact the DB.
Cisco CMX Command Reference Guide, Release 10.4
79
cmxos verify
cmxos verify
To verify the virtual machine configuration, use the cmxos verify command.
cmxos verify
Command Default None.
Examples The following example shows how to verify the virtual machine configuration:
[root@server]# cmxos verify
+----------+------------------------+--------------+--------+
| Check | expected | actual | Result |
+==========+========================+==============+========+
| memory | 8GB | 25GB | ? |
+----------+------------------------+--------------+--------+
| cpu | 4 | 8 | ? |
+----------+------------------------+--------------+--------+
| disk | 50GB | 51GB | ? |
+----------+------------------------+--------------+--------+
| hostname | rfc compliant hostname | cmx-vmdev146 | ? |
+----------+------------------------+--------------+--------+
Cisco CMX Commands
80
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands
•
•
•
•
•
•
•
•
•
•
•
•
•
Cisco CMX Command Reference Guide, Release 10.4
81
Cisco CMX High Availability Commands cmxha info
cmxha info
To view Cisco CMX high availability (HA) information, such as version, IP addresses, and so on, use the cmxha info command.
cmxha info
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Examples The following example shows how to print Cisco CMX HA information:
[cmxadmin@CMXHAPrimary ~]$ cmxha info
Version
Current Server Time
State
State Description
: 10.3.0-599
: Fri Mar 24 02:31:31 2017
: Primary Not Configured
: Primary has not been configured with a secondary
State Last Updated Time : Mon Nov 7 13:42:39 2016
Keepalived State : Stopped
Keepalived Updated Time : Mon Nov 7 13:42:39 2016
Role : PRIMARY
Primary IP Address : 192.0.2.1
Secondary IP Address :
Use Virtual IP Address : True
Virtual IP Address
Failover Type
:
: Automatic Failover
Email Notify Address :
--------------- Primary WLC Auth ---------------
MAC Address :
SHA1 Key
SHA2 Key
:
:
-------------- Secondary WLC Auth --------------
MAC Address :
SHA1 Key
SHA2 Key
:
:
--------------- System Information ---------------
Total Memory
Total Disk
: 25.0
GB
: 157.0 GB
Number of CPUs : 8
--------------- Version Information ---------------
Redis Version : 2.8.6
82
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands
Postgres Version
Cassandra Version
: 9.3.11
: 2.1.13
cmxha info
Cisco CMX Command Reference Guide, Release 10.4
83
Cisco CMX High Availability Commands cmxha config
cmxha config
To configure Cisco CMX high availability (HA), use the cmxha config command.
cmxha config { disable| enable| modify | { email | failover } | test | { email }}
Syntax Description disable enable modify email failover test email
Disables CMX HA configuration.
Enables CMX HA configuration.
Modifies CMX HA configuration.
Enter the email address.
Enter the failover type as either Manual or
Automatic .
Tests the CMX HA configuration.
Sends a test email with current email settings.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Examples The following example shows how to enable CMX HA:
[cmxadmin@CMXHAPrimary ~]$ cmxha config enable
Are you sure you wish to enable high availability? [y/N]: y
Please enter secondary IP address: 192.0.2.1
Please enter the cmxadmin user password for secondary:
Do you wish to use a virtual IP address? [y/N]: y
Please enter the virtual IP address: 192.0.2.2
Please enter failover type [manual|automatic]: automatic
Please enter an email address(es) for notifications (Use space, comma or semicolon to separate): [email protected]
Attempting to configure high availability with server: 192.0.2.1
Configuring primary server for HA
84
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands
Configuring secondary server for HA
........................................................................
Synchronizing Postgres data from primary to secondary
.........
Synchronizing Cassandra data from primary to secondary
....................
Syncing primary files to secondary
Successfully started high availability. Primary is syncing with secondary.
cmxha config
Cisco CMX Command Reference Guide, Release 10.4
85
Cisco CMX High Availability Commands cmxha secondary
cmxha secondary
To convert the system to a secondary server and display Cisco CMX high availability (HA) information, use the cmxha secondary command.
cmxha secondary { convert | info }
Syntax Description convert info
Converts the system to a secondary server.
Displays CMX HA information.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level. This command will retrieve the current information from the secondary server. If the current server is the primary server, this command will query the remote secondary server. If the current server is the secondary server, the local information is displayed. Use this command to display the server status in order to understand the remote status of the server.
Examples The following example shows how to view secondary server information:
[cmxadmin@CMXHAPrimary ~]$ cmxha secondary info
Version
Current Server Time
State
State Description
: 10.3.0-600
: Sun Apr 2 23:21:07 2017
: Secondary Not Configured
: Secondary has not been configured with a primary
State Last Updated Time : Thu Mar 30 21:58:25 2017
Keepalived State : Stopped
Keepalived Updated Time : Thu Mar 30 21:58:25 2017
Role : SECONDARY
Primary IP Address
Secondary IP Address
:
: 192.0.2.1
Use Virtual IP Address : True
Virtual IP Address
Failover Type
:
: Automatic Failover
Email Notify Address :
--------------- Primary WLC Auth ---------------
MAC Address
SHA1 Key
:
:
SHA2 Key :
-------------- Secondary WLC Auth --------------
86
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands
MAC Address
SHA1 Key
:
:
SHA2 Key :
--------------- System Information ---------------
Total Memory : 25.0
GB
Total Disk
Number of CPUs
: 156.0 GB
: 8
--------------- Version Information ---------------
Redis Version : 2.8.6
Postgres Version
Cassandra Version
: 9.3.11
: 2.1.13
cmxha secondary
Cisco CMX Command Reference Guide, Release 10.4
87
Cisco CMX High Availability Commands cmxha events
cmxha events
To view Cisco CMX high availability (HA) events, use the cmxha events command.
cmxha events
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Examples The following example shows how to view CMX HA events:
[cmxadmin@CMXHAPrimary ~]$ cmxha events
Time State Description
------------------------------------------------------------------------------------------
Fri Dec 2 01:15:02 2016 Primary Configure Invoked Attempting to initialize primary server
Fri Dec 2 01:15:17 2016 Primary Syncing Primary Syncing
Wed Dec 14 03:19:53 2016 Primary Initialize
Wed Dec 14 03:24:56 2016 Primary Syncing
Wed Dec 14 03:34:38 2016 Primary Active secondary server
Wed Dec 14 03:34:38 2016 Primary Active
Primary is sync
Wed Dec 14 04:00:02 2016 Primary Active
Attempting to initialize primary server
Primary Syncing
Primary is actively synchronizing with
Successfully enabled high availability.
Service check failed for master. Attempt to restart ser
Wed Dec 14 04:02:01 2016 Primary Active Service check succeeded for master after agent restart
Tue Dec 20 04:50:12 2016 Primary Disable Invoked Attempting to disable high availability
Tue Dec 20 04:52:13 2016 Primary Disable Invoked Successfully disabled high availability.
88
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands cmxha failover
cmxha failover
To fail over to the secondary server, use the cmxha failover command.
cmxha failover
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines The command prompts for confirmation and then initiates the failover to the secondary server.
Examples The following example shows how to initiate the failover to the secondary server:
[cmxadmin@CMXHAPrimary ~]$ cmxha failover
Are you sure you wish to failover to the secondary? [y/N]: y
Starting failover from primary to secondary server: 192.0.2.250
Syncing primary files to secondary
Configuring secondary server for Failover
Configuring primary server for Failover
Failover to secondary server has completed successfully
Cisco CMX Command Reference Guide, Release 10.4
89
Cisco CMX High Availability Commands cmxha failback
cmxha failback
To fail back to the primary server, use the cmxha failback command.
cmxha failback
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines The command prompts for confirmation and then initiates the failback to the primary server. We recommend that you run this command from the web UI. Note that this command requires a considerable amount of time for execution.
Examples The following example shows how to initiate the failback to the primary server:
[cmxadmin@CMXHAPrimary ~]$ cmxha failback
Are you sure you wish to failback to the primary? [y/N]: y
Starting to failback to primary server from secondary server: 192.0.2.250
Starting to synchronize data from secondary to primary server
...........................................................................................
Completed synchronization of data from secondary to primary server
Starting to synchronize data from primary to secondary server
........................................................................................
Completed failback to primary server
90
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands cmxha primary
cmxha primary
To convert the system to a primary server and display CMX high availability (HA) information, use the cmxha primary command.
cmxha primary { convert | info }
Syntax Description convert info
Converts the system to a primary server.
Displays the CMX HA information.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level. This command will retrieve the current information from the primary server. If the current server is a secondary server, this command will query the remote primary server. If the current server is the primary server, the local information is displayed. Use this command to display the server status in order to understand the remote status of the server.
Examples The following example shows how to convert the system to a primary server:
[cmxadmin@CMXHAPrimary ~]$ cmxha primary convert
This command should be run when HA is disabled and not configured.
Are you sure you wish to convert the system to a primary? [y/N]: y
Starting all services. This may take a while..
Started all services
Successfully completed primary convert
Cisco CMX Command Reference Guide, Release 10.4
91
Cisco CMX High Availability Commands cmxha diag
cmxha diag
To collect Cisco CMX high availability (HA) diagnostic information, use the cmaxha diag command.
cmxha diag collect
Syntax Description collect Collects logs and diagnostic information from the primary and secondary servers.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Examples The following example shows how to collect CMX HA diagnostic information:
[cmxadmin@CMXHAPrimary ~]$ cmxha diag collect
Please enter a description for the diagnostic collection: collect
Collected local diagnostic files into file:
/opt/cmx/srv/cmx-ha-diags/cmx_ha_diag_192.0.2.1_2017-04-02.tar.gz
[cmxadmin@CMX-LowEnd-2 ~]$
92
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands cmxha filesync
cmxha filesync
To synchronize files between the primary server and the secondary server, use the cmxha filesync command.
cmxha filesync replicate
Syntax Description replicate Replicates files to the secondary server.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level. We recommend that you run this command with Cisco
TAC assistance.
Cisco CMX Command Reference Guide, Release 10.4
93
Cisco CMX High Availability Commands cmxha init
cmxha init
To configure high availability (HA) at startup, use the cmxha init command.
cmxha init
Syntax Description This command has no arguments or keywords.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level. We recommend that you run this command with Cisco
TAC assistance.
94
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands cmxha logging
cmxha logging
To change or view the logging level of Cisco CMX high availability (HA), use the cmxha logging command.
cmxha logging { config { debug | info }| status }
Syntax Description config debug info status
Changes the logging level of CMX HA.
Sets the logging level to debug.
Sets the logging level to info.
Shows the current logging level.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level. We recommend that you run this command with Cisco
TAC assistance.
Examples The following example shows how to view the CMX HA logging level:
[cmxadmin@CMXHAPrimary ~]$ cmxha logging config info
Completed changing logging level to info
Cisco CMX Command Reference Guide, Release 10.4
95
Cisco CMX High Availability Commands cmxha splitbrain
cmxha splitbrain
To manage the Cisco CMX high availability (HA) split-brain scenario, use the cmxha splitbrain command.
cmxha splitbrain { info | use-primary | use-secondary }
Syntax Description info use-primary use-secondary
Displays information about the CMX HA split-brain scenario.
Uses the primary server in the split-brain scenario.
Uses the secondary server in the split-brain scenario.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level.
Examples The following example shows how to view CMX HA split-brain scenario information:
[cmxadmin@CMXHAPrimary ~]$ cmxha splitbrain info
System is not in split-brain state currently
96
Cisco CMX Command Reference Guide, Release 10.4
Cisco CMX High Availability Commands cmxha web
cmxha web
To enable or disable the high availability (HA) web services, use the cmxha web command.
cmxha web { disable | enable | status }
Syntax Description disable enable status
Disables the HA web service.
Enables the HA web service.
Shows the status of the HA web services.
Command Default None
Command Modes Admin root user
Command History
Release
Cisco CMX Release 10.3
Modification
This command was introduced.
Usage Guidelines This command should be run at the cmxadmin level. We recommend that you run this command with Cisco
TAC assistance.
Examples The following example shows how to view web service status: cmxadmin@CMXHAPrimary ~]$ cmxha web status
Web service enabled
Web service running
: True
: True
Cisco CMX Command Reference Guide, Release 10.4
97
cmxha web
Cisco CMX High Availability Commands
98
Cisco CMX Command Reference Guide, Release 10.4
I N D E X
C
cmxctl checkdb
cmxctl checklogs
cmxctl config controllers
cmxctl config import
cmxctl config maps
cmxctl config reload
cmxctl config verify
cmxctl debug
cmxctl disable
cmxctl dump
cmxctl enable
cmxctl influxdb wipe --silent
cmxctl jobs
cmxctl metrics notification
cmxctl node
cmxctl restart
cmxctl start
cmxctl status
cmxctl stop
cmxctl trace mac
cmxctl trace status
cmxctl trace update
cmxctl users
cmxctl version
cmxos addswap
cmxos backup
cmxos benchmark disk
cmxos checkpostgresdatasize
cmxos clean
cmxos configure
cmxos etchosts
cmxos firstboot
cmxos fixhaproxy
cmxos health filedescriptors
cmxos inventory
cmxos kill silent
cmxos openports
cmxos reconfigure
cmxos restore
cmxos sslcert
cmxos techsupport
cmxos techsupport dump
cmxos upgrade
cmxos verify
Cisco CMX Command Reference Guide, Release 10.4
IN-1
Index
IN-2
Cisco CMX Command Reference Guide, Release 10.4
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement