ib_acme(1)

💖 ib_acme(1) 💖

okay bestie, pull up a chair because we're talking about ib_acme — the test and configuration utility for the IB ACM. yes, that's the whole vibe. she's a little tool with big main character energy and two whole personalities. let's get into it 🫶

✨ SYNOPSIS ✨

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

🌸 DESCRIPTION 🌸

so ib_acme is literally here to help you configure and test the ibacm service. two modes, two moods, both iconic 💅

the first way to use her tests that ibacm is actually running and doing its job correctly. like a vibe check for your service.

the second way to use her automatically creates address and configuration files for the ibacm service. she just makes them for you. no cap, that's the whole thing ✨

🎀 OPTIONS 🎀

• -f addr_format — tells her what format your src_addr and dest_addr parameters are in. valid formats are: 'i' for ip address, 'n' for host name, 'l' for lid, 'g' for gid, and 'u' for unspecified. if you skip -f entirely, she assumes an unspecified address format, and ib_acme will use getaddrinfo or other mechanisms to figure out which format the address is using. she's resourceful like that 💁
• -s src_addr — the local source address of the path you wanna resolve. this can be an IP address, a system network name, or a LID, depending on whatever addr_format said.
• -d dest_addr — the destination address of the path to resolve. also can be an IP address, system network name, or LID, as indicated by the addr_format option.
• -v — says the resolved path info should be verified against the active IB SA. using -v gives you a sanity check that the resolved path info is actually usable given your current cluster configuration. love a wellness check ✨
• -c — instructs the ACM service to only return information that currently lives in its local cache. like, if it's not already in her head, she's not going looking 🔥
• -e [N] — displays one endpoint (N = 1, 2, ...) or all endpoints (N = 0 or not present).
• -P [opt] — queries performance data from the destination service. valid options are: "col" for outputting combined data in column format, "N" (N = 1, 2, ...) for outputting data for a specific endpoint N, "all" for outputting data for all endpoints, and "s" for outputting data for a specific endpoint with the address given by the -s option.
• -S svc_addr — hostname, IPv4-address or Unix-domain socket of the ACM service, default: /run/ibacm.sock
• -C repetitions — number of repetitions to perform resolution. used to measure performance of ACM cache lookups. defaults to 1.
• -A [addr_file] — with this option, the ib_acme utility automatically generates the address configuration file ibacm_addr.cfg. the generated file is constructed using the system host name. yes bestie, she knows your name 🥰
• -O [opt_file] — with this option, the ib_acme utility automatically generates the option configuration file ibacm_opts.cfg. this generated file is currently generated using static information.
• -D dest_dir — specify the destination directory for the output files.
• -V — enables verbose output. when you combine it with the -A or -O options, ib_acme will display additional details, such as generated address information saved to the ibacm_addr.cfg file. she's a yapper, let her yap 💜

🦋 NOTES 🦋

the ib_acme utility performs two main functions, bestie. keep up 💅

with the -A and -O options, she automatically generates address or options configuration files. the generated files are text based and may be edited — go off, customize them. these options are intended to provide a simple way to configure address and option information on all nodes on a cluster. every single one. periodt.

the other function of the ib_acme utility is to test the ibacm service, including helping to verify that the service is usable given the current cluster configuration. the ib_acme utility can resolve IP addresses, network names, or IB LIDs into a path record. then it can compare that path record against one obtained by the SA. and when you use her to test the ibacm service, heads up — the ib_acme utility has the side effect of loading the ibacm caches. 👀 that's not a bug, that's just what happens.

multiple, numerical destinations can be specified by adding brackets [] to the end of a base destination name or address. users may specify a list of numerical ranges inside the brackets using the following example as a guide: node[1-3,5,7-8]. this will result in testing node1, node2, node3, node5, node7, and node8. so much range. literally 🌈

👑 SEE ALSO 👑

• ibacm(7)
• ibacm(8)

okay that's the whole page, bestie 💖 this one came from the ib_acme source, dated 2014-06-16, and yeah — the header up top says ib_acme(1) and the footer down here says ib_acme … ib_acme(1), same energy both times 😌 you're gonna slay those path records. mwah 🫶✨