5 Managing STA Ports

This chapter includes the following sections:

Ports Used by STA

STA uses the following ports to retrieve and receive data. These are dedicated ports, and they must remain available to STA.

Unconfigurable External Ports

The ports described in Table 5-1 are external ports used for communication between the STA server and other network entities. The port values are fixed and cannot be changed during STA installation or after.

Firewall/routing configuration

Must be reachable between the STA server and the backup server (for SSH), and between the STA server and the monitored libraries (for SNMP and SNMPTRAP).

Table 5-1 Unconfigurable External Ports

Port Protocol Description/Purpose

22

SSH

Secure Shell. STA database backup; library log-in.

161

SNMP

Simple Network Management Protocol (SNMP). For transmittal of SNMP requests.

162

SNMPTRAP

For reception of SNMP notifications (traps). Traps are forwarded to configurable unprivileged internal port (default is 7027). See "Configurable Internal Ports".


Configurable Ports

Note:

See your network administrator for assistance with port number assignments. Although it is permissible to have two different processes assigned to the same port number if they use different protocols (UDP and TCP, for example), this practice is not recommended.

Configurable ports are defined as follows:

  • You initially define the port numbers during STA installation. The STA installer automatically verifies that the ports are not already in use on the network.

  • After STA installation, you can change the port numbers at any time using the STA Port Change Utility. The utility automatically verifies that the new ports are not already in use on the network and updates all appropriate processes on the STA server to use the new ports.

Configurable External Ports

The ports described in Table 5-2 are external ports used for communication between the STA server and other network entities. These ports are the configurable equivalent of standard ports 80 and 8080 (HTTP) and 443 (HTTPS), and they must be unique from other HTTP and HTTPS ports on the network.

Firewall/router configuration

Must be reachable between the STA server and the client running the STA GUI.

Table 5-2 Configurable External Ports

Default Port Protocol Description/Purpose

7019

HTTP

Access to the WebLogic Administration console, unsecure

7020

HTTPS

Access to the WebLogic Administration console, secure

7021

HTTP

staUi managed server. Access to the STA GUI, unsecure.

7022

HTTPS

staUi managed server. Access to the STA GUI, secure.


Configurable Internal Ports

The ports described in Table 5-3 are used for internal STA communications. These port values must be unique.

Firewall/router configuration

Not applicable

Table 5-3 Configurable Internal Ports

Default Port Protocol Description/Purpose

7023

HTTP

staEngine managed server. Basic STA internals, unsecure.

7024

HTTPS

staEngine managed server. Basic STA internals, secure.

7025

HTTP

staAdapter managed server. SNMP communication, unsecure.

7026

HTTPS

staAdapter managed server. SNMP communication, secure.

7027

SNMPTRAP

Internal unprivileged port for SNMP traps forwarded from external privileged port 162.


STA Port Administration Tasks

Note:

Beginning with STA 2.3.0, the following tasks are performed with the STA Port Change utility, which is included in the STA installation. See "Using the STA Port Change Utility" for additional information.

Start the STA Port Change Utility

Use this procedure to start and exit from the STA Port Change Utility. This task is a prerequisite for other port change tasks.

Note:

Before using this procedure, you must obtain the current username and password of the WebLogic administrator account.

Note:

This procedure requires the STA application to be running.
  1. Open a terminal session on the STA server, and log in as the Oracle user.

  2. Verify that the STA application is running. It may take a few minutes for the command to complete.

    $ STA status all
    mysql is running
    staservd service is running
    staweblogic service is running
    staengine service is running
     .... and the deployed application for staengine is in an ACTIVE state
    staadapter service is running
     .... and the deployed application for staadapter is in an ACTIVE state
    staui service is running
     .... and the deployed application for staui is in an ACTIVE state
    $
    

    If the application is not running, restart it. See "Start the STA Application" for instructions.

  3. Start the STA Port Change Utility. (See "Ensure the Correct Oracle User Path" for instructions on adding the location of the utility to the Oracle user path.)

    $ changeSTAPorts.sh
    

    The utility starts and verifies that the STA application is running.

    ********************************************************************************
    * Oracle StorageTek Tape Analytics 2.3.0.25.31                                 *
    * STA Port Change Utility                                                      *
    *                                                                              *
    * Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved. *
    ********************************************************************************
    This utility changes the HTTP and HTTPS port numbers used by the STA managed servers.
    To log in to this utility, you must enter the current WebLogic Administrator username and password.
     
    Checking STA server status .....
     
    +------------------------------------------------------+
    |                         Login                        |
    +------------------------------------------------------+
    
  4. At the prompts, enter the WebLogic administrator username and current password.

    Enter WebLogic Administrator username         : weblogic
    Enter current WebLogic Administrator password :
     
    Authenticating user...
    
  5. The utility main menu appears.

    +------------------------------------------------------+
    |                STA Port Change Utility               |
    |                       Main Menu                      |
    +------------------------------------------------------+
     
    Select port numbers to change
     
      1) WebLogic Administrator console port numbers
      2) STA Engine port numbers
      3) STA Adapter port numbers
      4) STA UI port numbers
      5) Exit
     
    Enter Choice [1-5] :
    
  6. Enter 5 to exit the utility and return to the system prompt.

    Enter Choice [1-8] : 5
    Quitting STA Configuration Utility.
    Exiting Utility.
    $
    

