---
title: "Legacy Orchestrator Docker CLI Reference"
slug: "orchestrator-climanager-reference"
tags: ["Docker", "CLI", "admin", "Legacy Orchestrator", "Command Line Interface", "Climanager Service"]
updated: 2025-02-13T21:10:51Z
published: 2025-02-13T21:10:51Z
canonical: "docs.crossworkassurance.cisco.com/orchestrator-climanager-reference"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crossworkassurance.cisco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Docker CLI Reference

## Overview of the climanager Service

### Command Line Interface

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

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

### Accessing climanager Service to Manage Legacy 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**:

<samp data-tomark-pass="">Skylight: config show</samp>

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

**Input Parameters** None

**Output Attributes** None

    

### config set

#### Network

**Syntax**:

```
config set network <parameter> <value>
```

**Command Description** This command to sets the network for Legacy Orchestrator Docker.

**Requirement**: Legacy Orchestrator services must be stopped.

**Example**:

<samp data-tomark-pass="">Skylight: config set network med-snmp-port 1025</samp>

<samp data-tomark-pass="">Removing existing Skylight Orchestrator containers ...<br> so-mysql-22.10-GA<br> so-nbin1-22.10-GA<br> so-medn1-22.10-GA<br> so-core-22.10-GA<br> so-export-22.10-GA<br> dc2714b7a953<br> 3e5fdc53e9e5</samp>

<samp data-tomark-pass="">Port has been set to: [1025]</samp>

**Input Parameters**

| Parameter | Value | Description |
| --- | --- | --- |
| core-http-port | A numeric value between 1 and 65535 | HTTP port for Legacy Orchestrator business service Default: port 80 |
| core-https-port | A numeric value between 1 and 65535 | HTTPS port for Legacy Orchestrator business service Default: port 443 |
| core-ip | IP address V4 or V6 format | IP address for Legacy Orchestrator business and NB API service |
| med-ip | IP address V4 or V6 format | IP address for Legacy Orchestrator mediation service ***Note**: Two configured interfaces with the same subnet is not supported on Legacy 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-port | A numeric value between 1024 and 49151 | SNMP trap port for Legacy 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.* |
| subnet | IPv4 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 Legacy Orchestrator container volume.

**Requirement**: Legacy Orchestrator services must be stopped.

**Example**:

<samp data-tomark-pass="">Skylight: config set volume-location logs /home/skylight/so/mysqltest</samp>

<samp data-tomark-pass="">Removing existing Skylight orchestrator containers ...</samp>

<samp data-tomark-pass="">Removing existing Skylight hamon container ...<br> Stopping so-ha-22.10-GA ... done<br> Removing so-ha-22.10-GA ... done</samp>

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

**Input Parameters**

| Parameter | Value | Description |
| --- | --- | --- |
| logs | String | Location for Legacy Orchestrator logs volume Default: /home/skylight/so/logs |
| mysql | String | Location for Legacy Orchestrator mysql volume Default: /home/skylight/so/mysql |
| data mediation | String | Location for Legacy Orchestrator mediation volume |
| data so-data | String | Location for Legacy 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**: Legacy Orchestrator services must be stopped.

**Example**:

<samp data-tomark-pass="">Skylight: config reset network med-snmp-port</samp>

<samp data-tomark-pass="">Removing existing Skylight orchestrator containers ...</samp>

<samp data-tomark-pass="">Port has been set to: [1163]</samp>

**Input Parameters**

| Parameter | Description |
| --- | --- |
| core-http-port | Revert the Legacy Orchestrator HTTP port to default (80) |
| core-https-port | Revert the Legacy Orchestrator HTTPS port to default (443) |
| core-ip | Revert IP address for Legacy Orchestrator business and NBAPI service to default (all host interface) |
| med-ip | Revert IP address for Legacy Orchestrator mediation service to default (all host interface) |
| med-snmp-port | Revert the Legacy 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**: Legacy Orchestrator services must be stopped

**Example**:

<samp data-tomark-pass="">Skylight: config reset volume-location mysql</samp>

