Using the perf-info base command without additional sub-commands will return the full set of available information.
Specific subsets of data can be retrieved using additional commands. The general format is as follows:
apax perf-info [base-command-options] [sub-command] [sub-command-options]
The following option is available for the base perf-info command:
- -c|--continuous – Retrieve the latest performance information continuously
Note
Data updates are based on polling rate (currently one second) and not COV (Change of Value) or cycle time.
Sub-Commands
- cycle-time – Retrieves cycle time information
- memory – Retrieves memory usage information
- comm-load – Retrieves communication load information
General options
These options are available for all commands.
- -?|-h|--help – Show help information
- -t|--targetIP – The target PLC IP address
- -u|--username - The authentication user name
- -p|--password – The password for a password-protected target PLC
- -C|--certificate – The file containing the public key for communicating with the PLC. For more information see certificate handling
-
-f|--format – Output format of the result. Tabular by default (tabular|CSV).
WARNING
Tabular format is not part of the API and might change in the future.
Cycle Time options
- -c|--continuous – Retrieves the latest cycle time information continuously
- --summary – Do not include detailed cycle time information per Task/OB
Note
Data updates are based on polling rate (currently one second) and not COV (Change of Value) or cycle time.