Documentation
Fast trainings
Community
Academy
PAM Solution
Affinity
v3.27
v3.28
v3.27
English
English
Portuguese
Contents
x
Changelog v3.27
General information
Installation
Administration
PAM Core
DevOps Secret Manager
Domum Remote Access
GO Endpoint Manager
Certificate Manager
Cloud IAM
Executions
Discovery
MySafe
Task Manager
Network Connector
Load Balancer
Arbitrator
A2A - APIs
Orbit Config Manager
Protected Information
senhasegura SaaS
Fast Trainings
Cloud Security
Other versions
Other documents
Powered by
Orbit CLI
32 Articles
in this category
Share this
Print
Share
Dark
Light
Contents
Orbit CLI
32 Articles
in this category
Share
Dark
Light
Overview
To facilitate the administration of the operating system that hosts the senhasegura, the integration with basic network services and even updates the binaries that make up the entire system architecture, from version 3.2 of senhasegura the administr...
Available commands
The orbit command if executed without any instructions will display its default syntax. Several modules are available for use, and each of these modules will act on different services or integrations of senhasegura. Caution If you are in a clu...
Running and restoring backup
Through the backup module you can run new backups and restore a specific backup. Caution The senhasegura backup files are encrypted. Restoring a backup can cause damage to a cluster structure and even prevent access to inside information. If the...
Changing default passwords
Using the orbit security command you can change the default password for users mt4adm and senhasegura . But only the user password mt4adm will be displayed or indicated by the administrator.
[email protected]
:~$ sudo orbit security --help...
Configuring network interfaces
Configure the primary senhasegura network interface to reach the Web interface, Proxies, and Webservices. Caution This functionality replaces the need for localhost login with the user 'orbit'. When configuring the network interface, you will n...
Disk management
You can expand the disk and get information from your partitions through the orbit disk command
[email protected]
:~$ sudo orbit disk --help Usage: orbit disk Disks management tools Flags: --help Show context-sensitive help. --expan...
DNS Settings
Configure the DNS servers that this instance will query using the command orbit dns .
[email protected]
:~$ sudo orbit dns --help Usage: orbit dns The Domain Name System (DNS) management tools Flags: --help Show context...
Configuring Domum Gateway
Using the command orbit domum-gateway you can set the gateway settings for the Domum module.
[email protected]
:~$ sudo orbit domum-gateway -h Usage: orbit domum-gateway <action> Domum Gateway settings tools Arguments...
Firewall Management
Using the orbit firewall command you can manage the source blocking that is performed by HIDS, and normalize firewall rules for running services. Until the current version (senhasegura v3.2) the blocking of a host occurs when this host exceeds th...
Getting the platform version
You can get the version of the senhasegura platform using the command orbit version . It is important that all members of a cluster are in the same version. And version information should be forwarded in the support request.
[email protected]
:~...
Check instance health
This command takes hardware and senhasegura information, application data, and logs for analysis during incidents or instance health validations.
[email protected]
:~$ orbit healthcheck --help Usage: orbit healthcheck <command> Health Check tool...
Hostname definitions
The orbit hostname command allows to work the hostname of the operating system of this instance of the senhasegura .
[email protected]
:~$ sudo orbit hostname --help Usage: orbit hostname [<hostname>] Change the server hostname. Changing the h...
Setting up instance location
Using the orbit locale command you can define the settings for location, server time zone and internal browser language. Caution The language settings of the web interface and proxy systems are changed through user preferences and through dedi...
Managing the Application
Caution It is possible to visualize application logs saved in files to be recorded and indexed in elasticsearch. There is a second instance in the cluster that makes the log files visualization possible, and those logs are up to 10.000 registers....
Managing the Cluster
The complete cluster configuration and status check process can be performed with the command cluster . In addition to the process, we will use the command application to initiate instances and define a master instance.
[email protected]
:~$ s...
NTP servers
Configure which NTP servers the instance should consult to keep the time synchronized, through the command orbit ntp . This configuration will be applied immediately. Changing NTP servers may affect the use of OTP tokens.
[email protected]
:~$ ...
Manipulating operating system services
To be able to start, stop and restart the operating system services, you must use the command orbit service .
[email protected]
:~$ sudo orbit service --help Usage: orbit service <service> <command> Send commands to the systemd manager Argumen...
Enabling proxy or loadbalancer IPs
If a proxy or loadbalancer system is being used, senhasegura will observe and identify the application client IP using the variable X-Forwarded-For . In these cases, the allowed IP of the WebService A2A token must remain the application's IP, but y...
Proxy System Settings
Proxy system configurations can be performed using the orbit proxy command. Each proxy has particularities, so some arguments affect only some systems.
[email protected]
:~$ sudo orbit proxy --help Usage: orbit proxy <proxy> [<action>] Applica...
Setting up remote partitions
The orbit partition command allows you to list, add, or remove remote partitions that are used to forward the backup database, session files, and encrypted information with the master key.
[email protected]
:~$ sudo orbit partition --help Usage...
Running senhasegura services manually
senhasegura services are responsible to execute the async tasks from all senhasegura modules. By default, only the primary cluster instance has condition and permission to execute all services. The others cluster members can only execute tasks rela...
Shutting down or restarting the server
To shut down or restart the server, use the command orbit shutdow . Caution The shutdown is immediate. No scheduling. The shutdown procedures performed by this command ensure that services will be shut down correctly avoiding problems in cluste...
SNMP Monitoring
Use the orbit snmp command to configure the server that will receive the MIB reading from senhasegura.
[email protected]
:~$ sudo orbit snmp --help Usage: orbit snmp Simple Network Management Protocol (SNMP) management tools Flags: -h, --he...
Tuning
The tuning of the environment is performed by changing environment properties of the PHP Webserver, database and engine. This way, all service architecture will work in a way more adequate to the hardware resources available in this instance. Tunin...
Reinstall repository certificates
Use the orbit apt-fix command to automatically reinstall repository certificates that have some kind of problem and need this procedure. Usage: orbit apt-fix Reconfigure the senhasegura main repository Flags: -h, --help Show context-sensiti...
Login with certificates
Use the orbit application auth-cert command to automatically login using a certificate. Usage: orbit application auth-cert <command> Arguments: <command> Configure the auth certification module: [enable|disable|ca] Flags: -h, --help ...
Updating the platform
With the orbit upgrade command, you will be able to update all the senhasegura platform packages. This includes the operating system packages, proxy, web application, and security settings. Info Validate that the instance has access to the off...
Web Application SSL Certificate
See the details of the certificate being used by the web application and install new certificates.
[email protected]
:~$ sudo orbit webssl --help Usage: orbit webssl Webserver SSL certificates management tools Flags: --help Show...
WebService A2A application management
WebService A2A applications have security features that can only be administered via Orbit Command Line.
[email protected]
:~$ sudo orbit api --help Usage: orbit api <cmd> A2A settings tools. Arguments: <cmd> Configuration option: [forward...
Zabbix Monitoring
You can configure which Zabbix servers will be able to receive the read data from the senhasegura by the command orbit zabbix .
[email protected]
:~$ sudo orbit zabbix --help Usage: orbit zabbix Zabbix client configuration Flags: --help ...
Discovery cleanup procedure
To run the Discovery cleanup procedure:
[email protected]
:~$ sudo orbit support db-cleanup --help Usage: orbit support db-cleanup <command> Delete all data from a given module Commands: support db-cleanup discovery Delete all data from...
Command for partial release of browser tabs in VNCHTTP sessions
This command releases the display of the browsers tab bar on the proxy: sudo orbit fajita enable|disable sudo orbit fajita --help Usage: orbit fajita <component> [<action>] Fajita access proxy management tools Arguments: <component> Fajit...