Skip to main content

Cato Networks Source

img/send-data/cato-logo.png

Cato Networks is a cloud-native, global SD-WAN provider that delivers a secure, optimized, and agile global network for businesses of all sizes. Cato's cloud-based platform converges multiple network and security functions into a unified solution that includes SD-WAN, network security, cloud security, and secure access service edge (SASE) capabilities.

This source ingests Security and Audit events from Cato API.

Data Sources‚Äč

Cato Networks source ingests security events from EventsFeed API and audit events from AuditFeed API.

Prerequisites‚Äč

  • In the Cato Management Application, only account administrators with the Editor privilege can generate keys. (CMA).
  • To ingest security events, you must enable the events feeds on your account. To enable the events feed, follow the steps below:
    1. In the navigation panel, select System > API Access Management.
    2. Select Event Feed Enabled. After this, your account starts sending events to the Cato API server.
      cato-networks-enable-events-feed.png

Setup and Configuration‚Äč

In this configuration, you will set up the Cato Networks API Key and Account ID parameter to access the Cato networks API.

API Key‚Äč

All access to Cato networks require an API Key. Follow the below instructions to set up an API Key.

  1. In the navigation menu, click Administration > API Management.
    cato-networks-administration.png
  2. On the API Keys tab, click New. The Create API Key panel opens.
  3. Enter a Key Name.
    cato-networks-new-api-key.png
  4. Select View in the API Permission.
  5. Select Any IP to allow this API key for any IP address under the Allow Access from IPs section.
  6. (Optional) Select a date when the API key expires. If you select an expiration date, then you need to update the source configuration with a new API key, or else an unauthorized error will be received.
  7. Click Apply. The API key is added, and a pop-up window containing the new API key is displayed.
  8. Copy the API Key generated by the Cato Management Application and save it in a secure location.
    note

    The API key value will not be available after closing this window. Kindly ensure that you copy and securely save the API key before closing the window.

  9. Click OK to close the pop-up window.

Account ID‚Äč

All API calls require an account ID parameter. When logged into the Cato account, look for a four-digit integer in the URL and take note of the account ID. .
cato-networks-account-id.png

States‚Äč

The Cato Networks integration Source is a device security platform that discover devices, tracks behavior, detects threats, and takes action to protect your business. When you create an Cato Networks Source, it goes through the following stages:

  1. Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
  2. Started. A collection task is created on the Hosted Collector.
  3. Initialized. The task configuration is complete in Sumo Logic.
  4. Authenticated. The Source successfully authenticated with Cato Networks.
  5. Collecting. The Source is actively collecting data from Cato Networks.

If the Source has any issues during any one of these states, it is placed in an Error state.

When you delete the Source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector. On the Collection page, the Health and Status for Sources is displayed. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

Setup Cato Networks Source‚Äč

When you create an Cato Networks Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Cato Networks Source:

  1. In Sumo Logic, select Manage Data > Collection > Collection. 
  2. On the Collection page, click Add Source next to a Hosted Collector.
  3. Search for and select Cato Networks.
    cato-logo
  4. Enter a Name for the Source. The description is optional.
    cato-config-main.png
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
    • green check circle.png¬†A green circle with a check mark is shown when¬†the field exists in the Fields table schema.
    • orange exclamation point.png¬†An orange triangle with an exclamation point is shown¬†when the field¬†doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent¬†fields to the Fields table schema is provided.¬†If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
  7. Enter the API Key for Cato Networks account.
  8. Enter the Account ID for Cato Networks account.
  9. Select the Data Types. You can select one or both of the data sources.
    • If All is selected, the integration will fetch both security and audit events. By default, All will be selected.
    • If Security Events is selected, the integration will fetch security data.
    • If Audit Events is selected, the integration will fetch audit data.
      note

      Data from the source will be fetched every 5 minutes.

Error Types‚Äč

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason for the error, if the source attempts to retry, and the name of the event log in the Health Event Index.

TypeReasonRetriesRetry BehaviorHealth Event Name
ThirdPartyConfigNormally due to an invalid configuration. You'll need to review your Source configuration and make an update.No retries are attempted until the Source is updated.Not applicableThirdPartyConfigError
ThirdPartyGenericNormally due to an error communicating with the third-party service APIs.YesThe Source will retry indefinitely.ThirdPartyGenericError
FirstPartyGenericNormally due to an error communicating with the internal Sumo Logic APIs.YesThe Source will retry indefinitely.FirstPartyGenericError

Restarting your Source‚Äč

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

  1. Open the Collection page, and go to Manage Data > Collection > Collection.
  2. Select the source and click the information icon on the right side of the row.
  3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
    restart-source-button
  4. Click Confirm to send the restart request.
    restart-source-confirm
  5. The bottom left of the platform will provide a notification informing you the request was successful.
    restart-source-initiated

API

To restart your source using the Sumo Management API, follow the instructions below:

  • Method: POST
  • Example endpoint:
    https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

JSON Configuration‚Äč

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

ParameterTypeRequiredDescriptionAccess
configJSON ObjectYesContains the configuration-parameters of the Source.na
schemaRefJSON ObjectYesUse {"type":"Cato Networks"} for Cato Networks Source.not modifiable
sourceTypeStringYesUse Universal for Cato Networks Source.not modifiable

Config Parameters‚Äč

ParameterTypeRequiredDescriptionAccess
nameStringYesType the desired name of the Source and it must be unique per Collector. This value is assigned to the metadata field _source. modifiable
descriptionStringNoType the description of the Source.modifiable
categoryStringNoType the category of the source. This value is assigned to the metadata field _sourceCategory.modifiable
fieldsJSON ObjectNoJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.modifiable
accountIDStringYesAccount ID of the account.modifiable
apikeyStringYesAPI key of the account.modifiable
dataTypesString ArrayYesSelect the datatype for which you want to ingest data. Possible values are All, Security Events or Audit Events.modifiable

JSON Example‚Äč

{
"api.version": "v1",
"source": {
"config": {
{
"name": "cato-network",
"description": "sample description",
"accountID": "1774",
"apiKey": "***********",
"dataTypes": [
"securityEvents",
"auditEvents",
"all",
],
}
},
"schemaRef": {
"type": "Cato Networks"
},
"sourceType": "Universal"
}
}
Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.