JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle VM Server for SPARC 2.2 Reference Manual     Oracle VM Server for SPARC
search filter icon
search icon

Document Information

System Administration

ldm(1M)

ldmconfig(1M)

ldmd(1M)

ldmp2v(1M)

ldm

- command-line interface for the Logical Domains Manager

Synopsis

ldm or ldm --help [subcommand] 
ldm -V 
ldm add-domain -i file 
ldm add-domain [cpu-arch=generic|native] [mac-addr=num] [hostid=num] 
  [failure-policy=ignore|panic|reset|stop] [extended-mapin-space=on]
  [master=master-ldom1,...,master-ldom4] [max-cores=[num|unlimited]]
  [uuid=uuid] [threading=max-ipc] ldom 
ldm add-domain ldom...
ldm set-domain -i file 
ldm set-domain [cpu-arch=generic|native] [mac-addr=num] [hostid=num]
  [failure-policy=ignore|panic|reset|stop] [extended-mapin-space=[on|off]]
  [master=[master-ldom1,...,master-ldom4]] [max-cores=[num|unlimited]]
  [threading=[max-throughput|max-ipc]] ldom
ldm remove-domain -a
ldm remove-domain ldom...
ldm list-domain [-e] [-l] [-o format] [-p] [ldom...] 
ldm migrate-domain [-f] [-n] [-p filename] source-ldom [user@]target-host[:target-ldom] 
ldm add-vcpu [-c] number ldom
ldm set-vcpu [-c] number ldom
ldm remove-vcpu [-c] number ldom
ldm add-core num ldom
ldm add-core cid=core-ID[,core-ID[,...]] ldom
ldm set-core num ldom
ldm set-core cid=[core-ID[,core-ID[,...]]] ldom
ldm remove-core [-f] num ldom
ldm remove-core cid=core-ID[,core-ID[,...]] ldom
ldm add-crypto number ldom
ldm set-crypto [-f] number ldom
ldm remove-crypto [-f] number ldom 
ldm add-memory [--auto-adj] size[unit] ldom 
ldm add-memory mblock=PA-start:size[,PA-start:size[,...]] ldom 
ldm set-memory [--auto-adj] size[unit] ldom 
ldm set-memory mblock=[PA-start:size[,PA-start:size[,...]]] ldom 
ldm remove-memory [--auto-adj] size[unit] ldom 
ldm remove-memory mblock=PA-start:size[,PA-start:size[,...]] ldom 
ldm start-reconf ldom
ldm cancel-reconf ldom
ldm cancel-operation (migration | reconf | memdr) ldom 
ldm add-io (bus | device | vf-name) ldom 
ldm set-io name=value [name=value ...] pf-name
ldm set-io [mac-addr=num] [alt-mac-addrs=[auto|num1,[auto|num2,...]]] [pvid=[pvid]]
  [vid=[vid1,vid2,...]] [mtu=size] [name=value...] vf-name
ldm remove-io (bus | device | vf-name) ldom 
ldm list-io [-l] [-p] [pf-name]
ldm list-io -d pf-name
ldm add-vsw [-q] [default-vlan-id=vlan-id] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...]
  [linkprop=phys-state] [mac-addr=num] [net-dev=device] [mode=sc] [mtu=size]
  [id=switch-id] [inter-vnet-link=on|off] vswitch-name ldom 
ldm set-vsw [-q] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...] [mac-addr=num]
  [net-dev=device] [linkprop=[phys-state]] [mode=[sc]] [mtu=size]
  [inter-vnet-link=[on|off]] vswitch-name 
ldm remove-vsw [-f] vswitch-name 
ldm add-vnet [mac-addr=num] [mode=hybrid] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...]
  [linkprop=phys-state] [id=network-id] [mtu=size] if-name vswitch-name ldom 
ldm set-vnet [mac-addr=num] [vswitch=vswitch-name] [mode=[hybrid]] [pvid=port-vlan-id]
  [linkprop=[phys-state]] [vid=vlan-id1,vlan-id2,...] [mtu=size] if-name ldom 
ldm remove-vnet [-f] if-name ldom 
ldm add-vds service-name ldom 
ldm remove-vds [-f] service-name 
ldm add-vdsdev [-f] [-q] [options={ro,slice,excl}] [mpgroup=mpgroup] backend
  volume-name@service-name
ldm set-vdsdev [-f] options=[{ro,slice,excl}] [mpgroup=mpgroup]
  volume-name@service-name
ldm remove-vdsdev [-f] volume-name@service-name 
ldm add-vdisk [timeout=seconds] [id=disk-id] disk-name volume-name@service-name ldom 
ldm set-vdisk [timeout=seconds] [volume=volume-name@service-name] disk-name ldom 
ldm remove-vdisk [-f] disk-name ldom 
ldm add-vdpcs vdpcs-service-name ldom 
ldm remove-vdpcs [-f] vdpcs-service-name 
ldm add-vdpcc vdpcc-name vdpcs-service-name ldom 
ldm remove-vdpcc [-f] vdpcc-name ldom 
ldm add-vcc port-range=x-y vcc-name ldom 
ldm set-vcc port-range=x-y vcc-name 
ldm remove-vcc [-f] vcc-name 
ldm set-vcons [port=[port-num]] [group=group] [service=vcc-server] ldom 
ldm create-vf [mac-addr=num] [alt-mac-addrs=[auto|num1,[auto|num2,...]]] [pvid=pvid]
  [vid=vid1,vid2,...] [mtu=size] [name=value...] pf-name 
ldm destroy-vf vf-name 
ldm add-variable var-name=[value]... ldom
ldm set-variable var-name=[value]... ldom
ldm remove-variable var-name... ldom 
ldm list-variable [var-name...] ldom 
ldm start-domain (-a | -i file | ldom...) 
ldm stop-domain [-f] (-a | ldom...) 
ldm panic-domain ldom 
ldm bind-domain [-f] [-q] (-i file | ldom) 
ldm unbind-domain ldom 
ldm list-bindings [-e] [-p] [ldom...] 
ldm add-spconfig config-name
ldm add-spconfig -r autosave-name [new-config-name]
ldm set-spconfig config-name 
ldm set-spconfig factory-default 
ldm remove-spconfig [-r] config-name 
ldm list-spconfig [-r [autosave-name]]
ldm list-constraints ([-x] | [-e] [-p]) [ldom...] 
ldm list-devices [-a] [-p] [core] [cpu] [crypto] [memory] [io] 
ldm list-services [-e] [-p] [ldom...]
ldm add-policy [enable=yes|no] [priority=value] [attack=value] [decay=value]
  [elastic-margin=value] [sample-rate=value] [tod-begin=hh:mm[:ss]]
  [tod-end=hh:mm[:ss]] [util-lower=percent] [util-upper=percent] [vcpu-min=value]
  [vcpu-max=value] name=policy-name ldom...
ldm set-policy [enable=[yes|no]] [priority=[value]] [attack=[value]] [decay=[value]]
  [elastic-margin=[value]] [sample-rate=[value]] [tod-begin=[hh:mm:ss]]
  [tod-end=[hh:mm:ss]] [util-lower=[percent]] [util-upper=[percent]] [vcpu-min=[value]]
  [vcpu-max=[value]] name=policy-name ldom...
ldm remove-policy [name=]policy-name... ldom
ldm init-system [-frs] -i file

Description

The ldm command interacts with the Logical Domains Manager and is used to create and manage logical domains. There can be only one Logical Domains Manager per server. The Logical Domains Manager runs on the control domain, which is the initial domain created by the service processor. The control domain is named primary.

A logical domain is a discrete logical grouping with its own operating system, resources, and identity within a single computer system. Each logical domain can be created, destroyed, reconfigured, and rebooted independently, without requiring a power cycle of the server. You can use logical domains to run a variety of applications in different domains and keep them independent for security purposes.

All logical domains are the same and can be distinguished from one another based on the roles that you specify for them. The following are the roles that logical domains can perform:

Control domain

Creates and manages other logical domains and services by communicating with the hypervisor.

Service domain

Provides services to other logical domains, such as a virtual network switch or a virtual disk service.

I/O domain

