IVM mksyscfg command

Purpose

Creates a logical partition on the managed system. This command is operable only in an Integrated Virtualization Manager environment.

Syntax

To create a logical partition on the managed system

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

Description

The mksyscfg command creates a logical partition on the managed system.

Flags

Flag name Description
-r ResourceType The type of resources to create:

lpar - Logical  partition resources

-m ManagedSystem The name of the managed system. This attribute is optional because there is only one system to manage. The name might 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/value pairs, which are in comma separated value (CSV) format. These attribute name/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 or the managed frame, 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 might need to be preceded by an escape character.

Required attributes for partitions

desired_mem
The assigned megabytes of memory for this partition
 
lpar_env
A required attribute that indicates the type of partition to create. This attribute is used to create an RPA partition, which supports AIX®, Linux, or IBM® i partition types.
name
Name of the partition to create.
max_mem
The maximum megabytes of memory for this partition
 
min_mem
The minimum megabytes of memory for this partition.
 
Optional attributes for partitions
allow_perf_collection
Permission for the partition to retrieve shared processor pool utilization information Valid values are:
  • 0: do not allow authority
  • 1: allow authority
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 a value other than none, then this attribute is optional. Valid values are:
  • Slot Number (virtual I/O)
  • none
 
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.
auto_start
Valid values are:

0 - do not automatically start with system power on
1 - automatically start with system power on

boot_mode
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 (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.
  • 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_proc_units
The assigned number of processing units for this partition
 
desired_procs
The assigned number of processors for this partition. In shared processing mode, this refers to virtual processors.
io_slots
Comma separated list of I/O slots for the partition. Each item in this list has the format: drc_index/slot_io_pool_id/is_required

The attribute names are not present in the list, just their values are present. For example, 21010003/none/1, specifies an I/O slot with a DRC index of 0x21010003 which is not assigned to an I/O pool, and it is a required slot.

Valid values for is_required:
  • 0 - no
  • 1 - yes
ipl_source
The IPL source for the IBM i logical partition. This attribute is optional. Valid values are:
  • a
  • b
  • c
  • d (default)
 
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 four '/' 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 partition to maintain its entitled processors. If a processor failure occurs, processing resources will be removed first from the lowest priority partition.
lpar_id
Unique integer ID for the partition. If this attribute is not specified, the lowest available partition will be assigned.
 
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_procs
The maximum number of processors for this partition. In shared processing mode, this refers to virtual processors.
max_proc_units
The maximum number of processing units for this partition
 
max_virtual_slots
Maximum number of virtual I/O adapter slots.
Note: The system determines this value.
mem_mode
The partition memory mode.
  • ded - dedicated memory
  • shared - shared memory
If the memory mode is shared, then 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. If the memory mode is omitted, then it is assumed to be a dedicated memory mode.
Note: The Virtual I/O Server logical partition only supports the dedicated memory mode.
mem_weight
The shared memory weight of the logical partition that uses shared memory. This attribute is used for determining the priority of logical partitions in a memory pool for distribution of memory. The weight must be a value from 0 - 255. If a value is not specified, the default is 128.
min_procs
The minimum number of processors for this partition. In shared processing mode, this refers to virtual processors.
min_proc_units
The minimum number of processing units for this partition
 
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_device
The paging space device to use if a memory pool is used. A paging 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, no device is assigned.
proc_mode
Valid values are:

ded- dedicated processor mode
shared- shared processor mode

 
profile_name
Name of the profile to create. This attribute is not required, but if specified, must be the same as the name attribute.
sharing_mode
Value values are:

keep_idle_procs- never share processors
share_idle_procs- share processors
only when the partition
is  inactive
share_idle_procs_always- share processors
only when the partition is active
share_idle_procs_active- always share processors
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 might be omitted. Optional values are additional_vlan_ids, 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; therefore, IVM handles changes 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
work_group_id
Valid values:
  • none: do not participate in the workload management group
  • 1: participate in the workload management group
-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 create a partition named lp3 with 128 megabytes, type:
    mksyscfg -r lpar -i "name=lp3,lpar_env=aixlinux,min_mem=128,desired_mem=128,\
    max_mem=128"
  2. To create a partition with 128 megabytes and a dedicated processor, type:
    mksyscfg -r lpar -i "name=lp4,lpar_env=aixlinux,min_mem=128,desired_mem=128,\
    max_mem=128,proc_mode=ded, sharing_mode=share_idle_procs,min_procs=1,\
    desired_procs=1,max_procs=2"
  3. To create a partition with 128 megabytes and 0.2 shared processing units, type:
    mksyscfg -r lpar -i "name=lp2,lpar_env=aixlinux,min_mem=128,desired_mem=128,\
    max_mem=128,proc_mode=shared, sharing_mode=uncap,min_procs=1,\
    desired_procs=1,max_procs=2,min_proc_units=0.1,desired_proc_units=0.2,\
    max_proc_units=2"
  4. To create a partition with 128 megabytes and 0.2 shared processing units, and a virtual Ethernet adapter on VLAN 1, type:
    mksyscfg -r lpar -i "name=lp2,lpar_env=aixlinux,min_mem=128,desired_mem=128,\
    max_mem=128,proc_mode=shared, sharing_mode=uncap,min_procs=1,desired_procs=1,\
    max_procs=2,min_proc_units=0.1,desired_proc_units=0.2, max_proc_units=2,\
    virtual_eth_adapters=4/0/1//0/0" 
  5. To create a partition with 128 megabytes and 0.2 shared processing units, a virtual Ethernet adapter on VLAN 1, and HEA ports 3 and 4, type:
    mksyscfg -r lpar -i "name=lp2,lpar_env=aixlinux,min_mem=128,desired_mem=128,\
    max_mem=128,proc_mode=shared, sharing_mode=uncap,min_procs=1,desired_procs=1,\
    max_procs=2,min_proc_units=0.1,desired_proc_units=0.2, max_proc_units=2,\
    virtual_eth_adapters=4/0/1//0/0,\ \
    "lhea_logical_ports=23000000/1/0/3/all,23000000/1/1/4/all\",\
    lhea_capabilities=23000000/0/////"
  6. To create a logical partition with 1 gigabyte, 2 virtual processors, and 2 virtual Ethernet adapters, type:
    mksyscfg -r lpar -i 'name=lp2,lpar_env=aixlinux,min_mem=256,desired_mem=1024,\
    max_mem=2048,proc_mode=shared,sharing_mode=uncap,min_procs=1,desired_procs=2,\
    max_procs=2,min_proc_units=0.1,desired_proc_units=0.2,max_proc_units=2,\
    "virtual_eth_adapters=4/0/1//0/0,""5/1/2/212,313/0/0"""'



Last updated: Wed, November 18, 2020