Skip to content

Commit bfff7a4

Browse files
committed
Add: dashboard, images and readme
1 parent 9d4eac8 commit bfff7a4

20 files changed

+9819
-78
lines changed

cisco_asa/README.md

Lines changed: 118 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,151 @@
1-
# Agent Integration: Cisco ASA
2-
31
## Overview
42

5-
This integration monitors [Cisco ASA][4].
3+
[Cisco ASA][4] is a robust firewall platform that provides enterprise-class protection with high availability and scalable performance. It adapts to evolving security needs and supports dynamic routing for modern networks and data centers.
64

7-
## Setup
5+
Integrate Cisco ASA with Datadog to gain insights into Threat Detection, User Authentication, User Authorization, User Management, Dynamic Traffic Insights, Connection Insights, ARP Collision Insights, Application Firewall, Transparent Firewall and Identity Firewall using pre-built dashboard visualizations. Datadog uses its built-in log pipelines to parse and enrich these logs, facilitating easy search and detailed insights. The integration can also be used for Cloud SIEM detection rules for enhanced monitoring and security.
86

9-
### Installation
7+
**Minimum Agent version:** 7.74.0
108

11-
The Cisco ASA check is included in the [Datadog Agent][2] package.
12-
No additional installation is needed on your server.
9+
**Disclaimer**: Your use of this integration, which may collect data that includes personal information, is subject to your agreements with Datadog. Cisco is not responsible for the privacy, security or integrity of any end-user information, including personal data, transmitted through your use of the integration.
1310

14-
### Configuration
11+
## Setup
1512

16-
!!! Add list of steps to set up this integration !!!
13+
### Configuration
1714

18-
### Validation
15+
#### Log collection
1916

20-
!!! Add steps to validate integration is functioning as expected !!!
17+
1. Collecting logs is disabled by default in the Datadog Agent. Enable it in `datadog.yaml`:
18+
/root/Bitbucket/datadog-security-connectors
19+
```yaml
20+
logs_enabled: true
21+
```
2122

22-
## Data Collected
23+
2. Add this configuration block to your `cisco_asa.d/conf.yaml` file to start collecting your Cisco ASA logs.
2324

24-
### Metrics
25+
```yaml
26+
logs:
27+
- type: tcp # or 'udp'
28+
port: <PORT>
29+
service: cisco-asa
30+
source: cisco-asa
31+
```
2532
26-
Cisco ASA does not include any metrics.
33+
See the sample [cisco_asa.d/conf.yaml][6] for available configuration options.
2734
28-
### Log Collection
35+
**Note**: Do not change the `source` and `service` values, as these parameters are integral to the pipeline's operation.
2936

37+
3. [Restart the Agent][3].
3038

31-
1. Collecting logs is disabled by default in the Datadog Agent. Enable it in the `datadog.yaml` file with:
39+
#### Syslog Configuration from Cisco ASA CLI:
3240

33-
```yaml
34-
logs_enabled: true
41+
1. Connect to the Cisco ASA CLI
42+
2. Enter privileged EXEC mode by running:
43+
```shell
44+
enable
45+
```
46+
- When prompted, enter the password.
47+
3. Enable global configuration mode:
48+
```shell
49+
configure terminal
3550
```
51+
4. Enable logging:
52+
```shell
53+
logging enable
54+
```
55+
5. Configure syslog log forwarding:
3656

37-
2. Add this configuration block to your `cisco_asa.d/conf.yaml` file to start collecting your Cisco ASA logs:
57+
Replace the placeholders with actual values:
58+
- **interface_name**: interface that the syslog server is associated with
59+
- **ip_address**: ip address of syslog server
60+
- **port**: port on which the syslog server is listening.
3861

39-
```yaml
40-
logs:
41-
- type: file
42-
path: /var/log/Cisco ASA.log
43-
source: cisco_asa
44-
service: <SERVICE_NAME>
62+
For UDP:
63+
```shell
64+
logging host <interface_name> <ip_address> udp/<port>
65+
```
66+
For TCP:
67+
```shell
68+
logging host <interface_name> <ip_address> tcp/<port>
69+
```
70+
6. Set logging level to debugging:
71+
```shell
72+
logging trap debugging
73+
```
74+
7. Enable RFC 5424 timestamp format:
75+
```shell
76+
logging timestamp rfc5424
4577
```
4678

