Docker CLI Reference
  • 21 Mar 2024
  • 17 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Docker CLI Reference

  • Dark
    Light
  • PDF

Article summary

Overview of the climanager Service

Command Line Interface

The commands described in this article are executed in the Command Line Interface (CLI) of Skylight orchestrator Docker.

In order to provide users with a familiar interface and reduce training time and the management of Skylight orchestrator Docker, a climanager service (socli) is installed on the host.

Accessing climanager Service to Manage Skylight orchestrator

  1. Using an SSH client, log in to your Docker host and execute:
/usr/bin/socli.sh
  1. On first use, you will be asked to confirm the connection to localhost on port 2200. For example:
The authenticity of host '[localhost]:2200 ([127.0.0.1]:2200)'
can't be established.
RSA key fingerprint is SHA256:FYQGJ....
Are you sure you want to continue connecting
(yes/no/[fingerprint])?
  1. Type yes to confirm.
  2. Enter the password of skylight user.

For additional security, idle sessions timeout after 10 minutes of inactivity.

Configuration Commands

config show

Syntax:

config show

Command Description
This command displays appliance configuration information.

Example:

Skylight: config show

network subnet = ["172.18.0.0/16" ] - ipv6enabled = "false"
network core-ip =
network core-http-port = 80
network core-https-port = 443
network medn1-ip =
network med-snmp-port = 1163
volume-location so-config = /home/skylight/so/config
volume-location so-mysql = /home/skylight/so/mysql
volume-location so-data = /home/skylight/so/data
volume-location so-logs = /home/skylight/so/logs

Input Parameters
None

Output Attributes
None

config set

Network

Syntax:

config set network <parameter> <value>

Command Description
This command to sets the network for Skylight orchestrator Docker.

Requirement:
Skylight orchestrator services must be stopped.

Example:

Skylight: config set network med-snmp-port 1025

Removing existing Skylight orchestrator containers ...
so-mysql-22.10-GA
so-nbin1-22.10-GA
so-medn1-22.10-GA
so-core-22.10-GA
so-export-22.10-GA
dc2714b7a953
3e5fdc53e9e5

Port has been set to: [1025]

Input Parameters

ParameterValueDescription
core-http-portA numeric value between 1 and 65535HTTP port for Skylight orchestrator business service

Default: port 80

core-https-portA numeric value between 1 and 65535HTTPS port for Skylight orchestrator business service

Default: port 443

core-ipIP address V4 or V6 formatIP address for Skylight orchestrator business and NB API service
med-ipIP address V4 or V6 formatIP address for Skylight orchestrator mediation service

Note: Two configured interfaces with the same subnet is not supported on Skylight orchestrator Docker because the IP stack will receive packets but will respond from either interface. Consequently, responses will not always get to their intended destinations.

med-snmp-portA numeric value between 1024 and 49151SNMP trap port for Skylight orchestrator

Default: port 1163

Note: This port should be set to the same value as the one set in UI, screen Admin/SNMP/SNMP fault receiver configuration.

subnetIPv4 and IPv6 subnet address in CIDR format.Subnet for private network

Note: IPv4 is mandatory, IPv6 is optional.

Output Attributes
None

Volume Location

Syntax:

config set volume-location <parameter> <value>

Command Description
This command sets location for Skylight orchestrator container volume.

Requirement:
Skylight orchestrator services must be stopped.

Example:

Skylight: config set volume-location logs /home/skylight/so/mysqltest

Removing existing Skylight orchestrator containers ...

Removing existing Skylight hamon container ...
Stopping so-ha-22.10-GA ... done
Removing so-ha-22.10-GA ... done

Removing current volume ...
so-logs
Creating volume so-logs mounted on /home/skylight/so/mysqltest ...
so-logs
Volume so-logs created:
[
    {
        "CreatedAt": "2022-10-04T02:38:40Z",
        "Driver": "local",
        "Labels": {},
        "Mountpoint": "/var/lib/docker/volumes/so-logs/_data",
        "Name": "so-logs",
        "Options": {
           "device": "/home/skylight/so/mysqltest",
           "o": "bind",
           "type": "none"
       },
       "Scope": "local"
    }
]
Re-creating Skylight hamon container by default...
Creating so-ha-22.10-GA ... done

