Reads the IBM TSM / Spectrum Protect client option file (dsm.opt or a differently named file) locally or from a remote computer and extracts the server address, user ID, and password. Returns a structured result object; the password is always returned as a SecureString.
Execution Flow
Synopsis
Locates the IBM TSM client option file via the private helper _FindDsmOptPath (or accepts an explicit path). The file may have a different name than dsm.opt; see Options File Detection Order below. Reads the file directly, for remote computers through the admin share (UNC path). Parses all non-comment key-value pairs into a hashtable and extracts TCPServeraddress, USERID, and PASSWORD. The password is always returned as a SecureString; plain text is available only when -IncludePasswordPlain is set.
No dbatools required. Requires the private helpers _FindDsmOptPath and _ToUncPath (both internal to sqmSQLTool). For remote computers, the caller must have access to the admin share of the target (or pass -Credential), and the remote registry is used to read the TSM service settings. On any error Success = $false is returned unless -EnableException is set.
Get-sqmTsmConfiguration-DsmOptPath'C:\Program Files\Tivoli\TSM\baclient\node01.opt'# Without -DsmOptPath the name is taken from the TSM service (-optfile=) or from any *.opt with TCPServeraddress