Updated man pages for z/VM.

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@15064 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
phamt 2013-02-05 18:05:43 +00:00
parent a28999ba55
commit 727de3ad74
6 changed files with 954 additions and 241 deletions

View File

@ -26,35 +26,31 @@ B<zVM specific :>
B<chhypervisor> I<noderange> [B<--adddisk2pool> I<function> I<region> I<volume> I<group>]
B<chhypervisor> I<noderange> [B<--addscsi> I<device_number> I<device_path> I<option> I<persist>]
B<chhypervisor> I<noderange> [B<--addvlan> I<name> I<owner> I<type> I<transport>]
B<chhypervisor> I<noderange> [B<--addvswitch> I<name> I<osa_dev_addr> I<osa_exp_adapter> I<controller> I<connect (0, 1, or 2)> I<memory_queue> I<router> I<transport> I<vlan_id> I<port_type> I<update> I<gvrp> I<native_vlan>]
B<chhypervisor> I<noderange> [B<--addzfcp2pool> I<pool> I<status> I<wwpn> I<lun> I<size> I<owner>]
B<chhypervisor> I<noderange> [B<--diskpool> I<name>]
B<chhypervisor> I<noderange> [B<--diskpoolnames>]
B<chhypervisor> I<noderange> [B<--fcpchannels> I<state>]
B<chhypervisor> I<noderange> [B<--getnetworknames>]
B<chhypervisor> I<noderange> [B<--getnetwork> I<name>]
B<chhypervisor> I<noderange> [B<--removediskfrompool> I<function> I<region> I<group>]
B<chhypervisor> I<noderange> [B<--removezfcpfrompool> I<pool> I<lun>]
B<chhypervisor> I<noderange> [B<--removescsi> I<device_number> I<persist (YES or NO)>]
B<chhypervisor> I<noderange> [B<--resetsmapi>]
B<chhypervisor> I<noderange> [B<--removevlan> I<name> I<owner>]
B<chhypervisor> I<noderange> [B<--removevswitch> I<name>]
B<chhypervisor> I<noderange> [B<--removezfcpfrompool> I<pool> I<lun> I<wwpn>]
B<chhypervisor> I<noderange> [B<--smcli> I<function> I<arguments>]
B<chhypervisor> I<noderange> [B<--zfcppoolnames>]
B<chhypervisor> I<noderange> [B<--zfcppool> I<pool> I<space>]
=back
=head1 DESCRIPTION
The B<chhypervisor> command can be used to configure the RHEV-h host.
The B<chhypervisor> command can be used to configure the RHEV-h.
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 .
@ -71,7 +67,7 @@ The columns of hypervisor table:
=over 2
B<hypervisor.node> - rhev-h host name or zVM host name.
B<hypervisor.node> - rhev-h host name or zVM host name (lower-case).
B<hypervisor.type> - Must be set to 'rhevh' or 'zvm'.
@ -161,6 +157,18 @@ region to group. If the volume already exists in the EXTENT CONTROL, use
function 5. If the volume does not exist in the EXTENT CONTROL, but is attached
to SYSTEM, use function 4.
=item B<--addscsi> I<device_number> I<device_path> I<option> I<persist>
Dynamically add a SCSI disk to a running z/VM system.
=item B<--addvlan> I<name> I<owner> I<type> I<transport>
Create a virtual network LAN.
=item B<--addvswitch> I<name> I<osa_dev_addr> I<osa_exp_adapter> I<controller> I<connect (0, 1, or 2)> I<memory_queue> I<router> I<transport> I<vlan_id> I<port_type> I<update> I<gvrp> I<native_vlan>
Create a virtual switch.
=item B<--addzfcp2pool> I<pool> I<status> I<wwpn> I<lun> I<size> I<owner>
Add a zFCP device to a device pool defined in xCAT. The device must have been
@ -168,57 +176,36 @@ carved up in the storage controller and configured with a WWPN/LUN before it
can be added to the xCAT storage pool. z/VM does not have the ability to
communicate directly with the storage controller to carve up disks dynamically.
=item B<--diskpool> I<name>
List the configuration for a given disk pool.
=item B<--diskpoolnames>
List the disk pool names available.
=item B<--fcpchannels> I<state>
List the state of real FCP adapter devices.
=item B<--getnetworknames>
List the defined network names available for a given host.
=item B<--getnetwork> I<name>
List the configuration for a given network.
=item B<--removediskfrompool> I<function> I<region> I<group>
Remove a disk from a disk pool defined in the EXTENT CONTROL. Function type can
be either: (1) Remove region, (2) Remove region from group, (3) Remove region
from all groups, OR (7) Remove entire group .
=item B<--removescsi> I<device_number> I<persist (YES or NO)>
Delete a real SCSI disk.
=item B<--removevlan> I<name> I<owner>
Delete a virtual network LAN.
=item B<--removevswitch> I<name>
Delete a virtual switch.
=item B<--removezfcpfrompool> I<pool> I<lun>
Remove a zFCP device from a device pool defined in xCAT.
=item B<--resetsmapi>
Reset z/VM SMAPI, assuming the SMAPI worker machines to reset are: VSMWORK1,
VSMWORK2, VSMWORK3, VSMREQIN, and VSMREQIU.
=item B<--smcli> I<function> I<arguments>
Execute a SMAPI function. A list of APIs supported can be found by using the
help flag, e.g. chhypervisor pokdev61 --smcli -h. Specific arguments associated
with a SMAPI function can be found by using the help flag for the function,
e.g. chhypervisor pokdev61 --smcli Image_Query_DM -h. Only z/VM 5.4 SMAPI
functions are supported at this time. Additional SMAPI functions will be added
in subsequent zHCP versions.
=item B<--zfcppoolnames>
List the zFCP device pool names available.
=item B<--zfcppool> I<pool> I<space>
List the devices in a given zFCP device pool. Space can be either: free or used.
e.g. chhypervisor pokdev61 --smcli Image_Query_DM -h. Only z/VM 6.2 and older
SMAPI functions are supported at this time. Additional SMAPI functions will be
added in subsequent zHCP versions.
=back
@ -274,61 +261,21 @@ To add a disk to a disk pool defined in the EXTENT CONTROL, enter:
To add a zFCP device to a device pool defined in xCAT, enter:
chhypervisor pokdev61 --addzfcp2pool zfcp1 free 500501234567C890 4012345600000000 8G
=item 3.
To list the free disks in a given disk pool, enter:
chhypervisor pokdev61 --diskpool POOL1 free
=item 4.
To list the disk pool names available, enter:
chhypervisor pokdev61 --diskpoolnames
=item 5.
To list the state of real FCP adapter devices, enter:
chhypervisor pokdev61 --fcpchannels free
=item 6.
To list the configuration for a given network, enter:
chhypervisor pokdev61 --getnetwork GLAN1
=item 7.
To list the defined network names available for a given node, enter:
chhypervisor pokdev61 --getnetworknames
=item 8.
To remove a region from a group in the EXTENT CONTROL, enter:
chhypervisor pokdev61 --removediskfrompool 2 DM1234 POOL1
=item 9.
=item 4.
To remove a zFCP device from a device pool defined in xCAT, enter:
chhypervisor pokdev61 --removezfcpfrompool zfcp1 4012345600000000
chhypervisor pokdev61 --removezfcpfrompool zfcp1 4012345600000000 500501234567C890
=item 10.
To reset z/VM SMAPI, enter:
chhypervisor pokdev61 --resetsmapi
=item 11.
=item 5.
To execute a SMAPI function (Image_Query_DM), enter:
chhypervisor pokdev61 --smcli Image_Query_DM -T LNX3
=item 12.
To list the zFCP device pool names available, enter:
chhypervisor pokdev61 --zfcppoolnames
=item 13.
To list the devices in a given zFCP device pool, enter:
chhypervisor pokdev61 --zfcppool zfcp1
=back

