OS Manuals

/usr/bin/ucx_info

ucx utilities

From ucx-utils 1.22.0-r5 (enterprise-packages), captured 2026-11-09 by running ucx_info --help (exit 255). permalink

/usr/bin/ucx_info: invalid option -- '-'
Usage: ucx_info [options]
At least one of the following options must be set:
  -v                   Show version information
  -d                   Show devices and transports
  -b                   Show build configuration
  -y                   Show type and structures information
  -s                   Show system information
  -c                   Show UCX configuration
  -C                   Comment-out default configuration values
  -F <string>          Only show configuration values whose name contains 'string'
  -a                   Show also hidden configuration
  -f                   Display fully decorated output

UCP information (-u is required):
  -p                   Show UCP context information
  -w                   Show UCP worker information
  -e                   Show UCP endpoint configuration
  -m <size>[,<type>]   Show UCP memory allocation info for a given size and type
[1794237723.061817] [localhost:2    :0]       tcp_iface.c:991  UCX  ERROR scandir(/sys/class/net) failed: No such file or directory
                       Supported memory types are: host
  -u <features>        UCP context features to use. String of one or more of:
                        'a' : atomic operations
                        'r' : remote memory access
                        't' : tag matching
                        's' : stream
                        'm' : active messages
                        'x' : exported memory handle
                        'd' : device-based operations
                       Modifiers to use in combination with above features:
                        'w' : wakeup
                        'e' : error handling

Other settings:
  -t <name>            Show devices of the specified transport (requires -d)
  -n <count>           Estimated UCP endpoint count (for ucp_init)
  -N <count>           Estimated UCP endpoint count per node (for ucp_init)
  -D <type>            Set which device types to use when creating UCP context:
                         'all'  : all possible devices (default)
                         'shm'  : shared memory devices only
                         'net'  : network devices only
                         'self' : self transport only
  -P <type>            Set peer process placement for printing UCP endpoint
                       configuration:
                         'self'  : same process (default)
                         'intra' : same node
                         'inter' : different node
  -A <ip>              Local IP device address to use for creating
                       endpoint in client/server mode
  -6                   IPv6 address specified with option -A
  -T                   Print system topology
  -M                   Print memory copy bandwidth
  -h                   Show this help message
Options (25)
OptionDescriptionSource
-vShow version informationhelp
-dShow devices and transportshelp
-bShow build configurationhelp
-yShow type and structures informationhelp
-sShow system informationhelp
-cShow UCX configurationhelp
-CComment-out default configuration valueshelp
-F stringOnly show configuration values whose name contains 'string'help
-aShow also hidden configurationhelp
-fDisplay fully decorated outputhelp
-pShow UCP context informationhelp
-wShow UCP worker informationhelp
-eShow UCP endpoint configurationhelp
-m sizeShow UCP memory allocation info for a given size and typehelp
-u featuresUCP context features to use.help
-t nameShow devices of the specified transport (requires -d)help
-n countEstimated UCP endpoint count (for ucp_init)help
-N countEstimated UCP endpoint count per node (for ucp_init)help
-D typeSet which device types to use when creating UCP context: 'all' : all possible devices (default) 'shm' : shared memory devices only 'net' : network devices only 'self' : self transport onlyhelp
-P typeSet peer process placement for printing UCP endpoint configuration: 'self' : same process (default) 'intra' : same node 'inter' : different nodehelp
-A ipLocal IP device address to use for creating endpoint in client/server modehelp
-6IPv6 address specified with option -Ahelp
-TPrint system topologyhelp
-MPrint memory copy bandwidthhelp
-hShow this help messagehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.