IVM chsyscfg command

Purpose

Changes attributes of logical partitions, logical partition profiles, or the managed system. This command is operable only in an Integrated Virtualization Manager environment.

Syntax

To change system attributes:

chsyscfg -r sys { -f ConfigurationFile | -i ConfigurationData } [ -m ManagedSystem ]

To change partition attributes

chsyscfg -r lpar { -f ConfigurationFile | -i ConfigurationData } [ -m ManagedSystem ]

To change partition profile attributes, the Host Ethernet Adapter logical port assignments, or the logical Host Ethernet Adapter capabilities

chsyscfg -r prof { -f ConfigurationFile | -i ConfigurationData } [ -m ManagedSystem ]

Description

The chsyscfg command changes attributes of logical partitions, logical partition profiles, or the managed system.

Flags

Flag name Description
-r ResourceType The type of resources to change:
sys
Managed system resources
lpar
Logical partition resources
prof
Logical partition profile resources
-m ManagedSystem The name of the managed system. This attribute is optional because there is only one system to manage. 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.
-f ConfigurationFile The name of the file containing the configuration data needed to change the resources. The configuration data consists of attribute name and value pairs, which are in comma separated value (CSV) format. These attribute name and value pairs form a configuration record. A line feed marks the end of a configuration record. The file must contain one configuration record for each resource to be changed, and each configuration record must be for the same resource type. If the resource type is the managed system, then the file must contain only one configuration record.

The format of a configuration record is as follows:

attribute-name=value,attribute-name=value,...<LF>

Note that certain attributes accept a comma separated list of values, as follows:

"attribute-name=value,value,...",...<LF>

When a list of values is specified, the attribute name/value pair must be enclosed in double quotation marks. Depending on the shell being used, nested double quotation marks may need to be preceded by an escape character, which is usually a \ (back slash) character.

If '+=' is used in the attribute name/value pair instead of '=', then the specified value is added to the existing value for the attribute if the attribute is numerical. If the attribute is a list, then the specified values are added to the existing list.

If '-=' is used in the attribute name/value pair instead of '=', then the specified value is subtracted from the existing value for the attribute if the attribute is numerical. If the attribute is a list, then the specified values are deleted from the existing list.

Attribute names for logical partitions

allow_perf_collection

Valid values are:
0 - do not allow authority
1 - allow authority

ipl_source
The IPL source for the IBM® i logical partition. This attribute is optional. Valid values are:
  • a
  • b
  • c
  • d
name | lpar_id
Name or ID of the logical partition to change (required)
new_name
New name for the logical partition.
work_group_id

Valid values are:
none - do not participate in the workload management
  group
1 - participate in the workload management group

 
Attribute names for logical partition profiles
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 is has a value other than none, then this attribute is optional. Valid values are:
  • Slot Number (virtual I/O)
  • none
auto_start

Valid values are:
0 - do not automatically start with system power on
1 - automatically start with system power on

 
boot_mode

Logical partition power on mode. Valid values are:
norm - normal
dd - diagnostic with default boot list
ds - diagnostic with stored boot list
of - Open Firmware OK prompt
sms - System Management Services

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 (for virtual I/O)
  • none
 
desired_io_entitled_mem
The amount of I/O entitled memory for a shared memory partition. This is the portion of memory that is reserved for I/O mappings. Valid values follow:
  • auto (automatically manage)
  • Number of megabytes
If the value is auto, the entitlement is calculated based on the virtual I/O configuration of the logical partition. If the virtual I/O configuration is changed, the entitlement is updated automatically. If auto is not used, no automatic adjustments are made. The default value is auto.
desired_mem
Assigned memory in megabytes
desired_procs
Assigned processors. In shared processing mode, this refers to virtual processors.
desired_proc_units
Assigned shared processing units.
 
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
lhea_logical_ports
Comma separated list of Logical Host Ethernet Adapter (LHEA) logical ports, with each logical port having the following format:
adapter-ID/port-group/physical-port-ID/ 
logical-port-ID/allowed-VLAN-IDs 