View File

@ -28,54 +28,66 @@ B<chvm> I<noderange> [B<-a> I<size>] [B<-d> I<disk>] [B<-p> I<disk>] [B<--resize
=head2 zVM specific:
B<chvm> I<noderange> [B<--add3390> I<disk_pool> I<device_address> I<cylinders> I<mode> I<read_password> I<write_password> I<multi_password>]
B<chvm> I<noderange> [B<--add3390> I<disk_pool> I<device_address (or auto)> I<size (G, M, or cylinders)> I<mode> I<read_password (optional)> I<write_password (optional)> I<multi_password (optional)>]
B<chvm> I<noderange> [B<--add3390active> I<device_address> I<mode>]
B<chvm> I<noderange> [B<--add9336> I<disk_pool> I<virtual_device> I<block_size> I<mode> I<blocks> I<read_password> I<write_password> I<multi_password>]
B<chvm> I<noderange> [B<--add9336> I<disk_pool> I<device_address (or auto)> I<size (G, M, or blocks)> I<mode> I<read_password (optional)> I<write_password (optional)> I<multi_password (optional)>]
B<chvm> I<noderange> [B<--adddisk2pool> I<function> I<region> I<volume> I<group>]
B<chvm> I<noderange> [B<--addnic> I<address> I<type> I<device_count>]
B<chvm> I<noderange> [B<--addnic> I<device_address> I<type> I<device_count>]
B<chvm> I<noderange> [B<--addprocessor> I<address>]
B<chvm> I<noderange> [B<--addpagespool> I<volume_address> I<volume_label> I<volume_use> I<system_config_name (optional)> I<system_config_type (optional)> I<parm_disk_owner (optional)> I<parm_disk_number (optional)> I<parm_disk_password (optional)>]
B<chvm> I<noderange> [B<--addprocessoractive> I<address> I<type>]
B<chvm> I<noderange> [B<--addprocessor> I<device_address>]
B<chvm> I<noderange> [B<--addvdisk> I<userID]> I<device_address> I<size>]
B<chvm> I<noderange> [B<--addprocessoractive> I<device_address> I<type>]
B<chvm> I<noderange> [B<--connectnic2guestlan> I<address> I<lan> I<owner>]
B<chvm> I<noderange> [B<--addvdisk> I<device_address> I<size>]
B<chvm> I<noderange> [B<--connectnic2vswitch> I<address> I<vswitch>]
B<chvm> I<noderange> [B<--addzfcp> I<pool> I<device_address (or auto)> I<loaddev (0 or 1)> I<size> I<tag (optional)> I<wwpn (optional)> I<lun (optional)>]
B<chvm> I<noderange> [B<--connectnic2guestlan> I<device_address> I<lan> I<owner>]
B<chvm> I<noderange> [B<--connectnic2vswitch> I<device_address> I<vswitch>]
B<chvm> I<noderange> [B<--copydisk> I<target_address> I<source_node> I<source_address>]
B<chvm> I<noderange> [B<--dedicatedevice> I<virtual_device> I<real_device> I<mode>]
B<chvm> I<noderange> [B<--dedicatedevice> I<virtual_device> I<real_device> I<mode (0 or 1)>]
B<chvm> I<noderange> [B<--deleteipl>]
B<chvm> I<noderange> [B<--formatdisk> I<disk_address> I<multi_password>]
B<chvm> I<noderange> [B<--disconnectnic> I<device_address>]
B<chvm> I<noderange> [B<--disconnectnic> I<address>]
B<chvm> I<noderange> [B<--formatdisk> I<device_address> I<multi_password>]
B<chvm> I<noderange> [B<--grantvswitch> I<VSwitch>]
B<chvm> I<noderange> [B<--grantvswitch> I<vswitch>]
B<chvm> I<noderange> [B<--removedisk> I<virtual_device>]
B<chvm> I<noderange> [B<--purgerdr>]
B<chvm> I<noderange> [B<--resetsmapi>]
B<chvm> I<noderange> [B<--removedisk> I<device_address>]
B<chvm> I<noderange> [B<--removediskfrompool> I<function> I<region> I<group>]
B<chvm> I<noderange> [B<--removenic> I<device_address>]
B<chvm> I<noderange> [B<--removenic> I<address>]
B<chvm> I<noderange> [B<--removeprocessor> I<device_address>]
B<chvm> I<noderange> [B<--removeprocessor> I<address>]
B<chvm> I<noderange> [B<--removeloaddev> I<wwpn> I<lun>]
B<chvm> I<noderange> [B<--replacevs> I<directory_entry>]
B<chvm> I<noderange> [B<--removezfcp> I<device_address> I<wwpn> I<lun>]
B<chvm> I<noderange> [B<--replacevs> I<directory_entry (optional)>]
B<chvm> I<noderange> [B<--setipl> I<ipl_target> I<load_parms> I<parms>]
B<chvm> I<noderange> [B<--setpassword> I<password>]
B<chvm> I<noderange> [B<--setloaddev> I<wwpn> I<lun>]
B<chvm> I<noderange> [B<--sharevolume> I<volume_address> I<share_enable (YES or NO)>]
B<chvm> I<noderange> [B<--undedicatedevice> I<device_address>]
=head1 DESCRIPTION
=head2 PPC (with HMC) specific:
@ -206,43 +218,51 @@ Change the size of the Hard disk. The disk can never be set to less than it's c
=over 10
=item B<--add3390> I<disk_pool> I<device_address> I<cylinders> I<mode> I<read_password> I<write_password> I<multi_password>
=item B<--add3390> I<disk_pool> I<device_address (or auto)> I<size (G, M, or cylinders)> I<mode> I<read_password (optional)> I<write_password (optional)> I<multi_password (optional)>
Adds a 3390 (ECKD) disk to a virtual server's directory entry.
Adds a 3390 (ECKD) disk to a virtual machine's directory entry. The size of the disk can be specified in GB, MB, or the number of cylinders.
=item B<--add3390active> I<device_address> I<mode>
Adds a 3390 (ECKD) disk that is defined in a virtual server's directory entry to that virtual server's active configuration.
Adds a 3390 (ECKD) disk that is defined in a virtual machine's directory entry to that virtual server's active configuration.
=item B<--add9336> I<disk_pool> I<virtual_device> I<block_size> I<mode> I<blocks> I<read_password> I<write_password> I<multi_password>
=item B<--add9336> I<disk_pool> I<device_address (or auto)> I<size (G, M, or blocks)> I<mode> I<read_password (optional)> I<write_password (optional)> I<multi_password (optional)>
Adds a 9336 (FBA) disk to a virtual server's directory entry.
Adds a 9336 (FBA) disk to a virtual machine's directory entry. The size of the disk can be specified in GB, MB, or the number of blocks.
=item B<--adddisk2pool> I<function> I<region> I<volume> I<group>
Add a disk to a disk pool defined in the EXTENT CONTROL. Function type can be either: (4) Define region as full volume and add to group OR (5) Add existing region to group. The disk has to already be attached to SYSTEM.
=item B<--addnic> I<address> I<type> I<device_count>
=item B<--addnic> I<device_address> I<type> I<device_count>
Adds a network adapter to a virtual server's directory entry (case sensitive).
Adds a network adapter to a virtual machine's directory entry (case sensitive).
=item B<--addprocessor> I<address>
=item B<--addpagespool> I<volume_addr> I<volume_label> I<volume_use> I<system_config_name (optional)> I<system_config_type (optional)> I<parm_disk_owner (optional)> I<parm_disk_number (optional)> I<parm_disk_password (optional)>
Adds a virtual processor to a virtual server's directory entry.
Add a full volume page or spool disk to the virtual machine.
=item B<--addprocessoractive> I<address> I<type>
=item B<--addprocessor> I<device_address>
Adds a virtual processor to a virtual server's active configuration (case sensitive).
Adds a virtual processor to a virtual machine's directory entry.
=item B<--addvdisk> I<userID]> I<device_address> I<size>
=item B<--addprocessoractive> I<device_address> I<type>
Adds a v-disk to a virtual server's directory entry.
Adds a virtual processor to a virtual machine's active configuration (case sensitive).
=item B<--connectnic2guestlan> I<address> I<lan> I<owner>
=item B<--addvdisk> I<device_address> I<size>
Adds a v-disk to a virtual machine's directory entry.
=item B<--addzfcp> I<pool> I<device_address (or auto)> I<loaddev (0 or 1)> I<size> I<tag (optional)> I<wwpn (optional)> I<lun (optional)>
Add a zFCP device to a device pool defined in xCAT. The device must have been carved up in the storage controller and configured with a WWPN/LUN before it can be added to the xCAT storage pool. z/VM does not have the ability to communicate directly with the storage controller to carve up disks dynamically.
=item B<--connectnic2guestlan> I<device_address> I<lan> I<owner>
Connects a given network adapter to a GuestLAN.
=item B<--connectnic2vswitch> I<address> I<vswitch>
=item B<--connectnic2vswitch> I<device_address> I<vswitch>
Connects a given network adapter to a VSwitch.
@ -250,57 +270,69 @@ Connects a given network adapter to a VSwitch.
Copy a disk attached to a given virtual server.
=item B<--dedicatedevice> I<virtual_device> I<real_device> I<mode>
=item B<--dedicatedevice> I<virtual_device> I<real_device> I<mode (0 or 1)>
Adds a dedicated device to a virtual server's directory entry.
Adds a dedicated device to a virtual machine's directory entry.
=item B<--deleteipl>
Deletes the IPL statement from the virtual server's directory entry.
Deletes the IPL statement from the virtual machine's directory entry.
=item B<--disconnectnic> I<device_address>
Disconnects a given network adapter.
=item B<--formatdisk> I<disk_address> I<multi_password>
Formats a disk attached to a given virtual server (only ECKD disks supported). The disk should not be linked to any other virtual server. This command is best used after add3390().
=item B<--disconnectnic> I<address>
=item B<--grantvswitch> I<vswitch>
Disconnects a given network adapter.
Grant vSwitch access for given virtual machine.
=item B<--grantvswitch> I<VSwitch>
=item B<--purgerdr>
Grant VSwitch access for given virtual server.
Purge the reader belonging to the virtual machine
=item B<--removedisk> I<virtual_device>
=item B<--removedisk> I<device_address>
Removes a minidisk from a virtual server's directory entry.
Removes a minidisk from a virtual machine's directory entry.
=item B<--resetsmapi>
=item B<--removenic> I<device_address>
Reset z/VM SMAPI, assuming the SMAPI worker machines to reset are: VSMWORK1, VSMWORK2, VSMWORK3, VSMREQIN, and VSMREQIU.
Removes a network adapter from a virtual machine's directory entry.
=item B<--removediskfrompool> I<function> I<region> I<group>
=item B<--removeprocessor> I<device_address>
Remove a disk from a disk pool defined in the EXTENT CONTROL. Function type can be either: (1) Remove region, (2) Remove region from group, (3) Remove region from all groups, OR (7) Remove entire group.
Removes a processor from an active virtual machine's configuration.
=item B<--removenic> I<address>
=item B<--removeloaddev> I<wwpn> I<lun>
Removes a network adapter from a virtual server's directory entry.
Removes the LOADDEV statement from a virtual machines's directory entry.
=item B<--removeprocessor> I<address>
=item B<--removezfcp> I<device_address> I<wwpn> I<lun>
Removes a processor from an active virtual server's configuration.
Removes a given SCSI/FCP device belonging to the virtual machine.
=item B<--replacevs> I<directory_entry>
=item B<--replacevs> I<directory_entry (optional)>
Replaces a virtual server's directory entry.
Replaces a virtual machine's directory entry. The directory entry can be echoed into stdin or a text file.
=item B<--setipl> I<ipl_target> I<load_parms> I<parms>
Sets the IPL statement for a given virtual server.
Sets the IPL statement for a given virtual machine.
=item B<--setpassword> I<password>
Sets the password for a given virtual server.
Sets the password for a given virtual machine.
=item B<--setloaddev> I<wwpn> I<lun>
Sets the LOADDEV statement in the virtual machine's directory entry.
=item B<--undedicatedevice> I<device_address>
Delete a dedicated device from a virtual machine's active configuration and directory entry.
=back
@ -426,15 +458,15 @@ Output is similar to:
=head2 zVM specific:
1. To adds a 3390 (ECKD) disk to a virtual server's directory entry:
1. To adds a 3390 (ECKD) disk to a virtual machine's directory entry:
chvm gpok3 --add3390 POOL1 0101 3338 MR
chvm gpok3 --add3390 POOL1 0101 2G MR
Output is similar to:
gpok3: Adding disk 0101 to LNX3... Done
2. To add a network adapter to a virtual server's directory entry:
2. To add a network adapter to a virtual machine's directory entry:
chvm gpok3 --addnic 0600 QDIO 3
@ -456,9 +488,9 @@ Output is similar to:
Output is similar to:
gpok3: Connecting NIC 0600 to VSwitch VSW1 on LNX3... Done
gpok3: Connecting NIC 0600 to vSwitch VSW1 on LNX3... Done
5. To removes a minidisk from a virtual server's directory entry:
5. To removes a minidisk from a virtual machine's directory entry:
chvm gpok3 --removedisk 0101
@ -466,7 +498,7 @@ Output is similar to:
gpok3: Removing disk 0101 on LNX3... Done
6. To Removes a network adapter from a virtual server's directory entry:
6. To Removes a network adapter from a virtual machine's directory entry:
chvm gpok3 --removenic 0700
@ -474,9 +506,9 @@ Output is similar to:
gpok3: Removing NIC 0700 on LNX3... Done
7. To replaces a virtual server's directory entry:
7. To replaces a virtual machine's directory entry:
chvm gpok3 --replacevs /tmp/dirEntry.txt
cat /tmp/dirEntry.txt | chvm gpok3 --replacevs
Output is similar to:

