Difference between revisions of "Command Line Interface (CLI, LYSH)"

Line 4: Line 4:
 
If you access the imRAD devices via a console port that is located in front of the device, the baud rate(speed) is 115,200 and the serial port type is an RJ-45 connector.
 
If you access the imRAD devices via a console port that is located in front of the device, the baud rate(speed) is 115,200 and the serial port type is an RJ-45 connector.
  
The default or initial Username and Password is each <span style="font-family:Courier;font-weight:bold;font-size:large;">ladmin</span> and <span style="font-family:Courier;font-weight:bold;font-size:large;>1111</span>.<br>
+
The default or initial Username and Password are <span style="font-family:Courier;font-weight:bold;font-size:large;">ladmin</span> and <span style="font-family:Courier;font-weight:bold;font-size:large;>1111</span> respectively.<br>
 
'''If you log in with the default, you must change the default password. If not, you can't access the CLI before changing the password.'''
 
'''If you log in with the default, you must change the default password. If not, you can't access the CLI before changing the password.'''
  
 
The CLI has two command line modes: user mode and configuration mode. By default, user mode is where you begin the session with the imRAD devices. The user mode contains commands that you can use to see logs, the status of services, configurations, system variables and information, and so on. You can run some Linux commands in the user mode.
 
The CLI has two command line modes: user mode and configuration mode. By default, user mode is where you begin the session with the imRAD devices. The user mode contains commands that you can use to see logs, the status of services, configurations, system variables and information, and so on. You can run some Linux commands in the user mode.
 +
 +
The configuration mode enables to have you can do changes on device configuration such as hostname, Database, IP address, nameserver, tiemzone, ntp, ufw, failover, etc. To enter the configuration mode, type the <code>configure</code> command in the user mode.
  
 
If press the <tab> key at any time,  you can complete the command or see the argument of the command, You can also display "help" by input -h or --help at the end of every command,  
 
If press the <tab> key at any time,  you can complete the command or see the argument of the command, You can also display "help" by input -h or --help at the end of every command,  
 
<pre>
 
<pre>
 
LYSH@MyHostName# show -h
 
LYSH@MyHostName# show -h
LYSH@lyondev-40# show -h
+
usage: show [-h] {apache2,command,config,datetime,dci,files,failover,hardware,interface,listen,log,
usage: show [-h] {apache2,command,config,datetime,dci,files,failover,hardware,interface,listen,log,loghost,multicast,mysql,ntp,php,service,session,system,uptime} ...
+
loghost,multicast,mysql,ntp,php,service,session,system,uptime} ...
  
 
  show the system informations
 
  show the system informations
 
 
positional arguments:
 
positional arguments:
 
     apache2                            show the status of apache2 service
 
     apache2                            show the status of apache2 service
 
     command                            show all or releated commands
 
     command                            show all or releated commands
 
     config                              show config files
 
     config                              show config files
     datetime                            show current time and zone
+
     datetime                            show current time and zone  
     dci                                show decrypted database connection information
+
     .....
    files                              find files in LYON_HOME and display them
+
</pre>
    failover                            show the configuration of system failover
+
 
    hardware                            show hardware information
+
If you want to see all commands, enter the <code>show command</code> in the user mode. If you want to find specific commands which include the keyword, enter the <code>show command {keyword}</code>. It shows all commands which contain the keyword.
    interface                          show network interfaces and assigned addresses
+
<pre>
    listen                              show network listening and program
+
LYSH@MyHostName# show command // list all commands
    log                                show logs
+
configure                        enable config mode
    loghost                            list the address of remote log servers
+
╠══ database                    Configure database backup or dci property
    multicast                          show multicast group membership information
+
║  ╠══ backup                  Configure database backup
    mysql                              show mysql config and replication status
+
║  ║  ╠══ disable                  disable database backup scheduler
    ntp                                show ntp server list and history
+
║  ║  ╠══ enable                  enable database backup scheduler
    php                                show a php information
