- Verifying and uploading configuration
- Deleting configuration from the CDS with
- Deleting state and configuration for a node type from the CDS with
- Listing configurations available in the CDS with
- Retrieving configuration from the CDS with
- Splitting an SDF by product type with
- Generating a
private-keyfor Encrypting Passwords with
- Retrieving Initconf and Rhino logs with
- Viewing the values associated with the special
Configuration YAML files can be validated and uploaded to CDS using the
rvtconfig tool can be run either on the SIMPL VM or any Rhino VoLTE TAS (RVT) VM.
On the SIMPL VM, you can find the command in the
resources subdirectory of
any RVT CSAR, after it has been extracted using
On any RVT VM, the
rvtconfig tool is in the
PATH for the
sentinel user and can be run directly by running:
rvtconfig commands are:
rvtconfig validatevalidates the configuration, even before booting any RVT VMs by using the SIMPL VM.
rvtconfig upload-configvalidates, encrypts, and uploads the configuration to CDS.
rvtconfig delete-deploymentdeletes a deployment from CDS.
Only use this when advised to do so by a Customer Care Representative.
rvtconfig delete-node-typedeletes state and configuration for a given node type from CDS
Only use this after deleting all VMs for a given node type.
rvtconfig list-configdisplays a summary of the configurations stored in CDS.
rvtconfig dump-configdumps the current configuration from CDS.
rvtconfig split-sdfsplits an SDF definition into separate ones, one for each instance.
rvtconfig generate-private-keygenerates a new private key for use in the SDF.
rvtconfig export-log-historyexports the quiesce log history from CDS.
rvtconfig describe-versionsprints the current values of
Commands that read or modify CDS state take a
(which is also aliased as
--cassandra-contact-point, or simply
For this parameter, specify the management address(es) of at least one TSN node.
Separate multiple addresses with a space, for example
--cds-address 220.127.116.11 18.104.22.168.
For more information, run
rvtconfig --help or
rvtconfig upload-config --help.
Create a directory to hold the configuration YAML files.
Ensure the directory contains the following:
configuration YAML files
the Solution Definition File (SDF)
Rhino license for nodes running Rhino.
|Do not create any subdirectories. Ensure the file names match the example YAML files.|
To validate configuration, run the command:
rvtconfig validate -t <node type> -i ~/yamls
<node type> is the node type you want to verify, which can be
If there are any errors, fix them, move the fixed files to the
yamls directory, and then
re-run the above
rvtconfig validate command on the
Once the files pass validation, store the YAML files in CDS using the
rvtconfig upload-config command.
If using the SIMPL VM, the
To upload the YAML files to CDS, run the command:
rvtconfig upload-config -c <cds-mgmt-addresses> -t <node type> -i ~/yamls
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm_version>) [--reload-resource-adaptors]
--vm-versionspecifies the version of the VM to target (as configuration can differ across a VM upgrade).
--vm-version-sourceautomatically derives the VM version from the given source. Failure to determine the version will result in an error.
this-rvtconfigwhen running the
rvtconfigtool included in the CSAR for the target VM, to extract the version information packaged into
this-vmif running the
rvtconfigtool directly on the RVT VM being configured, to extract the version information from the VM.
Any YAML configuration values which are specified as secrets are marked as such in the
YAML files' comments. These values will be encrypted using the generated private-key created by
rvtconfig generate-private-key and prior to uploading the SDF. In other words, the secrets should be
entered in plain text in the SDF, and the
upload-config command takes care of encrypting them.
Currently this applies to the following:
Rhino users' passwords
REM users' passwords
SSH keys for accessing the VM
the HTTPS key and certificate for REM.
If the CDS is not yet available, this will retry every 30 seconds for up to 15 minutes. As a large Cassandra cluster can take up to one hour to form, this means the command could time out if run while TSN nodes are still booting. If the command still fails after several attempts over an hour, troubleshoot the TSN nodes.
Restarting resource adaptors
If you apply configuration changes
that don’t include changes to any fields marked as needing an RA restart,
then you do not need to specify the
If you apply configuration changes that include changes to such fields
and do not specify the
Delete all deployment configuration from the CDS by running the command:
rvtconfig delete-deployment -c <cds-mgmt-addresses> -d <deployment-id> [--delete-audit-history]
|Only use this when advised to do so by a Customer Care Representative.|
Delete all state and configuration for a given node type and version from the CDS by running the command:
rvtconfig delete-node-type -c <cds-mgmt-addresses> -d <deployment-id> --site-id <site-id> --node-type <node type>
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm_version>) [--y]
|Only use this after deleting all VMs of this node type within the specified site. Functionality of all nodes of this type within the given site will be lost. These nodes will have to be redeployed to restore functionality.|
List all currently available configurations in the CDS by running the command:
rvtconfig list-config -c <cds-mgmt-addresses> -d <deployment-id>
This command will print a short summary of the configurations uploaded, the VM version they are uploaded for and which VMs are commissioned in that version.
Retrieve the VM group configuration from the CDS by running the command:
rvtconfig dump-config -c <cds-mgmt-addresses> -d <deployment-id> --group-id <group-id>
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm_version>)
Group ID syntax:
If the optional
--output-dir <directory> argument is specified,
then the configuration will be dumped as individual files in the given directory.
The directory can be expressed as either an absolute or relative path.
It will be created if it doesn’t exist.
--output-dir argument is omitted, then the configuration is printed to the terminal.
Create partial SDFs for each VM by running the command:
rvtconfig split-sdf -i <input-directory> -o <output-directory> <sdf>
|Used for upgrades from RVT 3.0.|
Rhino TAS and REM require the configuration to supply passwords that are encrypted with a private key.
rvtconfig can generate a private-key to encrypt a password with the following command:
The SDF can be updated with the generated private key.
Depending on hypervisor type:
During upgrade, when a downlevel VM is removed, it uploads its Initconf and Rhino logs to CDS. The log files are stored as encryted data in the CDS.
|Only the portions of the logs written during quiesce are stored.|
Retrieve the Initconf and Rhino logs for a deployment from the CDS by running the command:
rvtconfig export-log-history -c <cds-mgmt-addresses> -d <deployment-id> --zip-destination-dir <directory>
|The Initconf and Rhino logs are exported in unencrypted zip files. The zip file names will consist of VM hostname, version, and type of log.|
Viewing the values associated with the special
this-rvtconfig versions with
Some commands, e.g.
upload-config, can be used with the special version values
The meaning of these values changes depending on the running VM version or the rvtconfig version.
To view the real version string associated with these special values: