config

Usage

>> config [ count maxcount list ]

>> config <config_label> [ schedulelist ]

>> config create <configuration_label>

>> config delete <configuration_label> | all

Security

Open.

Description

This command is used to access information regarding all of the sampling configurations within the instrument. Configurations contain a list of schedules to be run in a deployment. The configuration is specified at the time of enabling the instrument. Configurations can be created, deleted, accessed, and modified, however, they cannot be renamed. If renaming is required it is recommended to delete the configuration and create a new configuration with the appropriate label.

To access meta information about all configurations which exist in the instrument, the config command can be used without any arguments. If a specific parameter is required, the parameter name can be provided as an argument to the config command. In this case only that parameter will be returned in response. The list of parameters are as follows:

• count reports the number of configurations currently defined.

• maxcount reports the maximum number of configurations that the logger can hold in its pool at any given time.

• list reports by label all defined configurations; labels in the list are separated by a pipe character (“|”), with no spaces.  Labels are reported in the order that the configurations were created, earliest first.

>> config
<< config count=5 maxcount=16 list=test_config|config_01|config_02|cfg_profiling|default_config

>> config list
<< config list=test_config|config_01|config_02|cfg_profiling|default_config

To access parameters for a specific config, provide the <config_label> as an argument to the config command. The following parameters are available for a given config:

• schedulelist reports a list of schedules to be executed when this configuration is used to enable a deployment.  Labels in the list must be separated by a pipe character ('|'), with no spaces.  The list must specify at least one valid schedule before the configuration can be used.  Specifying the keyword none, by itself, in place of a list of schedule labels, will clear the schedule list for the config. A maximum of eight schedule labels can be added to the schedulelist.

>> config
<< config count=5 maxcount=16 list=test_config|config_01|config_02|cfg_profiling|default_config

>> config config_01
<< config config_01 schedulelist=default_schedule

Modifications can only be performed on a single config at a time. In order to access or modify properties for a specific config, provide the <config_label> as an argument to the configs command. Currently there is only a single parameter available for a given config:

• schedulelist reports or sets a list of schedules to be executed when this configuration is used to enable a deployment.  Labels in the list must be separated by a pipe character (“|”), with no spaces.  The list must specify at least one valid schedule before the configuration can be used.  Specifying the keyword none, by itself, in place of a list of schedule labels, will clear the schedule list for the config.

A maximum of eight schedule labels can be added to the schedulelist.

Here are some points to be aware of when modifying a configuration.

• Any modification made to a configuration will apply only when it is used for future deployments; historical datasets in the logger's memory are not affected.

• The order of <schedule_labels> in the <schedule_label_list> does not matter.

>> config cfgPrimary
<< config cfgPrimary schedulelist=default_schedule

>> config cfgPrimary schedulelist = schedule_fast|schedule_burst
<< config cfgPrimary schedulelist=schedule_fast|schedule_burst

>> config cfgPrimary
<< config cfgPrimary schedulelist=schedule_fast|schedule_burst

create

Usage

>> config create <configuration_label>

Security

Unsafe - configurations may not be created while logging is enabled.

Description

A configuration can be created using the create actions within the config command. The <config_label> must be specified as an argument to the action.

>> config
<< config count=5 maxcount=16 list=test_config|config_01|config_02|cfg_profiling|default_config

>> config create standard_config
<< config create standard_config

>> config
<< config count=6 maxcount=16 list=test_config|config_01|config_02|cfg_profiling|default_config|standard_config

delete

Usage

>> config delete <configuration_label> | all

Security

Unsafe - configurations may not be deleted while logging is enabled.

Description

Deletes one or all configurations.  Configurations are specified by their labels.  At least one existing configuration must be specified.  The parameters are as follows:

• <configuration_label> specifies, by label, a single configuration to delete from the pool.

• all causes all user-defined configurations to be deleted from the pool.

A deleted configuration can no longer be used for a future deployment.  Any historical deployments in the logger memory that used the deleted configuration are not affected; all datasets include as part of their metadata a snapshot of the configuration when the logger was enabled.

>> config
<< configs count=6 maxcount=16 list=test_config|config_01|config_02|cfg_profiling|default_config|standard_config

>> config delete config_01
<< config delete config_01

>> config
<< config count=5 maxcount=16 list=test_config|config_02|cfg_profiling|default_config|standard_config

Deleting config_01 removes it from the pool and reduces the count by one.

>> config
<< configs count=6 maxcount=16 list=test_config|config_01|config_02|cfg_profiling|default_config|standard_config

>> config delete all
<< config delete all

>> config
<< config count=0 maxcount=16 list=none

Deleting all configurations removes all items from the pool and reduces the count to zero. The configuration list will indicate it is empty with the value of none.