NVIDIA UFM Enterprise Appliance Software User Manual v1.6.0
NVIDIA UFM Enterprise Appliance Software User Manual v1.6.0

System Management

This section describes the commands that configure and monitor the network interface.

Interface

interface

interface <eno8303 | eno8403 | eno12399np0 | eno12409np1 | ib0 | ib1 | ib2 | ib3>

Enters a network interface context.

Syntax Description

eno8303

Management port 0 (out of band)

eno8403

Management port 1 (out of band)

eno12399np0

Management port 2 (out of band)

eno12409np1

Management port 3 (out of band)

ib0

InfiniBand interface 0

ib1

InfiniBand interface 1

ib2

InfiniBand interface 2 (UFM 3.0 only)

ib3

InfiniBand interface 3 (UFM 3.0 only)

Default

N/A

Configuration Mode

config

History

1.3.0

Example

Copy
Copied!
            

ufmapl (config) # interface eno8303 ufmapl (config interface eno8303) #

Related Commands

N/A

Notes

N/A


show interfaces

show interfaces [eno8303 | eno8403 | eno12399np0 | eno12409np1 | ib0 | ib1 | ib2 | ib3]

Displays information about the network interfaces.

Syntax Description

eno8303

Management port 0 (out of band)

eno8403

Management port 1 (out of band)

eno12399np0

Management port 2 (out of band)

eno12409np1

Management port 3 (out of band)

ib0

InfiniBand interface 0

ib1

InfiniBand interface 1

ib2

InfiniBand interface 2 (UFM 3.0 only)

ib3

InfiniBand interface 3 (UFM 3.0 only)

Default

N/A

Configuration Mode

enable

History

1.6.0

Updated example and added command syntax

1.4.1

First release

Example

Copy
Copied!
            

swx-ufm3-06 # show interfaces eno8303 Interface eno8303 status: Comment : Admin up : yes Link up : yes DHCP running : yes IP address : 10.209.36.101 Netmask : 255.255.252.0 IPv6 enabled : yes Autoconf enabled : N/A Autoconf route : N/A Autoconf privacy : N/A DHCPv6 running : yes IPv6 addresses : 2   IPv6 address: fcfc:fcfc:209:36:b27b:25ff:fee9:30c8/64 fe80::b27b:25ff:fee9:30c8/64   Speed : 1000Mb/s (auto) Duplex : Full (auto) Interface type : ethernet Interface source : physical MTU : 1500 HW address : b0:7b:25:e9:30:c8   Rx: 6109552397 bytes 45457113 packets 36881549 mcast packets 295 discards 0 errors 0 overruns 0 frame Tx: 242521186 bytes 1211397 packets 0 discards 0 errors N/A overruns 0 carrier 1211397 collisions 1000 queue len

Related Commands

interface <ifname> ip address <IP address> <netmask>

Notes


ip address

ip address <IP address> <netmask>

Sets the IP address and netmask of this interface.

Syntax Description

IP address

IPv4 address

netmask

Subnet mask of IP address

Default

N/A

Configuration Mode

config interface

History

1.3.0

Example

Copy
Copied!
            

ufmapl (config interface eno8303) # ip address 10.10.10.10 255.255.255.0

Related Commands

interface

Notes

The command sequence is important. The ip address command should be used first during automation since it clears both default-gateway and name-server settings


ipv6 address

ipv6 address <IPv6 address>/<netmask>

Configures static IPv6 address and netmask to this interface, static option is possible.

Syntax Description

IPv6 address/netmask

Configures a static IPv6 address and netmask. Format example: 2001:db8:1234::5678/64.

Default

N/A

Configuration Mode

config interface management

History

1.3.0

Example

Copy
Copied!
            

ufmapl (config interface eno8303)# ipv6 address fe80::202:c9ff:fe5e:a5d8/6

Related Commands

N/A

Notes

N/A

Hostname

hostname

hostname <hostname>

Sets a static system hostname.

Syntax Description

hostname

String

Default

Configuration Mode

config

History

1.3.0

Example

Copy
Copied!
            

ufmapl(config) # hostname ufmapl-hostname

Related Commands

N/A

Notes

N/A


ip name-server

ip name-server <no ip name-server>

no ip name-server

Configures DNS servers to be used.

The no form of the command clears the name server.

Syntax Description

IPv4 address

IPv4 address

IPv6 address

IPv6 address

Default

No server name