Has direct access to a physical I/O device, such as a network card in a PCI EXPRESS (PCIe) controller or a single-root I/O virtualization (SR-IOV) virtual function. An I/O domain can own a PCIe root complex, or it can own a PCIe slot or on-board PCIe device by using the direct I/O (DIO) feature and an SR-IOV virtual function by using the SR-IOV feature.

An I/O domain can share physical I/O devices with other domains in the form of virtual devices when the I/O domain is also used as a service domain.

Root domain

Has a PCIe root complex assigned to it. This domain owns the PCIe fabric and all connected devices, and provides all fabric-related services, such as fabric error handling. A root domain owns all of the SR-IOV physical functions from which you can create virtual functions and assign them to I/O domains. A root domain is also an I/O domain, as it owns and has direct access to physical I/O devices.

The number of root domains that you can have depends on your platform architecture. For example, if you are using a Sun SPARC Enterprise T5440 server from Oracle, you can have up to four root domains.

Guest domain

Uses services from the I/O and service domains and is managed by the control domain.

You can use the Logical Domains Manager to establish dependency relationships between domains.

Master domain

A domain that has one or more domains that depend on it. A master domain specifies a failure policy to be enacted by its slave domains when the master domain fails. For instance, depending on the master domain's failure policy, a slave can be left as-is, panicked, rebooted, or stopped when the master domain fails.

Slave domain

A domain that depends on another domain. A domain can specify up to four master domains that dictate the failure policy to enact when one or more of the master domains fail.

Subcommand Summaries

Following are the supported subcommands along with a description and required authorization for each. For information about setting up authorization for user accounts, see Creating Authorizations and Profiles and Assigning Roles to User Accounts in Oracle VM Server for SPARC 2.2 Administration Guide.

Subcommand
Description
Authorization
add-spconfig
Adds a logical domain configuration to the service processor (SP).
solaris.ldoms.write
add-domain
Creates a logical domain.
solaris.ldoms.write
add-policy
Adds a resource management policy to an existing logical domain.
solaris.ldoms.write
add-resource
Adds a resource to an existing logical domain. See RESOURCES for resource definitions.
solaris.ldoms.write
bind-domain
Binds resources to a created logical domain.
solaris.ldoms.write
cancel-operation
Cancels an operation, such as a delayed reconfiguration (reconf), memory dynamic reconfiguration (DR) removal (memdr), or domain migration (migration).
solaris.ldoms.write
cancel-reconf
Cancels a delayed reconfiguration operation on the primary domain.
solaris.ldoms.write
create-vf
Creates a virtual function.
solaris.ldoms.write
destroy-vf
Destroys a virtual function.
solaris.ldoms.write
list-type
Lists server resources, including bindings, constraints, devices, services, and configurations for logical domains.
solaris.ldoms.read
list-domain
Lists logical domains and their states.
solaris.ldoms.read
list-variable
Lists variables for logical domains.
solaris.ldoms.read
migrate-domain
Migrates a logical domain from one machine to another.
solaris.ldoms.write
panic-domain
Panics the Oracle Solaris OS on a specified logical domain.
solaris.ldoms.write
remove-resource
Removes a resource from an existing logical domain. See RESOURCES for resource definitions.
solaris.ldoms.write
remove-domain
Deletes a logical domain.
solaris.ldoms.write
remove-policy
Removes a resource management policy from an existing logical domain.
solaris.ldoms.write
remove-spconfig
Removes a logical domain configuration from the service processor.
solaris.ldoms.write
remove-variable
Removes one or more variables from an existing logical domain.
solaris.ldoms.write
set-resource
Specifies a resource for an existing logical domain. This can be either a property change or a quantity change. This represents a quantity change when applied to the resources core, vcpu, memory, or crypto. For a quantity change, the subcommand becomes a dynamic or a delayed reconfiguration operation, where the quantity of the specified resource is assigned to the specified logical domain. If there are more resources assigned to the logical domain than are specified in this subcommand, some are removed. If there are fewer resources assigned to the logical domain than are specified in this subcommand, some are added. See RESOURCES for resource definitions.
solaris.ldoms.write
set-domain
Sets properties on a logical domain.
solaris.ldoms.write
set-io
Modifies a physical function or a virtual function.
solaris.ldoms.write
set-policy
Sets properties for a resource management policy to an existing logical domain.
solaris.ldoms.write
set-spconfig
Specifies a logical domain configuration to use.
solaris.ldoms.write
set-variable
Sets one or more variables for an existing logical domain.
solaris.ldoms.write
start-domain
Starts one or more logical domains.
solaris.ldoms.write
start-reconf
Enters delayed reconfiguration mode on the primary domain.
solaris.ldoms.write
stop-domain
Stops one or more running logical domains.
solaris.ldoms.write
unbind-domain
Unbinds or releases resources from a logical domain.
solaris.ldoms.write

Note - Not all subcommands are supported on all resources types.


Aliases

The following table shows the three kinds of aliases for ldm subcommands.

Alias Type
Short Form
Long Form
Action alias (verb)
ls
list
Action alias (verb)
rm
remove
Resource alias (noun)
config
spconfig
Resource alias (noun)
crypto
mau
Resource alias (noun)
dom
domain
Resource alias (noun)
mem
memory
Resource alias (noun)
var
variable
Resource alias (noun)
vcc
vconscon
Resource alias (noun)
vcons
vconsole
Resource alias (noun)
vdpcc
ndpsldcc
Resource alias (noun)
vdpcs
ndpsldcs
Resource alias (noun)
vds
vdiskserver
Resource alias (noun)
vdsdev
vdiskserverdevice
Resource alias (noun)
vsw
vswitch
Subcommand shortcut
bind
bind-domain
Subcommand shortcut
cancel-op
cancel-operation
Subcommand shortcut
create
add-domain
Subcommand shortcut
destroy
remove-domain
Subcommand shortcut
list
list-domain
Subcommand shortcut
migrate
migrate-domain
Subcommand shortcut
modify
set-domain
Subcommand shortcut
panic
panic-domain
Subcommand shortcut
start
start-domain
Subcommand shortcut
stop
stop-domain
Subcommand shortcut
unbind
unbind-domain

Note - In the syntax and examples in the remainder of this man page, the short forms of the action and resource aliases are used.


Resources

The following resources are supported:

core

CPU cores.

crypto

Any supported cryptographic unit on a supported server. Currently, the two cryptographic units supported are the Modular Arithmetic Unit (MAU) and the Control Word Queue (CWQ).

io

I/O devices, such as PCIe root complexes and their attached adapters and devices. Also direct I/O-assignable devices and PCIe SR-IOV virtual functions.

mem, memory

Default memory size in bytes. Or specify gigabytes (G), kilobytes (K), or megabytes (M). Virtualized memory of the server that can be allocated to guest domains.

vcc, vconscon

Virtual console concentrator service with a specific range of TCP ports to assign to each guest domain at the time it is created.

vcons, vconsole

Virtual console for accessing system-level messages. A connection is achieved by connecting to the vconscon service in the control domain at a specific port.

vcpu

Each virtual CPU represents one CPU thread of a server. For example, an 8-core Sun SPARC Enterprise T5120 server has 64 CPU threads (virtual CPUs) that can be allocated among the logical domains.

vdisk

Virtual disks are generic block devices backed by different types of physical devices, volumes, or files. A virtual disk is not synonymous with a SCSI disk and, therefore, excludes the target ID (tN) in the disk name. Virtual disks in a logical domain have the following format: cNdNsN, where cN is the virtual controller, dN is the virtual disk number, and sN is the slice.

vds, vdiskserver

Virtual disk server that allows you to export virtual disks to other logical domains.

vdsdev, vdiskserverdevice

Device exported by the virtual disk server. The device can be an entire disk, a slice on a disk, a file, or a disk volume.

vdpcc

Virtual data plane channel client. Only of interest in a Netra Data Plane Software (NDPS) environment.

vdpcs

Virtual data plane channel service. Only of interest in a Netra Data Plane Software (NDPS) environment.

vnet

Virtual network device that implements a virtual Ethernet device and communicates with other vnet devices in the system using the virtual network switch (vsw).