Input Parameters

ParameterValueDescription
logsStringLocation for Skylight orchestrator logs volume

Default: /home/skylight/so/logs

mysqlStringLocation for Skylight orchestrator mysql volume

Default: /home/skylight/so/mysql

data mediationStringLocation for Skylight orchestrator mediation volume
data so-dataStringLocation for Skylight orchestrator data volume

Default: /home/skylight/so/data

Output Attributes
None

config reset

Reset Network

Syntax:

config reset network <parameter>

Command Description
This command resets network parameter back to default.

Requirement:
Skylight orchestrator services must be stopped.

Example:

Skylight: config reset network med-snmp-port

Removing existing Skylight orchestrator containers ...

Port has been set to: [1163]

Input Parameters

ParameterDescription
core-http-portRevert the Skylight orchestrator HTTP port to default (80)
core-https-portRevert the Skylight orchestrator HTTPS port to default (443)
core-ipRevert IP address for Skylight orchestrator business and NBAPI service to default (all host interface)
med-ipRevert IP address for Skylight orchestrator mediation service to default (all host interface)
med-snmp-portRevert the Skylight orchestrator SNMP trap receiver port to default (1163)

Note: This port should be set to the same value as the one set in UI, screen Admin/SNMP/SNMP fault receiver configuration.

Output Attributes
None

Reset Volume Location

Syntax:

config reset volume-location <parameter>

Command Description
This command reset the volumes location to the default folder

Requirement:
Skylight orchestrator services must be stopped

Example:

Skylight: config reset volume-location mysql

Removing existing Skylight orchestrator containers ...

Port has been set to: [1163]

Input Parameters

ParameterDescription
mysqlRevert data volume of mysql to the /home/skylight/so/mysql
logsRevert data volume of the log to the /home/skylight/so/logs
dataRevert data volume of so-data to the /home/skylight/so/data

Output Attributes
None

Service Control Commands

Services Status

Syntax:

services status 

Command Description
This command displays a list of services on the Skylight orchestrator Docker and indicates the state of each service.

Example:

Skylight: services status

so-mysql - service is running | Up 15 hours (healthy)
so-nbin1 - service is running | Up 15 hours (healthy)
so-medn1 - service is running | Up 15 hours (healthy)
so-core - service is running | Up 15 hours (healthy)
so-export - service is running | Up 15 hours (healthy)
so-ha - service is running | Up 15 hours (healthy)
so-medn2 - service is running | Up 15 hours (healthy)
so-medn3 - service is running | Up 15 hours (healthy)
=================
8/8 service(s) are running

Input Parameters
None

Output Attributes
None

Services Start

Syntax:

services start 

Command Description
This command starts the services on the Skylight orchestrator Docker.

Example:

Skylight: services start

Proceed? (y/N)
y
Starting Skylight orchestrator services ...
Recreating so-mysql-22.10-GA ... done
Recreating so-core-22.10-GA ... done
Recreating so-medn1-22.10-GA ... done
Recreating so-nbin1-22.10-GA ... done
Creating so-medn3-22.10-GA ... done
Creating so-medn2-22.10-GA ... done
Recreating so-export-22.10-GA ... done

Input Parameters
None

Output Attributes
None

Services Stop

Syntax:

services stop 

Command Description
This command stops services on the Skylight orchestrator Docker

Example:

Skylight: services stop

Proceed ? (y/N)
y
Stopping Skylight orchestrator services ...
Stopping so-export-22.10-GA ... done
Stopping so-medn1-22.10-GA ... done
Stopping so-nbin1-22.10-GA ... done
Stopping so-core-22.10-GA ... done
Stopping so-mysql-22.10-GA ... done
Skylight orchestrator services are stopped

Input Parameters
None

Output Attributes
None

Utility Commands

Version

