Restricted Shell Commands

The RealPresence Web Suite Restricted Shell provides a means to log in to the RealPresence Web Suite portals from either a console or a Secure Shell (SSH) connection.

You can connect to the RealPresence Web Suite Services Portal or RealPresence Web Suite Experience Portal shell through the vSphere or Hyper-V Manager console or with an SSH client, using the FQDN or IP address assigned to that portal.

Note the following information regarding the restricted shell user name and password:
  • The user accounts caxis and polycom are set up in the system to perform operations within the shell.
  • These accounts have caxis and polycom, respectively, as the default passwords.
  • You must change these passwords when you first connect to the shell.
  • New passwords for the restricted shell users must include the following:
    • At least 14 characters
    • At least one upper case character
    • At least one lower case character
    • At least one non-alphanumeric character
  • In addition, they the passwords must not be any of the following:
    • Dictionary word or palindrome
    • Previously used password
    • Case change or rotated version of old password
    • Too similar to old password (fewer than five characters changed)
    • Too systematic (three or more sequential characters, such as def or 987, or repeated characters, such as aaa or ###).

The restricted shell supports basic Linux commands including cat, ifconfig, ls, ping, grep, pwd, scp, tail, cd, echo and exit .

The Restricted Shell of the RealPresence Web Suite Experience Portal (but not the RealPresence Web Suite Services Portal) also supports the openssl command.

The following table outlines the operations that you can perform in the shell.

Table 1. Restricted Shell Operations

Operation

Shell Command

Notes

View status of web services

service nginx status

service rpp-tomcat status

Show status for nginx and Tomcat. When these services are not running, users cannot access the web portals.

Start web services

service nginx start

service rpp-tomcat start

Start services that are not running. Do not use to restart services that are running.

Restart web services

service nginx restart

service rpp-tomcat restart

Restart web services that are running.

Note: This can be done in the administration interface of the RealPresence Web Suite Experience Portal.

Caution: Both restarting web services and rebooting the server will log out all users and (for the RealPresence Web Suite Experience Portal) end all calls. The system remains inaccessible until the server has rebooted and/or web services have restarted. Restart or reboot only during a maintenance window when there is no activity on the system.

Collect log files

collect_logs

Collect all the log files on a server into an archive file. You can use the scp command to securely copy that file to another location.

Change system host name

change_hostname

Displays the current host name, along with a prompt asking whether you want to change the host name. Type the new host name exactly as specified in DNS. A confirmation message is displayed for the name changed successfully.

Change the password for the caxis or polycom user

passwd

Change the password for the shell user account with which you are logged in.

New shell user passwords must meet the requirements specified prior to this table.

Configure or change Network Time Protocol (NTP) settings

change_ntp

Displays a list of NTP servers configured in the system. Follow the prompts to add new time servers.

Note: This can be done in the administration interface of each portal.

Synchronize system date and time with a specific NTP server

ntpdate -u <FQDN or IP address of the NTP server>

The system indicates that the time has been adjusted.

Set or change system date and time

change_system_datetime

Follow the prompts, and then enter the date and time in the following format:

Day Month Date Hour:Minute:Second Zone Year

For example:

Mon Jun 17 20:27:27 UTC 2015

The system indicates when a time and date change has been successful.

Setting the date and time manually is appropriate only to get the system time close to the NTP server time to which it must be synchronized.

Change the time zone for the system

change_timezone

The current time zone is displayed. Follow the prompts to change the time zone, pressing Enter repeatedly to scroll through a list of 608 time zones from which to choose, and finally entering the number of that time zone at the prompt that appears at the end of the list.

Note: Choosing the time zone is easier in the administration interface of each portal.

View system network information

show_network_info

Displays all relevant network settings, including IP configuration and the DNS domain and servers.

Change network settings

change_network_settings

You can make the following network setting changes:
  • Enable or disable Dynamic Host Configuration Protocol (DHCP)
  • Enable or disable static IP
  • Configure static IP settings
  • Change Domain Name System (DNS) settings
  • Restart network services for the new settings to take effect

Follow the prompts to modify the settings.

View system space information

show_system_info

Displays all relevant space information for each file system, including total space, used space, available space, used percentage, and mounted directory.

Reboot the server

reboot

Stops and restarts the server.

Caution: Both restarting web services and rebooting the server will log out all users and (for the RealPresence Web Suite Experience Portal) end all calls. The system remains inaccessible until the server has rebooted and/or web services have restarted. Restart or reboot only during a maintenance window when there is no activity on the system.

Show the current product version

show_product_info

Displays the version or build number of the RealPresence Web Suite Services Portal or RealPresence Web Suite Experience Portal software.

Regenerate self-signed certificate

regenerate_certificates

Creates a new self-signed certificate, replacing the current one. A message indicates that the certificate has been regenerated successfully. Follow the prompts to restart the web services and apply the new certificate.

Note: For the RealPresence Web Suite Services Portal, this can be done in the administration interface. But Polycom strongly recommends using trusted CA-signed certificates.

Caution: Both restarting web services and rebooting the server will log out all users and (for the RealPresence Web Suite Experience Portal) end all calls. The system remains inaccessible until the server has rebooted and/or web services have restarted. Restart or reboot only during a maintenance window when there is no activity on the system.

Manage RealPresence Web Suite Services Portal features

manage_feature

RealPresence Web Suite Services Portal only. Enable or disable features. Currently, the command controls only one feature, SSO_WITH_SAML , which is not yet fully implemented and is not supported.

Manage firewall

firewall

RealPresence Web Suite Services Portal only. Lets you check the current status of the firewall and activate or deactivate it.

Enable or disable root login

manage_root_login

Lets you check the current status of root login, enable console login by root, or disable it.

In some circumstances, enabling root login may be necessary in order for Polycom Global Services to resolve an issue. We strongly recommend leaving root access disabled at all other times.