Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

virtinfo(8)

Name

virtinfo - virtual environment information

Synopsis

virtinfo [-c {<class>[,...] | all}] [<subcommand>] 
  list [[-H] -o <field>[,...]] [<environment>] ... 
  get  [[-H] -o <field>[,...]] {all | <property>[,...]}
     [<environment>] ...

Description

The virtinfo utility provides virtualization information returned by libv12n(3LIB) about the current environment, parent environment and a list of supported environments. If no options are specified, virtinfo performs the equivalent of virtinfo list.

Options

The virtinfo command supports the following option:

–c

Choose from available virtual environment classes: current, parent, supported, or unsupported.

Without the –c option, all classes are assumed.

Sub Commands

The virtinfo command supports the following subcommands:

list [[–H] –o < field>[,...]] [<environment>] ...

Lists all virtual environments from chosen environment classes. The list can be limited by listing environments of interest. For each environment the following fields are displayed:

name

Environment name

class

Environment class. It can be current, parent, supported, or unsupported.

–H

Used for scripting mode. This option does not print headers and separates fields by a single tab instead of arbitrary white space.

–o field

Displays a comma-separated list of fields.

get [[–H] –o < field>[,...]] {all | <property>[,...]}
[<environment>] ...

Retrieve a property of an environment. Properties are environment and class specific. For example an LDoms supported environment may support different properties to an LDoms current environment. The environment list to query can be limited by listing environments of interest.

For each property the following fields are displayed:

name

Environment name

class

Environment class

property

Property name

value

Property value

–H

Used for scripting mode. This option does not print headers and separates fields by a single tab instead of arbitrary white space.

–o field

Displays a comma-separated list of fields.

If the subcommand is used to print selected properties (i.e. all is not used), all possible combinations of chosen classes and virtual environments, and selected properties are assumed and virtinfo errors out on the first invalid combination it iterates through. No partial output consisting of remaining valid combinations of a class, virtual environment, and property is printed in such a situation.

Exit Status

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

Examples

Example 1 Viewing Default Information

The following example shows the default output:

$ virtinfo
NAME            CLASS      
logical-domain  current    
logical-domain  parent     
non-global-zone supported  
kernel-zone     supported  
logical-domain  unsupported

The current domain is an LDoms guest domain. Both non-global zones and kernel-zones are supported as guests. Non-control logical domains always show logical-domain as the parent. LDoms guests cannot be created as guests.

Example 2 Getting All Properties for all Classes and Virtual Environments from within a Kernel Zone Virtual Environment

By providing all properties, the following example shows that the kernel-zone virtual environment is not supported from within Kernel Zones, and its status property provides the reason why not. It also shows that the solaris branded Zones are supported. As this example is run on bare metal x86 architecture, there is no parent class virtual environment.

$ virtinfo get all
NAME            CLASS       PROPERTY VALUE
kernel-zone     current     zonename bumblebee
non-global-zone supported   -        -
kernel-zone     unsupported status   not supported in kernel-zone
Example 3 Check to see if Kernel Zones are Supported

The following example shows how to check if the current environment is capable of supporting a Kernel Zone:

$ virtinfo -c supported list kernel-zone
NAME          CLASS
kernel-zone   supported
Example 4 Viewing All LDoms Properties in a Parsable Format

The following example shows all available information about an LDoms environment in a parsable format:

$ virtinfo -c current get -H -o property,value all logical-domain
control-role    true
io-role true
root-role       true
service-role    true
domain-name     primary
uuid    da64f9b8-3e37-688e-cc3f-e90a59db1ad
control-name    leftarrow
chassis-serial-number   1228BDY5D4
Example 5 Selecting a Property not Supported in Every Combination of a Class and Virtual Environment

The following example fails as the non-global-zone virtual environment in the supported class has no zonename property. As explained in the get subcommand section, if specific properties are queried, virtinfo errors out on the first invalid combination of a class, environment, and property.

$ virtinfo get zonename
virtual environment 'non-global-zone' in class 'supported' does not
support property: zonename

However, as the zonename property is supported for the kernel-zone environment in the current class if queried from within a Kernel Zone, we can narrow down the query. Note that you can always use get all to print only valid combinations of chosen classes and virtual environments with all available properties.

$ virtinfo -c current get zonename kernel-zone
NAME        CLASS   PROPERTY VALUE
kernel-zone current zonename kz1
Example 6 From Within a Kernel Zone, Only Print the Current Virtual Environment zonename Property Value

This command line prints the Kernel Zone name as used in the host.

$ virtinfo -c current get -H -o value zonename kernel-zone
kz1

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/library/libv12n
Interface Stability
Uncommitted

See Also

libuuid(3LIB), libv12n(3LIB)