CLI Syntax for 'sklnctl'

Description

"sklnctl" is a CLI tool for administrators to interact with the configuration of different Skyline components.

Important - On a Scalable Platform Security Group, you must run "g_all sklnctl" (except for the help commands).

Syntax for General Commands

sklnctl {-h | --help}

sklnctl {-v | --version}

sklnctl --show_open_telemetry

where:

Parameter

Description

sklnctl -h

sklnctl --help

Shows the built-in help.

sklnctl -v

sklnctl --version

Shows the "sklnctl" version.

sklnctl --show_open_telemetry

Shows the state and the exported targets.

Syntax to collect logs for Skyline troubleshooting

sklnctl collect_logs

where:

Parameter

Description

sklnctl collect_logs

Collects various log files from these directories for Skyline troubleshooting:

  • /opt/CPotelcol

  • /opt/CPviewExporter

  • /opt/CPotlpAgent

  • /var/log/nano_agent

  • /etc/cp/conf/

  • $CPDIR/log

Syntax to configure the Skyline OpenTelemetry Collector

For information about the Skyline OpenTelemetry Collector, see sk180522.

sklnctl collector

      {-h | --help}

      --update <Path to Configuration File>

where:

Parameter

Description

sklnctl collector {-h | --help}

Shows the built-in help for this command.

sklnctl collector --update <Path to Configuration File>

Loads the OpenTelemetry Collector configuration from the specified file.

Syntax to configure the Skyline OpenTelemetry Collector metric filter

sklnctl otelcol

      {-h | --help}

      --start

      --stop

      --restart

      --reload

      --status

      --enable

      --status

      --disable

      --is-active

      --is-enabled

      --is-failed

      --config

      --config --reset

      --pipeline --list

      --pipeline --status <pipeline>

      metrics

            {-h | --help}

            --add <Metric-ID-1> <Metric-ID-2> ...

            --insert-cp-label

            --is-default

            --remove <Metric-ID-1> <Metric-ID-2> ...

            --remove-cp-label

            --reset

            --show

where:

Parameter

Description

sklnctl otelcol {-h | --help}

Shows the built-in help for this command.

sklnctl otelcol --start

Starts the "cp-otelcol systemd" service.

This flag is available in:

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --stop

Stops the "cp-otelcol systemd" service.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --restart

Stops and restarts the "cp-otelcol" service.

Use this command after configuration changes that require a full restart.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --reload

Sends a reload (ExecReload) signal to the running service to applies configuration changes without a full restart if the binary supports it.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --status

Shows the detailed "systemd" status of the "cp-otelcol service" (equivalent to "systemctl status").

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --enable

Enables the "cp-otelcol" service to start automatically at boot.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --disable

Disables the "cp-otelcol" service from starting automatically at boot.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --is-active

Exits with code 0 if the service is currently active; non-zero if the service is not active.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --is-enabled

Exits with the code 0 if the service is enabled for auto-start.

Exits with a non-zero code if the service is not enabled for auto-start.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol --is-failed

Exits with code 0 if the service is in a failed state.

Exits with a non-zero code if the service is not in a failed state.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol config

Shows the full current OpenTelemetry Collector configuration as stored in ConfigPoint.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol config --reset

Resets the OpenTelemetry Collector configuration to its factory default.

Warning - This action is destructive (removes all user-defined changes).

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol pipeline --list

Shows all pipelines currently defined in the OpenTelemetry Collector service configuration (for example, metrics/skyline, logs/um).

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol pipeline --status <pipeline>

Shows whether the named pipeline is enabled or disabled.

For example:

sklnctl otelcol pipeline --status metrics/skyline

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl otelcol metrics {-h | --help}

Shows the built-in help for this command.

sklnctl otelcol metrics --add <Metric-ID-1> <Metric-ID-2> ...

Adds metrics to the allow-list.

See Skyline Metrics Repository.

sklnctl otelcol metrics --insert-cp-label