Configuration Mode

config

History

1.4.2

Updated command description and added the a no form of the command

1.3.0

First release

Example

ufmapl (config)# ip name-server 9.9.9.9

Related Commands

N/A

Notes

The command sequence is important. The ip name-server command should be used during automation, after running the ip address and the ip default-gateway commands


{ip | ipv6} host

{ip | ipv6} host <hostname> <ip-address>

no {ip | ipv6} host <hostname> <ip-address>

Sets the static domain name.

The no form of the command clears the domain name.

Syntax Description

hostname

String

ip-address

IPv4 or IPv6 address

Default

N/A

Configuration Mode

config

History

1.5.0

Example

Copy
Copied!
            

ufmapl (config)# ip host test-host 1.2.3.4 ufmapl (config)# ipv6 host my-ipv6-host 2001::8f9

Related Commands

show hosts

Notes


show hosts

show hosts

Displays hostname, DNS configuration, and static host mappings.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any configuration mode

History

1.4.0

Example

Copy
Copied!
            

ufmapl (config) # show hosts   Hostname: swx-ufm3-02     Name servers: 10.211.0.124 (on eno8303) 10.211.0.121 (on eno8303) 10.7.77.135 (on eno8303)   Domain names: mtr.labs.mlnx (on eno8303)   Static IPv4 host mappings: 127.0.0.1 --> localhost   Static IPv6 host mappings: ::1 --> localhost ::1 --> ip6-localhost ::1 --> ip6-loopback ff02::1 --> ip6-allnodes ff02::2 --> ip6-allrouters

Related Commands

N/A

Noes

N/A

Routing

ip default-gateway

ip default-gateway <address>

no ip default-gateway <address>

Configures a static default route.

The no form of the command removes the static route.

Syntax Description

address

gateway IPv4 or IPv6 address

Default

N/A

Configuration Mode

config

History

1.4.2

Updated syntax description and added a no form of the command

1.3.0

First release

Example

ufmapl (config)# ip default-gateway 10.209.36.1

Related Commands

N/A

Notes

The command sequence is important. The ip default-gateway command should be used during automation, after running the ip address command as it requires a static IP setting


ipv6 default-gateway

ipv6 default-gateway <address>

no ipv6 default-gateway <address>

Configures a static default route.

The no form of the command removes the static route.

Syntax Description

address

gateway IPv6 address

Default

N/A

Configuration Mode

config

History

1.4.2

Example

ufmapl (config)# ip default-gateway ::1

Related Commands

N/A

Notes

The command sequence is important. The ip default-gateway command should be used during automation, after running the ip address command as it requires a static IP setting


show {ip | ipv6} route

show {ip | ipv6} route [static]

Displays the routing table in the system.

Syntax Description

static

Filters the table with the static route entries

Default

N/A

Configuration Mode

Enable

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # show ip route Destination Mask Gateway Interface Source default 0.0.0.0 10.209.36.1 eno8303 dhcp 10.209.36.0 255.255.252.0 0.0.0.0 eno8303 interface  10.209.36.1 255.255.255.255 0.0.0.0 eno8303 dhcp 169.254.1.0 255.255.255.0 0.0.0.0 idrac interface  172.17.0.0 255.255.0.0 0.0.0.0 docker0 interface 

Related Commands

{ip | ipv6} route

Notes


show {ip | ipv6} default-gateway

show {ip | ipv6} default-gateway [static]

Displays the default gateway.

Syntax Description

static

Displays the static configuration of the default

gateway

Default

N/A

Configuration Mode

Enable

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # show ip default-gateway Active default gateways: 10.209.36.1 (interface: eno8303)

Related Commands

{ip | ipv6} default-gateway

Notes

ntp enable

ntp enable

Enables NTP.

Syntax Description

N/A

Default

N/A

Configuration Mode

config

History

1.3.0

Example

Copy
Copied!
            

ufmapl (config) # ntp enable

Related Commands

N/A

Notes

N/A


ntp server

ntp server <address>

no ntp server <address>

Configures an NTP server

The no form of the command removes NTP server

Syntax Description

address

IPv4 or IPv6 address

Default

N/A

Configuration Mode

config

History

1.4.2

Updated the command description and added a no form of the command

1.3.0

First release

Example

Copy
Copied!
            

ufmapl (config) # ntp server 10.10.10.10

Related Commands

N/A

Notes

N/A


ntp peer

ntp peer <address>