vsw, vswitch

Virtual network switch that connects the virtual network devices to the external network and also switches packets between them.

List Types

The following list types are supported:

bindings

Lists the resources bound to a logical domain.

config

Lists the logical domain configurations stored on the service processor (SP). On SPARC T3 based servers, the configurations are shown in the order of creation from the oldest to the newest.

constraints

Lists the constraints used to create a logical domain.

devices

Lists all free devices for the server.

services

Lists all services exported by a logical domain.

Options

The following table describes the ldm command options. The short form of the option is followed by the long form, if applicable.

-a
--all
Operates on all of the operand types.
 
--auto-adj

Specifies that the add-memory, set-memory, and remove-memory subcommands align memory changes on a 256-Mbyte boundary. The behavior of the --auto-adj option depends on the state of the affected domain.

  • Active domain. For dynamic reconfigurations, this option aligns the amount of memory to be added or removed to a 256-Mbyte boundary. The amount is rounded up for an add-memory operation and rounded down for a remove-memory operation. A set-memory operation is treated as either an add-memory or remove-memory operation. For any of these subcommands, the --auto-adj option ensures that the resulting size of the domain's memory is greater than or equal to the requested size.

    For delayed reconfigurations, this option has the same behavior as a bound or inactive domain. A delayed reconfiguration can occur under the following conditions:

    • The domain initiates a delayed reconfiguration.

    • A delayed reconfiguration is outstanding in the domain.

  • Bound domain or inactive domain. This option aligns the resulting size of the domain by rounding up to the next 256-Mbyte boundary. This alignment occurs in add-memory, set-memory, and remove-memory operations.

-c number
--core number
Performs the following discrete CPU operations:
  • Sets the allocation unit for the domain from threads to cores, if not already set, and sets the allocation to the specified number of cores.

  • If the domain is inactive, sets a cap on the number of cores that can be allocated to the domain when it is bound or active. A cap is set on the primary domain only if the domain is in a delayed reconfiguration mode.

If any allocation request results in more cores being assigned to a domain than is permitted by the cap, the command fails.

This option configures hard partitioning on your Oracle VM Server for SPARC system. See Configuring the System With Hard Partitions in Oracle VM Server for SPARC 2.2 Administration Guide.

You can change the allocation unit from cores to threads and remove the cap. Make these changes by issuing an add-vcpu, set-vcpu, or rm-vcpu command without the -c option on an inactive domain or on the primary domain that is in delayed reconfiguration mode.

Starting with the Oracle VM Server for SPARC 2.2 release, the CPU cap and the allocation of CPU cores is handled by separate commands. By using these commands you can independently allocate CPU cores, set a cap, or both. The allocation unit can be set to cores even when no cap is in place. However, running the system in this mode is not acceptable for configuring hard partitioning on your Oracle VM Server for SPARC system.

  • Allocate the specified number of CPU cores to a domain by using the add-core, set-core, and rm-core subcommands.

  • Set the cap by using the create-domain or set-domain subcommand to specify the max-cores property value.

-e
--extended
Generates an extended listing containing services and devices that are automatically set up, that is, not under your control.
-f
--force
Attempts to force an operation.
-i file
--input file
Specifies the XML configuration file to use in creating a logical domain.
-l
--long
Generates a long listing.
-n
--dry-run
Makes a dry run of a migration to check to see if the migration will succeed. Does not actually migrate the domain.
-o format
--output format
Specifies one or more of the following formats for an ldm list command, depending on what you want to see: console, core, cpu, crypto, disk, domain, memory, network, physio, resmgmt, serial, and status. If you specify more than one format, delimit each format by a comma with no spaces.
-p
--parseable
Generates a machine-readable version of the output.
-q
 
Disables the validation of network or disk back-end devices so that the command runs more quickly.
-r
 
For the add-spconfig, list-spconfig, and remove-spconfig subcommands: Performs a manual configuration recovery.
-r
--reboot
For the init-system subcommand: Reboots the system after configuration.
-s
--services-only
Restores only the virtual services configuration (vds, vcc, and vsw).
-x file
--xml file
Specifies that an XML file containing the constraints for the logical domain be written to standard output (stdout). Can be used as backup file.
-V
--version
Displays version information.
 
--help
Displays usage statements.

Properties


Note - You can use various ldm set-* commands to reset any property to its default value by specifying an empty value. For example, the following ldm set-policy command resets the attack property to its default value:

# ldm set-policy attack= high-policy ldom1

The following properties are supported:

alt-mac-addrs=auto|num1,[auto|num2,...]

Specifies a comma-separated list of alternate MAC addresses. Valid values are numeric MAC addresses and the auto keyword, which can be used one or more times to request that the system generate an alternate MAC address. The auto keyword can be mixed with numeric MAC addresses.

attack=value

Specifies the maximum number of resources to be added during any one resource control cycle. If the number of available resources is less than the specified value, all of the available resources are added. By default, the attack is unlimited so that you can add as many CPU threads as are available. Valid values are from 1 to the number of free CPU threads on the system.

cid=core-ID

Specifies the physical core IDs to assign to or remove from a domain. To remove all named cores, omit core-ID values for the cid property by running the ldm set-core cid= command.

The cid property should only be used by an administrator who is knowledgeable about the topology of the system to be configured. This advanced configuration feature enforces specific allocation rules and might affect the overall performance of the system.

cpu-arch=generic|native

Specifies one of the following values:

  • generic uses common CPU hardware features to enable a guest domain to perform a CPU-type-independent migration.

  • native uses CPU-specific hardware features to enable a guest domain to migrate only between platforms that have the same CPU type. native is the default value.

Using the generic value might result in reduced performance compared to the native value. This occurs because the guest domain does not use some features that are only present in newer CPU types. By not using these features, the generic setting enables the flexibility of migrating the domain between systems that use newer and older CPU types.

decay=value

Specifies the maximum number of resources to be removed during any one resource control cycle. Only the number of currently bound CPU threads minus the value of vcpu-min can be removed even if the value specified by this property is larger. By default, the value is 1. Valid values are from 1 to the total number of CPU threads minus 1.

default-vlan-id=

Specifies the default virtual local area network (VLAN) to which a virtual network device or virtual switch needs to be a member, in tagged mode. The first VLAN ID (vid1) is reserved for the default-vlan-id.

elastic-margin=value

Specifies the amount of buffer space between util-lower and the number of free CPU threads to avoid oscillations at low CPU thread counts. Valid values are from 0 to 100. The default value is 5.

enable=yes|no

Enables or disables resource management for an individual domain. By default, enable=yes.

extended-mapin-space=on|off

Enables or disables extended mapin space for a domain. By default, extended-mapin-space=off.

The extended mapin space refers to the additional LDC shared memory space. This memory space is required to support a large number of virtual I/O devices that use direct-mapped shared memory. This extended mapin space is also used by virtual network devices to improve performance and scalability.

failure-policy=

Specifies the master domain's failure policy, which controls how slave domains behave when the master domain fails. This property is set on a master domain. The default value is ignore. Following are the valid property values:

  • ignore ignores failures of the master domain (slave domains are unaffected).

  • panic panics any slave domains when the master domain fails.

  • reset resets any slave domains when the master domain fails.

  • stop stops any slave domains when the master domain fails.

group=

Specifies a group to which to attach a console. The group argument allows multiple consoles to be multiplexed onto the same TCP connection.

hostid=

Specifies the host ID for a particular domain. If you do not specify a host ID, the Logical Domains Manager assigns a unique host ID to each domain.

id=

Specifies an ID for a new virtual disk device, virtual network device, and virtual switch device, respectively.

inter-vnet-link=on|off

Specifies whether to assign a channel between each virtual network device. The default value is on.

When inter-vnet-link=on, the Logical Domains Manager assigns a channel between each pair of virtual network devices that are connected to the same virtual switch for better guest-to-guest performance.

When inter-vnet-link=off, the Logical Domains Manager only assigns channels for communications between virtual network devices and virtual switches. In this case, guest-to-guest communications traffic goes through the virtual switch. This setting reduces the number of channels that are used for virtual network devices. Thus, the maximum number of virtual devices that you can add to the system is increased.

