configuration_csv - bruno-beloff/scs_analysis GitHub Wiki
docs > software repositories > scs_analysis > commands > estate management
DESCRIPTION
The configuration_monitor utility is used to download configuration information from all devices accessible to the user, and render this in CSV form. Four modes are available:
-
--separate - download the latest configuration for all devices, and save this to separate CSV files, each named for a node. Any nodes specified on the command line are ignored.
-
--latest - download the latest configuration for all devices, and save this in the named CSV file.
-
--diff-histories - download the history of configuration changes for all devices. Where there has been at least one change in the configuration for each device, save the history files in the named directory.
-
--full-histories - download the history of all configuration changes for all devices.
Nodes are:
hostname, packs, afe-baseline, afe-id, aws-api-auth, aws-client-auth, aws-group-config, aws-project, csv-logger-conf, display-conf, gas-baseline, gas-model-conf, gps-conf, interface-conf, greengrass-identity, mpl115a2-calib, mqtt-conf, ndir-conf, opc-conf, opc-version, pmx-model-conf, pressure-conf, psu-conf, psu-version, pt1000-calib, scd30-baseline, scd30-conf, schedule, shared-secret, sht-conf, networks, modem, sim, system-id, timezone-conf
For separate and latest modes, two rec values are included:
-
rec.report - the most recent time that the device reported its status
-
rec.update - the most recent time that at least one of the fields changed value (not that those fields might not be included in the CSV file)
For diff-histories and full-histories modes, a single rec value is included, equivalent to rec.update.
Output CSV cell values are always wrapped in quotes ('"').
The --credentials flag is only required where the user wishes to store multiple identities. Setting the credentials is done interactively using the command line interface.
SYNOPSIS
configuration_csv.py [-c CREDENTIALS] { -n | -s | -l OUTPUT_CSV | { -d | -f } [-o OUTPUT_CSV_DIR] } [-t DEVICE_TAG [-x]] [-v] [NODE_1..NODE_N]
| Options | |
|---|---|
| --version | show program's version number and exit |
| -h, --help | show this help message and exit |
| -n, --node-names | list the available nodes |
| -s, --separate | retrieve latest configurations to separate CSVs (ignores NODEs) |
| -l LATEST, --latest=LATEST | retrieve latest configurations to single CSV |
| -d, --diff-histories | retrieve configuration history differences |
| -f, --full-histories | retrieve full configuration histories |
| -t DEVICE_TAG, --device-tag=DEVICE_TAG | the device for the history report |
| -x, --exactly | exact match for tag |
| -o OUTPUT_CSV_DIR, --output-csv-dir=OUTPUT_CSV_DIR | the directory in which to write histories |
| -v, --verbose | report narrative to stderr |
EXAMPLES
configuration_csv.py -vs configs.csv
configuration_csv.py -vdo afe_ids afe-id
configuration_csv.py -vft scs-bgx-431
SEE ALSO
scs_analysis/cognito_user_credentials
scs_analysis/configuration_monitor
scs_analysis/configuration_monitor_check
scs_analysis/configuration_report