View File

@ -20,14 +20,6 @@ B<lsvm> [B<-l>| B<--long>] I<noderange>
B<lsvm> I<noderange>
B<lsvm> I<noderange> B<--getnetworknames>
B<lsvm> I<noderange> B<--getnetwork> I<network_name>
B<lsvm> I<noderange> B<--diskpoolnames>
B<lsvm> I<noderange> B<--diskpool> I<pool_name>
=head1 DESCRIPTION
The lsvm command lists all partition profiles defined for the partitions specified in noderange. If noderange is a CEC, all the partitions associated with that CEC are displayed.
@ -56,15 +48,7 @@ Note: Only the virtual machine which is in power on state can be listed by lsvm
=head2 For zVM:
The first form of lsvm list the directory entry.
The second form of this command list the defined network names available for a given node.
The third form of this command list the configuration for a given network.
The fourth form of this command list the disk pool names available.
The fifth form of this command list the configuration for a given disk pool.
Show the directory entry for a given virtual machine.
=head1 OPTIONS
@ -89,22 +73,6 @@ B<-l>
Show lparnames for lpars.
B<--getnetworknames>
List the defined network names available for a given node.
B<--getnetwork> I<network_name>
List the configuration for a given network.
B<--diskpoolnames>
List the disk pool names available.
B<--diskpool> I<pool_name>
List the configuration for a given disk pool.
=head1 RETURN VALUE
@ -240,52 +208,6 @@ Output is similar to:
gpok3: INCLUDE LNXDFLT
gpok3: COMMAND SET VSWITCH VSW2 GRANT LNX3
6. To list the defined network names available for a given node:
lsvm gpok3 --getnetworknames
Output is similar to:
gpok3: LAN:QDIO SYSTEM GLAN1
gpok3: LAN:HIPERS SYSTEM GLAN2
gpok3: LAN:QDIO SYSTEM GLAN3
gpok3: VSWITCH SYSTEM VLANTST1
gpok3: VSWITCH SYSTEM VLANTST2
gpok3: VSWITCH SYSTEM VSW1
gpok3: VSWITCH SYSTEM VSW2
gpok3: VSWITCH SYSTEM VSW3
7. To list the configuration for a given network:
lsvm gpok3 --getnetwork GLAN1
Output is similar to:
gpok3: LAN SYSTEM GLAN1 Type: QDIO Connected: 1 Maxconn: INFINITE
gpok3: PERSISTENT UNRESTRICTED IP Accounting: OFF
gpok3: IPTimeout: 5 MAC Protection: Unspecified
gpok3: Isolation Status: OFF
8. To list the disk pool names available:
lsvm gpok3 --diskpoolnames
Output is similar to:
gpok3: POOL1
gpok3: POOL2
gpok3: POOL3
9. List the configuration for a given disk pool:
lsvm gpok3 --diskpool POOL1 free
Output is similar to:
gpok3: #VolID DevType StartAddr Size
gpok3: EMC2C4 3390-09 0001 10016
gpok3: EMC2C5 3390-09 0001 10016
=head1 FILES
/opt/xcat/bin/lsvm

