=head1 NAME

B<getadapter> - Obtain all network adapters's predictable name and some other information before provision or network configuration.

=head1 SYNOPSIS

B<getadapter> I<noderange> [B<-f>]

B<getadapter> [B<-h>|B<--help>|B<-v>|B<--version>|B<-V>]

=head1 DESCRIPTION

Traditionally, network interfaces in Linux are enumerated as eth[0123...], but these names do not necessarily correspond to actual labels on the chassis. B<getadapter> help customer to get predictable network device name and some other network adapter information before provision or network configuration.

B<getadapter> use genesis to collect network adapters information, so that mean it need to restart the target node.

B<getadapter> follows below scheme:

If the target node is scaned for the first time, B<getadapter> will trigger genesis to collect information then save the information at local.
If the target node has ever been scaned, i.e. this node has network device information in local, B<getadapter> use the local information first.
If user doesn't want to use local information, can use B<-f> option to force to trigger new round scan process.
if part nodes of I<noderange> don't have network device information in local and the rest have, B<getadapter> only trigger real scan process for these nodes which don't have local information, the nodes have network device information in local, B<getadapter> still use the local information first.

B<getadapter> tries to collect more information for the  target network device,  but doesn't guarantee collect same much information for every network device.

Below are the possible information can be collect up to now:
B<name>: the consistent name which can be used by confignic directly in operating system which follow the same naming scheme with rhels7
B<pci>: the pci location
B<mac>: the MAC address
B<candidatename>: All the names which satisfy predictable network device naming scheme. I<(if xcat enhance confignic command later, user can use these names to configure their network adapter, even customize their name)>
B<vender>:  the vender of network device
B<model>:  the model of network device
B<linkstate>:  the link state of network device

=head1 OPTIONS

B<-h>

Display usage message.

B<-v>

Command Version.

B<-V>

Display verbose message.

B<-f>

Force to trigger new round scan. ignore the data collected before.


=head1 EXAMPLES

1. To collect node[1-3]'s network device information, enter:

 getadapter  node[1-2]

Output is similar to:

 -->Starting scan for: node1,node2
 The whole scan result:
 --------------------------------------
 [node1]: Adapter information exists, no need to scan.
 --------------------------------------
 [node2] scan successfully, below are the latest data
 node2:[1]->eno1!mac=34:40:b5:be:6a:80|pci=/pci0000:00/0000:00:01.0/0000:0c:00.0|candidatename=eno1/enp12s0f0/enx3440b5be6a80
 node2:[2]->enp0s29u1u1u5!mac=36:40:b5:bf:44:33|pci=/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.1/2-1.1.5/2-1.1.5:1.0|candidatename=enp0s29u1u1u5/enx3640b5bf4433

Every node gets a separate section to display its all network adapters information, every network adapter owns single line which start as node name and followed by index and other information.


2. Force to trigger new round scan

  getadatper node -f



=head1 SEE ALSO

L<noderange(3)|noderange.3>


