Initialize the Cisco AMP Beat
Prerequisites
- The Open Collector is installed. If you have not already installed it, follow the instructions in the Open Collector Installation and User Guide, and then return to this topic.
- You have the required keys: Cisco Client ID and API Key.
The following port is open:
Direction
Port
Protocol
Source
Outbound 443 HTTPS ciscoampbeat
Initialize the Beat
Confirm the Open Collector is running:
CODE./lrctl status
You should see the open_collector and metrics as shown in the following graphic:
If the Open Collector is not running correctly, see the Troubleshoot the Open Collector topic in the Open Collector Installation and User Guide.Start the beat:
CODE./lrctl ciscoampbeat start
Enter the following details:
The Cisco AMP Client ID and API key are saved in encrypted format.
- Cisco AMP Client ID:
Cisco AMP API Key:
URL Address for preferred region:
It’s important to note that the API is location-based and varies depending on where your AMP instance resides.Currently, three regions exist:
- U.S.: api.amp.cisco.com
- Asia, Pacific, Japan & China: api.apjc.amp.cisco.com
- Europe: api.eu.amp.cisco.com
Event types:
The default value of Event Types is ALL.User can provide multiple Event Type IDs with comma:
For more information on specific Event type IDs, see https://api-docs.amp.cisco.com/api_actions/details?api_action=GET+%2Fv0%2Fevent_types&api_host=api.amp.cisco.com&api_resource=Event+Type&api_version=v0.
- Cisco AMP Client ID:
Check the status of the service:
CODE./lrctl ciscoampbeat status
Default Config Values for CiscoAMPBeat:
S. No. | Field Name | Default Value |
---|---|---|
1. | HeartbeatInterval | 60s |
2. | HeartbeatDisabled | false |
3. | Period | 4s |
4. | apiKey | User provides this value. |
5. | clientID | User provides this value. |
6. | eventTypes | User provides this value. (Default: All) |
7. | limit | 250 |
8. | numbackdaysDataAuditLogs | 7 |
9. | numbackdaysData | 7 |
10. | uriAddress | User provides this value. |
11. | version | v1 |
12. | throttlingIntervalSecs | 60 seconds |