Change Port Numbers for the WebLogic Administration Console

Use this procedure to change the HTTP and HTTPS port numbers for the WebLogic Administration console. You must change both port numbers, and the utility prevents you from specifying port numbers registered to another process or already in use on the STA server.

After you specify the new port numbers, the utility automatically implements the changes and restarts the WebLogic server and STA application.

Note:

Before using this procedure, you must obtain the username and password of the WebLogic administrator account.

Note:

This procedure requires the STA application to be running.
  1. Start the STA Port Change Utility; see "Start the STA Port Change Utility" for instructions.

  2. At the main menu, enter 1 to change the WebLogic Administrator console port numbers.

    +------------------------------------------------------+
    |                STA Port Change Utility               |
    |                       Main Menu                      |
    +------------------------------------------------------+
     
    Select port numbers to change
     
      1) WebLogic Administrator console port numbers
      2) STA Engine port numbers
      3) STA Adapter port numbers
      4) STA UI port numbers
      5) Exit
     
    Enter Choice [1-5] : 1
    

    The utility displays information about the option and the HTTP and HTTPS port numbers currently assigned to the WebLogic Administration console.

    +------------------------------------------------------+
    |      WebLogic Administrator console port numbers     |
    +------------------------------------------------------+
    After you specify the new port numbers, the utility automatically restarts the WebLogic administration server and the STA managed servers. The restart process may take approximately 20 minutes.
    Caution: Do not interrupt the process once it starts, as it may cause irrecoverable errors in STA.
     
    Port requirements:
    * Must be numeric from 1024 to 65535
    * Must be unique and available, not already in use
     
    Caution: Specifying a port number that is already in use may cause port conflict and prevent the STA managed server from starting up properly.
     
    Current WebLogic Administrator console HTTP/HTTPS port numbers : 7019 / 7020
    
  3. At the prompts, enter the new HTTP and HTTPS port numbers.

    Enter new HTTP port number  : 7009
    Enter new HTTPS port number : 7010
     
    

    The utility implements the changes and restarts all STA processes.

    Changing WebLogic Administrator console HTTP/HTTPS ports. This may take up to 20 minutes.
    Changing ports in progress....
    
    WebLogic Administration server ports were changed successfully. The HTTP/HTTPS ports for WebLogic Administration console have been updated to 7009 / 7010.
     
    Port Change successful. Press [ENTER] to return to main menu
    
  4. Press Enter to return to the main menu.

Change Port Numbers for an STA Managed Server

Use this procedure to change the HTTP and HTTPS port numbers for any of the following STA managed servers:

  • staEngine

  • staAdapter

  • staUi

See "Domain Servers" for a description of the managed servers.

Note:

Before using this procedure, you must obtain the username and password of the WebLogic administrator account.

Note:

This procedure requires the STA application to be running.
  1. Start the STA Port Change Utility; see "Start the STA Port Change Utility" for instructions.

    The utility main menu appears.

    +------------------------------------------------------+
    |                STA Port Change Utility               |
    |                       Main Menu                      |
    +------------------------------------------------------+
     
    Select port numbers to change
     
      1) WebLogic Administrator console port numbers
      2) STA Engine port numbers
      3) STA Adapter port numbers
      4) STA UI port numbers
      5) Exit
     
    Enter Choice [1-5] : 
    
  2. Enter the number for the managed server you want to change (2, 3, or 4). This procedure uses the staEngine as an example.

    Enter Choice [1-8] : 2
    

    The utility displays information about the option and the HTTP and HTTPS port numbers currently assigned to the selected managed server.

    +------------------------------------------------------+
    |                STA Engine port numbers               |
    +------------------------------------------------------+
    After you specify the new port numbers, the utility automatically restarts the WebLogic administration server and the STA managed servers. The restart process may take approximately 20 minutes.
    Caution: Do not interrupt the process once it starts, as it may cause irrecoverable errors in STA.
     
    Port requirements:
    * Must be numeric from 1024 to 65535
    * Must be unique and available, not already in use
     
    Caution: Specifying a port number that is already in use may cause port conflict and prevent the STA managed server from starting up properly.
     
    Current STA Engine HTTP/HTTPS port numbers : 7023 / 7024
    
  3. At the prompts enter the new HTTP and HTTPS port numbers.

    Enter new HTTP port number  : 7013
    Enter new HTTPS port number : 7014
    

    The utility implements the changes and restarts all STA processes.

    Changing STA Engine HTTP/HTTPS ports. This may take. This may take up to 20 minutes.
    Changing ports in progress.....................................STA Engine HTTP and HTTPS ports were changed successfully. The HTTP/HTTPS ports for STA Engine have been updated to 7013 / 7014.
     
    Port Change successful. Press [ENTER] to return to main menu
    
  4. Press Enter to return to the main menu.

    +------------------------------------------------------+
    |                STA Port Change Utility               |
    |                       Main Menu                      |
    +------------------------------------------------------+
     
    Select port numbers to change
     
      1) WebLogic Administrator console port numbers
      2) STA Engine port numbers
      3) STA Adapter port numbers
      4) STA UI port numbers
      5) Exit
     
    Enter Choice [1-5] : 
    
  5. Enter 5 to exit the utility and return to the system prompt.

    Enter Choice [1-8] : 5
    Quitting STA Configuration Utility.
    Exiting Utility.
    $
    

Using the STA Port Change Utility

Note:

The STA Port Change Utility is available starting with STA 2.3.0. For earlier releases, you must deinstall and reinstall STA to make any changes to port numbers. For additional information, see the STA Administration Guide for the STA release you are running.

The STA Port Change Utility allows you to change the STA configurable external and internal port numbers (see "Ports Used by STA" for details). You can change as many port numbers as you want in a single session. After each port number change, the utility automatically restarts the WebLogic server and the STA managed servers.

Note:

After you specify each port number change, the utility automatically stops and restarts all STA processes to implement the changes; therefore, Oracle recommends that you back up the STA database before using the utility. See "Updates Made by the STA Port Change Utility" for details.

STA Port Change Utility Location

The utility is a shell script run from the system command line. The script file name is changeSTAPorts.sh, and it is located in the following directory:

/Oracle_storage_home/StorageTek_Tape_Analytics/common/bin

where Oracle_storage_home is the Oracle storage home location specified during STA installation.

See "Ensure the Correct Oracle User Path" for instructions on adding the directory to the Oracle user path.

STA Port Change Utility Requirements

Caution:

STA port numbers must be unique and dedicated to the specified STA process. To prevent port conflicts, you should verify that the port numbers you want to use are not already registered or in use by another process on the STA server. See the STA Installation and Configuration Guide for details about the port numbers used by STA.

Following are requirements for running the STA Password Change Utility:

  • You must be logged in as the Oracle user.

  • The STA application and all STA services must be running. See "Display the Status of the STA Application" to verify.

  • You must know the Weblogic administrator username and password; the script will prompt for this information as soon as it is started.

Updates Made by the STA Port Change Utility

When you confirm each port number change, the utility automatically makes the following updates:

  • Restarts the WebLogic server and all STA managed servers to implement your changes

  • Stops and restarts all STA processes. Some library transactions will be lost during this process.

STA Port Change Utility Logs

The STA Port Change Utility logs track all updates made by the STA Port Change utility. The logs can useful for troubleshooting issues with the utility or the ports themselves.

The logs are located in the following directory:

/var/log/tbi/changeutility

Following is a sample directory listing showing the files.

$ ls -l /var/log/tbi/changeutility
-rw-r--r-- 1 oracle oinstall  126 Feb 22 09:44 STAChangeUtility-0.log

The log records when the STA Port Change Utility is used. See "Using the STA Port Change Utility" for details.

For each log, there may be up to 10 different log files in the directory, each with a sequential number, 0 to 9, indicating their order. Log "0" is always the active log, and logs "1" through "9" are historical. Log files have a 1.0 MB size limit, and when log "0" reaches the limit, the logs are rotated—log "0" becomes log "1", log "1" becomes log "2", and so on—and a new log "0" is started. Any existing log "9" is overwritten by log "8" and effectively deleted, or rolled off.