+
║  ║  ╠══ hour                    Configure the starting hour of database backup
    service                            show service status, mode and versions
+
║  ║  ╠══ interval                Configure the database backup interval in days
    session                            show who is logged on
+
...
    system                              show the system general informations
+
 
    uptime                              show how long the system has been running
+
LYSH@MyHostName# show command ip // search commands which contain "ip"
 +
configure fail2ban              Configure the fail2ban(bans IP that makes too many password failures)
 +
configure ip                    Add/Delete an IP address
 +
configure ip add                add an IP address to an ethernet interface.
 +
configure ip delete              delete an IP address from an ethernet interface
 +
show multicast                  show multicast group membership information
 
</pre>
 
</pre>
  
 +
The followings are main commands and you can read about other commands by searching a keyword on this page.
 
# [[CLI - Networking]]
 
# [[CLI - Networking]]
 
# [[CLI - Hostname]]
 
# [[CLI - Hostname]]

Revision as of 17:20, 22 April 2021

We provide Command Line Interface (CLI), the name is LYSH, that is used for configuring, monitoring, and maintaining the imRAD devices. The CLI allows you to directly execute commands, whether using a console or using remote access methods such as Secure Shell (SSH, port 22). We do not provide the telnet to access the imRAD devices.

If you access the imRAD devices via a console port that is located in front of the device, the baud rate(speed) is 115,200 and the serial port type is an RJ-45 connector.

The default or initial Username and Password are ladmin and 1111 respectively.
If you log in with the default, you must change the default password. If not, you can't access the CLI before changing the password.

The CLI has two command line modes: user mode and configuration mode. By default, user mode is where you begin the session with the imRAD devices. The user mode contains commands that you can use to see logs, the status of services, configurations, system variables and information, and so on. You can run some Linux commands in the user mode.

The configuration mode enables to have you can do changes on device configuration such as hostname, Database, IP address, nameserver, tiemzone, ntp, ufw, failover, etc. To enter the configuration mode, type the configure command in the user mode.

If press the <tab> key at any time, you can complete the command or see the argument of the command, You can also display "help" by input -h or --help at the end of every command,

LYSH@MyHostName# show -h
usage: show [-h] {apache2,command,config,datetime,dci,files,failover,hardware,interface,listen,log,
loghost,multicast,mysql,ntp,php,service,session,system,uptime} ...

 show the system informations
positional arguments:
    apache2                             show the status of apache2 service
    command                             show all or releated commands
    config                              show config files
    datetime                            show current time and zone    
    .....

If you want to see all commands, enter the show command in the user mode. If you want to find specific commands which include the keyword, enter the show command {keyword}. It shows all commands which contain the keyword.

LYSH@MyHostName# show command		// list all commands
configure                        enable config mode
╠══ database                     Configure database backup or dci property
║   ╠══ backup                   Configure database backup
║   ║   ╠══ disable                  disable database backup scheduler
║   ║   ╠══ enable                   enable database backup scheduler
║   ║   ╠══ hour                     Configure the starting hour of database backup
║   ║   ╠══ interval                 Configure the database backup interval in days
...

LYSH@MyHostName# show command ip	// search commands which contain "ip"
configure fail2ban               Configure the fail2ban(bans IP that makes too many password failures)
configure ip                     Add/Delete an IP address
configure ip add                 add an IP address to an ethernet interface.
configure ip delete              delete an IP address from an ethernet interface
show multicast                   show multicast group membership information

The followings are main commands and you can read about other commands by searching a keyword on this page.

  1. CLI - Networking
  2. CLI - Hostname
  3. CLI - Services(daemons)
  4. CLI - Log
  5. CLI - System
  6. CLI - Database
  7. CLI - List commands and other Linux commands
  8. CLI - System Failover
  9. CLI - Updating system
  10. CLI - shutdown and reboot
  11. CLI - Configuration Mode