IVM chhwres command

Purpose

Changes hardware resources. This command is operable only in an Integrated Virtualization Manager environment.

Syntax

To add, remove, or modify physical or virtual I/O, memory, or processors settings

chhwres -r io | mem | proc | virtualio | mempool [ --rsubtype scsi | slot | eth | fc | pgdev] [-m <managed system>] -o a | r | s | rs [-p <partition name> | --id <partition ID>] [-l <DRC index>] [-s <virtual slot number>] [-q<quantity>] [--procs <quantity>] [--procunits <quantity>] [-w <wait time>] [-d <detail level>] [--force] [-a "<attributes>"] [--entitled <size>] [--device] [--help]

To add, remove, or modify Host Ethernet Adapter resource assignments and settings

chhwres -r hea [--rsubtype slot | eth ] [-m <managed system>] -o a | r | s [-p <partition name> | --id <partition ID>] [-l <HEA DRC index>] [-g<port group ID>] [--physport <physical port ID>] [--logport <logical port ID>] [-w <wait time>] [-d <detail level>] [--force] [-a"<attributes>"] [--help]

Description

The chhwres command changes the hardware resource configuration of the managed system. The chhwres command is used to perform dynamic LPAR operations.

Flags

Flag name Description
--device Specifies the paging space device to add or remove. The --device flag is valid only with -r mempool --rsubtype pgdev.
-r Specifies the type of hardware resources to change. Valid values are io for physical I/O, hea for Host Ethernet Adapter resources, virtualio for virtual I/O, mem for memory, and proc for processing resources.
--rsubtype
Specifies the subtype of hardware resources to change. Valid values for --rsubtype depend on the resource type you specify.
  • io: slot, taggedio
  • virtualio: eth, scsi, fc, hsl, virtualopti
  • mempool: pgdev
-m managed system

Specifies the name of the managed system for which the hardware resource configuration is to be changed.

The name may either be the user-defined name for the managed system, or be in the form tttt-mmm*ssssssss, where tttt is the machine type, mmm is the model, and ssssssss is the serial number of the managed system.

-o

Specifies the operation to perform. Valid values are a to add hardware resources to a logical partition, r to remove hardware resources from a logical partition, and s to set hardware resource related attributes for a logical partition an Host Ethernet Adapter, or the managed-system.

-p

Specifies the name of the logical partition for which the operation is to be performed.

You can either use this option to specify the name of the logical partition for which the operation is to be performed, or use the --id option to specify the logical partition's ID. The -p and the --id options are mutually exclusive.

The logical partition name or --id is required for virtual Ethernet.

--id partition ID

Specifies the ID of the logical partition for which the operation is to be performed. To perform an add or remove operation, the logical partition must be in the running state.

You can either use this option to specify the ID of the logical partition for which the operation is to be performed, or use the -p option to specify the logical partition's name. The --id and the -p options are mutually exclusive.

A logical partition is required to be specified with this option or the -p option for all operations except a virtual Ethernet, memory, Host Ethernet Adapter set operation.

-l

When adding, removing, or moving a physical I/O slot, use this option to specify the DRC index of the slot.

When performing an Host Ethernet Adapter operation, use this option to specify the adapter ID of the Host Ethernet Adapter for which the operation is to be performed.

This option is not valid for any other operation.

-s

Specifies the virtual slot number of the virtual I/O adapter to add or remove. When adding or removing a virtual I/O adapter, this option is required.

-q Specifies the quantity of memory to add or remove. The quantity specified must be in megabytes, it must be a multiple of the memory region size for the managed-system, and it must be greater than 0.
--procs quantity

When adding or removing processing resources to or from a logical partition using dedicated processors, use this option to specify the quantity of dedicated processors to add or remove.

When adding or removing processing resources to or from a logical partition using shared processors, use this option to specify the quantity of virtual processors to add or remove.

The quantity of processing resources specified with this option must be a whole number greater than 0.

--procunits

When adding or removing processing resources to or from a logical partition using shared processors, use this option to specify the quantity of processing units to add or remove.

Otherwise, the quantity of processing units specified with this option can have up to 2 decimal places. In either case, the quantity specified must be greater than 0.

--physport Specifies the ID of the Host Ethernet Adapter physical port. This option is required when adding an Host Ethernet Adapter logical port to a logical partition. This option is also required when setting Host Ethernet Adapter physical port attributes. This option is not valid for any other operation.
--logport Specifies the ID of the Host Ethernet Adapter logical port to add or remove. This option is required for a Host Ethernet Adapter add or remove operation. This option is not valid for any other operation.
-g Specifies the Host Ethernet Adapter port group. This option is required for all Host Ethernet Adapter operations, and is not valid for any other operation.
-w