Inserts Check Point organization as an additional label for each metric.

sklnctl otelcol metrics --is-default

Shows if the default list of metrics is exported.

sklnctl otelcol metrics --remove <Metric-ID-1> <Metric-ID-2> ...

Removes metrics from the allow-list (stops exporting these metrics).

sklnctl otelcol metrics --remove-cp-label

Removes the Check Point organization additional label from each metric.

sklnctl otelcol metrics --reset

Resets the allow-list to the default (exports all metrics).

sklnctl otelcol metrics --show

Shows all metrics that are exported.

Syntax to configure the Skyline OpenTelemetry Agent

For more information about the Skyline OpenTelemetry Agent, see sk181615.

sklnctl otlp

      {-h | --help}

      add

            {-h | --help}

            --name /<Path>/<Custom Shell Script File> --path /<Path>/<JSON File> [--yes]

      change

            {-h | --help}

            --name <Name of the Collector or Script> --interval <Number> [--yes]

      disable

            {-h | --help}

            --name <Name of the Collector or Script>

      enable

            {-h | --help}

            --name <Name of the Collector or Script>

      modify

            {-h | --help}

            --name <Name of the Collector or Script> --state {enabled | disabled} [--yes]

      process

            {-h | --help}

            --add <Name of Process 1>,<Name of Process 2>,...

            --remove <Name of Process 1>,<Name of Process 2>,...

            --reset

            --show

      remove

            {-h | --help}

            --name <Name of the Custom Script> [--yes]

      --start

      --stop

      --restart

      --reload

      --status

      --enable

      --disable

      --is-active

      --is-enabled

      --is-failed

      --instance <name>

      config

      config --reset

      disable --all

      enable --all

where:

Parameter

Description

sklnctl otlp {-h | --help}

Shows the built-in help for this command.

sklnctl otlp add {-h | --help}

Shows the built-in help for this command.

sklnctl otlp add --name /<Path>/<Custom Shell Script File> --path /<Path>/<JSON File> [--yes]

Adds a custom script to the OpenTelemetry Agent.

See Custom Metrics.

sklnctl otlp change {-h | --help}

Shows the built-in help for this command.

sklnctl otlp change --name <Name of the Collector or Script> --interval <Number> [--yes]

Changes the running time interval of the specified OpenTelemetry Agent Collector or OpenTelemetry Agent Script.

  • To see the names of the OpenTelemetry Agent Collectors and Scripts, run:

    sklnctl otlp config | jq .

    Each of these Collectors and Scripts exports specific data.

  • Add "--yes" to skip the confirmation.

sklnctl otlp disable {-h | --help}

Shows the built-in help for this command.

sklnctl otlp disable --name <Name of the Collector or Script>

Disables the specified OpenTelemetry Agent Collector or OpenTelemetry Agent Script.

  • To see the names of the OpenTelemetry Agent Collectors and Scripts, run:

    sklnctl otlp config | jq .

    Each of these Collectors and Scripts exports specific data.

sklnctl otlp enable {-h | --help}

Shows the built-in help for this command.

sklnctl otlp enable --name <Name of the Collector or Script>

Enables the specified OpenTelemetry Agent Collector or OpenTelemetry Agent Script.

  • To see the names of the OpenTelemetry Agent Collectors and Scripts, run:

    sklnctl otlp config | jq .

    Each of these Collectors and Scripts exports specific data.

sklnctl otlp modify {-h | --help}

Shows the built-in help for this command.

sklnctl otlp modify --name <Name of the Collector or Script> --state {enabled | disabled} [--yes]

Activates / deactivates the specified OpenTelemetry Agent Collector or OpenTelemetry Agent Script.

  • To see the names of the OpenTelemetry Agent Collectors and Scripts, run:

    sklnctl otlp config | jq .

    Each of these Collectors and Scripts exports specific data.

  • Add "--yes" to skip the confirmation.

sklnctl otlp process {-h | --help}

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 179.

Shows the built-in help for this command.