Syntax:

version

Command Description
This command displays the current version of the Skylight orchestrator Docker.

Example:

Skylight: version

Skylight orchestrator version: 22.10-GA (build: 5-aaace227)

Input Parameters
None

Output Attributes
None

Exit

Syntax:

exit

Command Description
This command exits the Climanager Service session.

Example:

Skylight: exit

Input Parameters
None

Output Attributes
None

Transport Layer Security​ Commands

TLS configuration

Syntax:

tls <enable|disable> value <TLSv1|TLSv1.1>

Command Description
This command enables or disables Transport Layer Security (TLS) 1.0 or 1.1 configuration for reverse proxy.​


Note: Skylight orchestrator services must be started.

Example:

Skylight: tls enable value TLSv1

Command executed successfully.
Please restart Skylight orchestrator services to apply this configuration.


Note: After running this command, you must restart Skylight orchestrate services to apply the new configuration.

Input Parameters

ParameterValueDescription
tlsenable or disableEnables or disables TLS configuration for reverse proxy.
valueTLSv1 or TLSv1.1TLS version to be enabled or disabled.

Note: TLSv1 value: TLS v1.0 and later.

TLSv1.1 value: TLS v1.1 and later.

Output Attributes
None

TLS Show

Syntax:

tls show

Command Description
This command displays a list of the supported Transport Layer Security (TLS) versions for reverse proxy on the Skylight orchestrator.​


Note: Skylight orchestrator services must be started.

Example:

Skylight: tls show

The supported TLS versions for reverse proxy: TLSv1.2 and later

Input Parameters
None

Output Attributes
None

Usage-Data

Syntax:

usage-data show statistics user <user> password <password> unit <unit>

Command Description
This command will retrieve the usage data count from NBAPI.


Note: Skylight orchestrator services must be started.

Example (with parameters):

Skylight: usage-data show statistics password 2admin$admin user admin1 unit month

{
   "features" : [
      {
         "count" : 0,
         "name" : "session",
         "type" : "TWAMP"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ECHO-UDP"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ECHO-ICMP"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ETH-DM"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ETH-VS"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ETH-LB"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "2xOneWay"
      },
      {
         "count" : 0,
         "name" : "sat",
         "type" : "Y1564/RFC2544"
      }
   ],
   "time" : "2023-08-01 00:00 -0400",
   "unit" : "month"
}

Input Parameters

ParameterMandatoryValueDescription
unitNhour, day, month, yearSpecifies the time unit for retrieving usage data count. Default value is hour unit.
userYStringThe username is used for authentication when accessing the NBAPI.
passwordYStringThe corresponding password for the provided username.

Output Attributes
None

Example (without parameters):

Skylight: usage-data show statistics
username:admin1
password:************

{
   "features" : [
      {
         "count" : 0,
         "name" : "session",
         "type" : "TWAMP"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ECHO-UDP"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ECHO-ICMP"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ETH-DM"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ETH-VS"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "ETH-LB"
      },
      {
         "count" : 0,
         "name" : "session",
         "type" : "2xOneWay"
      },
      {
         "count" : 0,
         "name" : "sat",
         "type" : "Y1564/RFC2544"
      }
   ],
   "time" : "2023-09-12 00:00 -0400",
   "unit" : "hour"
}

Input Parameters

ParameterMandatoryValueDescription
unitNday, month, year, hourSpecifies the time unit for retrieving usage data count. Default value is hour unit.
userYStringThe username is used for authentication when accessing the NBAPI.
passwordYStringThe corresponding password for the provided username.

Output Attributes
None

Shell Commands

Shell Host

Syntax:

shell host

Command Description
This command will grant access to the Docker host by “skylight” user

Requirement:
Skylight orchestrator services must be started

Example:

Skylight: shell host

Input Parameters
None

Output Attributes
None

Shell Container

Syntax:

shell container <parameter/container-name>

Command Description
This command will grant access to containers in the Skylight orchestrator Docker.

Requirement:
Skylight orchestrator services must be started.