Specifies the elapsed time, in minutes, after which an add, remove, or move operation will be stopped. wait-time must be a whole number. If wait-time is 0, the operation will not be timed out.

If this option is not specified, a default value of 5 minutes is used.

This option is valid for all add, remove, and move operations for AIX®, Linux, and Virtual I/O Server logical partitions. This option is also valid for memory add, remove, and move operations for IBM® i logical partitions.

-d

Specifies the level of detail to be displayed upon return of an add or remove operation. Valid values are 0 (none) through 5 (highest).

If this option is not specified, a default value of 0 is used.

This option is valid for all add or remove operations for AIX, Linux, and Virtual I/O Server logical partitions.

--entitled Dynamically changes the amount of I/O entitled memory that is assigned to the logical partition. Use the -o parameter to specify which operation to perform.
--force Forces an add or remove operation to be performed for an AIX, Linux, and Virtual I/O Server logical partition that does not have an RMC connection to the Integrated Virtualization Manager. If this command completes successfully, you will need to restart your operating system for the change to take effect. Use this option only if you intentionally configured your LAN to isolate the Integrated Virtualization Manager from the operating system of your logical partition.
-a attributes Specifies the configuration data needed to create virtual I/O adapters or set hardware resource related attributes. The configuration data consists of attribute name/value pairs, which are in comma separated value (CSV) format. The configuration data must be enclosed in double quotation marks. Possible values are:
adapter_type
Whether the adapter is a client or server. Valid values are client and server. IVM requires the value to be client. This attribute is optional.
addl_vlan_ids
alt_console_slot
The location of the physical I/O slot that contains the alternate console device for the IBM i logical partition. The default value is none.
alt_restart_device_slot
The location of the virtual I/O slot that contains the alternate restart device for the IBM i logical partition. If the load source slot has a value other than none, then this attribute is optional. Valid values are:
  • Slot number (virtual I/O)
  • none
 
conn_speed
The configured connection speed of the port in Mbps. Possible values are:
  • auto
  • 10
  • 100
  • 1000
  • 10000
console_slot
The location of the virtual I/O slot that contains the console device for the IBM i logical partition. Valid values are:
  • Slot number (virtual I/O)
  • none
flow_control
Receive flow control value of the port
  • 1 (enabled)
  • 0 (disabled)
 
hsl_pool_id
Whether the logical partition participates in the high-speed link (HSL) pool. The default value is 0 (does not participate).
ieee_virtual_eth
Valid values:
  • 0 - not IEEE 802.1Q compatible
  • 1 - IEEE 802.1Q compatible
is_trunk
Valid values:
  • 0 - no
  • 1 - yes
 
lhea_capabilities
Comma-separated list of logical Host Ethernet Adapter capabilities, with each capability having one of the following formats: adapter-ID/capability or adapter-ID/5/ieq/nieq/qp/cq/mr where ieq (interruptible event queues), nieq (non-interruptible event queues), qp (queue pairs), cq (completion queues), and mr (memory regions) each specify the resource amount in addition to the base minimum. Valid values are:
  • 0 - minimum
  • 1 - low
  • 2 - medium
  • 3 - high
  • 4 - dedicated
  • 5 - custom
load_source_slot
The location of the virtual I/O slot that contains the load source for the IBM i logical partition. If the alt_restart_device_slot has a value other than none, then this attribute is optional. Valid values are:
  • Slot number (virtual I/O)
  • none
 
max_pool_mem
Maximum amount of physical memory that can be assigned to the memory pool without taking the pool offline. The value should be designated in megabytes and must be a multiple of the logical memory block (LMB) size. This attribute is required. The attribute supports the =/+=/-= format.
max_recv_packet_size
Maximum transmission unit (MTU) size of the port. Possible values:
  • 1500 (default)
  • 9000 (jumbo)
mem_weight
The shared memory weight of the shared memory partition. This flag is used for determining the priority of logical partitions in a memory pool for distribution of memory. This attribute is only supported when the value of the -o parameter is s. This attribute supports the = format.
 
op_console_slot
The location of the virtual I/O slot that contains the directly-attached operations console device for the IBM i logical partition. The default value is none.
paging_storage_pool
The name of the default paging storage pool. This is the storage pool from which new paging space devices are created. This attribute is optional, but can only be defined during the creation stage.
paging_vios_ids
A comma-separated list of logical partition IDs of paging service partitions to associate with this memory pool. This attribute is optional, but if specified, must be equal to 1.
 