no ntp peer <address>

Configures an NTP peer

The no form of the command removes the NTP peer

Syntax Description

address

IPv4 or IPv6 address

Default

N/A

Configuration Mode

config

History

1.4.2

Added the no form of the command

1.3.0

First release

Example

Copy
Copied!
            

ufmapl (config) # ntp peer 11.11.11.11

Related Commands

N/A

Notes

N/A


image fetch

image fetch <URL>

Downloads a system image from a remote host.

Syntax Description

URL

HTTPS, SCP and SFTP are supported

Example: scp://username[:password]@hostname/path/filename

Default

N/A

Configuration Mode

config

History

1.5.0

Example

Copy
Copied!
            

ufmapl (config) # image fetch scp://root:123456@192.168.10.125/tmp/ufm-appliance-1.5.0-6-omu.tar 100.0%[###########################################################################################]

Related Commands

show images

Notes


image install

image install <image-name>

Installs an image file.

Syntax Description

image name

Specifies the image name

Default

N/A

Configuration Mode

config

History

1.5.0

Example

Copy
Copied!
            

ufmapl (config) # image install ufm-appliance-1.5.0-6-omu.tar Verifying image... Extracting image... Installing image... 20230809-07_24_52: UFM-OS UPGRADE to version 23.07.18-3 STARTED 20230809-07_24_52: UFM_OS_UPGRADE [STARTED ] WARNING!!! /tmp/ufm_os_upgrade_ml2ah98f/ufm-appliance-1.5.0-4-omu/ufm-os-upgrade.sh will require a restart upon completion. OFED drivers, kernel and kernel models will not work properly until the server is rebooted!!!   In case of a change to the secureboot certificate , a message will be prompted to the screen to indicate that an action is needed when restarting.     20230809-07_24_52: HighAvailability is detected, node role is: stand-by 20230809-07_24_53: Check if ufm-enterprise.service is running 20230809-07_24_53: ufm-enterprise.service is not running, continue with the upgrade 20230809-07_24_53: Extracting ISO... 20230809-07_24_53: CERTIFICATE-VALIDATION [PASSED ] 20230809-07_24_54: HA-STANDBY-MODE-ACTIVATE [PASSED ] 20230809-07_24_54: Backup HA cluster config to /var/tmp/ufm_os_upgrade_23_07_18-3/pcs_config_backup_23.07.18-3.tar.bz2 20230809-07_24_55: HA-PREPARATION [PASSED ] 20230809-07_24_55: A newer kernel version is detected: 4.15.0-213-generic, installing 20230809-07_25_22: KERNEL-UPGRADE [PASSED ] 20230809-07_25_22: Preparing MOFED repo 20230809-07_25_24: MOFED-PREPARATION [PASSED ] 20230809-07_25_24: Upgrading UFM-APPLIANCE SW 20230809-07_27_01: Upgrading UFM-APPLIANCE SW finished 20230809-07_27_01: APPLIANCE-UPGRADE [PASSED ] 20230809-07_27_01: HA-PACKAGES-UPGRADE [SKIPPED ] 20230809-07_27_01: Upgrading telemetry packages... 20230809-07_27_01: TELEMETRY-REQUIREMENTS-UPGRADE [PASSED ] 20230809-07_27_06: updating firmware 20230809-07_27_19: FW-UPGRADE [PASSED ] 20230809-07_27_19: Upgrading packages... 20230809-07_28_15: PACKAGES-UPGRADE [PASSED ] 20230809-07_28_15: Upgrading collection tools... 20230809-07_28_15: Updating FW rules 20230809-07_28_20: FIREWALL-PORTS [PASSED ] 20230809-07_28_20: UFMCLI tar is copied to /opt/ufm-os-firstboot to run on next-boot. 20230809-07_28_20: UFMCLI-PREPERATION [PASSED ] 20230809-07_28_20: HA-STANDBY-MODE-DEACTIVATE [PASSED ] 20230809-07_28_20: UFM-OS-UPGRADE [PASSED ] 20230809-07_28_20: UPGRADE finished, kernel modules, OFED and new kernel wont function properly until reboot is performed. 20230809-07_28_20: Please reboot the server.   Please check log file for more details: /var/log/ufm_os_upgrade_23.07.18-3.log Upgrade steps status information: /var/log/ufm_os_upgrade_23.07.18-3_status.log.

Related Commands

show images

