Starting and stopping an IBM Spectrum Protect object agent manually when using ports in the range 0 - 1024

Created by Miranda Bennett on Mon, 11/02/2020 - 10:39
Published URL:
https://www.ibm.com/support/pages/node/6357941
6357941

How To


Summary

If IBM Spectrum Protect is installed on an IBM AIX or Linux® operating system, and you configured an object agent that uses a port number in the range 0 - 1024, you must run the object agent with the root user ID. When you use the root user ID, you must start the object agent manually.

Steps

Before you begin

Create an object agent by using the Operations Center or the command-line interface. For instructions about creating an object agent, see the following topics:

Starting the agent manually

Method 1: Using the NOHUP command on AIX and Linux operating systems

Important: Service install and service start scripts are applicable only to Method 2 and Method 3. Do not use the scripts if you start the object agent by using Method 1.

To manually start the object agent in the background on AIX or Linux, use a shell command with the following attributes:

Attribute Additional information
nohup command By specifying this command, you allow the process to exist beyond the shell that started it.
Hostname Specify the hostname for the IBM Spectrum Protect server, for example: example.hostname.com
Port number for the IBM Spectrum Protect server For example, you can specify the following value:
1500
Port number for the object agent For example, you can specify the following value:
443
Directory and  name of the object agent configuration file
The object agent configuration file is generated when you define the object agent in the Operations Center or by using the DEFINE SERVER command.
It is located in the subdirectory with the same name as the object agent and its file name includes the following attributes:
  • IBM Spectrum Protect instance home directory (Example: /home/tsminst1)
  • Object agent name (Example: S3AGENT)
  • IBM Spectrum Protect server port number (Example: 1500) 
File name example
/home/tsminst1/S3AGENT/spObjectAgent_S3AGENT_1500.config
 
/dev/null parameters By specifying these parameters, you direct the system to discard the command output because the shell command does not generate useful output.
2>&1 parameters Specify these parameters to ensure that the system sends standard error (STDERR) output to the standard output data stream (STDOUT).
& parameter Specify this parameter to ensure that the system starts the shell command in the background.

Command example:

nohup /opt/tivoli/tsm/server/bin/spObjectAgent gateway protect 
example.hostname.com:1500 --address :443 
--protect-config /home/tsminst1/S3AGENT/spObjectAgent_S3AGENT_1500.config
 > /dev/null 2>&1 &

Stopping the agent manually (only for users of Method 1):

To stop the object agent manually on AIX or Linux, log in to the IBM Spectrum Protect server with the root user ID and cancel the object agent process by using the kill command with signal -15 and the operating system process ID. For example, if the process ID is 15432, you would issue the following command:

kill -15 15423

Method 2: Using the CHSSYS command on AIX

This is the preferred method in AIX environments. To manually start the object agent in the background, complete the following steps:
  1. Obtain the name of the object agent service by issuing the following command:
    lssrc -a | grep spoa
  2. Modify an AIX subsystem service to run as root user by issuing the following sequence of commands:
    chssys -s object_agent_service_name -u 0
    startsrc -s object_agent_service_name
    where object_agent_service_name specifies the name of the object agent service that you identified in step 1.

Command example:

If an object agent server was defined to use a Low Level Address (LLA) of 443 and the name S3AGENT, the object agent service name is spoa443S3AGENT. In this case, you would run the following commands:

chssys -s spoa443S3AGENT -u 0
startsrc -s spoa443S3AGENT

Method 3: Preserving the "service" mechanism on Linux

This is the preferred method for Linux environments. To manually start the object agent in the background on LINUX, complete the following steps:
  1. Obtain the name of the object agent service by issuing the following command:
    ls -1 /etc/systemd/system | grep spoa
  2. Go to the system directory and locate the .service file with the object agent service name that you obtained in step 1.
  3. Edit the .service file to change the values as shown:
    User=root
    Group=root
  4. Save the file and restart the service by issuing the following command:
    service object_agent_service_name restart

    where object_agent_service_name specifies the name of the object agent service that you identified in step 1.

Command example:

An object agent server is defined with an LLA of 443 and the name S3AGENT. The service file is located in the: /etc/systemd/system/spoa443S3AGENT directory. To manually start the object agent, issue the following command:

service spoa443S3AGENT restart

Document Location

Worldwide

[{"Line of Business":{"code":"LOB69","label":"Storage TPS"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSEQVQ","label":"IBM Spectrum Protect"},"ARM Category":[{"code":"a8m0z000000GpKaAAK","label":"Client-\u003EInstall\/Configuration"}],"ARM Case Number":"","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"}],"Version":"8.1.11"}]

Document Information

Modified date:
03 August 2021

UID

ibm16357941

Page Feedback