---
name: "ipmctl-set-preferences"
section: "1"
platform: "linux"
package: "ipmctl"
version: "03.00.00.0468-1"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/ipmctl-set-preferences"
---

# ipmctl-set-preferences(1)

Modifies one or more user preferences

## NAME

ipmctl-set-preferences - Modifies one or more user preferences

## SYNOPSIS

```
ipmctl set [OPTIONS] -preferences [PROPERTIES]
```

## DESCRIPTION

Modifies one or more user preferences in the PMem module software.

## OPTIONS

- \-h, -help

  Displays help for the command.

- \-ddrt

  Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.

- \-smbus

  Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.

**Note**\

The -ddrt and -smbus options are mutually exclusive and may not be used together.

- \-o (text\|nvmxml), -output (text\|nvmxml)

  Changes the output format. One of: "text" (default) or "nvmxml".

## PROPERTIES

CLI\_DEFAULT\_DIMM\_ID

The default display of PMem module identifiers. One of:

• "UID": Use the DimmUID attribute as defined in the section \[Show Dimm\].

• "HANDLE": Use the DimmHandle attribute as defined in section \[Show Dimm\]. This is the default

CLI\_DEFAULT\_SIZE

The default display of capacities in the CLI. One of:

• "AUTO": Automatically choose the best format for each capacity in binary multiples of bytes (i.e., B, MiB, GiB or TiB). This is the default.

• "AUTO\_10": Automatically choose the best format for each capacity in decimal multiples of bytes (i.e., B, MB, GB or TB).

• "B": Displays all capacities in bytes.

• "MB": Displays all capacities in megabytes.

• "MiB": Displays all capacities in mebibytes.

• "GB": Displays all capacities in gigabytes.

• "GiB": Displays all capacities in gibibytes.

• "TB": Displays all capacities in terabytes.

• "TiB": Displays all capacities in tebibytes.

APPDIRECT\_SETTINGS

The interleave settings to use when creating App Direct capacity in the format: (IMCSize\_ChannelSize). Must be one of the BIOS supported App Direct settings returned by the command \[Show System Capabilities\].

**Note**\

ByOne is not a valid setting for this preference. The default is "RECOMMENDED" which uses the BIOS recommended App Direct settings.

**Note**\

The same interleave settings are used for all the App Direct capacity in the system. Therefore, if any App Direct capacity already exists, this preference cannot be changed.

DBG\_LOG\_LEVEL

Whether debug logging is enabled in the PMem module host software. These logs pertain to the operation of the command-line tool only and do not reflect any logging functionality of the PMem module. One of:

• "0": Logging is disabled. This is the default.

• "1": Log Errors.

• "2": Log Warnings, Errors.

• "3": Log Informational, Warnings, Errors.

• "4": Log Verbose, Informational, Warnings, Errors.

## EXAMPLES

Use DimmUID as the default PMem module identifier and display all capacities in bytes.

```
ipmctl set -preferences CLI_DEFAULT_DIMM_ID=UID CLI_DEFAULT_SIZE=B
```

## RETURN DATA

Returns the status of the operation.

## SAMPLE OUTPUT

```
Set (Property)=(Value): Success|Error (Code)-(Description)
```