linkprop=phys-state

Specifies whether the virtual device reports its link status based on the underlying physical network device. When linkprop=phys-state is specified on the command line, the virtual device link status reflects the physical link state. By default, the virtual device link status does not reflect the physical link state.

mac-addr=

Defines a MAC address. The number must be in standard octet notation, for example, 80:00:33:55:22:66.

master=

Specifies the name of up to four master domains for a slave domain. This property is set on a slave domain. By default, there are no masters for the domain. The domain must already exist prior to an ldm add-domain operation.


Note - The Logical Domains Manager does not permit you to create domain relationships that result in a dependency cycle.


max-cores=num|unlimited

Specifies the maximum number of cores that are permitted to be assigned to a domain. If the value is unlimited, there is no constraint on the number of CPU cores that can be allocated.

mblock=PA-start:size

Specifies one or more physical memory blocks to assign to or remove from a domain. PA-start specifies the starting physical address of the memory block in hexadecimal format. size is the size of the memory block, including a unit, to be assigned to or removed from the domain. To remove all named memory blocks, omit PA-start:size values from the mblock property by running the ldm set-memory mblock= command.

The mblock property should only be used by an administrator who is knowledgeable about the topology of the system to be configured. This advanced configuration feature enforces specific allocation rules and might affect the overall performance of the system.

mode=

For add-vsw and set-vsw subcommands:

Omit this option when you are not running Oracle Solaris Cluster software in guest domains because you could impact virtual network performance.

Otherwise, specify one of the following:

  • Set mode=sc to enable virtual networking support for prioritized processing of Oracle Solaris Cluster heartbeat packets in a Logical Domains environment.

  • Leave the mode= argument blank in the set-vsw subcommand to stop special processing of heartbeat packets.

For add-vnet and set-vnet subcommands:

Omit this option when you do not want to use NIU Hybrid I/O.

Otherwise, specify one of the following:

mpgroup=

Defines the multipath group name for several virtual disk server devices (vdsdev). So, when a virtual disk cannot communicate with a virtual disk server device, a failover is initiated to another virtual disk server device in the multipath group.

mtu=

Specifies the maximum transmission unit (MTU) of a virtual switch, virtual network devices that are bound to the virtual switch, or both. Valid values are in the range of 1500-16000. The ldm command issues an error if an invalid value is specified.

name=policy-name

Specifies the resource management policy name.

net-dev=

Defines the path name of the actual network device.

options=

Specifies all or a subset of the following options for a specific virtual disk server device. Separate two or more options with commas and no spaces, such as ro,slice,excl.

  • ro – Specifies read-only access

  • slice – Exports a back end as a single slice disk

  • excl – Specifies exclusive disk access

Omit the options= argument or leave it blank in an add-vdsdev subcommand to have the default values of disk, not exclusive, and read/write. Leave the options= argument blank in the set-vdsdev subcommand to turn off any previous options specified.

port=

Specifies a specific port number or, left blank, lets the Logical Domains Manager set the port number.

port-range=

Defines a range of TCP ports.

priority=value

Specifies a priority for dynamic resource management (DRM) policies. Priority values are used to determine the relationship between DRM policies in a single domain and between DRM-enabled domains in a single system. Lower numerical values represent higher (better) priorities. Valid values are between 1 and 9999. The default value is 99.

The behavior of the priority property depends on whether a pool of free CPU resources is available, as follows:

  • Free CPU resources are available in the pool. In this case, the priority property determines which DRM policy will be in effect when more than one overlapping policy is defined for a single domain.

  • No free CPU resources are available in the pool. In this case, the priority property specifies whether a resource can be dynamically moved from a lower-priority domain to a higher-priority domain in the same system. The priority of a domain is the priority specified by the DRM policy that is in effect for that domain.

    For example, a higher-priority domain can acquire CPU resources from another domain that has a DRM policy with a lower priority. This resource-acquisition capability pertains only to domains that have DRM policies enabled. Domains that have equal priority values are unaffected by this capability. So, if the default priority is used for all policies, domains cannot obtain resources from lower-priority domains. To take advantage of this capability, adjust the priority property values so that they have unequal values.

pvid=

Specifies the VLAN to which the virtual network device needs to be a member, in untagged mode.

sample-rate=value

Specifies the cycle time, in seconds, which is the sample rate for DRM. Valid values are from 1 to 9999. The default and recommended value is 10.

service=

Specifies the name of the existing virtual console concentrator that you want to handle the console connection.

threading=max-ipc|max-throughput

The threading property specifies the workflow throughput of the domain.

The following are valid values for the threading property:

  • max-ipc. Only one thread is active for each CPU core that is assigned to the domain, which maximizes the number of instructions per cycle. Selecting this mode requires that the domain is also configured with the whole-core constraint. See the add-vcpu and set-vcpu subcommand descriptions.

  • max-throughput. Activates all threads that are assigned to the domain, which maximizes throughput. This mode is used by default and is also selected if you do not specify any mode (threading=).

timeout=

Defines the number of seconds for establishing a connection between a virtual disk client (vdc) and a virtual disk server (vds). If there are multiple virtual disk (vdisk) paths, then the vdc can try to connect to a different vds, and the timeout ensures that a connection to any vds is established within the specified amount of time. Specify 0 to disable the timeout in the set-vdisk subcommand.

tod-begin=hh:mm[:ss]

Specifies the effective start time of a policy in terms of hour, minute, and optional second. This time must be earlier than the time specified by tod-end in a period that begins at midnight and ends at 23:59:59. The default value is 00:00:00.

tod-end=hh:mm[:ss]

Specifies the effective stop time of a policy in terms of hour, minute, and optional second. This time must be later than the time specified by tod-begin in a period that begins at midnight and ends at 23:59:59. The default value is 23:59:59.

util-lower=percent

Specifies the lower utilization level at which policy analysis is triggered. Valid values are from 1 to util-upper minus 1. The default value is 60.

util-upper=percent

Specifies the upper utilization level at which policy analysis is triggered. Valid values are from util-lower plus 1 to 99. The default value is 85.

uuid=uuid

Specifies the universally unique identifier (UUID) for the domain. uuid is a hexadecimal string, such as 12345678-1234-abcd-1234-123456789abc, which consists of five hexadecimal numbers separated by dashes. Each number must have the specified number of hexadecimal digits: 8, 4, 4, 4, and 12, as follows:

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
vcpu-max=value

Specifies the maximum number of CPU thread resources for a domain. By default, the maximum number of CPU threads is unlimited. Valid values are from vcpu-min plus 1 to the total number of free CPU threads on the system.

vcpu-min=value

Specifies the minimum number of CPU thread resources for a domain. Valid values are from 1 to vcpu-max minus 1. The default value is 1.

vid=

Specifies the VLAN to which a virtual network device or virtual switch needs to be a member, in tagged mode.

volume=

Changes a volume name for a virtual disk.

vswitch=

Changes a virtual switch name for a virtual network.

Flags in list Subcommand Output

Following are definitions of the flags in the list subcommand output:

-

Placeholder

c

Control domain

d

Delayed reconfiguration

e

Error

n

Normal

r

Memory DR in progress

s

Column 1 – starting or stopping

Column 6 – source domain

t

Column 2 – transition

Column 6 – target domain

v

Virtual I/O service domain

The list flag values are position dependent. Following are the values that can appear in each of the five columns from left to right.

Table 1 List Flag Positions

Column 1
Column 2
Column 3
Column 4
Column 5
Column 6
s or -
n or t
d, r, or -
c or -
v or -
s, t, or e

Subcommand Usage

This section contains descriptions of every supported command-line interface (CLI) operation, that is, every subcommand and resource combination.

Add, Set, Remove, and Migrate Domains

Add Domains

This subcommand adds one or more logical domains by specifying one or more logical domain names or by using an XML configuration file. You can also specify property values to customize the domain, such as the MAC address, the host ID, a list of master domains, and a failure policy. If you do not specify these property values, the Logical Domains Manager automatically assigns default values.

