manage_tsm command for 1.0.17 and lower
The manage_tsm command configures IBM Spectrum Protect, formerly known as IBM® Tivoli® Storage Manager.
Parameters for the configuration of IBM Spectrum Protect client and IBM Spectrum Protect server
Syntax for LAN-based operations
manage_tsm --servername name --serveraddress address --commmethod method --tcpport port_number --passwordaccess access_method --configure-api
Syntax for LAN-free operations
manage_tsm --servername name --serveraddress address --commmethod method --lanfreecommmethod lanfree_communication_method --tcpport port_number --lanfreeshmport lanfree_shared_memory_port --shmport port_number --enablelanfree yes=LAN-free/no=not LAN-free --passwordaccess access_method --configure-api-sta
- --servername name
- Specifies the name of IBM Spectrum Protect server.
- --serveraddress address
- Specifies the address of IBM Spectrum Protect server, which can be an IP address or fully qualified host name.
- --commmethod method
- Specifies the communication method between IBM Spectrum Protect client and IBM Spectrum Protect server.
- --lanfreecommmethod lanfree_communication_method
- Specifies the communication protocol between IBM Spectrum Protect client and Spectrum Storage Agent.
- --tcpport port_number
- Specifies the address of the TCP/IP port of IBM Spectrum Protect server.
- --lanfreeshmport lanfree_shared_memory_port
- Specifies the port address for the communication between IBM Spectrum Protect client and Spectrum Storage Agent. To use it only when the lanfreecommmethod=sharedmem parameter is set.
- --shmport port_number
- Specifies the TCP/IP port address of a IBM Spectrum Protect server when shared memory is used.
- --enablelanfree yes/no
- Specifies whether an available LAN-free path is to be enabled to storage device that is attached to a storage area network (SAN).
- --passwordaccess access_method
- Specifies whether the password is to be generated automatically with access_method = generate or is to be set as a user prompt as access_method = prompt.
- --node cluster_node_name
- Used to execute commands on a particular node in the cluster. Example usage:
manage_tsm --password-change --node node0101-fab
- --nodename server_registered_nodename
- Sets nodename parameter in dsm.sys file to match
registration on the IBM Spectrum Protect
Server side. Example usage:
manage_tsm --nodename user01 --node node0101-fab --update --configure-api
- --ssl
- Sets secure socket layer (SSL). Possible values:
yes | no
. Default:yes
Parameters for the configuration of backup and restore
manage_tsm --configure-api --configure-ba --configure-api-sta --reconfigure-api --reconfigure-ba --reconfigure-api-sta --dsmsta-setstorageserver --start-dsmsta --stop-dsmsta --status-dsmsta --config-status --password-change --ba-dsmc --ba-dsmc --instructions --help
- --configure-api
- Configures IBM Spectrum Protect Client.
- --configure-ba
- Configures IBM Spectrum Protect backup-archive client.
- --configure-api-sta
- Configures API Client and the storage agent options file.
- --reconfigure-api
- Reconfigures IBM Spectrum Protect Client.
- --reconfigure-ba
- Reconfigures IBM Spectrum Protect backup-archive client.
- --reconfigure-api-sta
- Reconfigures the API Client and the storage agent options file.
- --dsmsta-setstorageserver
- Runs the dsmsta setstorageserver command to initialize the storage agent.
- --dsmsta-setstorageserver-reinitialize
- Runs the dsmsta setstorageserver command to reinitialize the storage agent.
- --start-dsmsta
- Starts services for dsmsta.
- --stop-dsmsta
- Stops services for dsmsta.
- --status-dsmsta
- Checks the status of dsmsta.
- --config-status
- Checks the status of the client configuration.
- --password-change
- Changes the password of IBM Spectrum Protect Client for all the nodes.
- --auth-password
- Verifies the established password connection between Client and Server.
- --ba-dsmc
- Calls the dsmc command to start IBM Spectrum Protect backup-archive client.
- --update
- Updates configuration file or adds extra parameters. Use it with the --configure-api or configure-api-sta command.
- --instructions
- Shows configuration instructions.
- --help
- Shows the command syntax.