All 4 '/' characters must be present, but optional values may be omitted. Optional values are allowed-VLAN-IDs.

 
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
lpar_avail_priority
The priority of the logical partition to maintain its entitled processors. If a processor failure occurs, processing resources will be removed first from the lowest priority logical partition. Valid values are 0 - 255.
Note: The Virtual I/O Server logical partition must have a higher priority than any other logical partition on the system.
 
lpar_proc_compat_mode
The requested compatibility mode. Use lssyscfg -r sys -F lpar_proc_compat_modes to retrieve a list of valid values.
max_mem
Maximum memory in megabytes.
min_mem
Minimum memory in megabytes.
 
min_procs
Minimum processors. In shared processing mode, this refers to virtual processors.
max_procs
Maximum processors. In shared processing mode, this refers to virtual processors.
max_proc_units
Maximum shared processing units.
min_proc_units
Minimum shared processing units.
max_virtual_slots
Maximum number of virtual I/O adapter slots
 
mem_mode
Logical partition memory mode. Valid values follow:
  • ded: dedicated processor mode
  • shared: shared processor mode
If the memory mode is shared, the logical partition cannot be assigned any physical I/O slots or host Ethernet adapter resources, the proc_mode attribute on the logical partition must be shared, and a memory pool must exist.
Note: The Virtual I/O Server logical partition only supports the dedicated memory mode.
mem_weight
The shared memory weight of the shared memory partition. The memory weight is used to determine the priority of logical partitions in a memory pool for distributing memory. Valid values are 0 - 255. The default value is 128.
name | lpar_name | lpar_id
Name or ID of the logical partition to change (required)
Note: This command uses the profile name and lpar_name interchangeably because this environment does not support multiple profiles per logical partition. When using this command on the Hardware Management Console, you must specify the profile name and logical partition name or ID because it supports multiple profiles per logical partition.
 
new_name
New name for the logical partition.
paging_device
The paging space device to use if a memory pool is used. A paging space device is a block storage device that has been added to the memory pool and is not designated as a paging device for any other logical partition. This attribute is optional. If omitted, an appropriate paging device is selected automatically. If the paging_device value is a blank string and a paging space device is currently assigned to this partition, the paging space device is removed from the logical partition.
proc_mode
Valid values follow:
  • ded: dedicated processor mode
  • shared: shared processor mode
sharing_mode
The sharing mode of the logical partition. Valid values follow:
  • keep_idle_procs: Never share processors
  • share_idle_procs: Share processors only when the 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
 
uncap_weight
A weighted average of processing priority when in uncapped sharing mode. The smaller the value, the lower the weight. Valid values are: 0 - 255
virtual_eth_adapters
Comma-separated list of virtual Ethernet adapters, with each adapter having the following format: slot_number/is_ieee/port_vlan_id/additional_vlan_ids/is_trunk/is_required All 5 '/' characters must be present, but optional values may be omitted. Optional values are is_ieee, additional_vlan_ids, is_required and is_trunk.
Valid values for is_ieee, is_trunk, and is_required"

0 - no
1 - yes

For example, 4/0/2//0/0 specifies a virtual Ethernet adapter with a virtual slot number of 4, is not IEEE 802.1Q enabled, has a port virtual LAN ID of 2, no additional virtual LAN IDs, it is not a trunk adapter, and is not required.

 
virtual_fc_adapters
Comma-separated list of virtual fibre channel adapters. Each item in this list has the following format:
virtual slot num/adapter_type/remote_lpar_id/
remote_lpar_name/remote_slot_num/wwpn_list/is_required
Required values: remote_lpar_id, remote_lpar_name, adapter_type, virtual_slot_num
Note: You can specify either remote_lpar_id, remote_lpar_name, or use them both, but at least one of the values is required.
Valid values for adapter_type:
  • client
  • server
