...
<any_directory> └── devo-collectors/ └── cisco_meraki/ ├── certs/ │ ├── chain.crt │ ├── <your_domain>.key │ └── <your_domain>.crtTo enable the collector for a customer:
In the Collector Server GUI, access the domain in which you want this instance to be created
Click Add Collector and find the one you wish to add.
In the Version field, select the latest value.
In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
In the sending method select Direct Send. Direct Send configuration is optional for collectors that create
Table
events, but mandatory for those that createLookups
.In the Parameters section, establish the Collector Parameters as follows below:
Editing the JSON configuration
Rw ui tabs macro | ||||||||
---|---|---|---|---|---|---|---|---|
We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running. StructureThe following directory structure should be created for being used when running the Cisco Meraki collector: | ||||||||
Code Block |
Code Block |
---|
{ "cisco_meraki": { "id": "<short_unique_identifier>", "enabled": true, "requests_per_second": 5, "services": { "network-events": { "api_key": "<api_key>", "start_time": "2021-01-01T00:00:00.000000Z" }, └── config/ "security-events": { └── config-cisco_meraki.yaml |
Devo certificates
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <any directory>/devo-collectors/cisco_meraki/certs
. Learn more about security credentials in Devo here.
Editing the config-cisco_meraki.yaml file
In the config-cisco_meraki.yaml file, replace the <short_unique_identifier>
, <api_key>
values and enter the ones that retrieved in the previous steps. In the <short_unique_identifier>
placeholder, enter the chosen value.
Code Block |
---|
globals: debug: false id: not_used name: cisco_meraki persistence: type: filesystem # File system persistence ON config: directory_name: state "api_key": "<api_key>", "start_time": "2021-01-01T00:00:00.000000Z" }, "changelog": { "api_key": "<api_key>", "start_time": "2021-01-01T00:00:00.000000Z" } } } } |
Info |
---|
Replace the placeholders |
The value chosen for the id
field will be used internally for having independent persistence areas.
Rw tab | ||
---|---|---|
|
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
Structure
The following directory structure should be created for being used when running the Cisco Meraki collector:
Code Block |
---|
<any_directory> └── devo-collectors/ └── cisco_meraki/ ├── certs/ │ ├── chain.crt │ ├── <your_domain>.key │ # Directory where the persistence will be saved in case of using filesystem outputs: devo_1:└── <your_domain>.crt └── config/ # Cloud Devo config EU (for US use collector-us.devo.io) type: devo_platform config: address: eu.elb.relay.logtrust.net port: 443 └── config-cisco_meraki.yaml |
Devo certificates
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <any directory>/devo-collectors/cisco_meraki/certs
. Learn more about security credentials in Devo here.
Editing the config-cisco_meraki.yaml file
In the config-cisco_meraki.yaml file, replace the <short_unique_identifier>
, <api_key>
values and enter the ones that retrieved in the previous steps. In the <short_unique_identifier>
placeholder, enter the chosen value.
Code Block |
---|
globals: debug: false id: not_used name: cisco_meraki persistence: type: SSLfilesystem chain: chain.crt cert: <your_domain>.crt key: <your_domain>.key inputs: cisco_meraki: id: <short_unique_identifier> # File system persistence ON config: directory_name: state # The value of this field will be used internally for having independent persistence areas enabled: true requests_per_second: 5 # Directory where the persistence will be saved in case of using filesystem outputs: devo_1: # Setup how many request API por second services: # Cloud Devo config EU (for US use collector-us.devo.io) type: devo_platform config: # Services available for this collector are Alerts, Secure Score and Secure score control profileaddress: eu.elb.relay.logtrust.net port: 443 network-events: type: SSL api_key: '<api_key>' chain: chain.crt cert: <your_domain>.crt key: <your_domain>.key inputs: cisco_meraki: id: <short_unique_identifier> # API Key obtained in the Meraki profile start_time: '2021-01-01T00:00:00.000000Z' # The value of this field #will Collectorbe Initialused time.internally for having independent persistence areas security-events: enabled: true apirequests_per_keysecond: '<api_key>' 5 # Setup how many request API por second Key obtained in the Merakiservices: profile start_time: '2021-01-01T00:00:00.000000Z' # Collector Initial time. changelog: api_key: '<api_key>' # Services available for this collector are Alerts, Secure Score and Secure score control profile network-events: # API Key obtained in the Meraki api_key: '<api_key>' # API Key obtained in the Meraki profile start_time: '2021-01-01T00:00:00.000000Z' # Collector Initial time. |
Note |
---|
The “start_time” fields must have the following format: Alerts “start_time” format: 0000-00-00T00:00:00.000Z |
Note |
---|
The Security-events Service may generate error logs if you do not have an MX appliance. |
Download the Docker image
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Collector Docker image
SHA-256 hash
collector-meraki_collector-docker-image-1.5.1
90b81f987c5a4e6aeb1dc055c369253da5557b0559c543c54d351717fa75b1d1
Use the following command to add the Docker image to the system:
Code Block |
---|
gunzip -c collector-cisco-meraki-docker-image-<version>.tgz | docker load |
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace "<version>
" with a proper value.
The Docker image can be deployed on the following services:
Docker
Execute the following command on the root directory <any_directory>/devo-collectors/cisco_meraki/
Code Block |
---|
docker run \
--name collector-cisco_meraki \
--volume $PWD/certs:/devo-collector/cisco_meraki/certs \
--volume $PWD/config:/devo-collector/cisco_meraki/config \
--volume $PWD/state:/devo-collector/cisco_meraki/state \
--env CONFIG_FILE=config-cisco_meraki.yaml \
--rm -it docker.devo.internal/collector/meraki_collector:<version> |
Note |
---|
Replace |
Docker Compose
The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/cisco_meraki/
directory.
Code Block |
---|
version: '3'
services:
collector-cisco_meraki:
image: docker.devo.internal/collector/meraki_collector:${IMAGE_VERSION:-latest}
container_name: collector-cisco_meraki
volumes:
- ./certs:/devo-collector/cisco_meraki/certs
- ./config:/devo-collector/cisco_meraki/config
- ./state:/devo-collector/cisco_meraki/state
environment:
- CONFIG_FILE=${CONFIG_FILE:-config-cisco_meraki.yaml} |
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/cisco_meraki/
directory:
Code Block |
---|
IMAGE_VERSION=<version> docker-compose up -d |
Note |
---|
Replace |
Activeboards
A number of predefined dashboards that make use of the configured collectors can be downloaded here. To instantiate them, follow these instructions:
Create a new Devo Activeboard in your domain.
In edit mode, click on the ellipsis button and select Edit raw configuration.
Open the downloaded file, select all the text, and copy it to the clipboard.
Paste the contents of the file in the raw editor. Make sure you replace completely the existing configuration.
Click on Save changes. The dashboard should show up immediately.
Change log
...
Release
...
Released on
...
Release type
...
Details
...
Download the Docker imageThe collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Use the following command to add the Docker image to the system:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace " The Docker image can be deployed on the following services: DockerExecute the following command on the root directory
Docker ComposeThe following Docker Compose file can be used to execute the Docker container. It must be created in the
To run the container using docker-compose, execute the following command from the
|
Activeboards
In Exchange a number of predefined dashboards that make use of the configured collectors can be installed directly in your domain to start working with your data.
Change log
Release | Released on | Release type | Details | Recommendations | ||||||||||||||||||
|
| Bug fixes:
Improvements:
|
| |||||||||||||||||||
|
| Improvements:
Bug fixing:
|
| |||||||||||||||||||
|
| Improvements:
Bug fixing:
| Recommended Version
| |||||||||||||||||||
|
| Improvements:
Bug fixing:
|
| |||||||||||||||||||
|
| Bug fixing:
|
| |||||||||||||||||||
|
| Improvements:
Bug fixing:
|
| |||||||||||||||||||
|
| Improvements:
Bug fixes:
|
| |||||||||||||||||||
|
| Improvements:
Bug fixes:
|
| |||||||||||||||||||
|
| Vulnerabilities mitigation:
|
| |||||||||||||||||||
|
| New features:
Improvements:
Vulnerabilities mitigation:
|
|