Command line

You can use the apcli command line to manage the appliance software, hardware, and modify some configuration settings.

The command line commands are available only locally, but you can call them remotely by using SSH. The commands can only be run by a user from the ibmapadmin group.

You can run each command from any node. The ap command includes a number of subcommands.

The commands can be divided into three groups:
  • Management commands:
    • apstart - starts the appliance software stack.
    • apstop - stops the appliance software stack.
    • ap node [enable|disable] - enables or disables nodes.
    • ap node rebalance - requests rebalancing of MLNs after enabling a node.
    • ap config - enables to configure alert rules and SMTP.
    • ap apps [enable|disable] - manages the state of the monitored applications.
  • Reporting commands:
    • ap state - reports appliance state.
    • ap version - displays software version
    • ap info - displays general information about the appliance.
    • ap hw - lists hardware inventory with status of each component.
    • ap sw - lists software inventory with status of each component.
    • ap node - lists state of all nodes and identifies master node.
    • ap apps - lists state of all monitored applications
    • ap issues - lists all issues.
    • ap ds - lists data slices and their states.
    • ap fs - lists all filesystems, mounts, NDSs and their states.
  • Special purpose commands:
    • apsetup - an interactive script for modifying the initial appliance configuration. For more information, see Configuring your appliance with the apsetup script
    • apdiag - collects various logs, commands output, and configuration files from the system for diagnosing issues. This command is described in detail in Running diagnostics by using the apdiag command.
    • aphistory - keeps a record of any significant alterations or modifications to the appliance, such as upgrade, service. aphistory is captured with every diagnostic data collection, whether that collection is done automatically after an error or alert is presented, or manually via the apdiag utility.
    • apcertmgmt - changes certificate for SSL communication in etcd, and X509 certificate for HTTPS in REST API.