Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.regatta.dev/llms.txt

Use this file to discover all available pages before exploring further.

The System Manager is the entity that manages the hardware and software components of the system, handles management commands and drives management operations.

​
Commands

The System Manager commands have the general form: MANAGE SYSMGR command [ parameters ].

​
SYSMGR SHOW

This command show the attributes of the System Manager. Synopsis 
MANAGE SYSMGR SHOW
Output The output of the command is tabular, with each row representing an attribute of the System Manger. The output has two columns: name and value. The following table lists the attributes that are included in the output:
NameDescription
EXTERNAL_NETA comma-separated list of external network addresses in the form of <ip_addr>:<port>
INTERNAL_NETA comma-separated list of internal network addresses in the form of <ip_addr>:<port>
SERVICE_PORTThe port number for Regatta support connection
EXTERNAL_SERVICE_NETExternal network address for Regatta service connection, in the form of <ip_addr>:<port>
DESCRIPTIONInformative description of the system.
The SERVICE_PORT attribute applies to the internal network. For external network service connection, the port number in the EXTERNAL_SERVICE_NET attribute may be different.

​
SYSMGR MODIFY

This command modifies attributes of the System Manager. Synopsis 
MANAGE SYSMGR MODIFY 
	[ NETWORK { ADD | REMOVE | SET } net_address [, ...] ] 
	[ DESCRIPTION free_text ] 

where net_address is: 
	( EXTERNAL IP ip_addr PORT port_num )
This command is allowed only when the system state is SETUP. Parameters NETWORK The NETWORK clause includes one or more network addresses. It can come with either of the following directives:
  • ADD – Adds the given network addresses to the list of existing addresses.
  • REMOVE – Remove each given network address from the list of existing addresses. Each removed network address must be an exact match to an existing one.
  • SET – Remove all the existing network addresses and replace them with the given network addresses.
DESCRIPTION Optional parameter. Free text that is added to the module.