From 88f1255ced258a1d0859538b87e42a2080d105b6 Mon Sep 17 00:00:00 2001 From: phamt Date: Fri, 9 Dec 2011 18:21:13 +0000 Subject: [PATCH] Added man pages for zVM commands. git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@11201 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- xCAT-client/pods/man1/lsvm.1.pod | 105 +++++++++++++++++++++++++++++ xCAT-client/pods/man1/mkvm.1.pod | 52 +++++++++++++- xCAT-client/pods/man1/rinv.1.pod | 39 +++++++++++ xCAT-client/pods/man1/rmvm.1.pod | 9 ++- xCAT-client/pods/man1/rpower.1.pod | 4 ++ xCAT-client/pods/man1/rscan.1.pod | 18 +++++ 6 files changed, 225 insertions(+), 2 deletions(-) diff --git a/xCAT-client/pods/man1/lsvm.1.pod b/xCAT-client/pods/man1/lsvm.1.pod index 03b531483..5677a1c48 100644 --- a/xCAT-client/pods/man1/lsvm.1.pod +++ b/xCAT-client/pods/man1/lsvm.1.pod @@ -16,6 +16,18 @@ B [B<-a>| B<--all>] I B [B<-l>| B<--long>] I +=head2 For zVM: + +B I + +B I B<--getnetworknames> + +B I B<--getnetwork> I + +B I B<--diskpoolnames> + +B I B<--diskpool> I + =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. @@ -35,6 +47,18 @@ The Memory Interleaving Mode has 3 valid options: More information about this part, refer to the section Using the *vm commands to define partitions in xCAT DFM in the link below. https://sourceforge.net/apps/mediawiki/xcat/index.php?title=XCAT_Power_775_Hardware_Management + +=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. =head1 OPTIONS @@ -59,6 +83,23 @@ B<-l> Show lparnames for lpars. +B<--getnetworknames> + +List the defined network names available for a given node. + +B<--getnetwork> I + +List the configuration for a given network. + +B<--diskpoolnames> + +List the disk pool names available. + +B<--diskpool> I + +List the configuration for a given disk pool. + + =head1 RETURN VALUE 0 The command completed successfully. @@ -176,6 +217,70 @@ Output is similar to: Maximum huge page memory(in pages): 24 Requested huge page memory(in pages): 15 +5. To list the virtual machine's directory entry: + + lsvm gpok3 + +Output is similar to: + + gpok3: USER LNX3 PWD 512M 1G G + 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 + +======= + Number of BSR arrays: 256,Bytes per BSR array: 4096,Available BSR array: 0; + Available huge page memory(in pages): 0 + Configurable huge page memory(in pages): 12 + Page Size(in GB): 16 + Maximum huge page memory(in pages): 24 + Requested huge page memory(in pages): 15 + =head1 FILES /opt/xcat/bin/lsvm diff --git a/xCAT-client/pods/man1/mkvm.1.pod b/xCAT-client/pods/man1/mkvm.1.pod index 3e4457994..a43828c50 100644 --- a/xCAT-client/pods/man1/mkvm.1.pod +++ b/xCAT-client/pods/man1/mkvm.1.pod @@ -1,6 +1,6 @@ =head1 NAME -B - Creates HMC- and IVM-managed partitions or other virtual machines. +B - Creates HMC-, IVM-, and zVM-managed partitions or other virtual machines. =head1 SYNOPSIS @@ -22,6 +22,12 @@ B [B<-V>| B<--verbose>] I B<--full> B I B<-m>|B<--master> I B<-s>|B<--size> I B<-f>|B<--force> +=head2 For zVM: + +B I I + +B I I B I B I + =head1 DESCRIPTION =head2 For PPC: @@ -40,6 +46,12 @@ Please note that the mkvm command currently only supports creating standard LPAR mkvm .... +=head2 For zVM: + +The first form of mkvm creates a new virtual machine based on a directory entry. + +The second form of this creates a new virtual machine with the same profile/resources as the specified node (cloning). + =head1 OPTIONS =over 10 @@ -146,6 +158,44 @@ Output is similar to: lpar5: Success lpar6: Success + +5. To create a new virtual machine (gpok3) based on a directory entry: + + mkvm gpok3 /tmp/dirEntry.txt + +Output is similar to: + + gpok3: Creating user directory entry for LNX3... Done + + +6. To clone a new virtual machine with the same profile/resources as the specified node: + + mkvm gpok4 gpok3 pool=POOL1 + +Output is similar to: + + gpok4: Cloning gpok3 + gpok4: Linking source disk (0100) as (1100) + gpok4: Linking source disk (0101) as (1101) + gpok4: Stopping LNX3... Done + gpok4: Creating user directory entry + gpok4: Granting VSwitch (VSW1) access for gpok3 + gpok4: Granting VSwitch (VSW2) access for gpok3 + gpok4: Adding minidisk (0100) + gpok4: Adding minidisk (0101) + gpok4: Disks added (2). Disks in user entry (2) + gpok4: Linking target disk (0100) as (2100) + gpok4: Copying source disk (1100) to target disk (2100) using FLASHCOPY + gpok4: Mounting /dev/dasdg1 to /mnt/LNX3 + gpok4: Setting network configuration + gpok4: Linking target disk (0101) as (2101) + gpok4: Copying source disk (1101) to target disk (2101) using FLASHCOPY + gpok4: Powering on + gpok4: Detatching source disk (0101) at (1101) + gpok4: Detatching source disk (0100) at (1100) + gpok4: Starting LNX3... Done + + =head1 FILES /opt/xcat/bin/mkvm diff --git a/xCAT-client/pods/man1/rinv.1.pod b/xCAT-client/pods/man1/rinv.1.pod index 4e1ad910e..f77f5d382 100644 --- a/xCAT-client/pods/man1/rinv.1.pod +++ b/xCAT-client/pods/man1/rinv.1.pod @@ -182,6 +182,45 @@ 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 +=item * + +To retrieve all information about a zVM node gpok3, enter: + + rinv gpok3 all + gpok3: z/VM UserID: XCAT3 + gpok3: z/VM Host: POKDEV61 + gpok3:Operating System: SUSE Linux Enterprise Server 11 (s390x) + gpok3: Architecture: s390x + gpok3: HCP: gpok3.endicott.ibm.com + gpok3: Privileges: + gpok3: Currently: G + gpok3: Directory: G + gpok3: + gpok3: Total Memory: 796M + gpok3: Processors: + gpok3: CPU 01 ID FF0C452E20978000 CP CPUAFF ON + gpok3: CPU 00 ID FF0C452E20978000 (BASE) CP CPUAFF ON + gpok3: + gpok3: Disks: + gpok3: DASD 0100 3390 EMC2C6 R/W 10016 CYL ON DASD C2C6 SUBCHANNEL = 0000 + gpok3: DASD 0190 3390 EV61A2 R/O 107 CYL ON DASD 61A2 SUBCHANNEL = 000E + gpok3: DASD 0191 3390 EMC20D R/O 1000 CYL ON DASD C20D SUBCHANNEL = 0013 + gpok3: DASD 019D 3390 EV61A2 R/O 146 CYL ON DASD 61A2 SUBCHANNEL = 000F + gpok3: DASD 019E 3390 EV61A2 R/O 250 CYL ON DASD 61A2 SUBCHANNEL = 0010 + gpok3: DASD 0300 9336 (VDSK) R/W 262144 BLK ON DASD VDSK SUBCHANNEL = 0014 + gpok3: DASD 0301 9336 (VDSK) R/W 524288 BLK ON DASD VDSK SUBCHANNEL = 0015 + gpok3: DASD 0402 3390 EV61A2 R/O 146 CYL ON DASD 61A2 SUBCHANNEL = 0011 + gpok3: DASD 0592 3390 EV61A2 R/O 70 CYL ON DASD 61A2 SUBCHANNEL = 0012 + gpok3: + gpok3: NICs: + gpok3: Adapter 0600.P00 Type: QDIO Name: UNASSIGNED Devices: 3 + gpok3: MAC: 02-00-06-00-05-38 LAN: * None + gpok3: Adapter 0700.P00 Type: QDIO Name: UNASSIGNED Devices: 3 + gpok3: MAC: 02-00-06-00-05-39 LAN: * None + gpok3: Adapter 0800.P00 Type: QDIO Name: FOOBAR Devices: 3 + gpok3: MAC: 02-00-06-00-05-3A VSWITCH: SYSTEM VSW2 + +=item * =back diff --git a/xCAT-client/pods/man1/rmvm.1.pod b/xCAT-client/pods/man1/rmvm.1.pod index 9a8a2520f..71e614d40 100644 --- a/xCAT-client/pods/man1/rmvm.1.pod +++ b/xCAT-client/pods/man1/rmvm.1.pod @@ -1,6 +1,6 @@ =head1 NAME -B - Removes HMC- and IVM-managed partitions. +B - Removes HMC-, IVM-, and zVM-managed partitions or virtual machines. =head1 SYNOPSIS @@ -77,6 +77,13 @@ Output is similar to: lpar1: Success +5. To remove a zVM virtual machine: + +I + +Output is similar to: + + gpok4: Deleting virtual server gpok4... Done =head1 FILES diff --git a/xCAT-client/pods/man1/rpower.1.pod b/xCAT-client/pods/man1/rpower.1.pod index 20b8913c4..bed4f9886 100644 --- a/xCAT-client/pods/man1/rpower.1.pod +++ b/xCAT-client/pods/man1/rpower.1.pod @@ -34,6 +34,10 @@ B I [B|B|B|B|B|B|B|B I [B|B] +=head2 zVM specific: + +B I [B|B|B|B|B] + =head1 DESCRIPTION B controls the power for a single or range of nodes, via the out-of-band path. diff --git a/xCAT-client/pods/man1/rscan.1.pod b/xCAT-client/pods/man1/rscan.1.pod index 46b26567d..9bff19ffa 100644 --- a/xCAT-client/pods/man1/rscan.1.pod +++ b/xCAT-client/pods/man1/rscan.1.pod @@ -178,6 +178,24 @@ Output is similar to: type name id type-model serial-number address fsp Server-9125-F2A-SN0262672-B 3 9125-F2A 0262672 192.168.200.243 +5. To collects the node information from one or more hardware control points on zVM AND populate the database with details collected by rscan: + +I + +Output is similar to: + + gpok2: + objtype=node + arch=s390x + os=sles10sp3 + hcp=gpok3.endicott.ibm.com + userid=LINUX2 + nodetype=vm + parent=POKDEV61 + groups=all + mgt=zvm + + =head1 FILES /opt/xcat/bin/rscan