Get a Quote     (408) 943-4100   TrueNAS Discord VendOp_Icon_15x15px Enterprise Support
TrueNAS.com Software Systems Company Community Security iX Portal Download
TrueNAS Enterprise TrueNAS SCALE TrueNAS CORE Compare Editions TrueCommand Software Status FreeNAS
Compare Systems F-Series M-Series H-Series R-Series Mini Series
Contact Us iXsystems Careers Clients Reviews
TrueNAS GitHub Community Forum Discord TrueNAS Merch Store
Use Cases Analytics Backup and Archival Cloud Data Mobility File Sharing iX Storj Media Creation Surveillance Virtualization
Industry Education Government Healthcare Research / AI / ML Media & Entertainment
Enterprise Support Community Support Documentation TrueNAS Security FAQ ZFS Overview
TrueNAS Blog Solution Guides Datasheets Case Studies Videos TrueCommand Cloud
Download TrueNAS SCALE Download TrueNAS CORE Get TrueNAS Enterprise Compare TrueNAS Editions Contact an Enterprise Specialist
  1. TrueNAS SCALE 23.10
  2. /
  3. CLI Reference Guide
  4. /
  5. Network
  6. /
  7. IPMI
Edit page
TrueNAS SCALETrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

IPMI

  4 minute read.

Last Modified 2024-03-19 08:38 EDT

The SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!

IPMI Namespace

The ipmi namespace has four commands and is based on user functions found in the SCALE API and web UI. It provides access to IPMI (Intelligent Platform Management Interface) configuration and management options.

IPMI Commands

The following ipmi namespace commands allow you to configure and manage IPMI access.

You can enter commands from the main CLI prompt or from the network namespace prompt.

Channels Command

The channels command returns a list of available IPMI channels.

Description

The channels command does not require entering properties or arguments. Enter the command, then press Enter. The command returns the number of IPMI channels the system has available.

Usage

From the CLI prompt, enter:

network ipmi channels

network ipmi channels
1

Get_Instance Command

The get_instance command returns the settings for a user-specified IPMI channel.

Description

The get_instance command requires the id property, which is a single integer you can find using the query command. Enter the command string, then press Enter. The command returns a table with the specified IPMI channel settings, including the IP address type, IP address, MAC address, subnet mask, gateway IP address, gateway MAC address, backup gateway IP, address, backup gateway MAC address, VLAN ID, VLAN ID status, and VLAN ID priority.

Usage

From the CLI prompt, enter:

network ipmi get_instance id=number

Where number is the IPMI channel ID you want to return settings for.

network ipmi get_instance id=1
+-----------------------------+-------------------+
|                     channel | 1                 |
|                          id | 1                 |
|           ip_address_source | static            |
|                  ip_address | 10.10.10.10       |
|                 mac_address | 3c:ec:de:5b:5e:58 |
|                 subnet_mask | 255.255.255.0     |
|  default_gateway_ip_address | 10.200.0.1        |
| default_gateway_mac_address | 00:00:00:00:00:00 |
|   backup_gateway_ip_address | 0.0.0.0           |
|  backup_gateway_mac_address | 00:00:00:00:00:00 |
|                     vlan_id | 0                 |
|              vlan_id_enable | false             |
|               vlan_priority | 0                 |
+-----------------------------+-------------------+

Query Command

The query command returns a table of all IPMI channels and their settings.

Description

The query command does not require entering properties or arguments. Enter the command, then press Enter. The command returns a table of all IPMI instances and their settings, including IP addresses type, IP addresses, MAC addresses, subnet masks, gateway IP addresses, gateway MAC addresses, backup gateway IP addresses, backup gateway MAC addresses, VLAN IDs, VLAN ID statuses, and VLAN ID priorities.

Usage

From the CLI prompt, enter:

network ipmi query

network ipmi query
+---------+----+-------------------+-------------+-------------------+---------------+----------------------------+-----------------------------+---------------------------+----------------------------+---------+----------------+---------------+
| channel | id | ip_address_source | ip_address  | mac_address       | subnet_mask   | default_gateway_ip_address | default_gateway_mac_address | backup_gateway_ip_address | backup_gateway_mac_address | vlan_id | vlan_id_enable | vlan_priority |
+---------+----+-------------------+-------------+-------------------+---------------+----------------------------+-----------------------------+---------------------------+----------------------------+---------+----------------+---------------+
| 1       | 1  | static            | 10.10.10.10 | 3c:ec:de:5b:5e:70 | 255.255.255.0 | 10.200.0.1                 | 00:00:00:00:00:00           | 0.0.0.0                   | 00:00:00:00:00:00          | 0       | false          | 0             |
+---------+----+-------------------+-------------+-------------------+---------------+----------------------------+-----------------------------+---------------------------+----------------------------+---------+----------------+---------------+

Update Command

The update command allows you to update the settings for a specified IPMI instance.

Description

The update command has six configuration properties. They are ipaddress, netmask, gateway, password, dhcp, and vlan explained in detail in Update Properties below. You must enter a channel and at least one property for the command to succeed. Enter the command string, then press Enter. The command returns a blank line.

PropertyDescriptionSyntax Example
ipaddressIPv4 address to assign to the channel.ipaddress="ipaddress"
netmaskSubnet mask associated with the IP address.netmask="expandednetmask"/i>"
gatewayIPv4 address used by the ipaddress to reach outside the local subnet.gateway="gateway"
passwordPassword to assign to the channel. The password must be between 8 and 16 characters and contain at least 3 of the following categories: lowercase character, uppercase character, digits 0-9, special characters (!, $, #, %, etc.)password=password
dhcpIf false, you must define ipaddress, netmask, and gateway.dhcp=true/false
vlanNumeric VLAN ID.vlan=integer

Usage

From the CLI prompt, enter:

network ipmi update channel=channelid ipaddress="ipaddress" netmask="netmask" gateway="gateway"

Where

  • channelid is the numeric channel ID.
  • ipaddress is the IPMI IP address.
  • netmask is the expanded netmask for the ipaddress.
  • gateway is the IPv4 address used by the ipaddress to reach outside the local subnet.
network ipmi update channel=1 ipaddress="10.230.0.10" netmask="255.255.240.0" gateway="10.230.0.1"

Related CLI IPMI Articles

Related CLI Network Articles

Have more questions or want to discuss your specific configuration? For further discussion or assistance, see these resources:

Found content that needs an update? You can suggest content changes directly! To request changes to this content, click the Feedback button located on the middle-right side of the page (might require disabling ad blocking plugins).