47-
Change the `path` and `service` parameter values and configure them for your environment.
79+
**Note**: The `port` value should be similar to the port provided in the `Log Collection` section.
4880

49-
3. [Restart the Agent][3].
81+
### Validation
82+
83+
[Run the Agent's status subcommand][2] and look for `cisco_asa` under the Logs Agent section.
84+
85+
## Data Collected
86+
87+
### Log Collection
88+
89+
The Cisco ASA integration collects Threat Detection, User Authentication, User Authorization, User Management, Dynamic traffic Insights, Connection Insights, ARP Collision Insights, Application Firewall, Transparent Firewall, Identity Firewall logs.
90+
91+
### Metrics
92+
93+
The Cisco ASA does not include any metrics.
5094

5195
### Events
5296

5397
The Cisco ASA integration does not include any events.
5498

5599
## Troubleshooting
56100

101+
**Permission denied while port binding:**
102+
103+
If you see a **Permission denied** error while port binding in the Agent logs, see the following instructions:
104+
105+
1. Binding to a port number under 1024 requires elevated permissions. Grant access to the port using the `setcap` command:
106+
107+
- Grant access to the port using the `setcap` command:
108+
109+
```shell
110+
sudo setcap CAP_NET_BIND_SERVICE=+ep /opt/datadog-agent/bin/agent/agent
111+
```
112+
113+
- Verify the setup is correct by running the `getcap` command:
114+
115+
```shell
116+
sudo getcap /opt/datadog-agent/bin/agent/agent
117+
```
118+
119+
With the expected output:
120+
121+
```shell
122+
/opt/datadog-agent/bin/agent/agent = cap_net_bind_service+ep
123+
```
124+
125+
**Note**: Re-run this `setcap` command every time you upgrade the Agent.
126+
127+
2. [Restart the Agent][3].
128+
129+
**Data is not being collected:**
130+
131+
Make sure that traffic is bypassed from the configured port if the firewall is enabled.
132+
133+
**Port already in use:**
134+
135+
If you see the **Port <PORT_NUMBER> Already in Use** error, see the following instructions. The example below is for a PORT_NUMBER equal to 514:
136+
137+
On systems using Syslog, if the Agent listens for logs on port 514, the following error can appear in the Agent logs: `Can't start UDP forwarder on port 514: listen udp :514: bind: address already in use`.
138+
139+
This error occurs because by default, Syslog listens on port 514. To resolve this error, take **one** of the following steps:
140+
141+
- Disable Syslog.
142+
- Configure the Agent to listen on a different, available port.
143+
57144
Need help? Contact [Datadog support][1].
58145

59146
[1]: https://docs.datadoghq.com/help/
60-
[2]: https://app.datadoghq.com/account/settings/agent/latest
147+
[2]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
61148
[3]: https://docs.datadoghq.com/agent/configuration/agent-commands/#start-stop-and-restart-the-agent
62-
[4]: **LINK_TO_INTEGRATION_SITE**
63-
[5]: https://github.com/DataDog/integrations-core/blob/master/cisco_asa/assets/service_checks.json
64-
149+
[4]: https://www.cisco.com/c/en_in/products/security/adaptive-security-appliance-asa-software/index.html
150+
[5]: https://docs.datadoghq.com/agent/guide/integration-management/?tab=linux#install
151+
[6]: https://github.com/DataDog/integrations-core/blob/master/watchguard_firebox/datadog_checks/watchguard_firebox/data/conf.yaml.example

cisco_asa/assets/cisco-asa.svg

Lines changed: 35 additions & 0 deletions
Loading

cisco_asa/assets/configuration/spec.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ files:
44
options:
55
- template: logs
66
example:
7-
- type: <tcp/udp>
8-
path: <PORT>
7+
- type: tcp/udp
8+
port: <PORT>
99
source: cisco-asa
1010
service: cisco-asa

0 commit comments

Comments
 (0)