Skip to content

Commit

Permalink
Merge pull request #7219 from gurevichmark/mrvm_manpage
Browse files Browse the repository at this point in the history
Fix rmvm man page formatting
  • Loading branch information
gurevichmark committed Jul 15, 2022
2 parents 522b767 + 7e5632a commit c9334d5
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 20 deletions.
47 changes: 37 additions & 10 deletions docs/source/guides/admin-guides/references/man1/rmvm.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,31 +47,58 @@ DESCRIPTION

The \ **rmvm**\ command removes the partitions specified in \ *noderange*\ . If \ *noderange*\ is an CEC, all the partitions associated with that CEC will be removed. Note that removed partitions are automatically removed from the xCAT database. For IVM-managed systems, care must be taken to not remove the VIOS partition, or all the associated partitions will be removed as well.

For DFM-managed (short For Direct FSP Management mode) normal power machines, only partitions can be removed. No options is needed.
For DFM-managed (short For Direct FSP Management mode) normal Power machines, only partitions can be removed. No options are needed.


*******
OPTIONS
*******


\ **-h|-**\ **-help**\ Display usage message.

\ **-v|-**\ **-version**\ Command Version.
\ **-h|-**\ **-help**\

Display usage message.


\ **-V|-**\ **-verbose**\ Verbose output.

\ **-r**\ Retain the data object definitions of the nodes.
\ **-v|-**\ **-version**\

Command Version.



\ **-V|-**\ **-verbose**\

Verbose output.



\ **-r**\

Retain the data object definitions of the nodes.



\ **-**\ **-service**\

Remove the service partitions of the specified CECs.


\ **-**\ **-service**\ Remove the service partitions of the specified CECs.

\ **-p**\

KVM: Purge the existence of the VM from persistent storage. This will erase all storage related to the VM in addition to removing it from the active virtualization configuration. Storage devices of "raw" or "block" type are not removed.

PPC: Remove the specified partition on normal Power machine.


KVM: Purge the existence of the VM from persistent storage. This will erase all storage related to the VM in addition to removing it from the active virtualization configuration. Storage devices of "raw" or "block" type are not removed.

PPC: Remove the specified partition on normal power machine.
\ **-f**\

Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested.


\ **-f**\ Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested.


************
Expand Down Expand Up @@ -172,7 +199,7 @@ Output is similar to:
gpok4: Deleting virtual server LNX4... Done
6. To remove a DFM-managed partition on normal power machine:
6. To remove a DFM-managed partition on normal Power machine:


.. code-block:: perl
Expand Down
35 changes: 25 additions & 10 deletions xCAT-client/pods/man1/rmvm.1.pod
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,43 @@ B<rmvm [-p]> I<noderange>

The B<rmvm> command removes the partitions specified in I<noderange>. If I<noderange> is an CEC, all the partitions associated with that CEC will be removed. Note that removed partitions are automatically removed from the xCAT database. For IVM-managed systems, care must be taken to not remove the VIOS partition, or all the associated partitions will be removed as well.

For DFM-managed (short For Direct FSP Management mode) normal power machines, only partitions can be removed. No options is needed.
For DFM-managed (short For Direct FSP Management mode) normal Power machines, only partitions can be removed. No options are needed.

=head1 OPTIONS

=over 10

B<-h|--help> Display usage message.
=item B<-h|--help>

B<-v|--version> Command Version.
Display usage message.

B<-V|--verbose> Verbose output.
=item B<-v|--version>

B<-r> Retain the data object definitions of the nodes.
Command Version.

B<--service> Remove the service partitions of the specified CECs.
=item B<-V|--verbose>

B<-p>
Verbose output.

=item B<-r>

Retain the data object definitions of the nodes.

=item B<--service>

Remove the service partitions of the specified CECs.

=item B<-p>

KVM: Purge the existence of the VM from persistent storage. This will erase all storage related to the VM in addition to removing it from the active virtualization configuration. Storage devices of "raw" or "block" type are not removed.

PPC: Remove the specified partition on normal power machine.
PPC: Remove the specified partition on normal Power machine.

=item B<-f>

Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested.

B<-f> Force remove the VM, even if the VM appears to be online. This will bring down a live VM if requested.
=back

=head1 RETURN VALUE

Expand Down Expand Up @@ -97,7 +112,7 @@ Output is similar to:
gpok4: Deleting virtual server LNX4... Done


6. To remove a DFM-managed partition on normal power machine:
6. To remove a DFM-managed partition on normal Power machine:

rmvm lpar1

Expand Down

0 comments on commit c9334d5

Please sign in to comment.