Symantec logo

vxvmprint

NAME

vxvmprint - Print VERITAS SAN Volume Manager Storage Object properties

SYNOPSIS

vxvmprint [-ADFghHlmnopqrst] :object_type[object_name...] [object_type [object_name],...]] [:on {:object_type[object_name...] [+:object_type[object_name...] [:object_type[object_name...]] ...]} ] [:select {:attribute_name[=attribute_value] [+attribute_name[=attribute_value]...] ...]} ]

DESCRIPTION

The vxvmprint command prints the components of a storage network. It allows distributed listing of storage object's properties. As with vxvm, this command relies on the VERITAS Enterprise Administrator (VEA) infrastructure to provide a distributed framework.

If the host on which this command is executed is in a GCS domain, then the scope of this command is GCS. But, if the host is not in a GCS domain then, its scope is local host. Even if the host is in GCS domain, you can print the objects of a particular host (volume manager, volume client, or volume server), using the -h hostname option. When the -h hostname option is specified, vxvmprint prints all the diskgroups (private, shared and SAN) imported on that host.

vxvmprint provides the following object type: :object_type [object_name...] - named objects of type :object_type [object_type...] - all objects of type :object_type :on {...} - objects of type on listed objects :object_type :select {attribut=attribute_value +...} - objects of type with listed attributes.

You can directly list the objects of a specific type or a specific object of a particular type by specifying the object type and/or name as follows:

vxvmprint :volume - Prints information about all the volumes from SANVM disk groups.

vxvmprint :volume:vol1 vol2 - Prints information about volume vol1 and vol2 in any of the SANVM disk groups.

Each object type is preceded by a ':' (colon) and if there are any arguments to the object type then it is followed by a space. The two previous examples depict how you can specify only object type and object type combined with object name.

You can specify multiple object types and multiple objects to be printed through the same command.

vxvmprint :volume :disk - Prints all the volumes in SANVM disk groups and disks in a domain.


  Note    If the keyword is followed by a space, then all the following arguments (space separated) are considered to be arguments to this keyword. The argument list to keyword continues until it meets an argument that starts with colon, which is treated as a new keyword and not an argument. For example:


vxvmprint :volume vol1 vol2 vol3 :disk:d1

Here, vol1, vol2 and vol3 are arguments to keyword volume and d1 is argument to keyword disk.

You can list and print objects that have particular relationship between each other by using the on clause. Anything inside the curly braces following on forms the condition for the search of the object types mentioned before the on clause. Multiple conditions inside curly braces can be combined using a plus (+) sign or a space. + means the output set must match all the conditions (intersection) that are combined using + sign. Space means output set can match any one of the conditions (unions) that are combined using space inside curly braces. Conditions are formed of object types and object names in case of on clause. The same syntax that applies for specifying the object type and names outside the on clause applies to the conditions inside the clause. Examples showing how to use on clause can be found in the SAN Volume Manager Administrator's Guide.

You can list and print objects that have specific attributes by using the select clause. Anything inside the curly braces following select forms the condition for the search of the object types mentioned before the select clause. Multiple conditions inside curly braces can be combined using plus (+) sign or a space. + means the output set must match all the conditions (intersection) that are combined using + sign. Space means output set can match any one of the conditions (union) that are combined using space inside curly braces. Conditions are formed of attribute name and value pairs. You can specify only one value of attribute in a given name-value pair. If there are more than one values of a given attribute then it should be specified as different name-value pairs. Syntax for specifying attribute name-value pair is as follows: attribute_name [<|>|=|>=|<=attribute_value]. Examples showing how to use select clause can be found in the SAN Volume Manager Administrator's Guide.

KEYWORDS

vxvm print has the following keywords and options:

-A

Display all active records (imported disk groups)

-D domain

Specifies the physical management domain or logical structure domain

-f object_type,object_type:format

For given types, use the given format.

-F [object_type:]string %{field:-10s}

Set explicit format for record.

-g dgname

Name of the disk group.

-h hostname

Host from which the objects have to be retrieved.

-H

Display usage help.

-l

Print in long format (property page).

-m gcshostname

The GCS host name.

-n

Print only record names.

-o output_type

Specifies how the data should be represented in output. By default, the output is always in tabular format. There might be some output types that do not output the data to standard output but redirect it to something else - for example, create a XML output and redirect it to file.

-p

Print performance statistics.

-q

Suppress header in report.

-r

Print all the related objects (children) to the objec.

-s [object_type:]order

Sorting order.

-t

Print the hierarchical information.

Object types

vxvmprint supports the following output types:

capability | cp capability_name

Displays all or specified capabilities from target volume server.

nodetype:{vm | vs | vc}

Displays node of specific type.

node[:nodename]

Display properties of all/specified nodes.

volumeserverset | vsset[:vssetname]

Display all/specified volume server set records.

diskgroup | dg [:dg_name]

Display the properties of a disk group. If dg_name is not specified, all disk groups that match the criteria are displayed. Disk group can also be specified using -g dgname option.

dgtype:{private | san | shared}

Display disk groups of the specified type.

disk | d [:disk_name]

Display disk properties. disk_name can be either daname or dmname.

pooldefinition | pd [pooldefinition_name]

Display all or specified pool definitions from target volume server.

poolset | ps [poolset_name]

Display all or specified pool sets from target volume server.

storagepool | sp [pool_name]

Display all/specified storage pools from disk groups.

subdisk[:subdisk_name]

Display all/specified subdisk records.

plex[:plex_name]

Display plex information for the specified disk group. If the disk group name is not specified, plexes under all disk groups are displayed.

templateset | ts [templateset_name]

Display all or specified template sets for target volume server.

usertemplate | ut [usertemplate_name]

