ap commands
The ap command and its subcommands display information about the appliance and send management requests.
Syntax
ap [-h] [-v] [--host address] [--user user] [--password password]
[--from-file file_path]
{apps,config,df,ds,elog,events,fs,hw,info,issues,maintenance,node,sd,state,sw,version} ...
Optional parameters
If you do not specify any of the parameters, the same output as for ap state is displayed, that is the general state of the entire appliance.
rackX, hadomainX is used.- -h|--help
-
Displays help for the command.
- -v|--verbose
-
Displays some additional information from the logs.
You can use the following parameters to run the ap command remotely:
- --host address
- Specifies the address of the system. Default value is
localhost. When specifying other than default, you must also provide user and password. - --user user
- User name to access the host.
- --password password
- Password to access the host.
- --from-file file_path
-
Uses the specified file to load hostname, user and password. Values provided as options override the values from the file.
Subcommands
- ap apps [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>] [-d] [-f] [{enable,disable} <application>]
- Lists and manages the state of monitored applications. Without any parameters, the command lists
all monitored applications and their state, as in the
example:
Parameters specific to the command are as follows:ap apps +------------+------------------+ | Name | Management State | +------------+------------------+ | DashDB | ENABLED | | CallHome | ENABLED | | WebConsole | ENABLED | +------------+------------------+ Generated: 2018-07-27 08:52:02- -d|--detail
-
Displays detailed information about the state of all monitored applications. Specifies application type:
- Appliance application: applications that the user connects to use the appliance, for example, Db2 Warehouse, DSX.
- Platform application: applications that are used to manage the appliance, which are part of the management platform, for example, Web Console, Call Home.
- -f|--force
- Does not ask before taking action.
- enable application
- Enables the specified application.
- disable application
- Disables the specified application.Note: When disabling Db2 Warehouse with ap apps disable dashDB command, the database is stopped and it cannot be started by running apstart. The only way to start the database is by running ap apps enable dashDB. Running apstart instead will result in a warning message.
- ap config [--host <address>] [-h] (--set alerts_rules --type (action|to|add_to) [--scope <alert_type>|<alert_reason_code>] --value (<action_int>|<email_list>) | --del alerts_rules --type (action|to|add_to) [--scope <alert_type>|<alert_reason_code>] | --test alerts_rules --reason_code <reason_code> | --list alerts_rules | --set smtp --mail_server_name <server_name> --mail_server_port <port> --sender_name <sender_name> --sender_address <sender_address> | --list smtp)
- Enables you to configure alert rules or SMTP.
- ap df [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>]
- Shows storage utilization.
- ap ds [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>]
- Displays information about the mapping of multiple logical nodes (MLNs) and logical ports, as
well as MLN status. A sample command and output
follow:
ap ds +------------+--------------+--------------+--------+ | Data slice | Node | Logical Port | Status | +------------+--------------+--------------+--------+ | 0 | node0101-fab | 0 | UP | | 1 | node0101-fab | 1 | UP | | 2 | node0101-fab | 2 | UP | | 3 | node0102-fab | 0 | UP | | 4 | node0102-fab | 1 | UP | | 5 | node0102-fab | 2 | UP | | 6 | node0102-fab | 3 | UP | | 7 | node0103-fab | 0 | UP | | 8 | node0103-fab | 1 | UP | | 9 | node0103-fab | 2 | UP | | 10 | node0103-fab | 3 | UP | +------------+--------------+--------------+--------+ Generated: 2018-07-27 08:52:20 - ap elog close <node> (<elog_event_id> | all)
- Used to close elog related events.
- -f| --force
- Does not ask before performing action.
- <node>
- Positional argument. Node for which the event closes.
- <elog_event_id>
- Positional argument. ID of the event to close. Might be set as
allto close all of the events.
- close
- Positional argument. Might be used to close an FSP event with ID
ZZZgenerated on nodeYin HA domainXby ap elog close hadomainX.nodeY ZZZ command. For instance:
To close all the FSP events for a specified node runap elog close hadomain1.node2 0x504BDCB8ap elog close hadomain1.node3 all
- ap events [--host <address>] [[-h] [-d] [-ni] [-rc <reason_code>] [-tp <type>] [-tg <target>] [-tsub <target>]| <event_id> | [--user <user>] [--password <password>] [--from-file <file_path>]
- Displays information about all events. The output is the same as for ap issues
-e.
- --from <time> --to <time>
- Specifies the time frame for which to display events. The values can be provided in three
forms:
where--from YYYY-MM-DD-hh:mm --to YYYY-MM-DD-hh:mmYYYY-MM-DD-hh:mmis date and time.
where--from YYYY-MM-DD --to YYYY-MM-DDYYYY-MM-DDis a date. In this case, the start time is assumed to be 00:00:00 and the end time is 23:59:59.
where N is a number of days before the current date, so, for example,--from -N --to -N--from -32sets the start date to 32 days before the current date. The starts time is assumed to be 00:00:00 and the end time is 23:59:59.
- -ni| --no_information
- Displays events with severity other than INFORMATION.
- -tp <type> [<type> ...]| --types <type> [<type> ...]
- Displays only events for the given type(s).
- -rc <reason_code> [<reason_code> ...]| --reason_codes <reason_code> [<reason_code> ...]
- Displays only events for the given reason code(s).
- -tg <target>| --target <target>
- Displays only events of the given target.
- -tsub <target>| --target_subcomponents <target>
- Displays all events for target and its subcomponents.
- ap fs [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>] [-d]
- Displays file system information. A sample command and output follow.
ap fs +-----------+------------+---------------------------------------------+-----------+-----------+--------+--------+ | HA Domain | Filesystem | Disk | Size [GB] | Used [GB] | % Used | Status | +-----------+------------+---------------------------------------------+-----------+-----------+--------+--------+ | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000400001d | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000500001e | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a8000000007000020 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a8000000008000021 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a8000000009000022 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000a000023 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000b000024 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000c000025 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000d000026 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | data | nsd.mpath_36005076a81b5348a800000000e000027 | 1566.72 | 0.47 | 0.03 | OK | | hadomain1 | head | nsd.mpath_36005076a81b5348a8000000000000019 | 1024.00 | 12.08 | 1.18 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a8000000010000029 | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a800000001100002a | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a800000001200002b | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a800000001300002c | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a800000001400002d | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a800000001500002e | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a800000001600002f | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a8000000017000030 | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a8000000018000031 | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | local | nsd.mpath_36005076a81b5348a8000000019000032 | 1566.72 | 105.28 | 6.72 | OK | | hadomain1 | platform | nsd.mpath_36005076a81b5348a800000000f000028 | 3072.00 | 2.76 | 0.09 | OK | | hadomain1 | scratch | nsd.mpath_36005076a81b5348a800000000100001a | 10240.00 | 4.10 | 0.04 | OK | +-----------+------------+---------------------------------------------+-----------+-----------+--------+--------+ Filesystems mounts +------------+-----------------+-------------------------------------+ | Filesystem | Node | Mountpoint | +------------+-----------------+-------------------------------------+ | data | hadomain1.node1 | /opt/ibm/appliance/storage/data | | data | hadomain1.node2 | /opt/ibm/appliance/storage/data | | data | hadomain1.node3 | /opt/ibm/appliance/storage/data | | head | hadomain1.node1 | /opt/ibm/appliance/storage/head | | head | hadomain1.node2 | /opt/ibm/appliance/storage/head | | head | hadomain1.node3 | /opt/ibm/appliance/storage/head | | local | hadomain1.node1 | /opt/ibm/appliance/storage/local | | local | hadomain1.node2 | /opt/ibm/appliance/storage/local | | local | hadomain1.node3 | /opt/ibm/appliance/storage/local | | platform | hadomain1.node1 | /opt/ibm/appliance/storage/platform | | platform | hadomain1.node2 | /opt/ibm/appliance/storage/platform | | platform | hadomain1.node3 | /opt/ibm/appliance/storage/platform | | scratch | hadomain1.node1 | /opt/ibm/appliance/storage/scratch | | scratch | hadomain1.node2 | /opt/ibm/appliance/storage/scratch | | scratch | hadomain1.node3 | /opt/ibm/appliance/storage/scratch | +------------+-----------------+-------------------------------------+ Generated: 2018-07-27 08:53:00 - ap hw [--host <address>] [-h] [SN | location | -t <type>] [-d] [<subcomponent> -s <level>] [--user <user>] [--password <password>] [--from-file <file_path>]
Displays a list of the hardware devices with their roles, statuses, and other properties. Parameters are as follows:
- SN | location
- A positional argument. Specifies the serial number or location of the device. If you do not specify a serial number or location, information about all devices is displayed.
- -t type|--type type
-
Displays information about devices of the specified type. For types available in your system, see the output table in
ap hw -d. - -d|--detail
-
Displays additional information.
- -s|--subcomponents
- Shows subcomponents tree of the specified device. You can specify to which level you want to see
the tree, for example,
-s 1displays only direct subcomponents of the device, while-s 2shows all subcomponents of the device, and their subcomponents.
ap hw +----------------------------+------------------+-------------+--------------+-----------------+----------------------+ | Name | Location | Status | SN | Model | FW | +----------------------------+------------------+-------------+--------------+-----------------+----------------------+ | Fabric Switch | hadomain1.fabswa | ATTENTION | MT1720X08174 | MSN2410 | 3.4.1 | | Fabric Switch | hadomain1.fabswb | UNREACHABLE | | | | | Fibre Channel Switch | hadomain1.fcswa | OK | EWY4046M01H | 8960_F64 | 8.0.1b | | Fibre Channel Switch | hadomain1.fcswb | UNREACHABLE | | | | | Flash Storage Node | hadomain1.fsn1 | WARNING | 73F01Z | 9840-AE2 | 1.4.6.1 | | Management Switch | hadomain1.mgtswa | ATTENTION | EC1706003855 | 4610-54T-O-AC-B | 3.2.1 | | Management Switch | hadomain1.mgtswb | ATTENTION | EC1706003830 | 4610-54T-O-AC-B | 3.2.1 | | Compute Node | hadomain1.node1 | ATTENTION | 21259AA | 8247-22L | FW860.42 (SV860_138) | | Compute Node | hadomain1.node2 | ATTENTION | 213322A | 8247-22L | FW860.42 (SV860_138) | | Compute Node | hadomain1.node3 | ATTENTION | 21331FA | 8247-22L | FW860.42 (SV860_138) | | Rackmount Power Controller | hadomain1.rpc1 | OK | 55418J | 00AK187 | | | Rackmount Power Controller | hadomain1.rpc2 | OK | 55418W | 00AK187 | | | Rackmount Power Controller | hadomain1.rpc3 | OK | 55418T | 00AK187 | | | Rackmount Power Controller | hadomain1.rpc4 | OK | 55418X | 00AK187 | | | Terminal Server | hadomain1.ts1 | OK | QX87400027 | DSX2-32 | 2.2.0.5.1825 | +----------------------------+------------------+-------------+--------------+-----------------+----------------------+ Generated: 2018-07-27 08:52:29- ap info [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>]
- Displays general information about the appliance. Sample output
follows:
ap info +-------------------------------------+ | General information | +-----------------+-------------------+ | MTM | 3452-DB1 | | Serial | NZTULET | +-----------------+-------------------+ +--------------------------------------------+ | System information | +-----------------------+--------------------+ | Description | | | Location | | | Country Code | | | Model | M4001-003 | +-----------------------+--------------------+ +--------------------------------+ | Customer information | +--------------------+-----------+ | Company | | | Address 1 | | | Address 2 | | | Address 3 | | | ICN | | +--------------------+-----------+ - ap issues [-h] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>] [-d] [-i] [-e] [-c] [-hw] [-sw] [-gpfs] [--show_registry] [--open_service_request <alert_id> [<alert_id> ...]] [-rc <reason_code> [<reason_code> ...]] [-tp <type> [<type> ...]] [-tg <target>] [-tsub <target>] [-ni] [--from <time_specifier>] [--to <time_specifier>] | <issue_id> | [-f] --close <issue_id> | --service_requests [<srid>] | --generate_test_alert | --close_test_alert | --generate_test_sw_alert | --close_test_sw_alert
- Displays information about current system issues. Parameters are as follows. If you do not
specify any parameters, a list of all current issues (with their types, severities, and
descriptions) is displayed.
- -d|--detail
-
Displays detailed information about all issues.
- -i|--issues
- Displays information about all open issues.
- -c|--closed
- Displays information about all closed issues.
- -e|--events
- Displays information about all events.
- -hw|--hw
- Displays information about all hardware components with some issues.
- -sw|--sw
- Displays information about all software components with some issues.
- -gpfs
- Displays information about all GPFS components with some issues.
- --from <time> --to <time>
- Specifies the time frame for which to display events. The values can be provided in three
forms:
where--from YYYY-MM-DD-hh:mm --to YYYY-MM-DD-hh:mmYYYY-MM-DD-hh:mmis date and time.
where--from YYYY-MM-DD --to YYYY-MM-DDYYYY-MM-DDis a date. In this case, the start time is assumed to be 00:00:00 and the end time is 23:59:59.
where N is a number of days before the current date, so, for example,--from -N --to -N--from -32sets the start date to 32 days before the current date. The starts time is assumed to be 00:00:00 and the end time is 23:59:59.
- -tp <type> [<type> ...]| --types <type> [<type> ...]
- Displays only issues/events for the given type(s).
- -rc <reason_code> [<reason_code> ...]| --reason_codes <reason_code> [<reason_code> ...]
- Displays only issues/events for the given reason code(s).
- -tg <target>| --target <target>
- Displays only issues/events of the given target.
- -tsub <target>| --target_subcomponents <target>
- Displays all issues/events for target and its subcomponents.
- -ni| --no_information
- Displays events with severity other than INFORMATION.
- --close issue_id
- Closes alert with the specified ID.
- -f|--force
- Does not ask before closing the alert.
- issue_id
- Positional argument. Displays detailed information about a particular issue.
- --generate_test_alert
- Generates a test issue.
- --close_test_alert
- Closes a test issue.
- --generate_test_sw_alert
- Generates a test software issue.
- --close_test_sw_alert
- Closes a test software issue.
- --show_registry
- Shows alerts registry.
- --open_service_request <alert_id> [<alert_id> ...]
- Opens PMRs for a specified set of issues and events.
- -sr [<srid>]| --service_requests [<srid>]
- Shows service requests opened by Platform Manager with their statuses and associated alert IDs.
ap issues Open alerts (issues) +------+---------------------+----------------------+-------------------------------------+-------------------------------------+----------+ | ID | Date (CEST) | Type | Reason Code and Title | Target | Severity | +------+---------------------+----------------------+-------------------------------------+-------------------------------------+----------+ | 1005 | 2018-07-05 14:49:58 | HW_NEEDS_ATTENTION | 201: Unhealthy component detected | hw://hadomain1.fabswa.port49 | WARNING | | 1006 | 2018-07-05 14:49:58 | HW_NEEDS_ATTENTION | 201: Unhealthy component detected | hw://hadomain1.fsn1 | WARNING | | 1007 | 2018-07-05 14:49:58 | HW_NEEDS_ATTENTION | 201: Unhealthy component detected | hw://hadomain1.node1.hba_fc3 | WARNING | ... +------+---------------------+----------------------+-------------------------------------+-------------------------------------+----------+ Generated: 2018-07-27 08:54:18ap issues 1005 General Information ID : 1005 Date : 2018-07-05 14:49:58.001512 Close Date : None Target : hw://hadomain1.fabswa.port49 Target Type : port Severity : WARNING Title : Unhealthy component detected Stateful : 1 Referenced Alert ID : None Classification Group : HW Type : HW_NEEDS_ATTENTION Reason Code : 201 Processing Status State : DELIVERED Log Collection Status : COLLECTED SMTP Status : FAILED Call Home Status : NOT_APPLICABLE Service Request SRID : None SR Status : None Collected Logs Log File Path : /var/log/appliance/platform/management/alerts/alert_1005.tar.gz Log File Node : hadomain1.node1 Log File Checksum : 4491b05fd074a4d734d38c162b03fd4d Additional Data: Message : Status on component port at location hw://hadomain1.fabswa.port49 is WARNING admin_tc : up creator_id : fabsw@hw://hadomain1.fabswa dest_alias : fabsw01b location : hw://hadomain1.fabswa.port49 oper_tc : down reason_checksum : d41d8cd98f00b204e9800998ecf8427e serial : status : WARNING type : port type_desc : Fabric Switch Port Generated: 2018-07-27 08:54:40 - ap maintenance [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>] [-f] [-r <reason>] [enable -r <reason>] [disable]
- Manages the maintenance mode of platform manager. When in maintenance mode, platform is
monitored, but all management actions are hanged (no alerts or PMRs are open and no invasive actions
are performed by platform manager). Parameters specific to the command are as follows:
- -f|--force
- Does not ask for confirmation before taking action.
- enable -r <reason>
- Enables maintenance mode. Requires providing a reason by using -r argument.
- disable
- Disables maintenance mode.
- -r|--reason <reason>
- Reason of the maintenance mode.
- ap node [-h] [-v] [--host <address>] [-d] [-f] [{enable,disable,init} <node>] [rebalance] [--user <user>] [--password <password>] [--from-file <file_path>]
- Displays detailed information about nodes and enables to change node state, or rebalance nodes.
Parameters specific to the command are as follows:
- -d|--detail
-
Displays detailed information about nodes
- -f|--force
- Does not ask before taking action on a node.
- enable node
- Enables the specified node. The node format should be
hadomainX.nodeY, where X is the HA domain number, and Y is the node number in that HA domain. - disable node
- Disables the specified node. The node format should be
hadomainX.nodeY, where X is the HA domain number, and Y is the node number in that HA domain. - init node
- Initializes Platform Manager on a node that was removed physically. This operation is performed by IBM Support.
- rebalance
- Rebalances MLNs after a node was enabled.
ap node -d +-----------------+---------+-----------+-----------+--------+ | Node | State | Monitored | Is Master | Is HUB | +-----------------+---------+-----------+-----------+--------+ | hadomain1.node1 | ENABLED | YES | YES | YES | | hadomain1.node2 | ENABLED | YES | NO | NO | | hadomain1.node3 | ENABLED | YES | NO | NO | +-----------------+---------+-----------+-----------+--------+ - ap sd [-h] [-v] [--host <address>] [-d] [-f] [{enable,disable} <storage_drive>] [--user <user>] [--password <password>] [--from-file <file_path>]
- Important: This subcommand is supported only on M4002-001 models.
In M4002-001 models, each node has four storage NVMe drives. These drives must be managed manually. With the ap sd command, you can disable and enable storage drives, for example when a drive is damaged and needs to be replaced.
Without any parameters, the command lists all appliance storage drives and their state, as in the example:Parameters specific to the command are as follows:[root@node0101 ~]# ap sd +------------------------+---------+ | Drive | State | +------------------------+---------+ | hadomain1.node1.drive1 | ENABLED | | hadomain1.node1.drive2 | ENABLED | | hadomain1.node1.drive3 | ENABLED | | hadomain1.node1.drive4 | ENABLED | | hadomain1.node2.drive1 | ENABLED | | hadomain1.node2.drive2 | ENABLED | | hadomain1.node2.drive3 | ENABLED | | hadomain1.node2.drive4 | ENABLED | | hadomain1.node3.drive1 | ENABLED | | hadomain1.node3.drive2 | ENABLED | | hadomain1.node3.drive3 | ENABLED | | hadomain1.node3.drive4 | ENABLED | +------------------------+---------+ Generated: 2019-03-12 12:32:31- -f|--force
- Does not ask before performing action.
- enable storage_drive
- Enables the specified storage drive.
- disable storage_drive
- Disables the specified storage drive.
- ap state [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>] [-d] [-e]
- Displays the state of the system (appliance). Parameters are as follows:
- -d|--details
-
Displays the state for appliance, application and platform manager separately.
- -e|--explain
- Explains appliance state.
A sample command and output follow:ap state -d System state is 'Starting' Application state is 'Containers_Started' Platform management state is 'Active' - ap sw [--host <address>] [-h] [-v] [location | -t type] [-d] [--user <user>] [--password <password>] [--from-file <file_path>]
- Displays a list of the software components with their statuses. When no parameters are provided,
displays appliance application components only. Parameters are as follows:
- location
- Specifies software inventory location.
- -t type
- Specifies the type of software items to list.
- -d|--details
- Displays all software inventory items.
For a list of components, see Software components.
A sample command and output follow:ap sw +-----------------------+---------------------+--------+--------------------------------------------------------------+ | Name | Location | Status | Version | +-----------------------+---------------------+--------+--------------------------------------------------------------+ | Appliance Application | apiserver | OK | 2.1.5 20180628 | | Appliance Application | db2 | OK | 11.1.9.0 | | Appliance Application | ha-management | OK | 2.6.1 | | Appliance Application | ldap | OK | 2.4.44 | | Appliance Application | lift | OK | 3.0.0.451 | | Appliance Application | spark | OK | Spark 2.3.0 (git revision a0d7949896) built for Hadoop 2.7.3 | | Application Node | db2/hadomain1.node1 | OK | | | Application Node | db2/hadomain1.node2 | OK | | | Application Node | db2/hadomain1.node3 | OK | | | Web Console | webconsole | OK | 1.0.10.0 | +-----------------------+---------------------+--------+--------------------------------------------------------------+ Generated: 2018-07-27 08:56:01 - ap version [-h] [-v] [--host <address>] [--user <user>] [--password <password>] [--from-file <file_path>] [-b] [-p] [-c]
- -b|--build
-
Displays build information.
- -p|--platform
- Displays version of platform management
- -c|--cli
- Displays version of
apcli
ap version Appliance software version is 1.0.10.0