sklnctl otlp process --add <Name of Process 1>,<Name of Process 2>,... [--yes]

Note - This feature is available in (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 179.

Configures the OpenTelemetry Agent process collector - adds the specified processes to the custom list of monitored processes (/var/log/CPotlpAgent/custom_monitored_process_list.json).

Procedure:

  1. Create the required directory /var/log/CPotlpAgent:

    mkdir /var/log/CPotlpAgent

  2. Run the required command:

    sklnctl otlp process --add ...

Notes:

  • You must enter the process name as it appears in the output of the "ps" or "top" command.

  • To specify several processes, you must enter a comma-separated list of strings (without spaces).

    Example:

    sklnctl otlp process --add pdpd,pepd

  • When you add a process to this custom list for the first time, the command copies all the processes from the default list of monitored processes ($CPOTLPAGENT_DIR/monitored_process_list.json) to the custom list of monitored processes and then adds the specified processes.

  • The relevant metrics are System > Process.

sklnctl otlp process --remove <Name of Process 1>,<Name of Process 2>,... [--yes]

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 179.

Configures the OpenTelemetry Agent process collector - removes the specified processes from the custom list of monitored processes.

  • You must enter the process name as it appears in the custom list of monitored processes. Run:

    cat /var/log/CPotlpAgent/custom_monitored_process_list.json

  • To specify several processes, you must enter a comma-separated list of strings (without spaces).

    Example:

    sklnctl otlp process --remove pdpd,pepd

sklnctl otlp process --reset [--yes]

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 179.

Configures the OpenTelemetry Agent process collector - removes all processes that and administrator added to the custom list of monitored processes.

  • This command does not change the default list of monitored processes.

  • This command does not remove the processes that were copied from the default list of monitored processes.

sklnctl otlp process --show

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 179.

For the OpenTelemetry Agent process collector, shows all monitored processes from the custom list of monitored processes (/var/log/CPotlpAgent/custom_monitored_process_list.json).

sklnctl otlp remove {-h | --help}

Shows the built-in help for this command.

sklnctl otlp remove --name <Name of the Custom Script> [--yes]

Removes a custom script from the OpenTelemetry Agent.

See Custom Metrics.

  • You must specify the script name as appears in the output of this command (in the section "scripts" > sub-section "metrics"):

    sklnctl otlp config | jq .

  • Add "--yes" to skip the confirmation.

sklnctl otlp --start

Starts the OpenTelemetry Agent service (all instances on Traditional VSX / Multi-Domain Security Management; single instance on Standalone).

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --stop

Stops the OpenTelemetry Agent service.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --restart

Restarts the OpenTelemetry Agent service.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --reload

Reloads the OpenTelemetry Agent configuration without a full restart.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --status

Prints the detailed systemd status of the OpenTelemetry Agent service.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --enable

Enables the OpenTelemetry Agent service for auto-start at boot.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --disable

Disables the OpenTelemetry Agent service from starting at boot.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --is-active

Returns 0 if the OpenTelemetry Agent service is active.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --is-enabled

Returns 0 if the OpenTelemetry Agent service is enabled.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --is-failed

Returns 0 if the OpenTelemetry Agent service is in a failed state.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp --instance <name>

Targets a specific virtual system or domain instance (for example, vs0 or Domain_A_Server).

Omitting this flag applies the action to all instances on Traditional VSX / Multi-Domain Security Management; single instance on Standalone.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp config

Prints the full current OpenTelemetry Agent configuration as stored in the Gaia Unified Configuration Database.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp config --reset

Resets the OpenTelemetry Agent configuration to its factory default.

Warning - This operation is destructive. All custom scripts, collectors, and settings are lost.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp disable --all

Disables all configured collectors and scripts in one operation, without having to name each one individually.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

sklnctl otlp enable --all

Re-enables all configured collectors and scripts in one operation.

Note - This feature is available (sk180522):

  • In R82.20 and higher - in the Skyline OpenTelemetry Collector starting from Take 118.

  • In R82.10 and lower - in the Skyline OpenTelemetry Collector starting from Take 89.

Syntax to configure the Smart-1 Cloud DT pipeline from the Skyline OpenTelemetry Agent

sklnctl s1c_dt

      --enable

      --disable

      --status

      --dry-run {on | off}

      --debug {on | off}

where:

Parameter

Description

sklnctl s1c_dt --enable

Adds and activates the Smart-1 Cloud DT pipeline in the OpenTelemetry Agent configuration, so telemetry data flows from Smart-1 Cloud to the collector.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl s1c_dt --disable

Removes the Smart-1 Cloud DT pipeline from the OpenTelemetry Agent configuration and stops the telemetry flow.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl s1c_dt --status

Reports whether the Smart-1 Cloud DT pipeline is currently configured and active.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl s1c_dt --dry-run {on | off}

Enables (on) or disables (off) the dry-run mode for the Smart-1 Cloud DT pipeline.

In dry-run mode, the pipeline processes data but does not forward it to any export destination.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

sklnctl s1c_dt --debug {on | off}

Enables (on) or disables (off) debug mode for the Smart-1 Cloud DT pipeline.

Debug mode increases log verbosity for troubleshooting data flow issues.

Note - This feature is available in R82.20 (and higher) in the Skyline OpenTelemetry Collector starting from Take 118 (sk180522).

Syntax for advanced Skyline configuration

sklnctl export

      {-h | --help}

      --debug

      --debug-stop

      --disable-cp-context-flag <String>

      --enable-cp-context-flag <String>

      --initial-interval <Number>

      --max-elapsed-time <Number>

      --max-interval <Number>

      --off

      --on

      --record

      --record-stop

      --retry-on-failure <Name of Exporter>

      --retry-on-failure-stop <Name of Exporter>

      --set "$(cat /<Path>/<File with JSON Payload>.json)"

      --set-env

where:

Parameter

Description

sklnctl export {-h | --help}

Shows the built-in help for this command.

sklnctl export --debug

Starts the Skyline debug mode.

sklnctl export --debug-stop

Stops the Skyline debug mode.

sklnctl export --disable-cp-context-flag <String>

Disables a related Check Point context processor flag.

Note - This command is for Check Point internal use.

sklnctl export --enable-cp-context-flag <String>

Enables a related Check Point context processor flag.

Note - This command is for Check Point internal use.

sklnctl export --initial-interval <Number>

Time to wait after the first failure before retrying.

Default = 5 seconds.

sklnctl export --max-elapsed-time <Number>

The maximum amount of time (including retries) spent trying to send a request/batch.

If set to 0, the retries are never stopped.

Default = 300 seconds.

Requirements:

  • "max-elapsed-time" > "initial-interval".

  • "max-elapsed-time" > "max-interval".

sklnctl export --max-interval <Number>

The maximum amount of time between consecutive retries.

Default = 30 seconds.

sklnctl export --off

Disables Skyline.

sklnctl export --on

Enables Skyline.

sklnctl export --record

Enables the Skyline record mode.

Note - This command is for Check Point internal use.

sklnctl export --record-stop

Disables the Skyline record mode.

Note - This command is for Check Point internal use.

sklnctl export --retry-on-failure <Name of Exporter>

Starts the Skyline "retry-on-failure" mode (try to send metrics again, if failed for the first time).

sklnctl export --retry-on-failure-stop <Name of Exporter>

Starts the Skyline "retry-on-failure" mode.

sklnctl export --set "$(cat /<Path>/<File with JSON Payload>.json)"

Loads the JSON payload from the specified file.

sklnctl export --set-env <Name of Environment>

Sets the environment label for metrics exported to Prometheus. Refer to sk179870.

An "environment" allows you to group machines under a common name.

For example, you can set the environment "Cluster1" to "GW-A" and "GW-B", and these machines appear under the environment "Cluster1" in the dashboard.