View File

@ -30,7 +30,7 @@ B<mkvm> I<noderange> [B<-s>|B<--size> I<disksize>] [B<--mem> I<memsize>] [B<--cp
B<mkvm> I<noderange> I<directory_entry_file_path>
B<mkvm> I<noderange> I<source_virtual_machine> B<pool=> I<disk_pool> B<pw=> I<multi_password>
B<mkvm> I<noderange> I<source_virtual_machine> B<pool=> I<disk_pool>
=head1 DESCRIPTION

View File

@ -1,6 +1,6 @@
=head1 Name
B<rinv> - remote hardware inventory
B<rinv> - Remote hardware inventory
=head1 B<Synopsis>
@ -28,6 +28,32 @@ B<rinv> I<noderange> {B<mtm>|B<serial>|B<mac>|B<bios>|B<diag>|B<mprom>|B<mparom>
B<rinv> I<noderange> [B<-t>]
=head2 zVM specific:
B<rinv> I<noderange> [B<config>|B<all>]
B<rinv> I<noderange> [B<--diskpoolspace>]
B<rinv> I<noderange> [B<--diskpool> I<pool> I<space (all, free, or used)>]
B<rinv> I<noderange> [B<--fcpdevices> I<state (active, free, or offline)> I<details (optional)>]
B<rinv> I<noderange> [B<--diskpoolnames>]
B<rinv> I<noderange> [B<--networknames>]
B<rinv> I<noderange> [B<--network> I<name>]
B<rinv> I<noderange> [B<--ssi>]
B<rinv> I<noderange> [B<--smapilevel>]
B<rinv> I<noderange> [B<--wwpn>]
B<rinv> I<noderange> [B<--zfcppool> I<pool> I<space (free or used)>]
B<rinv> I<noderange> [B<--zfcppoolnames>]
=head1 B<Description>
B<rinv> retrieves hardware configuration information from the on-board
@ -112,6 +138,52 @@ Print version.
Set the values in the vm table to what vCenter has for the indicated nodes.
B<zVM specific :>
=item B<--diskpoolspace>
Calculates the total size of every known storage pool.
=item B<--diskpool> I<pool> I<space (all, free, or used)>
Lists the storage devices (ECKD and FBA) contained in a disk pool.
=item B<--fcpdevices> I<state (active, free, or offline)> I<details (optional)>
Lists the FCP device channels that are active, free, or offline.
=item B<--diskpoolnames>
Lists the known disk pool names.
=item B<--networknames>
Lists the known network names.
=item B<--network> I<name>
Shows the configuration of a given network device.
=item B<--ssi>
Obtain the SSI and system status.
=item B<--smapilevel>
Obtain the SMAPI level installed on a given hypervisor.
=item B<--wwpn>
Query all FCPs on a z/VM system and return a list of WWPNs.
=item B<--zfcppool> I<pool> I<space (free or used)>
List the SCSI/FCP devices contained in a zFCP pool.
=item B<--zfcppoolnames>
List the known zFCP pool names.
=back
=head1 B<Examples>
@ -182,6 +254,89 @@ To retrieve information about a VMware node vm1, enter:
vm1: Hard disk 1 (d0): 9000 MB @ [nfs_192.168.68.21_vol_rc1storage_vmware] vm1_3/vm1.vmdk
vm1: Hard disk 2 (d4): 64000 MB @ [nfs_192.168.68.21_vol_rc1storage_vmware] vm1_3/vm1_5.vmdk
B<zVM specific :>
=item *
To list the defined network names available for a given node:
rinv pokdev61 --getnetworknames
Output is similar to:
pokdev61: LAN:QDIO SYSTEM GLAN1
pokdev61: LAN:HIPERS SYSTEM GLAN2
pokdev61: LAN:QDIO SYSTEM GLAN3
pokdev61: VSWITCH SYSTEM VLANTST1
pokdev61: VSWITCH SYSTEM VLANTST2
pokdev61: VSWITCH SYSTEM VSW1
pokdev61: VSWITCH SYSTEM VSW2
pokdev61: VSWITCH SYSTEM VSW3
=item *
To list the configuration for a given network:
rinv pokdev61 --getnetwork GLAN1
Output is similar to:
pokdev61: LAN SYSTEM GLAN1 Type: QDIO Connected: 1 Maxconn: INFINITE
pokdev61: PERSISTENT UNRESTRICTED IP Accounting: OFF
pokdev61: IPTimeout: 5 MAC Protection: Unspecified
pokdev61: Isolation Status: OFF
=item *
To list the disk pool names available:
rinv pokdev61 --diskpoolnames
Output is similar to:
pokdev61: POOL1
pokdev61: POOL2
pokdev61: POOL3
=item *
List the configuration for a given disk pool:
rinv pokdev61 --diskpool POOL1 free
Output is similar to:
pokdev61: #VolID DevType StartAddr Size
pokdev61: EMC2C4 3390-09 0001 10016
pokdev61: EMC2C5 3390-09 0001 10016
=item *
List the known zFCP pool names.
rinv pokdev61 --zfcppoolnames
Output is similar to:
pokdev61: zfcp1
pokdev61: zfcp2
pokdev61: zfcp3
=item *
List the SCSI/FCP devices contained in a given zFCP pool:
rinv pokdev61 --zfcppool zfcp1
Output is similar to:
pokdev61: #status,wwpn,lun,size,range,owner,channel,tag
pokdev61: used,500507630613c411,4014402f00000000,2g,3B40-3B7F,ihost13,3b77,
pokdev61: used,500507630613c411,4014403200000000,8192M,3B40-3B7F,ihost13,3b77,replace_root_device
pokdev61: free,500507630613c411,4014403300000000,8g,3B40-3B7F,,,
pokdev61: free,5005076306138411,4014403100000000,2g,3B40-3B7F,,,
pokdev61: free,500507630613c411;5005076306138411,4014403000000000,2G,3B40-3B7F,,,
=back

View File

@ -0,0 +1,657 @@
=head1 NAME
B<xcat> - extreme Cluster Administration Tool.
=head1 DESCRIPTION
Extreme Cluster Administration Toolkit (xCAT). xCAT is a scalable distributed computing management
and provisioning tool that provides a unified interface for hardware control, discovery, and
OS diskful/diskfree deployment.
=head1 XCAT DATABASE
All of the cluster configuration information is in the xCAT database. See L<xcatdb(5)|xcatdb.5> for
descriptions of every table in the database.
=head1 XCAT COMMANDS
What follows is a short description of each xCAT command. To get more information about a particular
command, see its man page. Note that the commands are listed in alphabetical order B<within each section>,
i.e. all the commands in section 1, then the commands in section 3, etc.
=over 12
=item L<addkit(1)|addkit.1>
Install a kit on the xCAT management node
=item L<addkitcomp(1)|addkitcomp.1>
Assign kit components to osimage.
=item L<cfgve(1)|cfgve.1>
Configure the elements for a virtual environment.
=item L<cfm2xcat(1)|cfm2xcat.1>
Migrates the CFM setup in CSM to the xdcp rsync setup in xCAT.
=item L<chdef(1)|chdef.1>
Change xCAT data object definitions.
=item L<chhypervisor(1)|chhypervisor.1>
Configure the virtualization hosts.
=item L<chkkitcomp(1)|chkkitcomp.1>
Check if kit component fits to osimage.
=item L<chkosimage(1)|chkosimage.1>
Use this xCAT command to check an xCAT osimage.
=item L<chvm(1)|chvm.1>
Changes HMC-, IVM-, and zVM-managed partition profiles or virtual machines. For Power 775, chvm could be used to change the octant configuration values for generating LPARs; change the I/O slots assignment to LPARs within the same CEC.
=item L<clonevm(1)|clonevm.1>
Create masters from virtual machines and virtual machines from masters.
=item L<csm2xcat(1)|csm2xcat.1>
Allows the migration of a CSM database to an xCAT database.
=item L<db2sqlsetup(1)|db2sqlsetup.1>
Sets up the IBM DB2 for xCAT to use.
=item L<dumpxCATdb(1)|dumpxCATdb.1>
dumps the xCAT db tables .
=item L<genimage(1)|genimage.1>
Generates a stateless image to be used for a diskless install.
=item L<getmacs(1)|getmacs.1>
Collects node MAC address.
=item L<gettab(1)|gettab.1>
select table rows, based on attribute criteria, and display specific attributes.
=item L<getxcatdocs(1)|getxcatdocs.1>
downloads the xCAT documentation and converts to HTML and PDF
=item L<groupfiles4dsh(1)|groupfiles4dsh.1>
Builds a directory of files for each defined nodegroup in xCAT.
=item L<imgcapture(1)|imgcapture.1>
Captures an image from a Linux diskful node and create a diskless image on the management node.
=item L<imgexport(1)|imgexport.1>
Exports an xCAT image.
=item L<imgimport(1)|imgimport.1>
Imports an xCAT image or configuration file into the xCAT tables so that you can immediately begin deploying with it.
=item L<liteimg(1)|liteimg.1>
Modify statelite image by creating a series of links.
=item L<lsdef(1)|lsdef.1>
Use this command to list xCAT data object definitions.
=item L<lsflexnode(1)|lsflexnode.1>
Display the information of flexible node
=item L<lshwconn(1)|lshwconn.1>
Use this command to display the connection status for CEC and Frame nodes.
=item L<lskmodules(1)|lskmodules.1>
list kernel driver modules in rpms or driver disk image files
=item L<lslite(1)|lslite.1>
Display a summary of the statelite information.
=item L<lsslp(1)|lsslp.1>
Discovers selected networked services information within the same subnet.
=item L<lstree(1)|lstree.1>
Display the tree of service node hierarchy, hardware hierarchy, or VM hierarchy.
=item L<lsve(1)|lsve.1>
Lists detail attributes for a virtual environment.
=item L<lsvm(1)|lsvm.1>
Lists partition profile information for HMC-, IVM-, KVM-, Vmware- and zVM-managed nodes. For Power 775, it lists the LPARs' I/O slots information and CEC configuration.
=item L<lsxcatd(1)|lsxcatd.1>
lists xCAT daemon information.
=item L<mkdef(1)|mkdef.1>
Use this command to create xCAT data object definitions.
=item L<mkdsklsnode(1)|mkdsklsnode.1>
Use this xCAT command to define and initialize AIX/NIM diskless machines.
=item L<mkflexnode(1)|mkflexnode.1>
Create a flexible node.
=item L<mkhwconn(1)|mkhwconn.1>
Sets up connections for CEC and Frame nodes to HMC nodes or hardware server.
=item L<mknimimage(1)|mknimimage.1>
Use this xCAT command to create xCAT osimage definitions and related AIX/NIM resources. The command can also be used to update an existing AIX diskless image(SPOT).
=item L<mkvm(1)|mkvm.1>
Creates HMC-, IVM-, and zVM-managed partitions or other virtual machines.
=item L<monadd(1)|monadd.1>
Registers a monitoring plug-in to the xCAT cluster.
=item L<moncfg(1)|moncfg.1>
Configures a 3rd party monitoring software to monitor the xCAT cluster.
=item L<mondecfg(1)|mondecfg.1>
Deconfigures a 3rd party monitoring software from monitoring the xCAT cluster.
=item L<monls(1)|monls.1>
Lists monitoring plug-in modules that can be used to monitor the xCAT cluster.
=item L<monrm(1)|monrm.1>
Unregisters a monitoring plug-in module from the xCAT cluster.
=item L<monshow(1)|monshow.1>
Shows event data for monitoring.
=item L<monstart(1)|monstart.1>
Starts a plug-in module to monitor the xCAT cluster.
=item L<monstop(1)|monstop.1>
Stops a monitoring plug-in module to monitor the xCAT cluster.
=item L<mysqlsetup(1)|mysqlsetup.1>
Sets up the MySQL database for xCAT to use.
=item L<nimnodecust(1)|nimnodecust.1>
Use this xCAT command to customize AIX/NIM standalone machines.
=item L<nimnodeset(1)|nimnodeset.1>
Use this xCAT command to initialize AIX/NIM standalone machines.
=item L<nodeaddunmged(1)|nodeaddunmged.1>
Create a unmanaged node.
=item L<nodech(1)|nodech.1>
Changes nodes' attributes in the xCAT cluster database.
=item L<nodechmac(1)|nodechmac.1>
Updates the MAC address for a node.
=item L<nodechprofile(1)|nodechprofile.1>
updates a profile used by a node
=item L<nodediscoverls(1)|nodediscoverls.1>
List all discovered nodes
=item L<nodediscoverstart(1)|nodediscoverstart.1>
starts the node discovery process
=item L<nodediscoverstatus(1)|nodediscoverstatus.1>
gets the node discovery process status
=item L<nodediscoverstop(1)|nodediscoverstop.1>
stops the node discovery process.
=item L<nodegrpch(1)|nodegrpch.1>
Changes attributes at the group level in the xCAT cluster database.
=item L<nodeimport(1)|nodeimport.1>
Create profiled nodes by importing hostinfo file.
=item L<nodels(1)|nodels.1>
lists the nodes, and their attributes, from the xCAT database.
=item L<nodepurge(1)|nodepurge.1>
Removes nodes.
=item L<noderefresh(1)|noderefresh.1>
Update nodes configurations by running associated kit plugins.
=item L<noderm(1)|noderm.1>
Removes the nodes in the noderange from all database table.
=item L<nodestat(1)|nodestat.1>
display the running status of each node in a noderange
=item L<packimage(1)|packimage.1>
Packs the stateless image from the chroot file system.
=item L<pasu(1)|pasu.1>
run the ASU to many nodes in parallel
=item L<pcons(1)|pcons.1>
Runs a command on the noderange using the out-of-band console.
=item L<pgsqlsetup(1)|pgsqlsetup.1>
Sets up the PostgreSQL database for xCAT to use.
=item L<pping(1)|pping.1>
parallel ping the nodes.
=item L<ppping(1)|ppping.1>
parallel ping from nodes to other nodes in the cluster.
=item L<prsync(1)|prsync.1>
parallel rsync
=item L<pscp(1)|pscp.1>
parallel remote copy
=item L<psh(1)|psh.1>
parallel remote shell
=item L<rbeacon(1)|rbeacon.1>
Turns beacon on/off/blink or gives status of a node or noderange.
=item L<rbootseq(1)|rbootseq.1>
Persistently sets the order of boot devices for BladeCenter blades or PPC LPARs using Direct FSP Management (DFM).
=item L<rcons(1)|rcons.1>
remotely accesses the serial console of a node
=item L<regnotif(1)|regnotif.1>
Registers a Perl module or a command that will get called when changes occur in the desired xCAT database tables.
=item L<renergy(1)|renergy.1>
remote energy management tool
=item L<replaycons(1)|replaycons.1>
replay the console output for a node
=item L<restartxcatd(1)|restartxcatd.1>
Restart the xCAT daemon (xcatd) on AIX.
=item L<restorexCATdb(1)|restorexCATdb.1>
restores the xCAT db tables .
=item L<reventlog(1)|reventlog.1>
retrieve or clear remote hardware event logs
=item L<rflash(1)|rflash.1>
Performs Licensed Internal Code (LIC) update support for HMC-attached POWER5 and POWER6 Systems, and POWER7 systems using Direct FSP management.
=item L<rinv(1)|rinv.1>
Remote hardware inventory
=item L<rmdef(1)|rmdef.1>
Use this command to remove xCAT data object definitions.
=item L<rmdsklsnode(1)|rmdsklsnode.1>
Use this xCAT command to remove AIX/NIM diskless machine definitions.
=item L<rmflexnode(1)|rmflexnode.1>
Delete a flexible node.
=item L<rmhwconn(1)|rmhwconn.1>
Use this command to remove connections from CEC and Frame nodes to HMC nodes.
=item L<rmhypervisor(1)|rmhypervisor.1>
Remove the virtualization hosts.
=item L<rmigrate(1)|rmigrate.1>
Execute migration of a guest VM between hosts/hypervisors
=item L<rmimage(1)|rmimage.1>
Removes the Linux stateless or statelite image from the file system.
=item L<rmkit(1)|rmkit.1>
Remove Kits from xCAT
=item L<rmkitcomp(1)|rmkitcomp.1>
Remove kit components from osimage.
=item L<rmnimimage(1)|rmnimimage.1>
Use this xCAT command to remove NIM resources specified in an xCAT osimage definition.
=item L<rmvm(1)|rmvm.1>
Removes HMC-, IVM-, KVM-, Vmware- and zVM-managed partitions or virtual machines.
=item L<rnetboot(1)|rnetboot.1>
Cause the range of nodes to boot to network.
=item L<rollupdate(1)|rollupdate.1>
performs cluster rolling update
=item L<rpower(1)|rpower.1>
remote power control of nodes
=item L<rscan(1)|rscan.1>
Collects node information from one or more hardware control points.
=item L<rsetboot(1)|rsetboot.1>
Sets the boot device to be used for BMC-based servers for the next boot only.
=item L<rspconfig(1)|rspconfig.1>
Configures nodes' service processors
=item L<rspreset(1)|rspreset.1>
resets the service processors associated with the specified nodes
=item L<rvitals(1)|rvitals.1>
remote hardware vitals
=item L<sinv(1)|sinv.1>
Checks the software configuration of the nodes in the cluster.
=item L<snmove(1)|snmove.1>
Move xCAT compute nodes to a different xCAT service node.
=item L<swapnodes(1)|swapnodes.1>
swap the location info in the db (all the attributes in the ppc table and the nodepos table) between 2 nodes. If swapping within a cec, it will assign the IO adapters that were assigned to the defective node to the available node.
=item L<switchblade(1)|switchblade.1>
reassign the BladeCenter media tray and/or KVM to the specified blade
=item L<tabgrep(1)|tabgrep.1>
list table names in which an entry for the given node appears.
=item L<unregnotif(1)|unregnotif.1>
unregister a Perl module or a command that was watching for the changes of the desired xCAT database tables.
=item L<updateSNimage(1)|updateSNimage.1>
Adds the needed Service Node configuration files to the install image.
=item L<updatenode(1)|updatenode.1>
Update nodes in an xCAT cluster environment.
=item L<wcons(1)|wcons.1>
windowed remote console
=item L<wkill(1)|wkill.1>
kill windowed remote consoles
=item L<wvid(1)|wvid.1>
windowed remote video console for nodes
=item L<xCATWorld(1)|xCATWorld.1>
Sample client program for xCAT.
=item L<xcat(1)|xcat.1>
extreme Cluster Administration Tool.
=item L<xcat2nim(1)|xcat2nim.1>
Use this command to create and manage AIX NIM definitions based on xCAT node, group and network object definitions.
=item L<xcatchroot(1)|xcatchroot.1>
Use this xCAT command to modify an xCAT AIX diskless operating system image.
=item L<xcoll(1)|xcoll.1>
Formats and consolidates the output of the B<psh>, B<rinv> commands.
=item L<xdcp(1)|xdcp.1>
Concurrently copies files to or from multiple nodes. In addition, provides an option to use rsync to update the files on the nodes, or to an installation image on the local node.
=item L<xdsh(1)|xdsh.1>
Concurrently runs remote commands on multiple nodes (Management Node, Service Nodes, compute nodes), or an install image.
=item L<xdshbak(1)|xdshbak.1>
Formats the output of the B<xdsh> command.
=item L<xdshcoll(1)|xdshcoll.1>
Formats and consolidates the output of the B<xdsh,sinv> commands.
=item L<xpbsnodes(1)|xpbsnodes.1>
PBS pbsnodes front-end for a noderange.
=item L<noderange(3)|noderange.3>
syntax for compactly expressing a list of node names
=item L<xcatstanzafile(5)|xcatstanzafile.5>
Format of a stanza file that can be used with xCAT data object definition commands.
=item L<chtab(8)|chtab.8>
Add, delete or update rows in the database tables.
=item L<copycds-cdrom(8)|copycds-cdrom.8>
Client side wrapper for copycds supporting physical drives.
=item L<copycds(8)|copycds.8>
Copies Linux distributions and service levels from DVDs/ISOs to the xCAT /install directory.
=item L<makeconservercf(8)|makeconservercf.8>
creates the conserver configuration file from info in the xCAT database
=item L<makedhcp(8)|makedhcp.8>
Creates and updates DHCP configuration files.
=item L<makedns(8)|makedns.8>
sets up domain name services (DNS).
=item L<makehosts(8)|makehosts.8>
sets up /etc/hosts from the xCAT hosts table.
=item L<makeknownhosts(8)|makeknownhosts.8>
Make a known_hosts file under $ROOTHOME/.ssh for input noderange.
=item L<makenetworks(8)|makenetworks.8>
Gather cluster network information and add it to the xCAT database.
=item L<makeroutes(8)|makeroutes.8>
add or delete routes to/from the os route table on nodes.
=item L<mknb(8)|mknb.8>
creates a network boot root image for node discovery and flashing
=item L<mkrrbc(8)|mkrrbc.8>
Adds or deletes BladeCenter management module and switch node definitions in the xCAT cluster database.
=item L<mkrrnodes(8)|mkrrnodes.8>
Adds or deletes nodes in the xCAT cluster database.
=item L<nodeadd(8)|nodeadd.8>
Adds nodes to the xCAT cluster database.
=item L<nodeset(8)|nodeset.8>
set the boot state for a noderange
=item L<rinstall(8)|rinstall.8>
Begin installation on a noderange
=item L<rmosdistro(8)|rmosdistro.8>
remove OS Distro
=item L<runsqlcmd(8)|runsqlcmd.8>
Runs sql command files against the current xCAT database.
=item L<setupiscsidev(8)|setupiscsidev.8>
creates a LUN for a node to boot up with, using iSCSI
=item L<tabch(8)|tabch.8>
Add, delete or update rows in the database tables.
=item L<tabdump(8)|tabdump.8>
display an xCAT database table in CSV format.
=item L<tabedit(8)|tabedit.8>
view an xCAT database table in an editor and make changes.
=item L<tabprune(8)|tabprune.8>
Deletes records from the eventlog,auditlog,isnm_perf,isnm_perf_sum tables.
=item L<tabrestore(8)|tabrestore.8>
replaces the contents of an xCAT database table with the contents in a csv file.
=item L<winstall(8)|winstall.8>
Begin installation on a noderange and display in wcons
=item L<xcatconfig(8)|xcatconfig.8>
Sets up the Management Node during the xCAT install.
=item L<xcatd(8)|xcatd.8>
The xCAT daemon
=item L<xcatdebug(8)|xcatdebug.8>
Enable or disable the trace facilities for xCAT. (Only supports Linux Operating System)
=item L<xcatsetup(8)|xcatsetup.8>
Prime the xCAT database using naming conventions specified in a config file.
=item L<xcatsnap(8)|xcatsnap.8>
Gathers information for service about the current running xCAT environment.
=item L<xcattest(1)|xcattest.1>
Run automated xCAT test cases.
=item L<buildkit(1)|buildkit.1>
Build product software kits to be installed in an xCAT cluster.
=back