Add man pages for rhev commands
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@13618 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
daniceexi
parent
ce0980f030
commit
15dd2b9ad2
167
xCAT-client/pods/man1/cfghost.1.pod
Normal file
167
xCAT-client/pods/man1/cfghost.1.pod
Normal file
@ -0,0 +1,167 @@
|
||||
=head1 NAME
|
||||
|
||||
B<cfghost> - Configure the RHEV hosts for a virtual environment.
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<cfghost> I<noderange> [B<-a>]
|
||||
|
||||
B<cfghost> I<noderange> [B<-n>]
|
||||
|
||||
B<cfghost> I<noderange> [B<-p>]
|
||||
|
||||
B<cfghost> I<noderange> [B<-e>]
|
||||
|
||||
B<cfghost> I<noderange> [B<-d>]
|
||||
|
||||
B<cfghost> I<noderange> [B<-r> B<-f>]
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<cfghost> command can be used to configure the RHEV-h host.
|
||||
|
||||
The rhev-h host will register to the rhev-m automatically, but admin needs to
|
||||
approve the host can be added to the 'cluster' with B<-a> flag .
|
||||
|
||||
After registering, the network interfaces of host need to be added to the 'network' of
|
||||
RHEV. And the power management for the host should be configured so that
|
||||
rhev-m could make proper decision when certain host encountered error.
|
||||
|
||||
For each host, an entry should be added to the hypervisor table:
|
||||
|
||||
The columns of hypervisor table:
|
||||
|
||||
=over 2
|
||||
|
||||
B<hypervisor.node> - rhev-h host name.
|
||||
|
||||
B<hypervisor.type> - Must be set to 'rhevh'.
|
||||
|
||||
B<hypervisor.mgr> - The rhev manager (The FQDN of rhev-m server) for the host.
|
||||
|
||||
B<hypervisor.interface> - The configuration for the nics. Refer to B<-n>.
|
||||
|
||||
B<hypervisor.cluster> - The cluster that the host will be added to. The
|
||||
default is 'Default' cluster if not specified.
|
||||
|
||||
=back
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
=over 2
|
||||
|
||||
=item B<-a>
|
||||
Approve the host that to be added to cluster.
|
||||
|
||||
Before approve, the status of the host must be 'pending_approval'.
|
||||
|
||||
=item B<-n>
|
||||
Configure the network interfaces for the host.
|
||||
|
||||
Note: This operation only can be run when host is in 'maintenance mode'.
|
||||
Use B<-d> to switch the host to 'maintenance' mode.
|
||||
|
||||
The interfaces which configured in hypervisor.interface will be added
|
||||
to the network of RHEV.
|
||||
|
||||
The format of hypervisor.interface is multiple [network:interfacename:
|
||||
protocol:IP:netmask:gateway] sections separated with '|'. For example:
|
||||
[rhevm2:eth0:static:10.1.0.236:255.255.255.0:0.0.0.0].
|
||||
|
||||
=over 2
|
||||
|
||||
B<network> - The logic network which has been created by 'cfgve -t nw'
|
||||
or the default management network 'rhevm'.
|
||||
|
||||
B<interfacename> - Physical network name: 'eth0','eth1'...
|
||||
|
||||
B<protocol> - To identify which boot protocol to use for the interface: dhcp
|
||||
or static.
|
||||
|
||||
B<IP> - The IP address for the interface.
|
||||
|
||||
B<netmask> - The network mask for the interface.
|
||||
|
||||
B<gateway> - The gateay for the interface. This field only can be set when
|
||||
the interface is added to 'rhevm' network.
|
||||
|
||||
=back
|
||||
|
||||
=item B<-p>
|
||||
Configure the power management for the host.
|
||||
|
||||
The power management must be configured for the rhev-h host to make the
|
||||
rhev-m to monitor the power status of the host, so that when certain host
|
||||
failed to function, rhev-m will fail over certain role like SPM to other active host.
|
||||
|
||||
For rack mounted server, the bmc IP and user:password need to be set for the
|
||||
power management (These parameters are gotten from ipmi table). rhev-m uses the
|
||||
ipmi protocol to get the power status of the host.
|
||||
|
||||
=item B<-e>
|
||||
To activate the host.
|
||||
|
||||
=item B<-d>
|
||||
To deactivate the host to maintenance mode.
|
||||
|
||||
=item B<-r>
|
||||
To remove hosts from the rhev-m.
|
||||
|
||||
The host should be deactivate to maintenance mode before the removing.
|
||||
|
||||
=item B<-f>
|
||||
It can be used with B<-r> to remove the target object by force.
|
||||
|
||||
For removing of host, if B<-f> is specified, the host will be deactivated to maintenance before the removing.
|
||||
|
||||
=item B<-h>
|
||||
Display usage message.
|
||||
|
||||
=back
|
||||
|
||||
=head1 RETURN VALUE
|
||||
|
||||
0 The command completed successfully.
|
||||
|
||||
1 An error has occurred.
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
=over 2
|
||||
|
||||
=item 1.
|
||||
To approve the host 'host1', enter:
|
||||
|
||||
cfghost host1 -a
|
||||
|
||||
=item 2.
|
||||
To configure the network interface for the host 'host1', enter:
|
||||
|
||||
cfghost host1 -n
|
||||
|
||||
=item 3.
|
||||
To configure the power management for the host 'host1', enter:
|
||||
|
||||
cfghost host1 -p
|
||||
|
||||
=item 4.
|
||||
To activate the host 'host1', enter:
|
||||
|
||||
cfghost host1 -e
|
||||
|
||||
=item 5.
|
||||
To deactivate the host 'host1', enter:
|
||||
|
||||
cfghost host1 -d
|
||||
|
||||
=item 6.
|
||||
To remove the host 'host1', enter:
|
||||
|
||||
cfghost host1 -r -f
|
||||
|
||||
=back
|
||||
|
||||
=head1 FILES
|
||||
|
||||
/opt/xcat/bin/cfghost
|
||||
|
||||
174
xCAT-client/pods/man1/cfgve.1.pod
Normal file
174
xCAT-client/pods/man1/cfgve.1.pod
Normal file
@ -0,0 +1,174 @@
|
||||
=head1 NAME
|
||||
|
||||
B<cfgve> - Configure the elements for a virtual environment.
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<cfgve> [B<-t> sd] [B<-m> manager] [B<-o> object] [B<-c> | B<-g> | B<-s>
|
||||
| B<-a> | B<-b> | B<-r> B<-f>]
|
||||
|
||||
B<cfgve> [B<-t> nw] [B<-m> manager] [B<-o> object] [B<-c> B<-d> data center
|
||||
| B<-r>]
|
||||
|
||||
B<cfgve> [B<-t> tpl] [B<-m> manager] [B<-o> object] [B<-r>]
|
||||
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<cfgve> command can be used to configure a virtual environment for
|
||||
'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<cfgve> command supports three types of object: B<sd>, B<nw>
|
||||
and B<tpl>.
|
||||
|
||||
=over 3
|
||||
|
||||
B<sd> - The B<create>, B<attach>, B<detach>, B<activate>,
|
||||
B<deactivate> and B<remove> operations are supported.
|
||||
|
||||
B<nw> - The B<create> and B<remove> operations are supported.
|
||||
|
||||
B<tpl> - The B<remove> operation is supported.
|
||||
|
||||
=back
|
||||
|
||||
The mandatory parameter B<-o object> is used to specify which object to configure.
|
||||
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
=over 2
|
||||
|
||||
=item B<-t>
|
||||
Specify the B<type> of the target object.
|
||||
|
||||
Supported types:
|
||||
B<sd> - Storage Domain
|
||||
B<nw> - Network
|
||||
B<tpl> - Template
|
||||
|
||||
=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 name of the target object.
|
||||
|
||||
=item B<-d>
|
||||
The name of data center.
|
||||
|
||||
Specify the 'Data Center' that will be used for the object to be attached to.
|
||||
It is used by <nw> type.
|
||||
|
||||
=item B<-c>
|
||||
To create the target object.
|
||||
|
||||
For creating of B<Storage Domain>, the target storage domain will be created
|
||||
first, then attached to data center and activated.
|
||||
|
||||
The parameters that used to create the storage domain are gotten
|
||||
from 'virtsd' table. The detail parameters in the virtsd table:
|
||||
|
||||
=over 3
|
||||
|
||||
B<virtsd.node> - The name of the storage domain.
|
||||
|
||||
B<virtsd.sdtype> - The type of storage domain. Valid value: data, iso, export.
|
||||
Default value is 'data'.
|
||||
|
||||
B<virtsd.stype> - The storage type. Currently only 'nfs' is supported.
|
||||
|
||||
B<virtsd.location> - The location of the storage. Format: [nfsserver:nfspath].
|
||||
The NFS export directory must be configured for read write access and must
|
||||
be owned by vdsm:kvm.
|
||||
|
||||
B<virtsd.host> - A host must be specified for a storage doamin as SPM
|
||||
(Storage Pool Manager) when initialize the storage domain. The role of SPM
|
||||
may be migrated to other host by rhev-m during the running of the datacenter
|
||||
(For example, when the current SPM encountered issue or going to maintenance
|
||||
status.
|
||||
|
||||
B<virtsd.datacenter> - The storage will be attached to. 'Default' data center
|
||||
is the default value.
|
||||
|
||||
=back
|
||||
|
||||
=item B<-g>
|
||||
To activate the target object.
|
||||
|
||||
=item B<-s>
|
||||
To deactivate the target object.
|
||||
|
||||
=item B<-a>
|
||||
To attach the target object.
|
||||
|
||||
=item B<-b>
|
||||
To detach the target object.
|
||||
|
||||
=item B<-r>
|
||||
To remove the target object.
|
||||
|
||||
For removing of B<Storage Domain>, the storage space will be formatted after removing.
|
||||
|
||||
=item B<-f>
|
||||
It can be used with B<-r> to remove the target object by force.
|
||||
|
||||
For removing of B<Storage Domain>, if B<-f> is specified, the storage domain will be deactivated and detached from data center before the removing.
|
||||
|
||||
=item B<-h>
|
||||
Display usage message.
|
||||
|
||||
=back
|
||||
|
||||
=head1 RETURN VALUE
|
||||
|
||||
0 The command completed successfully.
|
||||
|
||||
1 An error has occurred.
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
=over 2
|
||||
|
||||
=item 1.
|
||||
To create the Storage Domain 'sd1', enter:
|
||||
|
||||
cfgve -t sd -m <FQDN of rhev manager> -o sd1 -c
|
||||
|
||||
=item 2.
|
||||
To deactivate the Storage Domain 'sd1' from data center, enter:
|
||||
|
||||
cfgve -t sd -m <FQDN of rhev manager> -o sd1 -s
|
||||
|
||||
=item 3.
|
||||
To remove the Storage Domain 'sd1', enter:
|
||||
|
||||
cfgve -t sd -m <FQDN of rhev manager> -o sd1 -r
|
||||
|
||||
=item 4.
|
||||
To create the network 'nw1', enter:
|
||||
|
||||
cfgve -t nw -m <FQDN of rhev manager> -o nw1 -c
|
||||
|
||||
=item 5.
|
||||
To remove the template 'tpl01', enter:
|
||||
|
||||
cfgve -t tpl -m <FQDN of rhev manager> -o tpl01 -r
|
||||
|
||||
=back
|
||||
|
||||
=head1 FILES
|
||||
|
||||
/opt/xcat/bin/cfgve
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<lsve(1)|lsve.1>
|
||||
181
xCAT-client/pods/man1/lsve.1.pod
Normal file
181
xCAT-client/pods/man1/lsve.1.pod
Normal file
@ -0,0 +1,181 @@
|
||||
=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 mandatory parameter B<-o object> is used to specify which object to list.
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
=over 2
|
||||
|
||||
=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
|
||||
B<nw> - Network
|
||||
B<tpl> - Template
|
||||
|
||||
=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<-h>
|
||||
Display usage message.
|
||||
|
||||
=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>
|
||||
Loading…
Reference in New Issue
Block a user