Note: If you specify a value for adapter type, the Integrated Virtualization Manager (IVM) requires the adapter type to be a client.

Optional values: wwpn_list, is_required, remote_slot_num

When you add a virtual fibre channel adapter, wwpn_list can be left blank to allow IVM to automatically assign worldwide port names to the client adapter. If you leave wwpn_list blank and the virtual slot number specified for this adapter already contains a virtual fibre channel adapter, IVM will use the worldwide port names that are already assigned. New worldwide port names will only be generated if it is a new adapter. If you specify a wwpn_list value, there must be exactly two values. Each worldwide port name must be a 16-character hexadecimal value. These values are not case sensitive.

Valid values for is_required:

0 - no
1 - yes

A value of none or an empty string indicates that no virtual fibre channel adapters should be assigned.
Note: If the logical partition being changed is the Virtual I/O Server, you cannot change the current configuration. The IVM handles the client and server adapter as a pair; thus, IVM handles modifications automatically.
 
virtual_scsi_adapters
Comma-separated list of virtual SCSI adapters. Each item in this list has the format:
slot_num/adapter_type/remote_lpar_id/remote_lpar_name/
remote_slot_num/is_required
The attribute names are not present in the list, just their values are present. If an attribute is optional and is not to be included, then no value is specified for that attribute. For example, 2/client//lpar2/3/0 specifies a virtual client SCSI adapter with a virtual slot number of 2, a server partition name of lpar2, a server slot number of 3, and is not required. The server partition ID was omitted.
Required values: slot_num, adapter_type, remote_lpar_id, remote_lpar_name
Note: You can specify remote_lpar_id, remote_lpar_name, or both, but at least one of the values is required.

Optional values: is_required, remote_slot_num

Note: IVM requires that virtual slot number 2 always contain a virtual SCSI adapter, so if you specify adapters in any other slots, the default adapter is still created in slot number 2. If you use the chsyscfg command with an empty list for the virtual_scsi_adapters attribute, all virtual SCSI adapters are removed, except the default adapter.
Valid values for adapter_type:
  • client: client adapter
  • server: server adapter, valid for Virtual I/O Server logical partitions only
Valid values for is_required:
  • 0 - no
  • 1 - yes
 
Attribute names for the managed system
lpar_comm_default
Returns the lpar_comm_ipaddr to using the default IP address configured on the system as reported by lstcpip -interfaces. Valid values:
  • 1: Default IP address will be used.
lpar_comm_ipaddr
The IP address through which client logical partitions will communicate with the management logical partition. This is used primarily for dynamic LPAR. It is defaulted to the first IP address available on your system, but can be manually set if desired. If you set this manually and then change your systems IP address, you must update this value.
Note: This attribute supports multiple IP addresses using a comma-separated list.
new_name
New name for the managed system
pend_configured_max_lpars
The maximum number of logical partitions which can be created after restarting the managed system.
This option is deprecated. Instead use:
chsyscfg -r prof
with attribute "max_virtual_slots" value for partition 1.
-i ConfigurationData This option allows you to enter configuration data on the command line, instead of using a file. Data entered on the command line must follow the same format as data in a file, and must be enclosed in double quotation marks.

When this option is used, only a single resource can be changed.

The -i and the -f options are mutually exclusive.

Exit Status

This command has a return code of 0 on success.

Security

This command is not accessible by users with the ViewOnly role.

Examples

  1. To change the user defined name for the managed system, type:
    chsyscfg -r sys -i "new_name=sys1"
  2. To change logical partitions using the configuration data in the file /tmp/lparfile, type:
    chsyscfg -r lpar -f /tmp/lparfile
  3. To reduce a partition profile's assigned and minimum memory by 256 MB, type:
    chsyscfg -r prof -i "lpar_name=partition3,min_mem-=256,desired_mem-=256" 



Last updated: Wed, November 18, 2020