Notes

  • The image should be installed on the standby node only. Installation on the master node is not allowed.

  • Once the installation is complete, perform system reboot using the command:

    Copy
    Copied!
                

    reload


image delete

image delete <image-name>

Deletes the specified image file from the hard drive.

Syntax Description

image-name

Specifies the image name

Default

N/A

Configuration Mode

config

History

1.5.0

Example

Copy
Copied!
            

ufmapl (config) # image delete ufm-appliance-1.5.0-6-omu.tar

Related Commands

show images

Notes


show images

show image

Displays information about the system images and boot parameters.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any configuration mode

History

1.5.0

Example

Copy
Copied!
            

ufmapl (config) # show images Installed images: Partition 1: version: ufm_appliance UFMAPL_1.4.3.1_UFM_6.13.2.5 2023-06-13 08:42:27 x86_64 Images available to be installed: 1: Image : ufm-appliance-1.5.0-6-omu.tar

Related Commands

image delete

image fetch

image install

Notes


User Accounts

username

username root disable

no username root disable

Disable logging into root account

The no form of the command reenable login into root account

Syntax Description

N/A

Default

N/A

Configuration Mode

config

History

1.4.1

Example

Copy
Copied!
            

ufmapl (config) # username root disable

Related Commands

N/A

Notes

N/A

username admin password

username admin password <password>

Changes the "admin" user password.

Syntax Description

password

Specifies a password for the user in string form.

Default

N/A

Configuration Mode

config

History

1.4.2

Example

Copy
Copied!
            

ufmapl (config) # username admin password 123456

Related Commands

N/A

Notes

N/A

AAA Methods

aaa authentication login default

aaa authentication login default <auth method> [<auth method>]

Sets a sequence of authentication methods. Up to two methods can be configured.

Syntax Description

auth-method

Possible values:

  • local

  • tacacs+

Default

N/A

Configuration Mode

config

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # aaa authentication login default local tacacs+

Related Commands

show aaa

Notes

Setting tacacs+ as one of the authentication methods enables tacacs.

Setting no taccas+ and only local in the authentication methods disables tacacs.

show aaa

show aaa

Displays the AAA configuration.

Syntax Description

N/A

Default

N/A

Configuration Mode

Enable

History

1.6.0

Example

Copy
Copied!
            

ufmapl [ mgmt-sa ] (config) # show aaa AAA authorization: Map Order: remote-only   Authentication method(s): local tacacs+   Accounting method(s): tacacs+

Related Commands

aaa authentication login default

Notes

TACACS+

tacacs-server

tacacs-server {key <secret> | timeout <seconds>}

no tacacs-server {key | timeout}

Sets global TACACS+ server attributes.

The no form of the command resets the attributes to default values.

Syntax Description

key

Set a secret key (shared hidden text string) known to the system and to the TACACS+ server

timeout

Timeout in seconds (1-60)

Default

1 second

Configuration Mode

config

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # tacacs-server key testkey

Related Commands

show tacacs

tacacs-server host

Notes

Each TACACS+ server can override the global secret parameter using the command "tacacs-server host"

tacacs-server host

tacacs-server host <ip-address> {auth-port <port> | key <secret>}

no tacacs-server host <ip-address> {auth-port <port>}

Configures TACACS+ server attributes.

The no form of the command removes the TACACS+ server.

Syntax Description

ip-address

TACACS+ server IP address

auth-port

TACACS+ server UDP port number

key

Set a secret key (shared hidden text string) known to the system and to the TACACS+ server

Default

Default TCP port is 49

Configuration Mode

config

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # tacacs-server key testkey

Related Commands

show tacacs

tacacs-server

Notes

  • TACACS+ servers are tried in the order they are configured

  • If the user does not specify a parameter for this configured TACACS+ server, the configuration will be taken from the global TACACS+ server configuration. Refer to "tacacs-server" command.

show tacacs

show tacacs

Displays TACACS+ configurations.

Syntax Description

N/A

Default

N/A

Configuration Mode

Enable

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # show tacacs TACACS+ defaults: Timeout : 1    TACACS+ servers:  10.209.36.156:49: Key : ********    1.2.3.4:49: Key : ********

Related Commands

tacacs-server

tacacs-server host

Notes

show resources

show resources

