Skip to main content

UXSPi proxy tool

The UXSPI proxy tool is an executable binary that accepts UXSPi command syntax and invokes the corresponding OneCLI command.

UXSPi proxy tool syntax

uxspi.exe [command] [-parameter]

For more information about UXSPI, refer to: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-xpress

The following table lists commands and parameters used by the UXSPI proxy tool and the corresponding XClarity Essentials OneCLI commands and parameters.

Table 1. Matrix of UXSPi and OneCLI commands and parameters
UXSPiOneCLI
CommandParameterCommandParameter
acquire--check -updateacquireNot 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-passwordNot supported.
--no-proxyEmpty
--preview-user=userNot supported.
--preview-password= passwordNot supported.
--preview-password-secure= secure-passwordNot supported.
--xml--xml
--vmware-esxi-update= 4.1/5.0Not supported.
--include-softwareNot supported.
compare-F, --firmwarecompare--type fw
-D, --drivers--type dd
--include-softwareNot supported.
-f update-ids, --force=update-ids--forceid update-ids
-s update-ids, --select= update-ids/all/undetectedNot supported.
-l UXSP, --local=UXSP-- dir UXSP
-n, --newNot supported.
-e update-ids, --exclude=update-ids--excludeid update-ids
-i update-ids, --include=update-ids--Includeid update-ids
--ignore-undetected= update-idsNot supported.
-L, --latest-- scope latest
--remote= remote_addressNot supported.
--remote-user=userNot supported.
--remote-password=passwordNot supported.
--remote-password-secure= secure-password NewNot supported.
--remote-dir=directoryNot supported.
--noinventoryNot supported.
-o, --linuxoverride= update-ids--forceid update-ids
Note
B the -f and -o parameters in UXSPi map to --forceid.
--nouxspNot supported.
-r, --reportNot supported.
--tuiNot supported.
--timeout=timeNot supported.
--xmlNot supported.
--disable-imm-lanNot supported.
--vmware-esxi=url--esxi url
--host= IMM_IP_Address--bmc url
--update-args="IMM: --user=userid --password=pwd,UEFI:--backup"
--esxi-updatefileNot supported.
-m type, --machine-type=type--mt type
--ignore-mtos-checkNot supported.
update-F, --firmwareupdate--type fw
-D, --drivers--type dd
--include-softwareNot supported.
-f update-ids, --force=update-ids--forceid update-ids
-s update-ids, --select=update-ids/all/undetectedNot supported.
-l UXSP, --local=UXSP-- dir UXSP
-n, --newNot supported.
-e update-ids, --exclude=update-ids--excludeid update-ids
-i update-ids, --include=update-ids--Includeid update-ids
--ignore-undetected=update-idsNot supported.
-L, --latest-- scope latest
--remote=remote_addressNot supported.
--remote-user=userNot supported.
--remote-password=passwordNot supported.
--remote-password-secure= secure-password NewNot supported.
--remote-dir=directoryNot supported.
--noinventoryNot supported.
-o, --linuxoverride=update-ids--forceid update-ids
Note
B the -f and -o parameters in UXSPi map to --forceid.
--nouxspNot supported.
-r, --reportNot supported.
--tuiNot supported.
--timeout=timeNot supported.
--xmlNot supported.
--disable-imm-lanNot supported.
--vmware-esxi=url--esxi url
--host=IMM_IP_Address--bmc url
--update-args="IMM: --user=userid --password=pwd,UEFI:--backup"
--esxi-updatefileNot supported.
--ignore-req--noreq
--ignore-hwcheckNot supported.
-m type, --machine-type=type--mt type
--ignore-mtos-checkNot supported.
bc

(Scan commands)

-s, --scanbc

(Scan commands)

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

(CMM update commands)

-m --mmbc

(CMM update commands)

Not supported. UXSPi needs input update file names, while OneCLI needs input package IDs. The IDs and files names cannot 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, --iobc

(I/O-module update commands)

Not supported. UXSPi needs input update file names, while OneCLI needs input package IDs. The IDs and files names cannot 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