Example:
Skylight: shell container core

Input Parameters

ParameterDescription
coreTo access an OS-level bash shell of core container
haTo access an OS-level bash shell of ha container
exportTo access an OS-level bash shell of export container
medTo access an OS-level bash shell of med container
nbiTo access an OS-level bash shell of nbi container
mysqlTo access an OS-level bash shell of mysql container

Output Attributes
None

Deployment Commands

Deployment Show Status

Syntax:

deployment show status

Command Description
This command shows deployment status.

Requirement:
Skylight orchestrator services must be started.

Example:

Skylight: deployment show status

[ Deployment configuration status ]

 [ Node: bizn1 ]
Name Host Port Pid Cluster State
bizn1instance bizn1 6048 1585 bizcluster running

 [ Node: medn1 ]
Name Host Port Pid Cluster State
medn1instance medn1 7048 180 medcluster running

 [ Node: nbin1 ]
Name Host Port Pid Cluster State
nbin1instance nbin1 9048 121 nbicluster running

 [ Node: medn2 ]
Name Host Port Pid Cluster State
medn2instance medn2 7048 462 medcluster running

 [ Node: medn3 ]
Name Host Port Pid Cluster State
medn3instance medn3 7048 459 medcluster running

Input Parameters
None

Output Attributes
None

Deployment Show Configuration

Syntax:

deployment show configuration

Command Description
This command shows the deployment configuration.

Requirement:
Skylight orchestrator services must be started.

Example:

Skylight: deployment show configuration

[ Deployment configuration ]

  Deployment type : single-node
  Profile name : 5K

  User profile name : user-20
    Max user session : 20

  Cluster configuration :
    Cluster type : medcluster
    Node Configuration :
       Node name : medn1
       Total instances : 1

Input Parameters
None

Output Attributes
None

Deployment Edit Command

Syntax:

deployment edit profile <profile> user-profile <number of user>

Command Description
This command to edit the deployment configuration

Requirement:
Skylight orchestrator services must be started

Example:

Skylight: deployment edit profile 15K user-profile user-20

Proceed ? (y/N)
y
Configuring deployment profile...
Cleanning up the existing mediation(s) data...
Stopping current Skylight orchestrator services ...
Stopping so-export-22.10-GA ... done
Stopping so-medn1-22.10-GA ... done
Stopping so-nbin1-22.10-GA ... done
Stopping so-core-22.10-GA ... done
Stopping so-mysql-22.10-GA ... done
Deployment configuration is done. Start Skylight orchestrator services to take effect.

Input Parameters

ParameterValueDescription
Profile5K, 15K, 30K, 60KThe type of profile
user-profileuser-20, user-xThe number of users

Where x is:

  • 100 users for Skylight orchestrator 23.04.1 or prior
  • 250 users for Skylight orchestrator 23.12 and later

System Alarm Commands

Syntax:

alarm show status more

Command Description
This command displays the current alarms on the Climanager (socli).


Note: Only supports alarms related to Hot Standby feature. See Alarms Related to Redundancy for details.

Example:

Skylight: alarm show status more

Codes: S - Severity, SA - Service affecting

Number S SA Last Change Condition Type Description
--------- ----- --- ------------------------- ------------------- -----------------------------------------
10.5.8 MJ NSA 2022-10-03 04:30:30-04:00 SITE-B-OFFLINE Site-B is offline "REDUNDANCY

Input Parameters
None

Output Attributes

AttributesDescription
NumbersThe alarming number from the Master Alarm List
SThe severity of the event that triggered the alarm
SAIndicates whether or not the event that triggered the alarm is service affecting.

Possible values:

  • SA – Service Affecting
  • NSA – Not Service Affecting
Condition TypeA short description of the condition being reported
DescriptionProvides additional information about the condition being reported

Performance Session Commands

mgr-command

Syntax:

mgr-commands

Command Description
This command is used for accessing mgr-commands mode in Skylight orchestrator Docker. This mode has its own set of commands that allow you to manage sender endpoints, reflector endpoints, and performance sessions.

