arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add -v and aix note

Browse Source
This commit is contained in:
nott 2013-10-12 12:58:15 -04:00
parent 6fa8fdfb74
commit baabb6d4ba
8 changed files with 110 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
xCAT-client/pods/man1/addkit.1.pod
View File

@ -4,38 +4,48 @@ B<addkit> - Install a kit on the xCAT management node
=head1 SYNOPSIS
B<addkit> [-h|--help]
B<addkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<addkit> [-i|--inspection] <kitlist>
B<addkit> [B<-i>|B<--inspection>] I<kitlist>
B<addkit> [-V|--verbose] [-p|--path <path>] <kitlist>
B<addkit> [B<-V>|B<--verbose>] [B<-p>|B<--path> I<path>] I<kitlist>
=head1 DESCRIPTION
The B<addkit> command install a kit on the xCAT management node from a kit tarfile or directory, creating xCAT database definitions for kit, kitrepo, kitcomponent.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
B<-h|--help>
=over 10
=item B<-h|--help>
Display usage message.
B<-V|--verbose>
=item B<-V|--verbose>
Verbose mode.
B<-i|--inspection>
=item B<-v|--version>
Command version.
=item B<-i|--inspection>
Show the summary of the given kits
B<-p|--path <path>>
=item B<-p|--path <path>>
The destination directory to which the contents of the kit tarfiles and/or kit deploy dirs will be copied. When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.
B<kitlist>
=item B<kitlist>
a comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be added to the xCAT cluster. Each entry can be an absolute or relative path. For kit_tarball_files, these must be valid kits tarfiles added. For kit_deploy_dirs, these must be fully populated directory structures that are identical to the contents of an expanded kit_tarball_file.
=back
=head1 RETURN VALUE
0 The command completed successfully.

33
xCAT-client/pods/man1/addkitcomp.1.pod
View File