Display all or specified user templates from target volume server.

volume[:vol_name]

Display the properties of all volumes, or a specified Volume, including volume sets. Only usable volumes (volumes that have device path for applications to use) are displayed.

volumeset | volset | vset [volumeset_name]

Display all or specified volume set records for target host.

volumetemplate | vt [template_name]

Display all or specified volume templates from target volume server.

hacomm

Display HACOMM information. Only the select clause is supported for the hacomm object type.

OUTPUT FORMATS

The following output format is for tabular output plug-in. This is the default output format. It can also be specified using the -o table option.

node and nodetype options: display nodes

$ vxvmprint :node (print all nodes) $ vxvmprint :nodetype vc (print information about all volume clients)
Nodes:

TYPE NAME VSS SET ROLES STATE
host svm3 - vc -
host svm4 eng_vsset vsvcvm not_synced

-----------------------------description of each field----------------------------
Nodes:

TYPE: type "host"
NAME: hostname
VS SET: vsset_name
ROLES: roles {vs, vc, vsvc, vsvm, vcvm, vsvcvm}
STATE: state {"-" | "normal" | "not_synced" | "down" | "prov_down"}

vsset option

Display vssets and their children, volume servers and disk groups (distributed only).

$vxvmprint :vsset

TYPE NAME
vsset vsset1

dgtype, diskgroup options: display disk groups and their children

$ vxvmprint :diskgroup (prints all SAN diskgroups) $ vxvmprint :dgtype san

TYPE NAME SUBTYPE ASSOC SUBASSOC/LENGTH STATE
dg gcshadg san - - IMPORTED
-----------------------------description of each field----------------------------------

Diskgroup:
TYPE: dg
NAME: dg_name {name of diskgroup}
ASSOC: dg name
SUBASSOC/LENGTH: number of blocks
STATE: state {IMPORTED/DEPORTED}

Display volumes

$ vxvmprint :volume

TYPE NAME ASSOC SUBASSOC/LENGTH STATE
vol volname1 dg1 32200 ACTIVE
vol volname2 dg1 34656 ACTIVE

---------------------description of each field------------------------------------

Volume:
TYPE: vol
NAME: vol_name {name of volume}
ASSOC: dg name
SUBASSOC/LENGTH: number of blocks
STATE: state {ACTIVE | STARTED | STOPPED | UNINITIALIZED | UNUSABLE | DEGRADED}

Display plexes

$ vxvmprint :plex

TYPE NAME ASSOC SUBASSOC/LENGTH STATE
pl volname1-01 volname1 32200 ACTIVE
pl volname2-01 volname1 34656 ACTIVE

---------------------description of each field---------------------------------------

Plex:
TYPE: pl
NAME: plex_name {name of plex}
ASSOC: volume name
SUBASSOC/LENGTH: number of blocks
STATE: state {ACTIVE | STARTED | STOPPED | UNINITIALIZED | UNUSABLE | DEGRADED}

Display subdisks

$ vxvmprint :subdisk

TYPE NAME ASSOC SUBASSOC/LENGTH STATE
sd dmname1-01 volname1-01 32200 ACTIVE
sd dmname2-01 volname1-01 34656 ACTIVE

---------------------description of each field------------------------------------

Subdisk:
TYPE: sd
NAME: subdisk_name {name of subdisk}
ASSOC: plex name
SUBASSOC/LENGTH: number of blocks
STATE: -

Display disks

$ vxvmprint :disk

TYPE NAME ASSOC SUBASSOC/LENGTH
dm dmname1 dg1 32200
dm dmname2 dg2 34656

---------------------description of each field------------------------------------

Disk:
TYPE: dm
NAME: disk media name
ASSOC: diskgroup name
SUBASSOC/LENGTH: number of blocks
Display storage pools

$ vxvmprint [-g dgname] :storagepool

TYPE NAME ASSOC STATE
st sp1 dg1 DATA
st sp2 dg2 CLONE

---------------------description of each field------------------------------------

Storage pool:
TYPE: st
NAME: storage pool name
ASSOC: diskgroup name
SUBASSOC/LENGTH: -
STATE: Type of storage pool {DATA | CLONE}

Display volume templates

$ vxvmprint [-g dgname] [-p poolname] [-C] :volumetemplate

TYPE NAME STATE AUTOINSTALL
vt template1 ACTIVE 0
vt template2 INACTIVE 3

---------------------description of each field------------------------------------

Volume template:
TYPE: vt
NAME: volume template name
STATE: {ACTIVE | INACTIVE}
AUTOINSTALL: Indicates whether template is auto installed. 0 means manually installed non-zero value means auto installed.
Display capabilities

$ vxvmprint [-g dgname] [-p poolname] [-C] :capability

TYPE NAME
cp cap1
cp cap2

---------------------description of each field------------------------------------

Capability:
TYPE: cp
NAME: capability name

Display template sets

$ vxvmprint [-C] :templateset

TYPE NAME
ts ts1
ts ts2

---------------------description of each field------------------------------------

Template set:
TYPE: ts
NAME: Template set name

Display pool sets

$ vxvmprint [-C] :poolset

TYPE NAME
ps ps1
ps ps2

---------------------description of each field------------------------------------

Pool set:
TYPE: ps
NAME: Pool set name

Display pool definitions

$ vxvmprint [-C] :pooldefinition

TYPE NAME
pd pd1
pd pd2

---------------------description of each field------------------------------------

Pool definition:
TYPE: pd
NAME: Pool definition name

Display user templates

$ vxvmprint [-h hostname] :usertemplate

TYPE NAME
ut ut1
ut ut2

---------------------description of each field------------------------------------

User template:
TYPE: ut
NAME: User template name

.br