UXSPI proxy tool

ToolsCenter Suite CLI can utilize scripts from prior releases of UpdateXpress System Pack Installer using the UXSPI proxy tool. The UXSPI proxy tool is an executable binary that maps a script to its corresponding ToolsCenter Suite CLI command.

UXSPI proxy tool syntax

uxspi.exe [command][-parameter]
For more information about UXSPI, refer to:

The following table lists commands and parameters used by the UXSPI proxy tool and the corresponding ToolsCenter Suite CLI commands and parameters.

Table 1. UXSPI commands and parameters
UXSPI Command UXSPI parameter ToolsCenter Suite CLI command ToolsCenter Suite CLI parameter
acquire --check -update acquire Not supported.
-l UXSP-path, --local=UXSP-path --dir UXSP-path
m type, --machine-type=type --mt type
--meta-only --metaonly
-o operating-system, --os=operating-system --ostype operating-system
-L , --latest --scope latest
-i update-id, --id=update-id --includeid update-id
Note: Must be used with --scope individual.
-r, --report --report
--proxy-address=address --proxy url
--proxy-port=port
--proxy-user=user
--proxy-password= password
--proxy-password-secure= secure-password Not supported.
--no-proxy Empty
--preview-user=user Not supported.
--preview-password= password Not supported.
--preview-password-secure= secure-password Not supported.
--xml --xml
--vmware-esxi-update= 4.1/5.0 Not supported.
--include-software Not supported.
compare -F, --firmware compare --type fw
-D, --drivers --type dd
--include-software Not supported.
-f update-ids, --force=update-ids --forceid update-ids
-s update-ids, --select= update-ids/all/undetected Not supported.
-l UXSP, --local=UXSP -- dir UXSP
-n, --new Not supported.
-e update-ids, --exclude=update-ids --excludeid update-ids
-i update-ids, --include=update-ids --Includeid update-ids
--ignore-undetected= update-ids Not supported.
-L, --latest -- scope latest
--remote= remote_address Not supported.
--remote-user=user Not supported.
--remote-password=password Not supported.
--remote-password-secure= secure-password New Not supported.
--remote-dir=directory Not supported.
--noinventory Not supported.
-o, --linuxoverride= update-ids --forceid update-ids
Note: B the -f and -o parameters in UXSPI map to --forceid.
--nouxsp Not supported.
-r, --report Not supported.
--tui Not supported.
--timeout=time Not supported.
--xml Not supported.
--disable-imm-lan Not supported.
--vmware-esxi=url --esxi url
--host= IMM_IP_Address --imm url
--update-args="IMM: --user=userid --password=pwd,UEFI:--backup"
--esxi-updatefile Not supported.
-m type, --machine-type=type --mt type
--ignore-mtos-check Not supported.
update -F, --firmware update --type fw
-D, --drivers --type dd
--include-software Not supported.
-f update-ids, --force=update-ids --forceid update-ids
-s update-ids, --select=update-ids/all/undetected Not supported.
-l UXSP, --local=UXSP -- dir UXSP
-n, --new Not supported.
-e update-ids, --exclude=update-ids --excludeid update-ids
-i update-ids, --include=update-ids --Includeid update-ids
--ignore-undetected=update-ids Not supported.
-L, --latest -- scope latest
--remote=remote_address Not supported.
--remote-user=user Not supported.
--remote-password=password Not supported.
--remote-password-secure= secure-password New Not supported.
--remote-dir=directory Not supported.
--noinventory Not supported.
-o, --linuxoverride=update-ids --forceid update-ids
Note: B the -f and -o parameters in UXSPI map to --forceid.
--nouxsp Not supported.
-r, --report Not supported.
--tui Not supported.
--timeout=time Not supported.
--xml Not supported.
--disable-imm-lan Not supported.
--vmware-esxi=url --esxi url
--host=IMM_IP_Address --imm url
--update-args="IMM: --user=userid --password=pwd,UEFI:--backup"
--esxi-updatefile Not supported.
--ignore-req --noreq
--ignore-hwcheck Not supported.
-m type, --machine-type=type --mt type
--ignore-mtos-check Not supported.
bc

(Scan commands)

-s, --scan bc

(Scan commands)

scan
--mm-address=address --cmm url
--mm-user=user
--mm-password=password
--mm-password-secure=secure-password Not supported.
bc

(CMM update commands)

-m --mm bc

(CMM update commands)

Not supported. UXSPI needs input update file names, while ToolsCenter Suite CLI needs input package IDs. The IDs and files names can not match, so the proxy tool will not transfer these commands.
--mm-address=address
--mm-user=user
--mm-password=password
--mm-password-secure=secure-password
--mm-file=file1
--mm-file2=file2
--mm-force
bc

(I/O-module update commands)

-i, --io bc

(I/O-module update commands)

Not supported. UXSPI needs input update file names, while ToolsCenter Suite CLI needs input package IDs. The IDs and files names can not match, so the proxy tool will not transfer these commands.
--mm-address=address
--mm-user=user
--mm-password=password
--mm-password-secure=secure-password
--io-bay=bayID
--io-user=user
--io-password=password
--io-password-secure=secure-password
--io-file=file1
--io-file2=file2

Example of an UXSPI proxy

./uxspi up -u -l ./ -i elx-lnvgy_fw_fc_16a-lp16-11.0.270.24-1_linux_32-64 -L -e all

Where the translated command is:

./OneCli update flash --dir ./ --scope individual --includeid  elx-lnvgy_fw_fc_16a-lp16-11.0.270.24-1_linux_32-64
This is the output generated from this example:
Lenovo ToolsCenterSuite CLI tcliXXX-X.X.X
Based on module version X.X.X
Licensed Materials - Property of Lenovo
(C) Copyright Lenovo Corp. 2013-2016 All Rights Reserved
Lenovo Flex System
Non-ThinkServer platform