1ib_acme(1)                          ib_acme                         ib_acme(1)
2
3
4

NAME

6       ib_acme - test and configuration utility for the IB ACM
7

SYNOPSIS

9       ib_acme [-f addr_format] [-s src_addr] -d dest_addr [-v] [-c] [-e] [-P] [-S svc_addr] [-C repetitions]
10       ib_acme [-A [addr_file]] [-O [opt_file]] [-D dest_dir] [-V]
11

DESCRIPTION

13       ib_acme  provides assistance configuring and testing the ibacm service.
14       The first usage of the service will test that the ibacm is running  and
15       operating  correctly.  The second usage model will automatically create
16       address and configuration files for the ibacm service.
17

OPTIONS

19       -f addr_format
20              Specifies the format of the src_addr and  dest_addr  parameters.
21              Valid  address  formats  are: 'i' ip address, 'n' host name, 'l'
22              lid, 'g' gid, and 'u' unspecified.  If the -f option is omitted,
23              an  unspecified  address  format  is  assumed.  ib_acme will use
24              getaddrinfo or other mechanisms to determine  which  format  the
25              address uses.
26
27       -s src_addr
28              Specifies  the local source address of the path to resolve.  The
29              source address can be an IP address,  system  network  name,  or
30              LID, as indicated by the addr_format option.
31
32       -d dest_addr
33              Specifies  the  destination address of the path to resolve.  The
34              destination address can be an IP address, system  network  name,
35              or LID, as indicated by the addr_format option.
36
37       -v     Indicates  that the resolved path information should be verified
38              with the active IB SA.  Use of the -v option provides  a  sanity
39              check that resolved path information is usable given the current
40              cluster configuration.
41
42       -c     Instructs the ACM service to only returned information that cur‐
43              rently resides in its local cache.
44
45       -e [N] Displays  one  (N  =  1,  2, ...) or all endpoints (N = 0 or not
46              present).
47
48       -P [opt]
49              Queries performance data from the  destination  service.   Valid
50              options  are:  "col" for outputting combined data in column for‐
51              mat,  "N" (N = 1, 2, ...) for outputting  data  for  a  specific
52              endpoint  N,   "all" for outputting data for all endpoints,  and
53              "s" for outputting data for a specific endpoint with the address
54              given by the -s option.
55
56       -S svc_addr
57              Hostname,  IPv4-address  or  Unix-domain  socket of ACM service,
58              default: /run/ibacm.sock
59
60       -C repetitions
61              number of repetitions to perform resolution.   Used  to  measure
62              performance of ACM cache lookups.  Defaults to 1.
63
64       -A [addr_file]
65              With  this  option,  the ib_acme utility automatically generates
66              the address configuration file  ibacm_addr.cfg.   The  generated
67              file is constructed using the system host name.
68
69       -O [opt_file]
70              With  this  option,  the ib_acme utility automatically generates
71              the option configuration  file  ibacm_opts.cfg.   The  generated
72              file is currently generated using static information.
73
74       -D dest_dir
75              Specify the destination directory for the output files.
76
77       -V     Enables  verbose  output.   When combined with -A or -O options,
78              ib_acme will  display  additional  details,  such  as  generated
79              address information saved to the ibacm_addr.cfg file.
80

NOTES

82       The  ib_acme  utility  performs two main functions.  With the -A and -O
83       options, it automatically generates address  or  options  configuration
84       files.   The  generated  files are text based and may be edited.  These
85       options are intended to provide a simple way to configure  address  and
86       option information on all nodes on a cluster.
87
88       The other function of the ib_acme utility is to test the ibacm service,
89       including helping to verify that the service is usable given  the  cur‐
90       rent  cluster  configuration.   The  ib_acme  utility  can  resolve  IP
91       addresses, network names, or IB LIDs into a path record.  It  can  then
92       compare  that path record against one obtained by the SA.  When used to
93       test the ibacm service, the ib_acme utility  has  the  side  effect  of
94       loading the ibacm caches.
95
96       Multiple, numerical destinations can be specified by adding brackets []
97       to the end of a base destination name or address.  Users may specify  a
98       list  of numerical ranges inside the brackets using the following exam‐
99       ple as a guide: node[1-3,5,7-8].  This will result  in  testing  node1,
100       node2, node3, node5, node7, and node8.
101

SEE ALSO

103       ibacm(7), ibacm(1)
104
105
106
107ib_acme                           2014-06-16                        ib_acme(1)
Impressum