DSMSTA SETSTORAGESERVER command

Edit online

Use the DSMSTA SETSTORAGESERVER command to initialize the storage agent and add communication information to the device configuration file and the storage agent options file dsmsta.opt.

Privilege class

Use this utility on the client system where the storage agent is installed. This utility does not remove any previous entries in the files. It appends information to the existing files. The option DEVCONFIG, which sets a name for the device configuration file, must be in the dsmsta.opt file for the command to work. See Example.

When you configure the storage agent by using the DSMSTA SETSTORAGESERVER command, use addresses that correspond to the communications method used by the backup-archive client. The backup-archive client supports either IPv4 (COMMMETHOD TCPIP) or IPv6 (COMMMETHOD V6TCPIP), but not both at the same time.

Syntax

Read syntax diagramSkip visual syntax diagramDSMSTA SETSTORAGESERVERMYName=storage_agent_nameDSMSTA SETSTORAGESERVERMYName=storage_agent_nameMYPAssword=storage_agent_passwordMYHLAddress=storage_agent_hladdressSERVERName=server_nameSERVERPAssword=server_passwordHLAddress=server_tcpip_addressLLAddress=server_tcpip_portSTAKEYDBPW=obfuscated_passwordSSL=YES

Parameters

All parameters are required. Allowed abbreviations for the options are shown in uppercase letters.

MYName
Specifies the name of the storage agent. This name is displayed in the SET STANAME command that is inserted into the device configuration file.

You must use the same name when you define the storage agent as a server to the IBM Storage Protect server.

MYPAssword
Specifies the password of the storage agent. This value is encrypted and used in the SET STAPASSWORD command that is inserted into the device configuration file.

You must use the same password when you define the storage agent as a server to the IBM Storage Protect server.

MYHLAddress
Specifies the TCP/IP address of the storage agent. This value is used internally in the SET STAHLADDRESS command that is inserted into the device configuration file.
SERVERName
Specifies the name of the IBM Storage Protect server. This name is displayed in the DEFINE SERVER command that is inserted into the device configuration file.
SERVERPAssword
Specifies the password of the server. This value is encrypted and is displayed in the SERVERPASSWORD parameter of the DEFINE SERVER command that is inserted into the device configuration file.
HLAddress
Specifies the TCP/IP address of the server. This value is used in the HLADDRESS parameter of the DEFINE SERVER command.
LLAddress
Specifies the TCP/IP port on which to access the server. This value is used in the LLADDRESS parameter of the DEFINE SERVER command.
STAKEYDBPW
Specifies the password that is used to verify and control access to the SSL key database. The value of the STAKEYDBPW parameter is stored in the storage agent options file.
SSL
Specifies whether the storage agent will use Secure Sockets Layer (SSL) for communicating with the server. The default value is NO.
Important:

Handling Special Characters in Shell When Using DSMSTA

When issuing the DSMSTA command from a Unix or Linux shell (for example, bash or ksh), ensure that you properly escape or quote arguments containing special characters. Shells interpret characters such as $, @, !, &, and others in specific ways, which can result in unexpected behavior or errors if not handled correctly.

Why Escaping Is Necessary?

For example, in the password St0r@93Pr0t3ct$3rv3r, the $ symbol is interpreted by the shell as a variable reference. If not properly escaped or quoted, the shell will attempt to substitute $3rv3r with the value of a shell variable named 3rv3r, which likely does not exist. This results in an incorrect password being passed to the command.

Recommended Approaches:

You can prevent shell interpretation using one of the following options:
  • Single quotation mark('): Prevents all interpretation of special characters. For example:
    ./dsmsta setstorageserver myname=sta_node mypassword='St0r@93Pr0t3ct$3rv3r'
myhla=10.90.6.56 hla=10.90.5.249 lla=1500 servername=server1
serverpa='P@$$w0rd4TSMserver' ssl=yes
  • Escape characters (\): Escapes individual special characters. For example:
    ./dsmsta setstorageserver myname=sta_node mypassword=St0r@93Pr0t3ct$3rv3r
myhla=10.90.6.56 hla=10.90.5.249 lla=1500 servername=server1
serverpa=P@\$\$w0rd4TSMserver ssl=yes

Best Practice

Use single quotation marks for passwords. If the password includes a single quotation mark ('), escape it or use double quotation marks to ensure it is handled correctly.

Example for issuing DSMSTA SETSTORAGESERVER command

Issue the DSMSTA SETSTORAGESERVER command with the following information:
  • Storage agent
    • Name: storagnt
    • Password: fun4me
    • TCP/IP address: agent.example.com
IBM Storage Protect server
  • Name: tsmsrver
  • Password: not4u
  • TCP/IP address: tsmsrver.example.com
  • SSL port: 1542
The command is:
dsmsta setstorageserver myname=storagnt mypassword=fun4me
myhladdress=agent.example.com
servername=tsmsrver serverpassword=not4u
   hladdress=tsmsrver.example.com lladdress=1502
The command generates the following lines in the device configuration file for the storage agent:
set staname storagnt
set stapassword xxxxx
set stahladdress agent.example.com
define server tsmsrver serverpassword=xxxxxxxx
  hladdress=tsmsrver.example.com lladdress=1502
The passwords (shown as xxxxxxxx) are encrypted in the file. The command also generates the following line in the dsmsta.opt file for the storage agent:
servername tsmsrver
To enable SSL communication and to ensure that the storage agent is authenticated through an LDAP directory server, issue the following command:
dsmsta setstorageserver myname=storagnt mypassword=fun4me
myhladdress=agent.example.com
servername=tsmsrver serverpassword=not4u
ssl=yes
stakeydbpw=password
hladdress=tsmsrver.example.com lladdress=1500
ssltcpport=1543