ldm add-dom -i file
ldm add-dom [cpu-arch=generic|native] [mac-addr=num] [hostid=num] [failure-policy=ignore|panic|reset|stop] [extended-mapin-space=on] [master=master-ldom1,...,master-ldom4] [max-cores=[num|unlimited]] [uuid=uuid] [threading=max-ipc] ldom
ldm add-dom ldom...

where:

Set Options for Domains

This subcommand enables you to modify only the mac-addr, hostid, failure-policy, extended-mapin-space, master, max-cores, and threading properties of each domain. You cannot use this command to update resource properties.


Note - If the slave domain is bound, all of its specified master domains must also be bound prior to invoking the ldm set-domain command.


ldm set-dom -i file
ldm set-dom [cpu-arch=generic|native] [mac-addr=num] [hostid=num] [failure-policy=ignore|panic|reset|stop] [extended-mapin-space=[on|off]] [master=[master-ldom1,...,master-ldom4]] [max-cores=[num|unlimited]] [threading=[max-throughput|max-ipc]] ldom

where:

Remove Domains

This subcommand removes one or more logical domains.

ldm rm-dom -a
ldm rm-dom ldom...

where:

Migrate Logical Domains

This subcommand migrates a domain from one location to another.

ldm migrate-domain [-f] [-n] [-p filename] source-ldom [user@]target-host[:target-ldom]

where:

Reconfiguration Operations

Logical Domains supports the following types of reconfiguration operations:

See Resource Reconfiguration in Oracle VM Server for SPARC 2.2 Administration Guide for more information about dynamic reconfiguration and delayed reconfiguration.

CPU Operations

You can allocate either CPU threads or CPU cores to a domain. To allocate CPU threads, use the add-vcpu, set-vcpu, and remove-vcpu subcommands. To allocate CPU cores, use the add-core, set-core, and remove-core subcommands.

Add CPU Threads

This subcommand adds the specified number of CPU threads or CPU cores to a logical domain. Note that a domain cannot be configured simultaneously with CPU cores and CPU threads. CPU core configurations and CPU thread configurations are mutually exclusive.

ldm add-vcpu [-c] number ldom

where:

Set CPU Threads

This subcommand specifies the number of CPU threads or CPU cores to be set in a logical domain. Note that a domain cannot be configured simultaneously with CPU cores and CPU threads. CPU core configurations and CPU thread configurations are mutually exclusive.

ldm set-vcpu [-c] number ldom

where:

Remove CPU Threads

This subcommand removes the specified number of CPU threads or CPU cores from a logical domain. Note that a domain cannot be configured simultaneously with CPU cores and CPU threads. CPU core configurations and CPU thread configurations are mutually exclusive.

ldm rm-vcpu [-c] number ldom

where:

Add CPU Cores

This subcommand adds the specified number of CPU cores to a domain. When you specify the number of CPU cores, the cores to be assigned are automatically selected. However, when you specify a core-ID value to the cid property, the specified cores are explicitly assigned.

The cid property should only be used by an administrator who is knowledgeable about the topology of the system to be configured. This advanced configuration feature enforces specific allocation rules and might affect the overall performance of the system.

You can explicitly assign cores to a domain as long as power management is not using the elastic policy.

ldm add-core num ldom ldm add-core cid=core-ID[,core-ID[,...]] ldom

where:

Set CPU Cores

This subcommand specifies the number of CPU cores to assign to a domain. When you specify the number of CPU cores, the cores to be assigned are automatically selected. However, when you specify a core-ID value to the cid property, the specified cores are explicitly assigned.

You can explicitly assign cores to a domain as long as power management is not using the elastic policy.

ldm set-core num ldom ldm set-core cid=[core-ID[,core-ID[,...]]] ldom

where:

Remove CPU Cores

This subcommand specifies the number of CPU cores to remove from a domain. When you specify the number of CPU cores, the cores to be removed are automatically selected. However, when you specify a core-ID value to the cid property, the specified cores are explicitly removed.

You can explicitly remove cores from a domain as long as power management is not using the elastic policy.

ldm remove-core [-f] num ldom ldm remove-core cid=[core-ID[,core-ID[,...]]] ldom

where:

Cryptographic Unit Operations

The cryptographic unit subcommands only pertain to SPARC platforms that have discrete cryptographic units.

Add Cryptographic Units

This subcommand specifies the number of cryptographic units to be added to a logical domain. Currently, the supported cryptographic units on supported servers are the Modular Arithmetic Unit (MAU) and the Control Word Queue (CWQ).

ldm add-crypto number ldom

where:

Set Cryptographic Units

This subcommand specifies the number of cryptographic units to be set in a logical domain. If you want to remove all cryptographic units from an active domain, you must specify the -f option.

To remove the last cryptographic unit from the primary domain when domains are active, you must do one of the following:

ldm set-crypto [-f] number ldom

where:

Remove Cryptographic Units

This subcommand removes the specified number of cryptographic units from a logical domain. If you want to remove all cryptographic units from an active domain, you must specify the -f option.

To remove the last cryptographic unit from the primary domain when domains are active, you must do one of the following:

ldm rm-crypto [-f] number ldom

where:

Memory Operations

Add Memory

This subcommand adds the specified amount of memory to a domain. When you specify a memory block size, the memory block to be assigned is automatically selected. However, when you specify a PA-start:size value to the mblock property, the specified memory blocks are explicitly assigned.

The mblock property should only be used by an administrator who is knowledgeable about the topology of the system to be configured. This advanced configuration feature enforces specific allocation rules and might affect the overall performance of the system.

ldm add-mem [--auto-adj] size[unit] ldom ldm add-mem mblock=PA-start:size[,PA-start:size[,...]] ldom

where:

Set Memory

This subcommand sets a specific amount of memory in a domain. Depending on the amount of memory specified, this subcommand is treated as an add-memory or remove-memory operation.

When you specify a memory block size, the memory block to be assigned is automatically selected. However, when you specify a PA-start:size value to the mblock property, the specified memory blocks are explicitly assigned.

ldm set-mem [--auto-adj] size[unit] ldom ldm set-mem mblock=PA-start:size[,PA-start:size[,...]] ldom

where:

Remove Memory

This subcommand removes the specified amount of memory from a logical domain. When you specify a memory block size, the memory block to be removed is automatically selected. However, when you specify a PA-start:size value to the mblock property, the specified memory blocks are explicitly removed.

ldm rm-mem [--auto-adj] size[unit] ldom ldm rm-mem mblock=PA-start:size[,PA-start:size[,...]] ldom

where:

Enter Delayed Reconfiguration Mode

This subcommand enables the domain to enter delayed reconfiguration mode. primary is the only valid value for ldom.

ldm start-reconf ldom

Cancel a Delayed Reconfiguration Operation

This subcommand cancels a delayed reconfiguration. primary is the only valid value for ldom.

ldm cancel-reconf ldom

Cancel Operations

This subcommand cancels a delayed reconfiguration (reconf), memory DR removal (memdr), or domain migration (migration) for a logical domain. For the reconf operation, primary is the only valid value for ldom.

ldm cancel-op migration ldom
ldm cancel-op reconf ldom
ldm cancel-op memdr ldom

Input/Output Devices

Add Input/Output Device

This subcommand adds a PCI bus or device to a specified logical domain.

ldm add-io (bus | device | vf-name) ldom

where:

Set a Property for a Virtual Function

This subcommand modifies the current configuration of a virtual function by changing the property values or by passing new properties. This command can modify both the class-specific properties and the device-specific properties.

You can change most network class-specific properties without requiring a reboot of the primary domain. Changes to the mtu property do require a reboot. You must stop the domain if you change a virtual function MAC address.

ldm set-io [mac-addr=num] [alt-mac-addrs=[auto|num1,[auto|num2,...]]] [pvid=[port-vlan-id]] [vid=[vlan-id1,vlan-id2,...]] [mtu=size] [name=value...] vf-name

where:

Set a Property for a Physical Function

This subcommand modifies the physical function configuration. Only the physical function device-specific properties are supported. Any change to the properties causes a delayed reconfiguration because the properties are applied during the attach operation of the physical function device driver.

The property values must be an integer or a string. Run the ldm list-io -d command to determine the property value type and whether a particular property can be set.

