Fortinet Document Library

Version:


Table of Contents

Cisco Meraki MX L7 Firewall

1.0.0
Copy Link

About the connector

Cisco Meraki MX L7 Firewall gives administrators complete control over the users, content, and applications on their network. This connector facilitates automated operations to fetch firewall rules, update the firewall rules etc.

This document provides information about the Cisco Meraki MX L7 Firewall connector, which facilitates automated interactions, with a service-based URI of Cisco Meraki MX L7 Firewall using FortiSOAR™ playbooks. Add the Cisco Meraki MX L7 Firewall connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list of MX L7 firewall rules and updating the MX L7 firewall rules for a specific MX network on the Cisco Meraki MX L7 Firewall.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-cisco-meraki-mx-l7-firewall

Prerequisites to configuring the connector

  • You must have the Service-based URI of Cisco Meraki MX L7 Firewall server to which you will connect and perform automated operations the API key configured for your account for using the Cisco Meraki API.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Cisco Meraki MX L7 Firewall connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL Service-based URI to which you will connect and perform the automated operations.
API Key API key configured for your account for using the Cisco Meraki API.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Get Network L7 Firewall Rules Retrieves a list of MX L7 firewall rules for a specific MX network based on the Network ID you have specified. get_network_firewall_rules
Investigation
Update Network L7 Firewall Rules Updates the MX L7 firewall rules for a specific MX network based on the Network ID and rules you have specified. update_firewall_rules
Investigation
Get Network L7 Firewall Rules Application Categories Retrieves the L7 firewall application categories and their associated applications for a specific MX network based on the Network ID you have specified. get_network_firewall_rules
Investigation

operation: Get Network L7 Firewall Rules

Input parameters

Parameter Description
Network ID ID of the MX network for which you want to retrieve the list of MX L7 firewall rules.

Output

The output contains the following populated JSON schema:
{
     "rules": [
         {
             "policy": "",
             "type": "",
             "value": ""
         }
     ]
}

operation: Update Network L7 Firewall Rules

Input parameters

Parameter Description
Network ID ID of the MX network whose L7 firewall rules you want to update.
Rules An ordered array of the MX L7 firewall rules that you want to update on the specified MX network.
Fox example, {"rules": [{"policy": "deny","type": "application","value": {"id": "meraki:layer7/application/67","name": "Xbox LIVE"}},{"policy": "deny","type": "host","value": "google.com"},{"policy": "deny","type": "blacklistedCountries","value": ["AX","CA"]}]}

Output

The output contains the following populated JSON schema:
{
     "rules": [
         {
             "policy": "",
             "type": "",
             "value": ""
         }
     ]
}

operation: Get Network L7 Firewall Rules Application Categories

Input parameters

Parameter Description
Network ID ID of the MX network for which you want to retrieve the L7 firewall application categories and their associated applications.

Output

The output contains the following populated JSON schema:
{
     "applicationCategories": [
         {
             "id": "",
             "name": "",
             "applications": [
                 {
                     "id": "",
                     "name": ""
                 }
             ]
         }
     ]
}

Included playbooks

The Sample - Cisco Meraki MX L7 Firewall - 1.0.0 playbook collection comes bundled with the Cisco Meraki MX L7 Firewall connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in CyOPsTM after importing the Cisco Meraki MX L7 Firewall connector.

  • Get Network L7 Firewall Rules
  • Get Network L7 Firewall Rules Application Categories
  • Update Network L7 Firewall Rules

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.

About the connector

Cisco Meraki MX L7 Firewall gives administrators complete control over the users, content, and applications on their network. This connector facilitates automated operations to fetch firewall rules, update the firewall rules etc.

This document provides information about the Cisco Meraki MX L7 Firewall connector, which facilitates automated interactions, with a service-based URI of Cisco Meraki MX L7 Firewall using FortiSOAR™ playbooks. Add the Cisco Meraki MX L7 Firewall connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list of MX L7 firewall rules and updating the MX L7 firewall rules for a specific MX network on the Cisco Meraki MX L7 Firewall.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-cisco-meraki-mx-l7-firewall

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Cisco Meraki MX L7 Firewall connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL Service-based URI to which you will connect and perform the automated operations.
API Key API key configured for your account for using the Cisco Meraki API.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function Description Annotation and Category
Get Network L7 Firewall Rules Retrieves a list of MX L7 firewall rules for a specific MX network based on the Network ID you have specified. get_network_firewall_rules
Investigation
Update Network L7 Firewall Rules Updates the MX L7 firewall rules for a specific MX network based on the Network ID and rules you have specified. update_firewall_rules
Investigation
Get Network L7 Firewall Rules Application Categories Retrieves the L7 firewall application categories and their associated applications for a specific MX network based on the Network ID you have specified. get_network_firewall_rules
Investigation

operation: Get Network L7 Firewall Rules

Input parameters

Parameter Description
Network ID ID of the MX network for which you want to retrieve the list of MX L7 firewall rules.

Output

The output contains the following populated JSON schema:
{
     "rules": [
         {
             "policy": "",
             "type": "",
             "value": ""
         }
     ]
}

operation: Update Network L7 Firewall Rules

Input parameters

Parameter Description
Network ID ID of the MX network whose L7 firewall rules you want to update.
Rules An ordered array of the MX L7 firewall rules that you want to update on the specified MX network.
Fox example, {"rules": [{"policy": "deny","type": "application","value": {"id": "meraki:layer7/application/67","name": "Xbox LIVE"}},{"policy": "deny","type": "host","value": "google.com"},{"policy": "deny","type": "blacklistedCountries","value": ["AX","CA"]}]}

Output

The output contains the following populated JSON schema:
{
     "rules": [
         {
             "policy": "",
             "type": "",
             "value": ""
         }
     ]
}

operation: Get Network L7 Firewall Rules Application Categories

Input parameters

Parameter Description
Network ID ID of the MX network for which you want to retrieve the L7 firewall application categories and their associated applications.

Output

The output contains the following populated JSON schema:
{
     "applicationCategories": [
         {
             "id": "",
             "name": "",
             "applications": [
                 {
                     "id": "",
                     "name": ""
                 }
             ]
         }
     ]
}

Included playbooks

The Sample - Cisco Meraki MX L7 Firewall - 1.0.0 playbook collection comes bundled with the Cisco Meraki MX L7 Firewall connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in CyOPsTM after importing the Cisco Meraki MX L7 Firewall connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.