Displays system resources.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any configuration mode

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # show resources Total Used Free Physical 65400 MB 2719 MB 60585 MB Swap 16252 MB 0 MB 16252 MB   Number of CPUs: 64 CPU load averages: 0.16 / 0.08 / 0.04   CPU 1 Utilization: 0% Peak Utilization Last Hour: 0% at 2023-11-05 09:45:01 Avg. Utilization Last Hour: 0%   CPU 2 Utilization: 5% Peak Utilization Last Hour: 19% at 2023-11-05 09:45:01 Avg. Utilization Last Hour: 7%   ...   CPU 64 Utilization: 0% Peak Utilization Last Hour: 1% at 2023-11-05 09:45:01 Avg. Utilization Last Hour: 1%

Related Commands

Notes


show version

show version

Displays version information for the currently running system image.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any configuration mode

History

1.4.2

Updated command output

1.4.0

First release

Example

Copy
Copied!
            

ufmapl (config) # show version   Product name: ufm_appliance Product release: UFMAPL_1.4.2.2_UFM_6.13.1.1 Build date: 2023-06-04 10:31:42 Version summary: ufm_appliance UFMAPL_1.4.2.2_UFM_6.13.1.1 2023-06-04 10:31:42 x86_64 UFM OS: 2.1.11 UFM CHASSIS HEALTH: 1.0.0-3 UFM HA: 5.1.1-4 UFM CLI: 1.2.0-8 Uptime: 3h 54m CPU load averages: 0.21 / 0.14 / 0.06 Number of CPUs: 64 System memory: 2463 MB used / 58693 MB free / 65400 MB total Swap: 0 MB used / 16252 MB free / 16252 MB total

Related Commands

N/A

Notes

N/A


show files system

show files system [detail]

Displays usage information of the file systems on the system.

Syntax Description

detail

Displays more detailed information on file-system

Default

N/A

Configuration Mode

Any configuration mode

History

1.6.0

Example

Copy
Copied!
            

ufmapl (config) # show files system   Statistics for /var filesystem: Space Total 1649517 MB Space Used 23438 MB Space Free 1626079 MB Space Available 1542216 MB Space Percent Free 98% Inodes Percent Free 99%   Statistics for /opt/ufm/files filesystem: Space Total 150105 MB Space Used 294 MB Space Free 149811 MB Space Available 142116 MB Space Percent Free 99% Inodes Percent Free 99%

Related Commands

Notes


Warning

The following CLI commands relate to the operating system license. For UFM License CLI commands, please refer to UFM License.

license install

license install <url>

Installs a UFM appliance OS license file from a remote host.

Syntax Description

url

https, sftp are supported. Example: sftp://username:password@hostname/path/filename

Default

N/A

Configuration Mode

config

History

1.4.1

First release

1.4.3

Added the first note in the "Notes" row.

Example

Copy
Copied!
            

ufmapl (config) # license install sftp://root:root/tmp/nvidia-ufm-os-restricted-3922145848058.lic

Related Commands

license delete

show license

Notes

  • The license installation is used to access the SHELL in cases where the root account is disabled. For UFM Enterprise license installation, please refer to Activating the UFM Enterprise License.

  • The license format must be as follow: *.lic

  • The license installation overrides the existing license, if present.

  • To generate UFM appliance OS license, the management interface MAC address (eno8303) should be provided to NVIDIA by running the "show interfaces" command.

license delete

license delete

Deletes a UFM appliance OS license file from the hard drive.

Syntax Description

N/A

Default

N/A

Configuration Mode

config

History

1.4.1

Example

Copy
Copied!
            

ufmapl (config) # license delete

Related Commands

license install

show license

Notes

N/A


show license

show license

Displays UFM appliance OS license information.

Syntax Description

N/A

Default

N/A

Configuration Mode

config

History

1.4.1

Example

Copy
Copied!
            

ufmapl (config) # show license Customer ID:     NVIDIA RND TESTING SN:              194042963524002 Type:            Subscription Status:          Valid MAC address:     b0:7b:25:e9:79:a2

Related Commands

license install

license delete

Notes

N/A


_shell

_shell

Runs a UNIX command shell such as bash. This shell command replaces the CLI; when the user exits the shell, they will be returned to the CLI.

Syntax Description

N/A

Default

N/A

Configuration Mode

enable

History

1.4.1

Example

Copy
Copied!
            

ufmapl # _shell root@ufmapl:~#

Related Commands

license install

license delete

show license

Notes

N/A


© Copyright 2023, NVIDIA. Last updated on Dec 13, 2023.