Note that the ldm set-io command succeeds only when the physical function driver successfully validates the resulting configuration.

ldm set-io name=value [name=value...] pf-name

where:

Remove Input/Output Device

This subcommand removes a PCI bus or device from a specified logical domain.

ldm rm-io (bus | device | vf-name) ldom

where:

Virtual Network Server

Add a Virtual Switch

This subcommand adds a virtual switch to a specified logical domain.

ldm add-vsw [-q] [default-vlan-id=vlan-id] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...] [linkprop=phys-state] [mac-addr=num] [net-dev=device] [mode=sc] [mtu=size] [id=switch-id] [inter-vnet-link=on|off] vswitch-name ldom

where:

Set Options for a Virtual Switch

This subcommand modifies the properties of a virtual switch that has already been added.

ldm set-vsw [-q] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...] [mac-addr=num] [net-dev=device] [linkprop=[phys-state]] [mode=[sc]] [mtu=size] [inter-vnet-link=[on|off]] vswitch-name

where:

Remove a Virtual Switch

This subcommand removes a virtual switch.

ldm rm-vsw [-f] vswitch-name

where:

Virtual Network – Client

Add a Virtual Network Device

This subcommand adds a virtual network device to the specified logical domain.

ldm add-vnet [mac-addr=num] [mode=hybrid] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...] [linkprop=phys-state] [id=network-id] [mtu=size] if-name vswitch-name ldom

where:

Set Options for a Virtual Network Device

This subcommand sets options for a virtual network device in the specified logical domain.

ldm set-vnet [mac-addr=num] [vswitch=vswitch-name] [mode=[hybrid]] [pvid=port-vlan-id] [linkprop=[phys-state]] [vid=vlan-id1,vlan-id2,...] [mtu=size] if-name ldom

where:

Remove a Virtual Network Device

This subcommand removes a virtual network device from the specified logical domain.

ldm rm-vnet [-f] if-name ldom

where:

Virtual Disk – Service

Add a Virtual Disk Server

This subcommand adds a virtual disk server to the specified logical domain.

ldm add-vds service-name ldom

where:

Remove a Virtual Disk Server

This subcommand removes a virtual disk server.

ldm rm-vds [-f] service-name

where:


Caution

Caution - The -f option attempts to unbind all clients before removal, which might cause loss of disk data if writes are in progress.


Add a Device to a Virtual Disk Server

This subcommand adds a device to a virtual disk server. The device can be an entire disk, a slice on a disk, a file, or a disk volume. See Chapter 7, Using Virtual Disks, in Oracle VM Server for SPARC 2.2 Administration Guide.

ldm add-vdsdev [-f] [-q] [options={ro,slice,excl}] [mpgroup=mpgroup] backend volume-name@service-name

where:

Set Options for a Virtual Disk Server Device

This subcommand sets options for a virtual disk server. See the Oracle VM Server for SPARC 2.2 Administration Guide.

ldm set-vdsdev [-f] options=[{ro,slice,excl}] [mpgroup=mpgroup] volume-name@service-name

where:

Remove a Device From a Virtual Disk Server

This subcommand removes a device from a virtual disk server.

ldm rm-vdsdev [-f] volume-name@service-name

where:


Caution

Caution - Without the -f option, the rm-vdsdev subcommand does not allow a virtual disk server device to be removed if the device is busy. Using the -f option can cause data loss for open files.


Virtual Disk – Client

Add a Virtual Disk

This subcommand adds a virtual disk to the specified logical domain. An optional timeout property allows you to specify a timeout for a virtual disk if it cannot establish a connection with the virtual disk server.

ldm add-vdisk [timeout=seconds] [id=disk-id] disk-name volume-name@service-name ldom

where:

Set Options for a Virtual Disk

This subcommand sets options for a virtual disk in the specified logical domain. An optional timeout property allows you to specify a timeout for a virtual disk if it cannot establish a connection with the virtual disk server.

ldm set-vdisk [timeout=seconds] [volume=volume-name@service-name] disk-name ldom

where:

Remove a Virtual Disk

This subcommand removes a virtual disk from the specified logical domain.

ldm rm-vdisk [-f] disk-name ldom

where:

Virtual Data Plane Channel – Service

Add a Virtual Data Plane Channel Service

This subcommand adds a virtual data plane channel service to the specified logical domain. This subcommand should only be used in a Netra Data Plane Software (NDPS) environment.

ldm add-vdpcs vdpcs-service-name ldom

where:

Remove a Virtual Data Plane Channel Service

This subcommand removes a virtual data plane channel service. This subcommand should only be used in a Netra Data Plane Software (NDPS) environment.

ldm rm-vdpcs [-f] vdpcs-service-name

where:

Virtual Data Plane Channel – Client

Add a Virtual Data Plane Channel Client

This subcommand adds a virtual data plane channel client to the specified logical domain. This subcommand should only be used in a Netra Data Plane Software (NDPS) environment.

ldm add-vdpcc vdpcc-name vdpcs-service-name ldom

where:

Remove a Virtual Data Plane Channel Client

This subcommand removes a virtual data plane channel client from the specified logical domain. This subcommand should only be used in a Netra Data Plane Software (NDPS) environment.

ldm rm-vdpcc [-f] vdpcc-name ldom

where:

Virtual Console

Add a Virtual Console Concentrator

This subcommand adds a virtual console concentrator to the specified logical domain.

ldm add-vcc port-range=x-y vcc-name ldom

where:

Set Options for a Virtual Console Concentrator

This subcommand sets options for a specific virtual console concentrator.

ldm set-vcc port-range=x-y vcc-name

where:

Remove a Virtual Console Concentrator

This subcommand removes a virtual console concentrator from the specified logical domain.

ldm rm-vcc [-f] vcc-name

where:


Caution

Caution - The -f option attempts to unbind all clients before removal, which might cause loss of data if writes are in progress.


Set Options for a Virtual Console

This subcommand sets a specific port number and group in the specified logical domain. You can also set the attached console's service. This subcommand can be used only when a domain is inactive.

ldm set-vcons [port=[port-num]] [group=group] [service=vcc-server] ldom

where:

Physical Functions and Virtual Functions

Virtual Functions

The PCIe single-root I/O virtualization (SR-IOV) standard enables the efficient sharing of PCIe devices among I/O domains. This standard is implemented in the hardware to achieve near-native I/O performance. SR-IOV creates a number of virtual functions that are virtualized instances of the physical device or function. The virtual functions are directly assigned to I/O domains so that they can share the associated physical device and perform I/O without CPU and hypervisor overhead.

PCIe physical functions have complete access to the hardware and provide the SR-IOV capability to create, configure, and manage virtual functions. A PCIe component on the system board or a PCIe plug-in card can provide one or more physical functions. An Oracle Solaris driver interacts with the physical functions that provide access to the SR-IOV features.

PCIe virtual functions contain the resources that are necessary for data movement. An I/O domain that has a virtual function can access hardware and perform I/O directly by means of an Oracle Solaris virtual function driver. This behavior avoids the overhead and latency that is involved in the virtual I/O feature by removing any bottlenecks in the communication path between the applications that run in the I/O domain and the physical I/O device in the root domain.

Some of these commands require that you specify an identifier for a physical function or virtual function as follows:

pf-name ::= pf-pseudonym | pf-path
vf-name ::= vf-pseudonym | vf-path

Use the pseudonym form when referring to a corresponding device. This is the form of the name that is shown in the NAME column of the ldm list-io output. When you run the ldm list-io -l command, the path form of the name appears in the output. The ldm list-io -p output shows the pseudonym form as the value of the alias= token and the path form as the value of the dev= token.

Create a Virtual Function

This subcommand creates a virtual function from a specified physical function by incrementing the number of virtual functions in the specified physical function by one. The new virtual function is assigned the highest number in the sequence of virtual function numbers. When you create a new virtual function, a delayed reconfiguration is initiated for the primary domain.

Network class virtual functions must have a MAC address assigned, which is assigned by default. To override the default MAC address value, specify another value for the mac-addr property.

