=head1 NAME

B<rscan> - Collects node information from one or more hardware control points.

=head1 SYNOPSIS

I<rscan [-h|--help]>

I<rscan [-v|--version]>

I<rscan [-V|--verbose] noderange [-w][-x|-z]>


=head1 DESCRIPTION

The rscan command lists hardware information for each node managed by the hardware control points specified in noderange.

Note that the first line of the output always contains information about the hardware control point itself. When using the rscan command to generate output for HMC or IVM hardware control points, note that FSPs and BPAs are included in the output.



=head1 OPTIONS



B<-h>          Display usage message.

B<-v>          Command Version.

B<-V>          Verbose output.

B<-w>          Writes output to xCAT database.

B<-x>          XML format.

B<-z>          Stanza formated output.


=head1 RETURN VALUE

  0 The command completed successfully.

  1 An error has occurred.

=head1 EXAMPLES

1. To list all nodes managed by HMC hmc01 in tabular format, enter:

I<rscan hmc01>


Output is similar to:

  type    name                       id   type-model  serial-number  address

  hmc     hmc01                           7310-C05    10F426A        hmc01
  fsp     Server-9117-MMA-SN10F6F3D       9117-MMA    10F6F3D        3.3.3.197
  lpar    lpar3                       4   9117-MMA    10F6F3D
  lpar    lpar2                       3   9117-MMA    10F6F3D
  lpar    lpar1                       2   9117-MMA    10F6F3D
  lpar    p6vios                      1   9117-MMA    10F6F3D


2. To list all nodes managed by IVM ivm02 in XML format and write the output to the xCAT database, enter:

I<rscan ivm02 -x -w>

Output is similar to:

 <Node>
   <cons></cons>
   <profile></profile>
   <parent></parent>
   <serial>10B7D1G</serial>
   <model>9133-55A</model>
   <node>Server-9133-55A-10B7D1G</node>
   <mgt>ivm</mgt>
   <nodetype>fsp</nodetype>
   <hcp>ivm02</hcp>
   <groups>fsp,all</groups>
   <id>10</id>
 </Node>

 <Node>
   <cons>ivm</cons>
   <profile>lpar01</profile>
   <parent>Server-9133-55A-10B7D1G</parent>
   <serial></serial>
   <model></model>
   <node>lpar01</node>
   <mgt>ivm</mgt>
   <nodetype>lpar,osi</nodetype>
   <hcp>ivm02</hcp>
   <groups>lpar,all</groups>
   <id>1</id>
 <Node>

 </Node>
   <cons>ivm</cons>
   <profile>lpar02</profile>
   <parent>Server-9133-55A-10B7D1G</parent>
   <serial></serial>
   <model></model>
   <node>lpar02</node>
   <mgt>ivm</mgt>
   <nodetype>lpar,osi</nodetype>
   <hcp>ivm02</hcp>
   <groups>lpar,all</groups>
   <id>2</id>
 </Node>


3. To list all nodes managed by HMC hmc02 in stanza format and write the output to the xCAT database, enter:

I<rscan hmc02 -z -w>

Output is similar to:

  Server-9458-100992001Y_B:
    objtype=node
    nodetype=bpa
    id=2
    model=9458-100
    serial=992001Y
    hcp=hmc02
    profile=
    parent=
    groups=bpa,all
    mgt=hmc
    cons=

  Server-9119-590-SN02C5F9E:
    objtype=node
    type=fsp
    id=10
    model=9119-590
    serial=02C5F9E
    hcp=hmc02
    profile=
    parent=Server-9458-100992001Y_B
    groups=fsp,all
    mgt=hmc
    cons=

  lpar01:
    objtype=node
    nodetype=lpar,osi
    id=1
    model=
    serial=
    hcp=hmc02
    profile=lpar01
    parent=Server-9119-590-SN02C5F9E
    groups=lpar,all
    mgt=hmc
    cons=hmc

  lpar02:
    objtype=node
    nodetype=lpar,osi
    id=2
    model=
    serial=
    hcp=hmc02
    profile=lpar02
    parent=Server-9119-590-SN02C5F9E
    groups=lpar,all
    mgt=hmc
    cons=hmc

=head1 FILES

/opt/xcat/bin/rscan


=head1 SEE ALSO

L<lsslp(1)|lsslp.1>