System command line

You can use the apcli command line to manage the system 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 users from the ibmapadmins 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 system software stack.
    • apstop - stops the system software stack.
    • ap node [enable|disable] - enables or disables nodes.
    • 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 system state.
    • ap version - displays software version
    • ap info - displays general information about the system.
    • 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 fs - lists all filesystems, mounts, NDSs and their states.
    • ap sd - disables and enables storage drives.
  • Special purpose commands:
    • 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 system, 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.
    • apusermgmt - manages platform users and application users' access.
    • ap_external_ldap - integrates Cloud Pak for Data System with an external LDAP/Windows Active Directory.