paging_vios_names
A comma-separated list of logical partition names of paging service partitions to associate with this memory pool. This attribute is optional, but if specified, must be equal to the name of the Virtual I/O Server logical partition.
pend_port_group_mcs_value
A Host Ethernet Adapter port group attribute value. In order to synchronize the pending value with the current value, you need to reboot the system.
pool_mem
The amount of physical memory to assign, to add, or remove from the memory pool in megabytes. This required value must be a multiple of the logical memory block size.

The attribute supports the =/+=/-= format.

 
port_vlan_id
This option is required if you are adding a virtual Ethernet adapter.
promisc_lpar_id
The ID assigned to the promiscuous logical partition. Possible values:
  • none
  • 1 - 254
promisc_lpar_name
Name assigned to the promiscuous logical partition.
sharing_mode
The sharing mode of the logical partition.

Valid values are:
keep_idle_procs: Never share processors
share_idle_procs:  Share processors only when logical
partition is inactive
share_idle_procs_always: Always share processors
share_idle_procs_active: Share processors only when
the logical partition is active
cap: Capped mode. uncap: Uncapped mode.

 
remote_lpar_id
The ID of the logical partition that has the virtual SCSI or virtual fibre channel server adapter.

A value of any indicates that any client adapter should be allowed to connect to this adapter.

Integrated Virtualization Manager (IVM) requires the value to be 1. This attribute is optional.

Note: The remote_lpar_id attribute and the remote_lpar_name attribute are mutually exclusive.
remote_lpar_name
Specifies a user-defined name for the logical partition where the virtual fibre channel or virtual SCSI server adapter will be created.

IVM will require the value of this to be the name of the Virtual I/O Server logical partition. This attribute is optional.

Note: The remote_lpar_id attribute and the remote_lpar_name attribute are mutually exclusive.
 
remote_slot_num
Specifies the slot number where the virtual fibre channel or virtual SCSI server adapter will be created on the remote logical partition.

If the value is not specified, IVM will use the next available slot. This attribute is optional.

trunk_priority
Valid values are integers between 1 and 15, inclusive. Required for a trunk adapter.
uncap_weight
The weighted average of processing priority when in uncapped sharing mode. The smaller the value, the lower the weight. Possible values are 0 - 255.
 
virtual_opti_pool_id
The location of the virtual I/O slot that contains the directly-attached operations console device for the IBM i logical partition. The default value is 0 (does not participate).
vlan_id_list
List of virtual LAN IDs that the logical port has access to.
wwpns
Designates the worldwide port names to this adapter, which are entered as a comma-separated list. If the worldwide port names are not specified, IVM will request that a pair be allocated. Each worldwide port name must be a 16-character hexadecimal value, and two worldwide port names must be specified.
--help Displays the help text for this command and exit.

Exit Status

This command has a return code of 0 on success.

Examples

  1. To change the tagged I/O for an IBM i logical partition, type the following command:
    chhwres -r io -rsubtype taggedio -o s --id <LPAR ID> | -p <LPAR NAME> 
    -a ATTR=VALUE
  2. Configure a Host Ethernet Adapter port for a logical partition:
    1. Add a Host Ethernet Adapter port to the logical partition with ID 2, with port 3 in port group 1:
      chhwres -r hea -o a -l 23000000 -g 1 -a vlan_id_list=all 
      --id 2 --logport 3 --physport 0
    2. Set the connection speed of physical port 0 to auto:
      chhwres -r hea -o s -l 23000000 -g 1 -a conn_speed=auto --physport 0
  3. Add a virtual Ethernet adapter to the management partition in slot 25 with VLAN tags on VLAN 212 and VLAN 313 to be used with a shared Ethernet adapter:
    chhwres -r virtualio --rsubtype eth -o a --id 1 -s 25 
    -a port_vlan_id=2,ieee_virtual_eth=1,
    \"addl_vlan_ids=212,313\",is_trunk=1,trunk_priority=1
  4. Add a virtual Ethernet adapter to partition 4 in virtual slot 5 with VLAN tags on VLAN 212 and VLAN 313:
    chhwres -r virtualio --rsubtype eth -o a --id 4 -s 5 
    -a port_vlan_id=2,ieee_virtual_eth=1,
    \"addl_vlan_ids=212,313\"
  5. Create a memory pool with 4 GB of physical memory in the pool and 8 GB of maximum memory in the pool. Use the rootvg volume group to create paging space devices:
    chhwres -r mempool -o a 
    -a pool_mem=4096,max_pool_mem=8192,paging_storage_pool=rootvg



Last updated: Wed, November 18, 2020