<samp data-tomark-pass="">Removing existing Skylight orchestrator containers ...</samp>

<samp data-tomark-pass="">Port has been set to: [1163]</samp>

**Input Parameters**

| Parameter | Description |
| --- | --- |
| mysql | Revert data volume of mysql to the /home/skylight/so/mysql |
| logs | Revert data volume of the log to the /home/skylight/so/logs |
| data | Revert 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 Legacy Orchestrator Docker and indicates the state of each service.

**Example**:

<samp data-tomark-pass="">Skylight: services status</samp>

<samp data-tomark-pass="">so-mysql - service is running | Up 15 hours (healthy)<br> so-nbin1 - service is running | Up 15 hours (healthy)<br> so-medn1 - service is running | Up 15 hours (healthy)<br> so-core - service is running | Up 15 hours (healthy)<br> so-export - service is running | Up 15 hours (healthy)<br> so-ha - service is running | Up 15 hours (healthy)<br> so-medn2 - service is running | Up 15 hours (healthy)<br> so-medn3 - service is running | Up 15 hours (healthy)<br> <samp data-tomark-pass="">=================<br> 8/8 service(s) are running</samp></samp>

**Input Parameters** None

**Output Attributes** None

 

  

### Services Start

**Syntax**:

```
services start
```

Command Description This command starts the services on the Legacy Orchestrator Docker.

**Example**:

<samp data-tomark-pass="">Skylight: services start</samp>

<samp data-tomark-pass="">Proceed? (y/N)<br> y<br> Starting Skylight orchestrator services ...<br> Recreating so-mysql-22.10-GA ... done<br> Recreating so-core-22.10-GA ... done<br> Recreating so-medn1-22.10-GA ... done<br> Recreating so-nbin1-22.10-GA ... done<br> Creating so-medn3-22.10-GA ... done<br> Creating so-medn2-22.10-GA ... done<br> Recreating so-export-22.10-GA ... done</samp>

**Input Parameters** None

**Output Attributes** None

  

### Services Stop

**Syntax**:

```
services stop
```

**Command Description** This command stops services on the Legacy Orchestrator Docker

**Example**:

<samp data-tomark-pass="">Skylight: services stop</samp>

<samp data-tomark-pass="">Proceed ? (y/N)<br> y<br> Stopping Skylight orchestrator services ...<br> Stopping so-export-22.10-GA ... done<br> Stopping so-medn1-22.10-GA ... done<br> Stopping so-nbin1-22.10-GA ... done<br> Stopping so-core-22.10-GA ... done<br> Stopping so-mysql-22.10-GA ... done<br> Skylight orchestrator services are stopped</samp>

**Input Parameters** None

**Output Attributes** None

  

  

## Utility Commands

### Version

**Syntax**:

```
version
```

**Command Description** This command displays the current version of the Legacy Orchestrator Docker.

**Example**:

<samp data-tomark-pass="">Skylight: version</samp>

<samp data-tomark-pass="">Skylight orchestrator version: 22.10-GA (build: 5-aaace227)</samp>

**Input Parameters** None

**Output Attributes** None

  

### Exit

**Syntax**:

```
exit
```

**Command Description** This command exits the Climanager Service session.

**Example**:

<samp data-tomark-pass="">Skylight: exit</samp>

**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**: Legacy Orchestrator services must be started.*

---

**Example**:

<samp data-tomark-pass="">Skylight: tls enable value TLSv1</samp>

<samp data-tomark-pass="">Command executed successfully.<br> Please restart Skylight orchestrator services to apply this configuration.</samp>

---

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

---

**Input Parameters**

| Parameter | Value | Description |
| --- | --- | --- |
| tls | enable or disable | Enables or disables TLS configuration for reverse proxy. |
| value | TLSv1 or TLSv1.1 | TLS 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 Legacy Orchestrator.​

---

***Note**: Legacy Orchestrator services must be started.*

---

**Example**:

<samp data-tomark-pass="">Skylight: tls show</samp>

