xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 11:42:05 +00:00
Code Issues Releases Wiki Activity

Merge pull request #4491 from gurevichmark/openbmc_rspconfig_man

Browse Source 
Usage and man page update for rspconfig dump
This commit is contained in:
Victor Hu 2017-12-13 15:32:13 -05:00 committed by GitHub
commit fb0c523d2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 114 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
docs/source/guides/admin-guides/references/man1/rspconfig.1.rst
View File

@ -49,6 +49,8 @@ OpenBMC specific:
\ **rspconfig**\ \ *noderange*\ {\ **ipsrc | ip | netmask | gateway | hostname | vlan | sshcfg**\ }
\ **rspconfig**\ \ *noderange*\ \ **dump**\ [\ **-l | -**\ **-list**\ ] [\ **-g | -**\ **-generate**\ ] [\ **-c | -**\ **-clear**\ {\ *id*\ |\ **all**\ }] [\ **-d | -**\ **-download**\ \ *id*\ ]
MPA specific:
=============
@ -430,6 +432,29 @@ OPTIONS
\ **dump**\
Manage OpenBMC system dumps. If no sub-option is provided, will generate, wait, and download the dump.
\ **-c**\ will clear a single specified dump, or use 'all' to clear all dumps on the BMC.
\ **-l**\ will list all the generated dumps on the BMC.
\ **-g**\ will generate a new dump on the BMC. Dump generation can take a few minutes.
\ **-d**\ will download a single dump from the BMC to /var/log/xcat/dump on management or service node.
\ **network**\ ={[\ *ip*\ ],[\ *host*\ ],[\ *gateway*\ ],[\ *netmask*\ ]|\*}
For MPA: get or set the MPA network parameters. If '\*' is specified, all parameters are read from the xCAT database.
@ -1230,6 +1255,48 @@ EXAMPLES
31. To list BMC dumps available for download:
.. code-block:: perl
rspconfig p9euh02 dump -l
Output is similar to:
.. code-block:: perl
p9euh02: [1] Generated: 09/06/2017 14:31:49, Size: 4528
p9euh02: [2] Generated: 09/06/2017 14:31:55, Size: 4516
p9euh02: [3] Generated: 09/06/2017 14:32:01, Size: 4236
p9euh02: [4] Generated: 09/06/2017 14:32:07, Size: 4248
p9euh02: [5] Generated: 09/06/2017 14:32:11, Size: 4268
32. To generate and download BMC dump:
.. code-block:: perl
rspconfig p9euh02 dump
Output is similar to:
.. code-block:: perl
Capturing BMC Diagnostic information, this will take some time...
p9euh02: Dump requested. Target ID is 6, waiting for BMC to generate...
p9euh02: Dump 6 generated. Downloading to /var/log/xcat/dump/20171211-0951_p9euh02_dump_6.tar.xz
********
SEE ALSO

1
perl-xCAT/xCAT/Usage.pm
View File

@ -146,6 +146,7 @@ my %usage = (
rspconfig <noderange> [userid=<userid> username=<username> password=<password>]
OpenBMC specific:
rspconfig <noderange> [ipsrc|ip|netmask|gateway|hostname|vlan]
rspconfig <noderange> dump [-l|--list] [-g|--generate] [-c|--clear {<id>|all}] [-d|--download <id>]
iDataplex specific:
rspconfig <noderange> [thermprofile]
rspconfig <noderange> [thermprofile=<two digit number from chassis>]

46
xCAT-client/pods/man1/rspconfig.1.pod
View File

@ -26,6 +26,8 @@ B<rspconfig> I<noderange> B<garp>=I<time>
B<rspconfig> I<noderange> {B<ipsrc>|B<ip>|B<netmask>|B<gateway>|B<hostname>|B<vlan>|B<sshcfg>}
B<rspconfig> I<noderange> B<dump> [B<-l>|B<--list>] [B<-g>|B<--generate>] [B<-c>|B<--clear> {I<id>|B<all>}] [B<-d>|B<--download> I<id>]
=head2 MPA specific:
B<rspconfig> I<noderange> {B<sshcfg>|B<snmpcfg>|B<pd1>|B<pd2>|B<network>|B<swnet>|B<ntp>|B<textid>|B<frame>}
@ -324,6 +326,26 @@ Select whether each memory bank should be enabled or disabled. State changes tak
The subnet mask.
=item B<dump>
Manage OpenBMC system dumps. If no sub-option is provided, will generate, wait, and download the dump.
=over 4
=item
B<-c> will clear a single specified dump, or use 'all' to clear all dumps on the BMC.
=item
B<-l> will list all the generated dumps on the BMC.
=item
B<-g> will generate a new dump on the BMC. Dump generation can take a few minutes.
=item
B<-d> will download a single dump from the BMC to /var/log/xcat/dump on management or service node.
=back
=item B<network>={[I<ip>],[I<host>],[I<gateway>],[I<netmask>]|*}
For MPA: get or set the MPA network parameters. If '*' is specified, all parameters are read from the xCAT database.
@ -813,6 +835,30 @@ Output is similar to:
fsp: Success
=item 31.
To list BMC dumps available for download:
rspconfig p9euh02 dump -l
Output is similar to:
p9euh02: [1] Generated: 09/06/2017 14:31:49, Size: 4528
p9euh02: [2] Generated: 09/06/2017 14:31:55, Size: 4516
p9euh02: [3] Generated: 09/06/2017 14:32:01, Size: 4236
p9euh02: [4] Generated: 09/06/2017 14:32:07, Size: 4248
p9euh02: [5] Generated: 09/06/2017 14:32:11, Size: 4268
=item 32.
To generate and download BMC dump:
rspconfig p9euh02 dump
Output is similar to:
Capturing BMC Diagnostic information, this will take some time...
p9euh02: Dump requested. Target ID is 6, waiting for BMC to generate...
p9euh02: Dump 6 generated. Downloading to /var/log/xcat/dump/20171211-0951_p9euh02_dump_6.tar.xz
=back
=head1 SEE ALSO