You can also set class-specific properties and device-specific properties when you create a virtual function. This command succeeds only when the physical function driver successfully validates the resulting configuration. By default, a new virtual function is not assigned to any domain. The virtual function can only be assigned (bound) to an I/O domain after the primary domain is rebooted and the virtual function is instantiated in the hardware. Plan ahead by determining whether you want to create multiple virtual functions. If you do, create them one after the other to avoid performing multiple reboots.

The device-specific properties depend on the properties that are exported by the physical function driver. For more information, use the ldm list-io -d command. When the command is successful, you see a message about a delayed reconfiguration.

ldm create-vf [mac-addr=num] [alt-mac-addrs=auto|num1,[auto|num2,...]] [pvid=port-vlan-id] [vid=vlan-id1,vlan-id2,...] [mtu=size] [name=value...] pf-name

where:

Destroy a Virtual Function

This subcommand destroys a virtual function from the specified physical function. This command succeeds only if the following are true:

ldm destroy-vf vf-name

where vf-name is the name of the virtual function.

Variables

Add Variable

This subcommand adds one or more variables for a logical domain.

ldm add-var var-name=[value]... ldom

where:

Set Variable

This subcommand sets variables for a logical domain.

ldm set-var var-name=[value]... ldom

where:


Note - Leaving value blank, sets var-name to no value.


Remove Variable

This subcommand removes a variable for a logical domain.

ldm rm-var var-name... ldom

where:

Other Operations

Start Domains

This subcommand starts one or more logical domains.

ldm start -a
ldm start -i file
ldm start ldom...

where:

Stop Domains

This subcommand stops one or more running logical domains. The subcommand sends a uadmin request to the logical domain if the Oracle Solaris OS is booted. to stop a domain in a more “graceful” manner, perform a shutdown or init operation in the domain that you want to stop. See the shutdown(1M) and init(1M) man page.

ldm stop [-f] -a
ldm stop [-f] ldom...

where:

Panic Oracle Solaris OS

This subcommand panics the Oracle Solaris OS on a specified logical domain, which provides a back trace and crash dump if you configure the Oracle Solaris OS to do that. The dumpadm(1M) command provides the means to configure the crash dump.

ldm panic ldom

ldom specifies the logical domain to panic.

Provide Help Information

This subcommand provides usage for all subcommands or the subcommand that you specify. You can also use the ldm command alone to provide usage for all subcommands.

ldm --help [subcommand]

subcommand specifies the ldm subcommand about which you want usage information.

Provide Version Information

This subcommand provides version information.

ldm --version
ldm -V
Bind Resources to a Domain

This subcommand binds, or attaches, configured resources to a logical domain.

ldm bind-dom [-f] [-q] -i file
ldm bind-dom [-f] [-q] ldom

where:

Unbind Resources From a Domain

This subcommand releases resources bound to configured logical domains.

ldm unbind-dom ldom

ldom specifies the logical domain from which to unbind resources.

Configure Operations

Add a Logical Domain Configuration

This subcommand adds a logical domain configuration, either based on the currently active configuration or on a previously autosaved configuration. The configuration is stored on the service processor (SP).

ldm add-config config-name
ldm add-config -r autosave-name [new-config-name]

where:

Set a Logical Domain Configuration

This subcommand enables you to specify a logical domain configuration to use. The configuration is stored on the SP.

ldm set-config config-name

config-name is the name of the logical domain configuration to use.

The default configuration name is factory-default. To specify the default configuration, use the following:

ldm set-config factory-default
Remove a Logical Domain Configuration

This subcommand removes a logical domain configuration that is stored on the SP, as well as any corresponding autosave configuration from the control domain.

ldm rm-config [-r] config-name

where:

List Operations

List Domains and States

This subcommand lists logical domains and their states. If you do not specify a logical domain, all logical domains are listed.

