diff --git a/xCAT-client/pods/man1/lsslp.1.pod b/xCAT-client/pods/man1/lsslp.1.pod index 481367c47..fc72ecb4d 100644 --- a/xCAT-client/pods/man1/lsslp.1.pod +++ b/xCAT-client/pods/man1/lsslp.1.pod @@ -1,6 +1,6 @@ =head1 NAME -B - Queries selected networked services information within the same subnet. +B - Discovers selected networked services information within the same subnet. =head1 SYNOPSIS @@ -14,7 +14,7 @@ I =head1 DESCRIPTION -The lsslp command queries selected service types using the -s flag. All service types are returned if the -s flag is not specified. If a specific broadcast address is not specified using the -b flag, the broadcast is performed out all broadcast enabled network adapters. The optional -r, -x, and -z flags format the output. +The lsslp command discovers selected service types using the -s flag. All service types are returned if the -s flag is not specified. If a specific broadcast address is not specified using the -b flag, the broadcast is performed out all broadcast enabled network adapters. The optional -r, -x, and -z flags format the output. NOTE: SLP broadcast requests will propagate only within the subnet of the network adapter broadcast IPs specified by the -b flag. If the -b flag is not specified, the SLP broadcast is sent to all network adapter IPs enabled for broadcast. diff --git a/xCAT-client/pods/man1/rbootseq.1.pod b/xCAT-client/pods/man1/rbootseq.1.pod index a7635f06a..8aa902462 100644 --- a/xCAT-client/pods/man1/rbootseq.1.pod +++ b/xCAT-client/pods/man1/rbootseq.1.pod @@ -1,7 +1,7 @@ =head1 NAME -B - Sets the boot order for BladeCenter blades. +B - Persistently sets the order of boot devices for BladeCenter blades. =head1 SYNOPSIS @@ -12,7 +12,9 @@ B [B<-h>|B<--help>|B<-v>|B<--version>] =head1 DESCRIPTION -B sets the boot sequence of the specified blades. Up to four different medium can be listed, separated by commas. +B sets the boot sequence (the order in which boot devices should be tried) for the specified blades. +Up to four different medium/devices can be listed, separated by commas. The boot sequence will remain +in effect for these blades until set differently. =head1 OPTIONS @@ -70,12 +72,16 @@ Display the current boot sequence. =head1 EXAMPLES +=over 3 - rbootseq 1,3 c,f,n,hd0 - rbootseq 14-56,70-203 c,f,n,hd0 - rbootseq 1,3,14-56,70-203 c,f,n,hd0 - rbootseq all,-129-256 c,f,n,hd0 +=item 1. +Set blades 14-56 and 70-203 to try to boot first from the CD drive, then the floppy drive, then +the network, and finally from the 1st hard disk: + + rbootseq blade[14-56],blade[70-203] c,f,n,hd0 + +=back =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/rcons.1.pod b/xCAT-client/pods/man1/rcons.1.pod index dae6950fb..f5ef334d4 100644 --- a/xCAT-client/pods/man1/rcons.1.pod +++ b/xCAT-client/pods/man1/rcons.1.pod @@ -1,6 +1,6 @@ =head1 Name -B - remote console +B - remotely accesses the serial console of a node =head1 B diff --git a/xCAT-client/pods/man1/rsetboot.1.pod b/xCAT-client/pods/man1/rsetboot.1.pod index 2f36fcd8d..d9540bc1a 100644 --- a/xCAT-client/pods/man1/rsetboot.1.pod +++ b/xCAT-client/pods/man1/rsetboot.1.pod @@ -1,7 +1,7 @@ =head1 NAME -B - Sets the boot order for servers with BMC service processors. +B - Sets the boot device to be used for BMC-based servers for the next boot only. =head1 SYNOPSIS @@ -12,7 +12,9 @@ B [B<-h>|B<--help>|B<-v>|B<--version>] =head1 DESCRIPTION -B sets the boot media to be used on the next boot of the specified nodes. +B sets the boot media that should be used on the next boot of the specified nodes. After the nodes are +booted with the specified device (e.g. via L), the nodes will return to using the +default boot device specified in the BIOS. Currently this command is only supported for IPMI nodes. =head1 OPTIONS @@ -42,9 +44,27 @@ Display the current boot setting. =head1 EXAMPLES - rsetboot 1,3 net - rsetboot 14-56,70-203 stat - rsetboot 1,3,14-56,70-203 default +=over 3 + +=item 1. + +Set nodes 1 and 3 to boot from the network on the next boot: + + rsetboot node1,node3 net + +=item 2. + +Display the next-boot value for nodes 14-56 and 70-203: + + rsetboot node[14-56],node[70-203] stat + +=item 3. + +Restore the next-boot value for these nodes back to their default set in the BIOS: + + rsetboot node1,node3,node[14-56],node[70-203] default + +=back =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/rspreset.1.pod b/xCAT-client/pods/man1/rspreset.1.pod index 737baa62f..b73071991 100644 --- a/xCAT-client/pods/man1/rspreset.1.pod +++ b/xCAT-client/pods/man1/rspreset.1.pod @@ -1,6 +1,6 @@ =head1 Name -B - remote hardware inventory +B - resets the service processors associated with the specified nodes =head1 B @@ -11,7 +11,9 @@ B [B<-h>|B<--help>|B<-v>|B<--version>] =head1 B B resets the service processors associated with the specified nodes. It searches -the B table and associated tables to find the service processors associated with the nodes. +the B table and associated tables to find the service processors associated with the nodes +specified. If the node is a BMC-based node, the node's BMC will be reset. If the node is a blade, +the blade's on board service processor will be reset. =head1 B @@ -30,7 +32,15 @@ Print version. =head1 B -B I +=over 3 + +=item 1. + +Reset the service processor that controls node5: + + rspreset node5 + +=back =head1 B diff --git a/xCAT-client/pods/man3/noderange.3.pod b/xCAT-client/pods/man3/noderange.3.pod index da40078e5..d845181b5 100644 --- a/xCAT-client/pods/man3/noderange.3.pod +++ b/xCAT-client/pods/man3/noderange.3.pod @@ -6,151 +6,76 @@ B - syntax for compactly expressing a list of node names I -node1,node2,node8,node20,group1 + node1,node2,node8,node20,group1 -node14-node56,node70-node203,group1-group10 + node14-node56,node70-node203,group1-group10 -node1,node2,node8,node20,node14-node56,node70-node203 + node1,node2,node8,node20,node14-node56,node70-node203 -node[14-56] + node[14-56] -all,-node129-node256,-frame01-frame03 + all,-node129-node256,-frame01-frame03 -/node.* + /node.* -^/tmp/nodes + ^/tmp/nodes -node10+5 + node10+5 -10-15,-13 + 10-15,-13 -group1@group2 + group1@group2 =head1 B -B is a syntax that can be used in most xCAT commands to conve- -niently specify a list of nodes. The result is that the command will +B is a syntax that can be used in most xCAT commands to +conveniently specify a list of nodes. The result is that the command will be applied to a range of nodes, often in parallel. -B is a comma-separated list. Each token (text between commas) +B is a comma-separated list. Each token (text between commas) in the list can be any of the forms listed below: Individual node or group: -I -I + node01 + group1 A range of nodes or groups: -I (equivalent to: node01,node02,node03,...node10) -I (equivalent to: group1,group2,group3) + node01-node10 (equivalent to: node01,node02,node03,...node10) + node[01-10] (same as above) + node01:node10 (same as above) + node[01:10] (same as above) + group1-group3 (equivalent to: group1,group2,group3) + (all the permutations supported above for nodes are also supported for groups) -A regular expression match of nodes or groups: - -I (will match any nodes that start with node3, node4, or -node5) -I (will match any groups that start with group1 or group2) +B tries to be intelligent about detecting padding, so +you can specify "node001-node200" and it will add the proper number of +zeroes to make all numbers 3 digits. An incremented range of nodes: -I (equivalent to: node10,node11,node12,node13) - -The full path of a file containing noderanges of nodes or groups: - -I<^/tmp/nodelist> + node10+3 (equivalent to: node10,node11,node12,node13) A node shorthand range of nodes: -I<10-20> (if prefix is `node', equivalent to: -node10,node11,node12,...node20) -I<10+3> (if prefix is `node', equivalent to: node10,node11,node12,node13) + 10-20 (equivalent to: node10,node11,node12,...node20) + 10+3 (equivalent to: node10,node11,node12,node13) -Or any combination: +Currently, the prefix that will be prepended for the above syntax is always "node". +Eventually, the prefix and optional suffix will be settable via the environment variables +XCAT_NODE_PREFIX and XCAT_NODE_SUFFIX, but currently this only works in bypass mode. -I +A regular expression match of nodes or groups: -Any individual B may be prefixed with an exclusion operator -(default -) with the exception of the file operator (default ^). + /node[345].* (will match any nodes that start with node3, node4, or node5) + /group[12].* (will match any groups that start with group1 or group2) -The intersection operator @ calculates the intersection of the left and -right sides: +The full path of a file containing noderanges of nodes or groups: -I (will result in the list of nodes group1 and group2 have -in common) + ^/tmp/nodelist -Any combination or multiple combinations of inclusive and exclusive -ranges of nodes and groups is legal. There is no precedence implied in -the order of the arguments. Exclusive ranges have precedence over -inclusive. - -Nodes have precedence over groups. If a node range match is made then -no group range match will be attempted. - -All node names are validated against the nodelist table. Invalid nodes -are ignored and return nothing. - -All group names are validated against the nodelist and nodetype table. -Invalid groups are ignored and return nothing. - -Throughout this man page the term I I I will be used. - -I I I is defined by the following regex: - -^([A-Za-z-]+)([0-9]+)(([A-Za-z-]+[A-Za-z0-9-]*)*) - -In plain english a node or group is in I I I if starting -from the begining there are one or more alpha characters of any case -and any number of - in any combination, followed by one or more num- -bers, then optionally followed by one alpha character of any case or -the - followed by any combination of case mixed alphanumerics and the --. - -B supports node/group names in I format. I I I is -B required, however some node range methods used to determine range -will not be used. E.g. If using a B of I with a -B table only listing I through I, B will enu- -merate then validate and return a proper range. If using a node range -of I with a B table only listing I through I B -will fail to return any values. - -Example of I I I node/group names: - -B< nodename prefix number suffix> - node1 node 1 - node001 node 001 - node-001 node- 001 - node-foo-001-bar node-foo- 001 -bar - node-foo-1bar node-foo- 1 bar - foo1bar2 foo 1 bar2 - rack01unit34 rack 01 unit34 - unit34rack01 unit 34 rack01 - pos0134 pos 0134 - -Example of non-I I I node/group names, but still valid: - -aa -yellow -red -12foo - - -The supported B syntaxes are checked for, and processed, in a -specific order. First B checks for the multiple range operator -(default ,). Each range is also processed by B. - -Next B checks for the file operator (default ^). If the file -exists (must be a full path name) each line will be processed as a -B. Lines starting with I<#> or the file operator (default ^) are -ignored. Only one B per line is read. All characters are -ignored after the first white space. - -e.g. - -^/tmp/nodes - -where - -cat /tmp/nodes outputs: +where /tmp/nodelist can contain entries like: #my node list (this line ignored) ^/tmp/foo #ignored @@ -161,103 +86,136 @@ cat /tmp/nodes outputs: /group[456].* -node50 -Next B checks for the exclusion operator (default -) then con- -tinues. This operator supports nodes and groups. B will not -confuse the exclusion or range operators with the - character in names. +Node ranges can contain any combination: -Next B checks for a numeric only range (e.g. 10-20, 5+3, or -just 10), then uses I<$XCAT>B<_>IB<_>I (default is `node') and -I<$XCAT>B<_>IB<_>I (optional) as the defaults to complete the node -names. B tries to be intelligent about detecting padding, so -you can specify `node001-node200' and it will add the proper number of -zeroes to make all numbers 3 digits. Noderange shorthand supports -nodes only. Noderange shorthand can be mixed with all other operators -except regex. i.e. exclusion, increment, range, and file may be used. + node01-node30,node40,^/tmp/nodes,/node[13].*,2-10,node50+5 -Next B checks for the for the regular expression operator -(default /). Regular expressions offer the most flexibility. If you -are interested in learning regex read the book I I -I. This operator supports nodes and groups. +Any individual B may be prefixed with an exclusion operator +(default -) with the exception of the file operator (default ^). This will cause +that individual noderange to be subtracted from the total resulting list of nodes. -Next B checks for the increment range operator (default +). -Increment range operator noderanges are in the format: +The intersection operator @ calculates the intersection of the left and +right sides: -IB<_>IB<_>IB<+>IB<_>IB<_>IB<_>I + group1@group2 (will result in the list of nodes that group1 and group2 have in common) -e.g. +Any combination or multiple combinations of inclusive and exclusive +ranges of nodes and groups is legal. There is no precedence implied in +the order of the arguments. Exclusive ranges have precedence over +inclusive. Parentheses can be used to explicitly specify precendence of any operators. -I +Nodes have precedence over groups. If a node range match is made then +no group range match will be attempted. -would yield node10 plus the next I<5> nodes. +All node and group names are validated against the nodelist table. Invalid names +are ignored and return nothing. -This action is performed using two different methods. If -IB<_>IB<_>I is in I I I then the range is enumerated to -IB<_>IB<_>IB<_>I. If not in I I I then a sorted -B table is used to return the node range. This operator sup- -ports nodes only. +=head2 B -Next B checks for a single node name or group name. +Throughout this man page the term B is used. +B is defined by the following regex: -Next B checks for the range operator (default -). Ranges are -performed first by validating that both the start and end nodes or -groups defining the range exist and if so the range is returned based -on the content of the B and B tables. If the start and -end nodes or groups defined in the range do not exist, I if both are -in I I I, I if both the prefix and suffix match, then the -range is enumerated and each node/group validated. Only valid -nodes/groups will be returned. B will not confuse the exclu- -sion or range operators with the - character in names. + ^([A-Za-z-]+)([0-9]+)(([A-Za-z-]+[A-Za-z0-9-]*)*) -Last B returns nothing if no match can be found. +In plain English, a node or group name is in B if starting +from the begining there are: -B uses the smallest integer to determine padding. e.g. -I will generate a list of nodes with numbers 1, 2, 3, 4, 5, -6, 7, 8, 9, 10. I will generate a list of nodes with -numbers 001, 002, 003, 004, 005, 006, 007, 008, 009, 010. +=over 2 + +=item * + +one or more alpha characters of any case and any number of "-" in any combination + +=item * + +followed by one or more numbers + +=item * + +then optionally followed by one alpha character of any case or "-" + +=item * + +followed by any combination of case mixed alphanumerics and "-" + +=back + +B supports node/group names in I format. B is +B required, however some node range methods used to determine range +will not be used for non-conformant names. + +Example of B node/group names: + + NODENAME PREFIX NUMBER SUFFIX + node1 node 1 + node001 node 001 + node-001 node- 001 + node-foo-001-bar node-foo- 001 -bar + node-foo-1bar node-foo- 1 bar + foo1bar2 foo 1 bar2 + rack01unit34 rack 01 unit34 + unit34rack01 unit 34 rack01 + pos0134 pos 0134 -Multiple instances of a node name are treated as one instance. e.g. -I will generate a list of nodes numbered 1 -through 10, the number 4 will only be listed once. =head1 B -I +=over 3 -Generates a list of all nodes (assuming all is a group) listed in the -B table less node5 through node10. +=item 1. -I +Generates a list of all nodes (assuming all is a group) listed in the +B table less node5 through node10: + + all,-node5-node10 + +=item 2. Generates a list of nodes 1 through 10 less nodes 3,4,5. Note that node4 is listed twice, first in the range and then at the end. Because exclusion has precedence node4 will be excluded. -I + node1-node10,-node3-node5,node4 + +=item 3. Generates a list of nodes 1 through 10 less nodes 3 and 5. -I<-node17-node32,all> + node1-node10,-node3,-node5 + +=item 4. Generates a list of all (assuming `all' is a group) nodes in the B table less 17 through 32. -I + -node17-node32,all + +=item 5. Generates a list of nodes 1 through 128, and user nodes 1 through 4. -I + node1-node128,user1-user4 + +=item 6. Generates a list of all nodes (assuming `all' is a group), less nodes in groups rack1 through rack3 (assuming groups rack1, rack2, and rack3 are defined), less nodes 100 through 200, less nodes in the storage group. Note that node150 is listed but is excluded. -I + all,-rack1-rack3,-node100-node200,node150,-storage + +=item 7. Generates a list of nodes matching the regex I. That is all nodes that start with node2 or node3 and end in anything or nothing. E.g. node2, node3, node20, node30, node21234 all match. + /node[23].* + +=back + + =head1 B L diff --git a/xCAT-client/pods/man5/xcatstanzafile.5.pod b/xCAT-client/pods/man5/xcatstanzafile.5.pod index 55cc9aaac..fbe0a0809 100644 --- a/xCAT-client/pods/man5/xcatstanzafile.5.pod +++ b/xCAT-client/pods/man5/xcatstanzafile.5.pod @@ -1,6 +1,6 @@ =head1 NAME -B - Describes the format of a stanza file that can be used with xCAT commands. +B - Format of a stanza file that can be used with xCAT data object definition commands. =head1 DESCRIPTION diff --git a/xCAT-client/pods/man8/winstall.8.pod b/xCAT-client/pods/man8/winstall.8.pod index 89a2d0ced..d97355659 100644 --- a/xCAT-client/pods/man8/winstall.8.pod +++ b/xCAT-client/pods/man8/winstall.8.pod @@ -1,6 +1,6 @@ =head1 Name -B - Begin installation on a noderange +B - Begin installation on a noderange and display in wcons =head1 B diff --git a/xCAT-client/share/doc/xCAT2.odt b/xCAT-client/share/doc/xCAT2.odt index 0b714c477..b64757d93 100644 Binary files a/xCAT-client/share/doc/xCAT2.odt and b/xCAT-client/share/doc/xCAT2.odt differ