xcat-core/xCAT-client/pods/man1/lsve.1.pod
daniceexi e83a221388 refine the man page
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/branches/2.7@13870 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
2012-09-21 02:12:01 +00:00

184 lines
3.8 KiB
Plaintext

=head1 NAME
B<lsve> - Lists detail attributes for a virtual environment.
=head1 SYNOPSIS
B<lsve> [B<-t> type] [B<-m> manager] [B<-o> object]
=head1 DESCRIPTION
The B<lsve> command can be used to list a virtual environment for
'Data Center', 'Cluster', 'Storage Domain', 'Network' and 'Template' objects.
The mandatory parameter B<-m manager> is used to specify the address of the
manager of virtual environment. xCAT needs it to access the RHEV manager.
The mandatory parameter B<-t type> is used to specify the type of the target
object.
Basically, B<lsve> command supports three types of object: B<dc>, B<cl>, B<sd>, B<nw>
and B<tpl>.
The parameter B<-o object> is used to specify which object to list. If no B<-o> is specified,
all the objects with the B<-t> type will be displayed.
=head1 OPTIONS
=over 2
=item B<-h>
Display usage message.
=item B<-m>
Specify the manager of the virtual environment.
For RHEV, the FQDN (Fully Qualified Domain Name) of the rhev manager have to be specified.
=item B<-o>
The target object to display.
=item B<-t>
Specify the B<type> of the target object.
Supported types:
B<dc> - Data Center (For type of 'dc', all the elements belongs to the data
center will be listed.)
B<cl> - Cluster
B<sd> - Storage Domain (To get the status of Storage Doamin, show it from
I<data center> it attached to.
B<nw> - Network
B<tpl> - Template
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
=over 2
=item 1.
To list the data center 'Default', enter:
lsve -t B<dc> -m <FQDN of rhev manager> -o Default
Output is similar to:
datacenters: [Default]
description: The default Data Center
state: up
storageformat: v1
storagetype: nfs
clusters: [Default]
cpu: Intel Westmere Family
description: The default server cluster
memory_hugepage: true
memory_overcommit: 100
storagedomains: [image]
available: 55834574848
committed: 13958643712
ismaster: true
status: active
storage_add: <Address of storage domain>
storage_format: v1
storage_path: /vfsimg
storage_type: nfs
type: data
used: 9663676416
networks: [rhevm2]
description:
state: operational
stp: false
networks: [rhevm]
description: Management Network
state: operational
stp: false
templates: [Blank]
bootorder: hd
cpucore: 1
cpusocket: 1
creation_time: 2008-04-01T00:00:00.000-04:00
display: spice
memory: 536870912
state: ok
stateless: false
type: desktop
=item 2.
To list the cluster 'Default', enter:
lsve -t B<cl> -m <FQDN of rhev manager> -o Default
Output is similar to:
cpu: Intel Westmere Family
description: The default server cluster
memory_hugepage: true
memory_overcommit: 10
=item 3.
To list the Storage Domain 'image', enter:
lsve -t B<sd> -m <FQDN of rhev manager> -o image
Output is similar to:
storagedomains: [image]
available: 55834574848
committed: 13958643712
ismaster: true
status:
storage_add: <Address of storage domain>
storage_format: v1
storage_path: /vfsimg
storage_type: nfs
type: data
used: 9663676416
=item 4.
To list the network 'rhevm', enter:
lsve -t B<nw> -m <FQDN of rhev manager> -o rhevm
Output is similar to:
networks: [rhevm]
description: Management Network
state: operational
stp: false
=item 5.
To list the template 'tpl01', enter:
lsve -t tpl -m <FQDN of rhev manager> -o tpl01
Output is similar to:
templates: [tpl01]
bootorder: network
cpucore: 2
cpusocket: 2
creation_time: 2012-08-22T23:52:35.953-04:00
display: vnc
memory: 1999634432
state: ok
stateless: false
type: server
=back
=head1 FILES
/opt/xcat/bin/lsve
=head1 SEE ALSO
L<cfgve(1)|cfgve.1>