ldm ls-dom [-e] [-l] [-o format] [-p][ [ldom...]

where:

List Bindings for Domains

This subcommand lists bindings for logical domains. If no logical domains are specified, all logical domains are listed.

ldm ls-bindings [-e] [-p] [ldom...]

where:

List Services for Domains

This subcommand lists all the services exported by logical domains. If no logical domains are specified, all logical domains are listed.

ldm ls-services [-e] [-p] [ldom...]

where:

List Constraints for Domains

This subcommand lists the constraints for the creation of one or more logical domains. If no logical domains are specified, all logical domains are listed.

ldm ls-constraints [-x] [ldom...]
ldm ls-constraints [-e] [-p] [ldom...]

where:

List Devices

This subcommand lists either free (unbound) resources or all server resources. The default is to list all free resources.

ldm ls-devices [-a] [-p] [core] [cpu] [crypto] [memory] [io]

where:

In the power management column (PM) or field (pm=), yes means that the CPU thread is power-managed, and no means that the CPU thread is powered on. It is assumed that 100 percent-free CPUs are power-managed by default.

List I/O Devices

This subcommand lists the I/O devices that are configured on the system. The list of devices includes I/O buses (including NIUs) and direct I/O-assignable devices.

The output is divided into the following sections:

ldm list-io [-l] [-p] [pf-name] ldm list-io -d pf-name

where:

List Logical Domain Configurations

This subcommand lists the logical domain configurations stored on the service processor (SP).

ldm ls-config [-r [autosave-name]]

-r [autosave-name] lists those configurations for which autosave files exist on the control domain. If autosave-name is specified, it only reports on autosave-name. The output also notes whether an autosave file is newer than the corresponding SP configuration.


Note - When a delayed reconfiguration is pending, the configuration changes are immediately autosaved. As a result, if you run the ldm ls-config -r command, the autosave configuration is shown as being newer than the current configuration.


List Variables

This subcommand lists one or more variables for a logical domain. To list all variables for a domain, leave the var-name blank.

ldm ls-var [var-name...] ldom

where:

Add, Set, and Remove Resource Management Policies

Add a Resource Management Policy

This subcommand enables you to add a resource management policy for one or more logical domains. A resource management policy consists of optional properties and their values.

You can enable a resource management policy in an active domain that supports CPU DR as long as power management is not using the elastic policy.

ldm add-policy [enable=yes|no] [priority=value] [attack=value] [decay=value] [elastic-margin=value] [sample-rate=value] [tod-begin=hh:mm[:ss]] [tod-end=hh:mm[:ss]] [util-lower=percent] [util-upper=percent] [vcpu-min=value] [vcpu-max=value] name=policy-name ldom...

where:

Modify a Resource Management Policy

This subcommand enables you to modify a resource management policy for one or more logical domains by specifying values for optional properties.

ldm set-policy [enable=[yes|no]] [priority=[value]] [attack=[value]] [decay=[value]] [elastic-margin=[value]] [sample-rate=[value]] [tod-begin=[hh:mm:ss]] [tod-end=[hh:mm:ss]] [util-lower=[percent]] [util-upper=[percent]] [vcpu-min=[value]] [vcpu-max=[value]] name=policy-name ldom...

where:

Remove a Resource Management Policy

This subcommand enables you to remove a resource management policy from a logical domain by specifying one or more policy names.

ldm remove-policy [name=]policy-name... ldom

where:

Configure or Reconfigure a Domain From an XML File

This subcommand enables you to use an existing configuration to configure one or more guest domains, the control domain, or both types of domains. The ldm init-system command takes an XML file (such as the output of ldm ls-constraints -x) as input, configures the specified domains, and reboots the control domain. Run this command with the factory default configuration.

ldm init-system [-frs] -i file

where:

Examples

Example 1 Create Default Services

Set up the three default services, virtual disk server, virtual switch, and virtual console concentrator so that you can export those services to the guest domains.

# ldm add-vds primary-vds0 primary
# ldm add-vsw net-dev=nxge0 primary-vsw0 primary
# ldm add-vcc port-range=5000-5100 primary-vcc0 primary

Example 2 List Services

You can list services to ensure they have been created correctly or to see what services you have available.

# ldm ls-services primary
VCC
    NAME         LDOM    PORT-RANGE
    primary-vcc0 primary 5000-5100
VSW
    NAME         LDOM    MAC             NET-DEV   DEVICE     DEFAULT-VLAN-ID PVID VID MODE
    primary-vsw0 primary 00:14:4f:f9:68:d0 nxge0 switch@0 1               1
VDS
    NAME         LDOM    VOLUME         OPTIONS      MPGROUP   DEVICE
    primary-vds0 primary

Example 3 Set Up the Control Domain Initially

The control domain, named primary, is the initial domain that is present when you install the Logical Domains Manager. The control domain has a full complement of resources, and those resources depend on what server you have. Set only those resources you want the control domain to keep so that you can allocate the remaining resources to the guest domains. Then save the configuration on the service processor. You must reboot so the changes take effect.

If you want to enable networking between the control domain and the other domains, you must plumb the virtual switch on the control domain. You must enable the virtual network terminal server daemon, vntsd(1M), to use consoles on the guest domains.

# ldm start-reconf primary
# ldm set-crypto 1 primary
# ldm set-vcpu 4 primary
# ldm set-mem 4G primary
# ldm add-config initial
# shutdown -y -g0 -i6
# ifconfig -a
# ifconfig vsw0 plumb
# ifconfig nxge0 down unplumb
# ifconfig vsw0 IP-of-nxge0 netmask netmask-of-nxge0 broadcast + up
# svcadm enable vntsd

Example 4 List Bindings

You can list bindings to see if the control domain has the resources you specified, or what resources are bound to any domain.

# ldm ls-bindings primary
NAME             STATE    FLAGS    CONS    VCPU  MEMORY  UTIL  UPTIME
primary          active   -t-cv            4     4G      12%   11m

MAC
    08:00:90:11:11:10

VCPU
    VID    PID    UTIL STRAND
    0      0      18%   100%
    1      1      13%   100%
    2      2     9.8%   100%
    3      3     5.4%   100%

MEMORY
    RA               PA             SIZE
    0x4000000        0x4000000      4G

IO
DEVICE           PSEUDONYM        OPTIONS
pci@400          pci_0
pci@500          pci_1
pci@400/pci@0/pci@9  PCIE2
pci@400/pci@0/pci@9  MB/SASHBA
pci@500/pci@0/pci@8  MB/NET0

VCC
    NAME             PORT-RANGE
    primary-vcc0     5000-5100

VSW
    NAME           MAC                 NET-DEV   DEVICE     MODE
    primary-vsw0   00:14:4f:f9:68:d0   nxge0   switch@0   prog,promisc

VDS
    NAME             VOLUME         OPTIONS          DEVICE
    primary-vds0

Example 5 Create a Logical Domain

Ensure that you have the resources to create the desired guest domain configuration, add the guest domain, add the resources and devices that you want the domain to have, set boot parameters to tell the system how to behave on startup, bind the resources to the domain, and save the guest domain configuration in an XML file for backup. You also might want to save the primary and guest domain configurations on the SC. Then you can start the domain, find the TCP port of the domain, and connect to it through the default virtual console service.

# ldm ls-devices
# ldm add-dom ldg1
# ldm add-vcpu 4 ldg1
# ldm add-mem 1g ldg1
# ldm add-vnet vnet1 primary-vsw0 ldg1
# ldm add-vdsdev /dev/dsk/c0t1d0s2 vol1@primary-vds0
# ldm add-vdisk vdisk1 vol1@primary-vds0 ldg1
# ldm set-var auto-boot\?=false ldg1
# ldm set-var boot-device=vdisk1 ldg1
# ldm bind-dom ldg1
# ldm ls-constraints -x ldg1 > ldg1.xml
# ldm add-config ldg1_4cpu_1G
# ldm start ldg1
# ldm ls -l ldg1
# telnet localhost 5000

Example 6 Use One Terminal for Many Guest Domains

Normally, each guest domain you create has its own TCP port and console. Once you have created the first guest domain (ldg1 in this example), you can use the ldm set-vcons command to attach all the other domains (second domain is ldg2 in this example) to the same console port. Note that the set-vcons subcommand works only on an inactive domain.

# ldm set-vcons group=ldg1 service=primary-vcc0 ldg2

If you use the ldm ls -l command after performing the set-vcons commands on all guest domains except the first, you can see that all domains are connected to the same port. See the vntsd(1M) man page for more information about using consoles.

Example 7 Add a Virtual PCI Bus to a Logical Domain

I/O domains are a type of service domain that have direct ownership of and direct access to physical I/O devices. The I/O domain then provides the service to the guest domain in the form of a virtual I/O device. This example shows how to add a virtual PCI bus to a logical domain.

# ldm add-io pci@7c0 ldg1

Example 8 Add Virtual Data Plane Channel Functionality for Netra Only

If your server has a Netra Data Plane Software (NDPS) environment, you might want to add virtual data plane channel functionality. First, you would add a virtual data plane channel service (primary-vdpcs0, for example) to the service domain, in this case, the primary domain.

# ldm add-vdpcs primary-vdpcs0 primary

Now that you have added the service to the service domain (primary), you can add the virtual data plane channel client (vdpcc1) to a guest domain (ldg1).

# add-vdpcc vdpcc1 primary-vdpcs0 ldg1

Example 9 Cancel Delayed Reconfiguration Operations for a Control Domain

A delayed reconfiguration operation blocks configuration operations on all other domains. There might be times when you want to cancel delayed configuration operations for a control domain. For example, you might do this so that you can perform other configuration commands on that domain or other domains. With this command, you can undo the delayed reconfiguration operation and do other configuration operations on this or other domains.

# ldm cancel-op reconf primary

Example 10 Migrate a Domain

You can migrate a logical domain to another machine. This example shows a successful migration.

# ldm migrate ldg1 root@dt90-187:ldg
Target password:

Example 11 List Configurations

The following examples show how to view the configurations. The first command shows the configurations that are stored on the SP. The second command shows the configurations on the SP as well as information about the autosave configurations on the control domain.

# ldm ls-config
factory-default
3guests [current]
data1
reconfig_primary
split1
# ldm ls-config -r
3guests [newer]
data1 [newer]
reconfig_primary
split1
unit

Both the current 3guests configuration and the data1 configuration have autosaved changes that have not been saved to the SP. If the system is powercycled while in this state, the Logical Domains Manager would perform the 3guests autosave recovery based on the specified policy. The autosave recovery action is taken for 3guests because it is marked as current.

The reconfig_primary and split1 autosave configurations are identical to the versions on the SP, not newer versions.

The unit configuration only exists as an autosave configuration on the control domain. There is no corresponding configuration for unit on the SP. This situation might occur if the configuration was lost from the SP. A configuration can be lost if the SP is replaced or if a problem occurred with the persistent version of the configuration on the SP. Note that using the rm-config command to explicitly remove a configuration also removes the autosave version on the control domain. As a result, no remnants of the configuration remain on either the control domain or on the SP.

Example 12 List I/O Devices

The following example lists the I/O devices on the system. The first section shows information about the PCIe bus on the primary domain. The second section shows information about the direct I/O-assignable devices.

# ldm ls-io
IO              PSEUDONYM       DOMAIN          
--              ---------       ------          
pci@400         pci_0           primary         
pci@500         pci_1           primary         

PCIE                 PSEUDONYM  STATUS  DOMAIN
----                 ---------  ------  ------
pci@400/pci@0/pci@c  PCIE1      EMP     -
pci@400/pci@0/pci@9  PCIE2      OCC     ldg1
pci@400/pci@0/pci@d  PCIE3      OCC     ldg2
pci@400/pci@0/pci@8  MB/SASHBA  OCC     primary
pci@500/pci@0/pci@9  PCIE0      EMP     -
pci@500/pci@0/pci@d  PCIE4      OCC     ldg2
pci@500/pci@0/pci@c  PCIE5      OCC     ldg1
pci@500/pci@0/pci@8  MB/NET0    OCC     primary

Exit Status

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

Attributes

See the attributes(5) man page for a description of the following attributes.

Attribute Type
Attribute Value
Availability
SUNWldm
Interface Stability
Uncommitted

See Also

dumpadm(1M), ifconfig(1M), shutdown(1M), vntsd(1M), attributes(5)

Oracle VM Server for SPARC 2.2 Administration Guide