For more about mgr-commands mode, see Introduction to mgr-commands Mode in the Skylight Appliance Monitor Command Reference.

Requirement:
Skylight orchestrator services must be started.

Example:

Skylight: mgr-commands

username: admin
password: ************
mgr/mgr#

Input Parameters
None

Output Attributes
None

mgr-config

Syntax:

mgr-config name <string> value <string>

Command Description
This command allows you to load and save configuration properties related to performance sessions. For example, you can set the data retention period and the size of the buffer used during the process of storing performance session data.

Depending on which property you set, this command may require a restart of the Skylight orchestrator services.

Requirement:
Skylight orchestrator services must be started.

Example:

Skylight: mgr-config name RRRetentionPeriod value 2

Input Parameters
For detailed information about the properties - configured using the mgr-config command, see the Skylight Appliance Monitor Command Reference.

Output Attributes
None

sdmm-deploytool

Syntax:

sdmm-deploytool reflectors <string> sessions <string>

Command Description
This command allows you to run a utility (known as the mass deployment tool) that can be used to create performance sessions in bulk. This tool requires two CSV files as input: a reflectors file and a sessions file.

For detailed information about the content of the required CSV files and procedures for creating sessions in bulk using the deployment tool, see the Skylight orchestrator Administration section.

Example

Skylight: sdmm-deploytool reflectors “/home/visionems/myReflectors.csv” sessions “/home/visionems/mySessions.csv”

Input Parameters

ParameterValueDescription
Input ParametersString enclosed in quotesThe name of the CSV file containing the list of reflectors. Must be in the required format: NAME, ADDRESS,[ADDRESS],[ADDRESS]
sessionsString enclosed in quotesThe name of the CSV file containing a definition of the sessions to be created. It must be in the required Format.

Format for TWAMP sessions:

TYPE, NAME, SLANAME, AF, TX, TXIF, SRCPORT, DSTPORT, PPS, INTERVAL, TOS, TTL, VPRIO, PLSIZE

Format for Ethernet-OAM (Y.1731) sessions:

TYPE,NAME,SLANAME,TX,TXIF, MEGLEVEL,PPS,INTERVAL,VPRIO,PLSIZE

Output Attributes
None

Backup and Restore Database

Backup Database

Syntax:

database backup

Command Description
This command allows you to backup the MySQL database, the backup is generated as a tar.gz file in the folder ‘backups’ of the ‘so-mysql’ volume.


Note:

On the Hot Standby system:

  • The backup must be taken from the active site.
  • The backup file is stored at /home/skylight/so/mysql-ha/backups folder.

On the Non-Hot Standby system, the backup is generated as a tar.gz file in the ${volume-location so-mysql}/backups folder.

By default: /home/skylight/so/mysql/backups


Requirement:
Skylight orchestrator services must be started.

Example:

Skylight: database backup

Please wait ... This could take several minutes.
Xtrabackup operating ...
Preparing files ...
Synchronised.
Verifying if there is enough space...
Compressing the backup folder ...
Archived in DB_BAK_2022-10-04_07-23-41.tar.gz

*** DATABASE BACKUP LOCAL END TIME 2022-10-04_07:24:03 ***

Input Parameters
None

Output Attributes
None

Restore Database

Syntax:

database restore <filename_of_the_backup_archive>

Command Description
This command allows you to backup MySQL database

Requirement:
Skylight orchestrator services must be stopped.
Make sure the skylight user has read access to the archive that was copied in the /tmp folder.

Example:

Skylight: database restore DB_BAK_2022-09-29_04-00-00.tar.gz

***** RESTORE Orchestrator DATABASE FROM BACKUP *****

WARNING - This process will wipe the current visiondata database

You are about to REPLACE the Orchestrator database (visiondata) with backup /tmp/DB_BAK_2022-09-29_04-00-00.tar.gz.

Continue y/N?
y

Please wait ... This could take several minutes.
Deleting previous ibdata ...
Copying files ...
Restore complete

Input Parameters
None

Output Attributes
None

