简介
本文档介绍可在Linux和MacOS上与Secure Endpoint Connector配合使用的命令行界面(CLI)命令。
背景信息
CLI命令可供系统上的所有用户使用；但是，某些命令取决于策略配置和/或根权限。相关命令将在本文中全面介绍。
思科安全终端Mac/Linux CLI
导航至CLI
安全终端CLI在系统中安装并运行安全终端连接器时可用：
- 打开Mac/Linux上的Terminal（终端）窗口。
- 在以下路径中运行CLI工具：
- 在Linux上：
/opt/cisco/amp/bin/ampcli
- 在Mac：
/opt/cisco/amp/ampcli上
- 当CLI启动时，会显示以下消息：
ampcli - Cisco Secure Endpoint Connector Command Line Interface
Interactive mode
Enter 'q' or Ctrl+c to Exit
[logger] Set minimum reported log level to notice
Trying to connect...
Connected.
ampcli>
可用的CLI命令
注意：所有可用的CLI命令也可以直接从命令行运行，例如/opt/cisco/amp/bin/ampcli helpor/opt/cisco/amp/ampcli helpworks等同于启动CLI和runhelp。
ampcli> help
about About Cisco Secure Endpoint connector
bp Show and sync behavioral protection signatures
* See 'bp help' for more.
clamav Show and sync ClamAV definitions
* See 'clamav help' for more.
connectivity-test Run connection tests
* See 'connectivity-test help' for more.
definitions Show virus definitions
defupdate Update virus definitions
exclusions List custom exclusions
history Show event history
* See 'history help' for more.
notify Toggle notifications
policy Show policy
quarantine List/restore quarantined file(s)
* See 'quarantine help' for more.
quit (or q) Quit ampcli interactive mode
scan Initiate/pause/stop a scan
* See 'scan help' for more.
status Get ampdaemon status
* See 'status help' for more.
sync Sync policy
verbose Toggle verbose mode
- 命令bp、clamav、connectivity-test、history、scan和quarantinetake其他参数，在用户与help一起运行该命令的情况下进行说明：
ampcli> bp help
Supported bp parameters:
status Display engine and definition information
sync Synchronizes BP signatures
ampcli> clamav help
Supported clamav parameters:
status Display engine and definition information
sync Synchronizes ClamAV definitions
ampcli> connectivity-test help
Supported connectivity-test parameters:
all Performs all connectivity tests
bpsig Performs a Behavioral Protection signature fetch test
crashdump Performs an upload test of a crash diagnostic
event Verifies connectivity to the event intake server
hc Performs a minimal connection test with the registration server
orbitalupdate Performs an orbital update download test
policy Performs a policy fetch test of the current policy. A policy serial number can be provided to fetch a specific policy
* Usage: 'policy [serial number]' (optional serial number, must be greater than 0)
fileupload Performs a file upload test
update Performs a connector update download test
ampcli> history help
Supported history parameters:
list List history
* Listing starts at page 1. Each time 'list' is run we move to
the next page. Specify a page number to jump directly to
that page.
pagesize Set history page size (max: 12)
* e.g. 'ampcli> history pagesize 10'
ampcli> scan help
Supported scan parameters:
flash Perform a flash scan
full Perform a full scan
custom Perform a custom scan on a file or directory (recursive)
e.g. '...> scan custom file_or_directory_to_scan'
pause Pause a running scan
resume Resume a paused scan
cancel Cancel a running scan
list List scheduled scans
ampcli> quarantine help
Supported quarantine parameters:
list List currently quarantined files
* Listing starts at page 1. Each time 'list' is run we move to
the next page. Specify a page number to jump directly to
that page.
restore Restore file by quarantine id
e.g. '...> quarantine restore <quarantine id>'
run 'quarantine list' first to find <quarantine id> in listing
注意：使用helpparameter可为给定命令提供支持的输入参数，状态帮助除外。当使用status CLI命令提供帮助时，它会显示所有支持的连接器状态的列表，以及每种状态的简短说明和可能原因。表中当前连接器的状态用**表示。
CLI命令用法
ampcli> about
Cisco Secure Endpoint Connector v1.16.0.123
Copyright (c) 2013-2021 Cisco Systems, Inc. All rights reserved.
This product incorporates open source software; refer to
/opt/cisco/amp/doc/acknowledgement.txt for details.
[ 22b608b3-b20e-4bd3-8b53-def824acce8a ]
bp（此选项仅适用于Linux上的1.22.0+和macOS上的1.24.0+连接器版本）
ampcli> bp status
Behavioral Protection is not enabled
-
-
- 如果启用了行为保护，则会显示引擎、模式和签名信息：
ampcli> bp status
APDE Engine Version: 3.1.0.0
BP Mode: Protect
BP Signature Serial Number: 8071
BP Signature Last Loaded: 2023-05-02 05:44:09 PM
ampcli> clamav status
Definition Version: ClamAV(bytecode.cvd: 334, daily.cvd: 26893, main.cvd: 62)
Definitions Published: bytecode.cvd: 22 Feb 2023 16-33 -0500
daily.cvd: 01 May 2023 03-22 -0400
main.cvd: 16 Sep 2021 08-32 -0400
Definitions Last Updated: 2023-05-01 04:01:55 PM
连通性测试
all -执行所有连接测试bpsig -执行行为保护签名提取测试crashdump - 执行崩溃诊断的上传测试事件 - 验证到事件获取服务器的连接hc - 执行与注册服务器的最小连接测试orbitalupdate -执行轨道更新下载测试policy [serial number] - 执行当前策略的策略获取测试。可以提供策略序列号来获取特定策略fileupload -执行文件上传测试update -执行连接器更新下载测试
defupdate -向云发送请求以更新病毒定义。
ampcli> exclusions
Exclusions:
Path /home
Path /mnt/hgfs
Regular Expression /var/log/.*\.log
历史记录
history list -列出连接器活动的历史记录（扫描、隔离区等）history pagesize <numeric_value> -设置历史记录视图的pagesize（最大值为12）
ampcli> history pagesize 12
Page size set to 12
隔离(此选项仅适用于Mac连接器版本1.21.0及更高版本（不适用于Linux）)
isolate stop <token> -使用用于启动隔离会话的令牌停止终端隔离会话
notify -在CLI中打开/关闭连接器通知。
- 在连接器策略中还必须启用此设置。
- 在Mac上，这不会影响UI中的通知。
ampcli> notify
Notifications set to on
ampcli> notify
Notifications set to off
ampcli> policy
Quarantine Behavior:
Quarantine malicious files.
Protection:
Monitor program install.
Monitor program start.
Passive on-execute mode.
Proxy: NONE
Notifications: Do not display cloud notifications.
Policy: Audit Policy for Cisco Secure Endpoint (#5755)
Last Updated: 2020-01-08 04:49 PM
Definition Version: ClamAV(bytecode.cvd: 331, daily.cvd: 25721, main.cvd: 59)
Definitions Last Updated: 2020-01-08 05:09 PM
对于Mac连接器版本1.16.0和更新版本以及Linux连接器版本1.17.0和更新版本，策略包括轨道策略状态：
Orbital: Enabled
轨道政策设置有两个值：
- 已启用：通过策略启用轨道。
- 已禁用：通过策略禁用轨道。
对于Mac连接器版本1.21.0及更高版本（不在Linux上），策略包括终端隔离的策略状态：
Isolation: Enabled
隔离策略设置有两个值：
- 已启用：通过策略启用终端隔离。
- 已禁用：通过策略禁用终端隔离。
posture —以JSON格式显示连接器状态
posture prettyprint -使用pretty print JSON格式打印状态
ampcli> posture
{"running": true, "connected": true, "connector_version": "1.19.1.1419", "agent_uuid": "e03ecde8-1aee-4d15-8bca-100e952ee4b9", "offline_engine": "ClamAV", "offline_engine_version": "0.103.5", "definition_version": "osx.cvd:1152", "last_definition_update_published": "osx.cvd: 05 May 2022 13-00 -0400", "last_definition_update_success": 1651857785, "last_scan": 1651857897, "last_scan_status": false, "protect_file_mode": true, "protect_process_mode": true, "scans": [{"scan_type": "flash", "scan_in_progress": false, "last_scan_finished": 1651857039}, {"scan_type": "full", "scan_in_progress": false, "last_scan_finished": 1651857897}, {"scan_type": "custom", "scan_in_progress": false, "last_scan_finished": 1651856819}], "engines": [{"enabled": true, "name": "ClamAV", "version": "0.103.5", "definitions": [{"version": 1152, "name": "osx.cvd", "timestamp": 1651770000, "last_successful_update": 1651857785}]}]}
quarantine(此选项仅对具有root权限的用户可用。)
quarantine list -列出系统上的隔离项目。quarantine restore <quarantine_id> -通过隔离id(可通过quarantine listcommand找到)恢复隔离的文件。
quit (or q) -退出安全终端Mac/Linux连接器CLI。
-
scan flash -执行系统的快速扫描。scan full - 执行系统的完全扫描。scan custom <path_to_scan> -扫描指定的文件或目录。scan pause -暂停当前正在运行的所有扫描。scan resume -恢复当前暂停的所有扫描。scan cancel -取消当前运行的所有扫描。scan list -列出要在系统上执行的所有计划扫描。
status —提供系统上连接器的当前状态。
状态帮助-显示所有连接器状态、当前连接器状态、每个状态状态的说明以及给定状态的原因的表。
ampcli> status
Status: Connected
Mode: Normal
Scan: Ready for scan
Last Scan: 2020-01-22 03:57 PM
Policy: Audit Policy for Cisco Secure Endpoint (#5755)
Command-line: Enabled
Faults: None
如果终端存在故障，故障字段会显示每个严重性级别（严重/主要/次要）的故障数。自连接器版本1.12.3起，CLI显示aFault ID字段，其中显示终端上引发的每个故障的故障代码。CLI输出与终端上存在的每个故障相关的指南。
例如：
Faults: 1 Critical, 1 Major
Fault IDs: 1, 3
ID 1 - Critical: The system extensions failed to load. Approve the system extensions in Security & Privacy System Preferences.
ID 3 - Major: Full Disk Access not granted. Grant access to the ampdaemon executable in Security & Privacy System Preferences.
ampcli> status help
Status Description Reason(s)
=================================================================================
| Initializing... | Program starting/loading. | --
| | |
| Provisioning... | Endpoint identity | --
| | enrollment/subscription. |
| | |
| Provisioning | Endpoint identity | Cannot reach AMP services.
| failed, retrying | enrollment/subscription failed. | Missing SSL certificates.
| | Connector will retry. |
| | |
| Registering... | Registering endpoint identity. | --
| | |
| Registration | Endpoint identity registration | Cannot reach AMP services.
| failed, retrying | failed. Connector will retry. | Missing SSL certificates.
| | |
| Connecting... | Registering with disposition | --
| | service. |
| | |
| Connection failed, | Registration with disposition | Cannot reach AMP services.
| retrying | service failed. Connector will | Missing SSL certificates.
| | retry. |
| | |
| ** Connected | Enrollment and registration | --
| | succeeded. Connected to AMP |
| | services. Connector is operating |
| | normally. |
| | |
| Disabled | Connector is not operational. | AMP subscription is invalid
| | | or has expired.
| | |
| Disconnected, | Lost connection to the disposition | Network connection to the
| retrying | service after an initial | disposition service has been
| | connection was established. | interrupted.
| | Connector will attempt to |
| | reconnect. |
| | |
| Offline (the | The local network has been | Cable disconnected.
| network is down) | disconnected. | The network interface is
| | | disabled.
| | |
=================================================================================
** indicates the current status of the Connector
Run "ampcli connectivity-test" to help diagnose connection errors
对于Mac连接器版本1.16.0及更高版本，对于Linux连接器版本1.17.0及更高版本，状态包括计算机上轨道的最新状态：
Orbital: Enabled (Running)
轨道状态有三个值：
- 已启用（正在运行）：表示当前策略已启用轨道，并且轨道服务当前正在计算机上运行。
- 已启用（未运行）：表示当前策略已启用Orbal，但Orbal服务当前未在计算机上运行。
- 已禁用：表示当前策略未启用轨道。
对于Mac连接器版本1.21.0及更高版本（不在Linux上），status包括计算机上的终端隔离的当前状态：
Isolation: Isolated
轨道状态有三个值：
- 隔离：表示当前策略已启用终端隔离，并且计算机与网络隔离。
- 未隔离：表示当前策略已启用终端隔离，并且计算机未隔离。
- Disabled in Policy：表示当前策略未启用终端隔离。
ampcli> verbose
Verbose mode set to on
ampcli> verbose
Verbose mode set to off
其他信息
技术支持和文档 - Cisco Systems
思科安全终端-用户指南
反馈