<samp data-tomark-pass="">The supported TLS versions for reverse proxy: TLSv1.2 and later</samp>

**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**: Legacy Orchestrator services must be started.*

---

**Example (with parameters)**:

<samp data-tomark-pass="">Skylight: usage-data show statistics password 2admin$admin user admin1 unit month</samp>

```
{
   "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**

| Parameter | Mandatory | Value | Description |
| --- | --- | --- | --- |
| unit | N | hour, day, month, year | Specifies the time unit for retrieving usage data count. Default value is hour unit. |
| user | Y | String | The username is used for authentication when accessing the NBAPI. |
| password | Y | String | The corresponding password for the provided username. |

**Output Attributes** None

**Example (without parameters)**:

<samp data-tomark-pass="">Skylight: usage-data show statistics<br> username:admin1<br> password:************</samp>

```
{
   "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**

| Parameter | Mandatory | Value | Description |
| --- | --- | --- | --- |
| unit | N | day, month, year, hour | Specifies the time unit for retrieving usage data count. Default value is hour unit. |
| user | Y | String | The username is used for authentication when accessing the NBAPI. |
| password | Y | String | The 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**: Legacy Orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: shell host</samp>

**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 Legacy Orchestrator Docker.

**Requirement**: Legacy Orchestrator services must be started.

**Example**: Skylight: shell container core

**Input Parameters**

| Parameter | Description |
| --- | --- |
| core | To access an OS-level bash shell of core container |
| ha | To access an OS-level bash shell of ha container |
| export | To access an OS-level bash shell of export container |
| med | To access an OS-level bash shell of med container |
| nbi | To access an OS-level bash shell of nbi container |
| mysql | To 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**: Legacy Orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: deployment show status</samp>

<samp data-tomark-pass="">[ Deployment configuration status ]</samp>

<samp data-tomark-pass="">&nbsp;[ Node: bizn1 ]<br> Name Host Port Pid Cluster State<br> bizn1instance bizn1 6048 1585 bizcluster running</samp>

<samp data-tomark-pass="">&nbsp;[ Node: medn1 ]<br> Name Host Port Pid Cluster State<br> medn1instance medn1 7048 180 medcluster running</samp>

<samp data-tomark-pass="">&nbsp;[ Node: nbin1 ]<br> Name Host Port Pid Cluster State<br> nbin1instance nbin1 9048 121 nbicluster running</samp>

<samp data-tomark-pass="">&nbsp;[ Node: medn2 ]<br> Name Host Port Pid Cluster State<br> medn2instance medn2 7048 462 medcluster running</samp>

<samp data-tomark-pass="">&nbsp;[ Node: medn3 ]<br> Name Host Port Pid Cluster State<br> medn3instance medn3 7048 459 medcluster running</samp>

**Input Parameters** None

**Output Attributes** None

 

  

### Deployment Show Configuration

**Syntax**:

```
deployment show configuration
```

**Command Description** This command shows the deployment configuration.

**Requirement**: Legacy orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: deployment show configuration</samp>

<samp data-tomark-pass="">[ Deployment configuration ]</samp>

<samp data-tomark-pass="">&nbsp; Deployment type : single-node<br> &nbsp;&nbsp;Profile name : 5K</samp>

<samp data-tomark-pass="">&nbsp;&nbsp;User profile name : user-20<br> &nbsp;&nbsp;&nbsp;&nbsp;Max user session : 20</samp>

<samp data-tomark-pass="">&nbsp;&nbsp;Session profile name : 52K</samp>

<samp data-tomark-pass="">&nbsp;&nbsp;Cluster configuration :<br> &nbsp;&nbsp;&nbsp; Cluster type : medcluster<br> &nbsp;&nbsp;&nbsp; Node Configuration :<br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Node name : medn1<br> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Total instances : 1</samp>

**Input Parameters** None

**Output Attributes** None

  

### Deployment Edit Command

**Syntax**:

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

**Command Description** This command edits the deployment configuration.

**Requirement**: Legacy Orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: deployment edit profile 15K user-profile user-20 session-profile 125K</samp>

<samp data-tomark-pass="">Proceed ? (y/N)<br> y<br> Configuring deployment profile...<br> Cleaning up the existing mediation(s) data...<br> Stopping current Skylight orchestrator services ...<br> Stopping so-export-24.09-GA ... done<br> Stopping so-medn1-24.09-GA ... done<br> Stopping so-nbin1-24.09-GA ... done<br> Stopping so-core-24.09-GA ... done<br> Stopping so-mysql-24.09-GA ... done<br> Deployment configuration is done. Start Skylight orchestrator services to take effect.</samp>

**Input Parameters**

| Parameter | Value | Description |
| --- | --- | --- |
| Profile | 5K, 15K, 30K, 60K | The type of profile |
| user-profile | user-20, user-250 | The number of users |
| session-profile | 52K, 125K | The number of sessions |

  

## 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:

<samp data-tomark-pass="">Skylight: alarm show status more</samp>

<samp data-tomark-pass="">Codes: S - Severity, SA - Service affecting</samp>

<samp data-tomark-pass="">Number S SA Last Change Condition Type Description<br> <samp data-tomark-pass="">--------- ----- --- ------------------------- ------------------- -----------------------------------------<br> <samp data-tomark-pass="">10.5.8 MJ NSA 2022-10-03 04:30:30-04:00 SITE-B-OFFLINE Site-B is offline "REDUNDANCY</samp></samp></samp>

**Input Parameters** None

**Output Attributes**

| Attributes | Description |
| --- | --- |
| Numbers | The alarming number from the Master Alarm List |
| S | The severity of the event that triggered the alarm |
| SA | Indicates whether or not the event that triggered the alarm is service affecting. Possible values: - SA – Service Affecting - NSA – Not Service Affecting |
| Condition Type | A short description of the condition being reported |
| Description | Provides 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 Legacy Orchestrator Docker. This mode has its own set of commands that allow you to manage sender endpoints, reflector endpoints, and performance sessions.

**Requirement**: Legacy Orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: mgr-commands</samp>

<samp data-tomark-pass="">username: admin<br> password: ************<br> mgr/mgr#</samp>

**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 Legacy Orchestrator services.

**Requirement**: Legacy orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: mgr-config name RRRetentionPeriod value 2</samp>

**Input Parameters** For detailed information about the properties - configured using the mgr-config command, see the ***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 Legacy Orchestrator *Administrative Operations* section.

**Example**

<samp data-tomark-pass="">Skylight: sdmm-deploytool reflectors “/home/visionems/myReflectors.csv” sessions “/home/visionems/mySessions.csv”</samp>

**Input Parameters**

| Parameter | Value | Description |
| --- | --- | --- |
| Input Parameters | String enclosed in quotes | The name of the CSV file containing the list of reflectors. Must be in the required format: NAME, ADDRESS,[ADDRESS],[ADDRESS] |
| sessions | String enclosed in quotes | The 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: <samp data-tomark-pass="">/home/skylight/so/mysql/backups </samp>*

---

**Requirement**: Legacy Orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: database backup</samp>

<samp data-tomark-pass="">Please wait ... This could take several minutes.<br> Xtrabackup operating ...<br> Preparing files ...<br> Synchronised.<br> Verifying if there is enough space...<br> Compressing the backup folder ...<br> Archived in DB_BAK_2022-10-04_07-23-41.tar.gz</samp>

<samp data-tomark-pass="">*** DATABASE BACKUP LOCAL END TIME 2022-10-04_07:24:03 ***</samp>

**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**: Legacy Orchestrator services must be stopped. Make sure the **skylight** user has read access to the archive that was copied in the **/tmp** folder.

**Example**:

<samp data-tomark-pass="">Skylight: database restore DB_BAK_2022-09-29_04-00-00.tar.gz</samp>

<samp data-tomark-pass="">***** RESTORE Orchestrator DATABASE FROM BACKUP *****</samp>

<samp data-tomark-pass="">WARNING - This process will wipe the current visiondata database</samp>

<samp data-tomark-pass="">You are about to REPLACE the Orchestrator database (visiondata) with backup /tmp/DB_BAK_2022-09-29_04-00-00.tar.gz.</samp>

<samp data-tomark-pass="">Continue y/N?<br> <samp data-tomark-pass="">y</samp></samp>

<samp data-tomark-pass="">Please wait ... This could take several minutes.<br> Deleting previous ibdata ...<br> Copying files ...<br> Restore complete</samp>

**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**: Legacy Orchestrator services must be started.

**To change administrator password**

1. Type:

```
admin change-admin-pass
```

1. At the prompt <samp data-tomark-pass="">Enter admin username [default: admin]&gt;</samp>, type **enter** for the default.  

At the prompt <samp data-tomark-pass="">Enter the admin password&gt;</samp>, enter the current admin password.  

At the prompt <samp data-tomark-pass="">Enter the new admin password&gt;</samp>, enter the new password.
2. At the prompt <samp data-tomark-pass="">Enter the new admin password again&gt;</samp>, re-enter the new password.  

Wait for the domain to restart.
3. Log in when prompted to confirm the new password.
4. At the prompt <samp data-tomark-pass="">Enter admin username [Enter to accept default]&gt;</samp>, type **enter** for the default
5. At the prompt <samp data-tomark-pass="">Enter admin password&gt;</samp>, enter the new password.

**Example**:

<samp data-tomark-pass="">Skylight: admin change-admin-pass</samp>

<samp data-tomark-pass="">Enter admin user name [default: admin]&gt;<br> Enter the admin password&gt;<br> Enter the new admin password&gt;<br> Enter the new admin password again&gt;<br> Command change-admin-password executed successfully.</samp>

<samp data-tomark-pass="">Restarting skylightdomain. Please wait ...<br> Successfully restarted the domain<br> Command restart-domain executed successfully.</samp>

<samp data-tomark-pass="">Please login to validate the new password<br> Enter admin user name [Enter to accept default]&gt;<br> Enter admin password&gt;<br> 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.<br> Login information relevant to admin user name [admin] for host [localhost] and admin port [5048] stored at [/home/visionems/.gfclient/pass] successfully.<br> Make sure that this file remains protected. Information stored in this file will be used by administration commands to manage associated domain.<br> Command login executed successfully.<br> Password was changed successfully</samp>

**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**: Legacy Orchestrator services must be started.

**Example**:

<samp data-tomark-pass="">Skylight: admin rsync-keys user skylight ip 10.220.0.11</samp>

<samp data-tomark-pass="">Exchanging SSH keys with skylight@10.220.0.11 ...<br> /usr/bin/ssh-copy-id: INFO: Source of key(s) to be installed: "/home/visionems/.ssh/id_rsa.pub"<br> /usr/bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter out any that are already installed<br> /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<br> Ubuntu 16.04.6 LTS<br> skylight@10.220.0.11's password:</samp>

<samp data-tomark-pass="">Number of key(s) added: 1</samp>

<samp data-tomark-pass="">Now try logging into the machine, with: "ssh 'skylight@10.220.0.11'"<br> and check to make sure that only the key(s) you wanted were added.</samp>

<samp data-tomark-pass="">SSH keys exchange with 'skylight@10.220.0.11' is complete.</samp>

**Input Parameters**

| Parameter | Value | Description |
| --- | --- | --- |
| user | string | **username** for the Rsync destination |
| ip | IPv4 and IPv6 | **IP** for the Rsync destination |

  

## Configuring Rsync for Rsync Destination Using the SSH Key

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

**To configuring Rsync for the Rsync destination using the SSH key on Legacy 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**.

**© 2026 Cisco and/or its affiliates. All rights reserved.** For more information about trademarks, please visit: [Cisco trademarks](https://www.cisco.com/c/en/us/about/legal/trademarks.html)[](https://www.cisco.com/c/en/us/about/legal/trademarks.html) For more information about legal terms, please visit: [Cisco legal terms](https://www.cisco.com/c/en/us/about/legal/terms-conditions.html)