Changing Administrator Password

Syntax:

admin change-admin-pass

Command Description
This command allows you to change the administrator password.

Requirement:
Skylight orchestrator services must be started.

To change administrator password

  1. Type:
admin change-admin-pass
  1. At the prompt Enter admin username [default: admin]>, type enter for the default.
    At the prompt Enter the admin password>, enter the current admin password.
    At the prompt Enter the new admin password>, enter the new password.
  2. At the prompt Enter the new admin password again>, re-enter the new password.
    Wait for the Skylight domain to restart.
  3. Log in when prompted to confirm the new password.
  4. At the prompt Enter admin username [Enter to accept default]>, type enter for the default
  5. At the prompt Enter admin password>, enter the new password.

Example:

Skylight: admin change-admin-pass

Enter admin user name [default: admin]>
Enter the admin password>
Enter the new admin password>
Enter the new admin password again>
Command change-admin-password executed successfully.

Restarting skylightdomain. Please wait ...
Successfully restarted the domain
Command restart-domain executed successfully.

Please login to validate the new password
Enter admin user name [Enter to accept default]>
Enter admin password>
Admin login information for host [localhost] and port [5048] is being overwritten with credentials provided. This is because the --savelogin option was used during create-domain command.
Login information relevant to admin user name [admin] for host [localhost] and admin port [5048] stored at [/home/visionems/.gfclient/pass] successfully.
Make sure that this file remains protected. Information stored in this file will be used by administration commands to manage associated domain.
Command login executed successfully.
Password was changed successfully

Input Parameters
None

Output Attributes
None

Generating and Importing SSH Key for Rsync Destination using the Rsync Password

Syntax:

admin rsync-keys user <user> ip <IP>

Command Description
This command allows you to generate and import the SSH Key for Rsync Destination

Requirement:
Skylight orchestrator services must be started.

Example:

Skylight: admin rsync-keys user skylight ip 10.220.0.11

Exchanging SSH keys with skylight@10.220.0.11 ...
/usr/bin/ssh-copy-id: INFO: Source of key(s) to be installed: "/home/visionems/.ssh/id_rsa.pub"
/usr/bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter out any that are already installed
/usr/bin/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are prompted now it is to install the new keys
Ubuntu 16.04.6 LTS
skylight@10.220.0.11's password:

Number of key(s) added: 1

Now try logging into the machine, with: "ssh 'skylight@10.220.0.11'"
and check to make sure that only the key(s) you wanted were added.

SSH keys exchange with 'skylight@10.220.0.11' is complete.

Input Parameters

ParameterValueDescription
userstringusername for the Rsync destination
ipIPv4 and IPv6IP for the Rsync destination

Configuring Rsync for Rsync Destination Using the SSH Key

The following procedure explains how to configure Rsync for transferring Skylight metrics collection files to an Rsync destination using the SSH key on Skylight orchestrator.

To configuring Rsync for the Rsync destination using the SSH key on Skylight orchestrator

  1. Access socli (SSH port 2200).

  2. Enter the following command to access core container:

shell container core
  1. Enter the command:
cat /home/visionems/.ssh/id_rsa.pub
  • Copy the output.
  1. Install the public key on the Rsync server.
    a. Access SSH to the Rsync server.
    b. Paste the outputfrom Step 3 into the authorized_keys file under the .ssh/ folder.

  2. Access socli (SSH port 2200).

  3. Enter the following command to access the core container:

shell container core
  1. Enter the following command to ensure successful SSH access to Rsync destination without a password:
ssh <rsync_user>@x.x.x.x
  • where: x.x.x.x is the IP address of the Rsync server.

When asked if you want to continue connecting, respond yes and press enter.

© 2024 Accedian Networks Inc. All rights reserved. Accedian®, Accedian Networks®,  the Accedian logo™, Skylight™, Skylight Interceptor™ and per-packet intel™, are trademarks or registered trademarks of Accedian Networks Inc. To view a list of Accedian trademarks visit: http://accedian.com/legal/trademarks/. 


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.