@ -1,47 +1,56 @@
=head1 NAME
B<addkitcomp> - Assign kit components to osimage.
B<addkitcomp> - Assign Kit components to an xCAT osimage.
=head1 SYNOPSIS
B<addkitcomp> [-h|--help]
B<addkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<addkitcomp> [-a|--adddeps] [-f|--force] [-n|--noupgrade] [-V|--verbose] -i <osimage> <kitcompname_list>
B<addkitcomp> [B<-V>|B<--verbose>] [B<-a>|B<--adddeps>] [B<-f>|B<--force>] [B<-n>|B<--noupgrade>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
The B<addkitcomp> command will assign kit components to osimage. The kit component meta rpm, package rpm and deploy parameters will be added to osimage's otherpkg.pkglist and postbootscripts will be added to osimages's postbootscripts attribute.
The B<addkitcomp> command will assign kit components to an xCAT osimage. The kit component meta rpm, package rpm and deploy parameters will be added to osimage's otherpkg.pkglist and postbootscripts will be added to osimages's postbootscripts attribute.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
B<-a|--adddeps>
=item B<-a|--adddeps>
Assign kitcomponent dependencies to the osimage.
B<-h|--help>
=item B<-h|--help>
Display usage message.
B<-V|--verbose>
=item B<-V|--verbose>
Verbose mode.
B<-f|--force>
=item B<-v|--version>
Command version.
=item B<-f|--force>
Add kit component to osimage even if there is a mismatch in OS, version, arch, serverrole, or kitcompdeps
B<-i <osimage>>
=item B<-i> I<osimage>
osimage name that kit component is assigning to
The osimage name that the kit component is assigning to.
B<-n|--noupgrade>
=item B<-n|--noupgrade>
Allow multiple versions of kitcomponent to be installed into the osimage, instead of kitcomponent upgrade
B<kitcompname_list>
=item B<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be added to the osimage.
=back
=head1 RETURN VALUE

27
xCAT-client/pods/man1/chkkitcomp.1.pod
View File

@ -1,35 +1,44 @@
=head1 NAME
B<chkkitcomp> - Check if kit component fits to osimage.
B<chkkitcomp> - Check if Kit components are compatible with an xCAT osimage.
=head1 SYNOPSIS
B<chkkitcomp> [-h|--help]
B<chkkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<chkkitcomp> [-V|--verbose] -i <osimage> <kitcompname_list>
B<chkkitcomp> [B<-V>|B<--verbose>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
The B<chkkitcomp> command will check if the kit components are fitting to the osimage or not. This command will ignore the current osimage.kitcomponents setting, and just to check if the kitcompname_list in the cmdline is fitting to the osimage by osversion/ostype/osarch/ and kit component dependencies.
The B<chkkitcomp> command will check if the kit components are compatible with the xCAT osimage. This command will if the kitcompname_list provided on the command line is compatible with the osimage.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
B<-h|--help>
=over 10
=item B<-h|--help>
Display usage message.
B<-V|--verbose>
=item B<-V|--verbose>
Verbose mode.
B<-i <osimage>>
=item B<-v|--version>
osimage name that is used for checking if kit components are fitting to it.
Command version.
B<kitcompname_list>
=item B<-i> I<osimage>
The name of the osimage is used for check.
=item B<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be checking to the osimage.
=back
=head1 RETURN VALUE

12
xCAT-client/pods/man1/lskit.1.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<lskit> - list info for one or more kits
B<lskit> - Lists information for one or more Kits.
=head1 SYNOPSIS
@ -17,25 +17,26 @@ B<lskit> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<lskit> command is used to list info for one or more kits. A kit is a special kind of package that is used to install a software product on one or more nodes in an xCAT cluster.
The B<lskit> command is used to list information for one or more kits. A kit is a special kind of package that is used to install a software product on one or more nodes in an xCAT cluster.
Note: The xCAT support for Kits is only available for Linux operating systems.
The B<lskit> command outputs the following info for each kit: the kit's basic info, the kit's repositories, and the kit's components. The command outputs the info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
Input to the command can specify any number or combination of the input options.
=head1 OPTIONS
=over 10
=item B<-K|--kitattr> I<kitattr_names>
where I<kitattr_names> is a comma-delimited list of kit attribute names. The names correspond to attribute names in the B<kit> table. The B<lskit> command will only display the specified kit attributes.
Where I<kitattr_names> is a comma-delimited list of kit attribute names. The names correspond to attribute names in the B<kit> table. The B<lskit> command will only display the specified kit attributes.
=item B<-R|--repoattr> I<repoattr_names>
where I<repoattr_names> is a comma-delimited list of kit repository attribute names. The names correspond to attribute names in the B<kitrepo> table. The B<lskit> command will only display the specified kit repository attributes.
Where I<repoattr_names> is a comma-delimited list of kit repository attribute names. The names correspond to attribute names in the B<kitrepo> table. The B<lskit> command will only display the specified kit repository attributes.
=item B<-C|--compattr> I<compattr_names>
@ -100,7 +101,6 @@ Display usage message.
=back
=head1 RETURN VALUE
=over 3

11
xCAT-client/pods/man1/lskitcomp.1.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<lskitcomp> - list info for one or more kit components
B<lskitcomp> - Used to list information for one or more kit components.
=head1 SYNOPSIS
@ -17,38 +17,34 @@ B<lskitcomp> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<lskitcomp> command is used to list info for one or more kit components. A kit is made up of one or more kit components. Each kit component is a meta package used to install a software product component on one or more nodes in an xCAT cluster.
The B<lskitcomp> command is used to list information for one or more kit components. A kit is made up of one or more kit components. Each kit component is a meta package used to install a software product component on one or more nodes in an xCAT cluster.
The B<lskitcomp> command outputs the kit component info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
Input to the command can specify any number or combination of the input options.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-C|--compattr> I<compattr_names>
where I<compattr_names> is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the B<kitcomponent> table. The B<lskitcomp> command will only display the specified kit component attributes.
=item B<-O|--osdistro> I<os_distro>
where I<os_distro> is the name of an osdistro in B<osdistro> table. The B<lskitcomp> command will only display the kit components matching the specified osdistro.
=item B<-S|--serverrole> I<server_role>
where I<server_role> is the name of a server role. The typical server roles are: mgtnode, servicenode, computenode, loginnode, storagennode. The B<lskitcomp> command will only display the kit components matching the specified server role.
=item I<kitcomp_names>
is a comma-delimited list of kit component names. The B<lskitcomp> command will only display the kit components matching the specified names.
=item B<-x|--xml|--XML>
Return the output with XML tags. The data is returned as:
@ -95,7 +91,6 @@ Display usage message.
=back
=head1 RETURN VALUE
=over 3

15
xCAT-client/pods/man1/lskitdeployparam.1.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<lskitdeployparam> - list the kit deployment parameters for either one or more kits, or one or more kit components
B<lskitdeployparam> - Lists the deployment parameters for one or more Kits or Kit components
=head1 SYNOPSIS
@ -15,12 +15,13 @@ B<lskitdeployparam> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<lskitdeployparam> command is used to list the kit deployment parameters for either one or more kits, or one or more kit components. Kit deployment parameters are used to customize the installation or upgrade of kit components.
The B<lskitdeployparam> command is used to list the kit deployment parameters for one or more kits, or one or more kit components. Kit deployment parameters are used to customize the installation or upgrade of kit components.
The B<lskitdeployparam> command outputs the kit component info in two formats: human-readable format (default), and XML format. Use the -x option to view the info in XML format.
The B<lskitdeployparam> command outputs the kit component information in two formats: human-readable format (default), and XML format. Use the -x option to view the information in XML format.
Input to the command can specify any number or combination of the input options.
Input to the command can specify any combination of the input options.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
@ -28,13 +29,11 @@ Input to the command can specify any number or combination of the input options.
=item B<-k|--kitname> I<kit_names>
where I<kit_names> is a comma-delimited list of kit names. The B<lskitdeployparam> command will only display the deployment parameters for the kits with the matching names.
Where I<kit_names> is a comma-delimited list of kit names. The B<lskitdeployparam> command will only display the deployment parameters for the kits with the matching names.
=item B<-c|--compname> I<comp_names>
where I<comp_names> is a comma-delimited list of kit component names. The B<lskitdeployparam> command will only display the deployment parameters for the kit components with the matching names.
Where I<comp_names> is a comma-delimited list of kit component names. The B<lskitdeployparam> command will only display the deployment parameters for the kit components with the matching names.
=item B<-x|--xml|--XML>

24
xCAT-client/pods/man1/rmkit.1.pod
View File

@ -4,31 +4,41 @@ B<rmkit> - Remove Kits from xCAT
=head1 SYNOPSIS
B<rmkit> [-h|--help]
B<rmkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<rmkit> [-V|--verbose] [-f|--force] <kitlist>
B<rmkit> [B<-V>|B<--verbose>] [B<-f>|B<--force>] I<kitlist>
=head1 DESCRIPTION
The B<rmkit> command removes kits on the xCAT management node from kit names.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
B<-h|--help>
=over 10
=item B<-h|--help>
Display usage message.
B<-V|--verbose>
=item B<-V|--verbose>
Verbose mode.
B<-f|--force>
=item B<-v|--version>
Command version.
=item B<-f|--force>
Remove this kit even there is any component in this kit is listed by osimage.kitcomponents. If this option is not specified, this kit will not be removed if any kit components listed in an osimage.kitcomponents
B<kitlist>
=item B<kitlist>
a comma delimited list of kits that are to be removed from the xCAT cluster. Each entry can be a kitname or kit basename. For kit basename, rmkit command will remove all the kits that have that kit basename.
A comma delimited list of kits that are to be removed from the xCAT cluster. Each entry can be a kitname or kit basename. For kit basename, rmkit command will remove all the kits that have that kit basename.
=back
=head1 RETURN VALUE

31
xCAT-client/pods/man1/rmkitcomp.1.pod
View File

@ -1,43 +1,52 @@
=head1 NAME
B<rmkitcomp> - Remove kit components from osimage.
B<rmkitcomp> - Remove Kit components from an xCAT osimage.
=head1 SYNOPSIS
B<rmkitcomp> [-h|--help]
B<rmkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<rmkitcomp> [-u|--uninstall] [-f|--force] [-V|--verbose] -i <osimage> <kitcompname_list>
B<rmkitcomp> [B<-V>|B<--verbose>] [B<-u>|B<--uninstall>] [B<-f>|B<--force>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
The B<rmkitcomp> command removes kit components from osimage. All the kit component attributes that attached to the osimage will be removed from osimage attributes, and the kit comoponent meta rpm and package rpm could be uninstalled by <-u|--uninstall> option.
The B<rmkitcomp> command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit comoponent meta rpm and package rpm could be uninstalled by <-u|--uninstall> option.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
B<-u|--uninstall>
=over 10
all the kit component meta rpm and package rpm in otherpkglist will be uninstalled during genimage for stateless image and updatenode for statefull nodes.
=item B<-u|--uninstall>
B<-h|--help>
All the kit component meta rpms and package rpms in otherpkglist will be uninstalled during genimage for stateless image and updatenode for stateful nodes.
=item B<-h|--help>
Display usage message.
B<-V|--verbose>
=item B<-V|--verbose>
Verbose mode.
B<-f|--force>
=item B<-v|--version>
Command version.
=item B<-f|--force>
Remove this kit component from osimage no matter it is a dependency of other kit components.
B<-i <osimage>>
=item B<-i> I<osimage>
osimage name that include this kit component.
B<kitcompname_list>
=item B<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be removed from the osimage.
=back
=head1 RETURN VALUE