What are Connectors
A connector is a component of Cisco Secure Workload that
-
facilitates the integration with different resources,
-
enables Secure Workload to gather data from these resources for various purposes.
To configure and work with connectors, choose from the navigation pane.
Note |
Connectors require a virtual appliance. For more information, see Virtual Appliances for Connectors. |
Connectors for Flow Ingestion
A flow ingestion connector is a data transmission tool that
-
streams flow observations from network devices like routers and firewalls to a central system,
-
supports multiple protocols like NetFlow v9 and IPFIX, and
-
stitches related client and server flows for integrated analysis.
|
Connector |
Description |
Deployed on Virtual Appliance |
|---|---|---|
|
NetFlow |
Collects NetFlow V9 and/or IP-FIX telemetry from network devices such as routers and switches. |
Secure Workload Ingest |
|
F5 BIG-IP |
Collects telemetry from F5 BIG-IP, stitch client, and server side flows, and enriches client inventory with user attributes. |
Secure Workload Ingest |
|
Citrix NetScaler |
Collects telemetry from Citrix ADC, stitch client, and server side flows. |
Secure Workload Ingest |
|
Cisco Secure Connector Firewall |
Collects telemetry data from Secure Firewall ASA, Secure Firewall Threat Defense, stitch client, and server side flows. |
Secure Workload Ingest |
|
Meraki |
Collects telemetry data from Meraki firewalls. |
Secure Workload Ingest |
|
ERSPAN |
Collects ERSPAN telemetry data from network devices which support ERSPAN. |
Secure Workload Ingest |
|
See also |
For more information, refer to Cloud Connectors. |
– |
For more information about required virtual appliances, refer to Virtual Appliances for Connectors.
NetFlow Connector
The NetFlow connector is a network solution that
-
allows Secure Workload to ingest flow observations from routers and switches in the network.
-
eliminates the need for host software agents, and
-
uses Cisco switches to relay records to the NetFlow connector for processing.
What is NetFlow
NetFlow is a network monitoring protocol that:
-
allows routers and switches to aggregate traffic passing through them into flows,
-
enables the export of flow data to a flow collector for storage, and
-
supports offline querying and analysis.
To set up NetFlow, follow these steps:
-
Enable the NetFlow feature on your network devices. Then, configure the flow templates for export.
-
Configure the NetFlow Collector Endpoint information on the remote network devices. The NetFlow collector listens to the configured endpoint to receive and process NetFlow flow records.
NetFlow is supported by Cisco routers and switches, providing a method to extensively understand traffic patterns.
Flow ingestion to Secure Workload
A NetFlow connector is a network component that
-
acts as a NetFlow collector,
-
registers as a NetFlow agent, and
-
supports NetFlow v9 and IPFIX protocols.
The NetFlow connector is configured to receive flow records from network devices and forward them to Secure Workload for analysis. You can enable them on a Secure Workload Ingest appliance and run it as a Docker container.
The NetFlow connector registers with Secure Workload as a Secure Workload NetFlow agent. It decapsulates NetFlow protocol packets (that is, flow records); processes flows, and reports them like a standard Secure Workload agent. They focus on reporting flow records without process or interface information, unlike a Deep Visibility Agent.
Note |
NetFlow connector supports NetFlow v9 and IPFIX protocols. |
Note |
Each NetFlow connector should report flows for a single VRF. The flows are exported and placed in the VRF based on the Agent VRF configuration in the Secure Workload cluster. To configure the VRF for the connector, choose and click the Configuration tab. Under the Agent Remote VRF Configurations section, click Create Config . Provide the VRF name, the IP subnet of the connector, and the range of port numbers to send flow records to the cluster. |
Rate limiting
A rate limit is a threshold that
-
allows the NetFlow connector to accept up to 15,000 flows per second.
-
ensures that if the limit is exceeded, additional flow records are dropped.
-
mandates a correct flow rate for customer support eligibility.
The NetFlow connector can parse packets with multiple flow and template records. It maintain efficiency within specified limits and identifies the flows.
The NetFlow connector accepts up to 15000 flows per second. If the connector parses more than 15000 flows per second, it drops the additional flow records.
The Secure Workload customer supports the NetFlow connector only if the flow rate is within this acceptable limit.
If the flow rate exceeds 15000 flows per second, it is important to adjust the flow rate to within limits and maintain it for at least three days. This helps rule out issues related to a higher incoming flow rate.
If the original issue persists, customer support becomes involved to investigate the problem and develop effective solutions.
Supported Information Elements
The NetFlow connector supports these information elements in NetFlow v9 and IPFIX protocols. For more information, refer to IP Flow Information Export (IPFIX) Entities.
|
Element ID |
Name |
Description |
Mandatory |
|---|---|---|---|
|
1 |
octetDeltaCount |
Number of octets in incoming packets for this flow. |
Yes |
|
2 |
packetDeltaCount |
Number of incoming packets for this flow. |
Yes |
|
4 |
protocolIdentifier |
The value of the protocol number in the IP packet header. |
Yes |
|
6 |
tcpControlBits |
TCP control bits observed for packets of this flow. The agent handles FIN, SYN, RST, PSH, ACK, and URG flags. |
No |
|
7 |
sourceTransportPort |
The source port identifier in the transport header. |
Yes |
|
8 |
sourceIPv4Address |
The IPv4 source address in the IP packet header. |
Either 8 or 27 |
|
11 |
destinationTransportPort |
The destination port identifier in the transport header. |
Yes |
|
12 |
destinationIPv4Address |
The IPv4 destination address in the IP packet header. |
Either 12 or 28 |
|
27 |
sourceIPv6Address |
The IPv6 source address in the IP packet header. |
Either 8 or 27 |
|
28 |
destinationIPv6Address |
The IPv6 destination address in the IP packet header. |
Either 12 or 28 |
|
150 |
flowStartSeconds |
The absolute timestamp of the first packet of the flow (in seconds). |
No |
|
151 |
flowEndSeconds |
The absolute timestamp of the last packet of the flow (in seconds). |
No |
|
152 |
flowStartMilliseconds |
The absolute timestamp of the first packet of the flow (in milliseconds). |
No |
|
153 |
flowEndMilliseconds |
The absolute timestamp of the last packet of the flow (in milliseconds). |
No |
|
154 |
flowStartMicroseconds |
The absolute timestamp of the first packet of the flow (in microseconds). |
No |
|
155 |
flowEndMicroseconds |
The absolute timestamp of the last packet of the flow (in microseconds). |
No |
|
156 |
flowStartNanoseconds |
The absolute timestamp of the first packet of the flow (in nanoseconds). |
No |
|
157 |
flowEndNanoseconds |
The absolute timestamp of the last packet of the flow (in nanoseconds). |
No |
NetFlow and NSEL for Cisco Secure Firewall connector
NetFlow Connector enables Secure Workload to ingest NetFlow v9 or IPFIX from Nexus routers or switches. No agents needed on hosts—connector on Ingest appliance processes flows up to 15K per second per conenctor with VRF support.
-
Flow analytics dashboard: View ingested flows in real-time Flow Rate Gauge (green <5K pps, yellow 5-10K, red >10K approaching limit).
-
Color coding:
Status Color Meaning Healthy Green Flows <10K pps, 0 drops Warning Yellow 10-14K pps, minor drops Critical Red >15K pps, rate limiting active -
Highlights client-server flow pairs using blue lines for bidirectional flows and orange lines for unidirectional flows.
Cisco Secure Firewall Connector (NSEL)
Ingests NSEL events from Cisco Secure Firewall, Cisco ASA or Secure Firewall Threat Defense to monitor stateful flows. It stitches NATed client-server flows and supports creation, teardown, or denial, or update events.
NSEL events dashboard
-
Event timeline: Interactive chart with color-coded events (green >create, blue >update, orange >teardown, red >denied).
-
Color code:
Event Color Action in Secure Workload Flow created Green Bidirectional flow reported Flow updated Blue Incremental bytes/pkts Flow denied Red Rejected (ACL/ICMP) disposition Flow teardown Orange Termination reason logged -
NAT stitching matrix: Heatmap shows stitched pairs (intensity by byte count); hover for Element IDs (For example, 225 post-NAT src IP).
-
TCP heuristics overlay: SYN/ACK/FIN flags inferred and visualized as flag badges on flows.
How to configure NetFlow on the Switch
This task is specific to the Cisco Nexus 9000 switch and might slightly differ for other Cisco platforms. Refer to the official Cisco configuration guide for detailed platform-specific settings.
Procedure
|
Step 1 |
Enter global configuration mode.
|
|
Step 2 |
Enable the NetFlow feature.
|
|
Step 3 |
Configure a flow record. This configuration generates five tuple information for flows:
|
|
Step 4 |
Configure a flow exporter to specify protocol, template exchange interval, and collector endpoint. Specify the IP and port on which the NetFlow connector is enabled on a Secure Workload Ingest appliance.
|
|
Step 5 |
Configure a flow monitor to associate the flow record and exporter:
|
|
Step 6 |
Apply the flow monitor to an interface.
NetFlow on the Nexus 9000 exports NetFlow v9 protocol packets for ingress traffic through interface 1/1. It sends flow records to 172.26.230.173:4729 using UDP protocol. Each flow record includes five-tuple traffic information and the byte/packet count of the flow.
|
How to configure the connector
For information about required virtual appliances, refer to Virtual Appliances for Connectors. For NetFlow connectors, IPv4 and IPv6 (dual stack mode) addresses are supported. However, note that dual stack support is currently a beta feature.
You can configure the connector with the following options:
-
Log: For more information, refer to Log Configuration .
In addition, you can update the listening ports of IPFIX protocol on the connector through the Docker container in Secure Workload Ingest appliance using an allowed command. You can issue this command on the appliance by providing the connector ID of the connector, the type of the port to be update, and the new port information. You can find the connector ID on the connector page in Secure Workload user interface. For more information, see update-listening-ports.
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of NetFlow connectors on a single Secure Workload Ingest appliance |
3 |
|
Maximum number of NetFlow connectors on one Tenant (root scope) |
10 |
|
Maximum number of NetFlow connectors on Secure Workload |
100 |
F5 Connector
An F5 connector is a network tool that:
-
allows Cisco Secure Workload to ingest flow observations from F5 BIG-IP ADCs,
-
enables remote monitoring of flow observations on these F5 devices, and
-
provides annotation of client-side and server-side flows, including user details that are available.
Using F5 connectors eliminates the need for software agents on hosts. Configure F5 BIG-IP ADC to export of IPFIX records to the F5 connector.
What is F5 BIG-IP IPFIX
BIG-IP IPFIX logging is a feature on F5 appliances that:
-
collects flow data detailing traffic navigating the F5 BIG-IP infrastructure,
-
exports IPFIX records to designated flow collectors, and
-
operates with F5 BIG-IP software version 12.1.2 and later.
For more information, refer to F5 BIG-IP IPFIX logging.
The setup involves these steps:
-
Create the IPFIX Log-Publisher on the F5 BIG-IP appliance.
-
Configure the IPFIX Log-Destination on the F5 BIG-IP appliance, which listens on the configured endpoint to receive and process flow records.
-
Create an F5 iRule that publishes IPFIX flow records to the log-publisher.
-
Add the F5 iRule to the virtual server of interest.
Note
F5 connector supports F5 BIG-IP software version 12.1.2 and above.
Flow ingestion to Secure Workload
An F5 BIG-IP connector is a component that
-
acts as an IPFIX collector,
-
stitches NATed flows for forwarding to Secure Workload, and
-
configures LDAP attributes for transactions if authentication is managed by F5.
Note |
F5 connector supports only the IPFIX protocol. |
Note |
Each F5 connector reports only flows for a single VRF. Based on the Agent VRF configuration in the Cisco Secure Workload cluster, the connector assigns the flows to the VRF .
|
How to configure IPFIX on F5 BIG-IP
The following steps are for F5 BIG-IP load balancer. For more information, refer to Configuring F5 BIG-IP for IPFIX.
|
Purpose |
Description |
|---|---|
|
1. Create a pool of IPFIX collectors. |
On a F5 BIG-IP appliance, create the pool of IPFIX collectors. These are the IP addresses associated with F5 connectors on a Secure Workload Ingest appliance. F5 connectors run in Docker containers on the VM listen on port 4739 for IPFIX packets. |
|
2. Create a log-destination. |
The log destination configuration on a F5 BIG-IP appliance specifies the actual pool of IPFIX collectors that are used. |
|
3. Create a log-publisher. |
A log publisher specifies where F5 BIG-IP sends the IPFIX messages. The publisher binds to a log-destination. |
|
4. Add a F5 and Secure Workload approved iRule. |
Secure Workload and F5 developed iRules that will export flow records to F5 connectors. These iRules export complete information about a given transaction, including all endpoints, byte counts, packet counts, and flow start and end times (in milliseconds). F5 connectors will create four independent flows, matching each with its related flow. |
|
5. Add the iRule to the virtual server. |
In the iRule settings of a virtual server, add the Secure Workload, approved iRule to the virtual server. |
These steps configures IPFIX on the F5 BIG-IP load balancer to export IPFIX protocol packets for traffic traveling through the appliance. Here is a sample config of F5.
In this example, flow records will be published to ipfix-pub-1. ipfix-pub-1 is configured with log-destination ipfix-collector-1 which sends the IPFIX messages to IPFIX pool ipfix-pool-1. ipfix-pool-1 has 10.28.118.6 as one of the IPFIX collectors. The virtual server vip-1 is configured with IPFIX iRule ipfix-rule-1 which specifies the IPFIX template and how the template gets filled and sent.
-
F5 and Secure Workload approved iRule for TCP virtual server. For more information, refer to L4 iRule for TCP virtual server.
-
F5 and Secure Workload approved iRule for UDP virtual server. For more information, refer to L4 iRule for UDP virtual server.
-
F5 and Secure Workload approved iRule for HTTPS virtual server. For more information, refer to iRule for HTTPS virtual server.
Note |
Before using the iRule downloaded from this guide, update the log-publisher to point to the log-publisher configured in the F5 connector where you add the iRule. |
Note |
F5 has published a GitHub repository, f5-tetration, to help you to start with flow-stitching. The iRules for publishing IPFIX records to the F5 connector for various protocol types are available at: f5-tetration/irules. Visit the site for the latest iRule definitions. In addition, F5 also develops a script to:
This tool enables flow-stitching use-case, minimizing manual configuration and reducing user error. The script is available at f5-tetration/scripts. |
How to configure the connector
A configuration connector is a component that
-
facilitates LDAP and log configuration,
-
enables updating IPFIX listening ports, and
-
supports a range of virtual appliances for connectivity.
For information about required virtual appliances, refer to Virtual Appliances for Connectors.
LDAP Configuration
The LDAP configuration supports discovery of LDAP attributes, provides a workflow to pick the relevant attribute for username identification and allows the fetching of up to six attributes per user for integration.
Log Configuration
For more information on log-related settings and to ensure correct integration with your system, refer to Log Configuration .
IPFIX Protocol Updates
You can update the IPFIX protocol listening ports on a Docker container through the Secure Workload Ingest appliance using a command that is allowed to be run on the container. You need the connector ID and new port data, which can be easily found on the connector page in Secure Workload user interface. For more information, refer to update-listening-ports.
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of F5 connectors on one Secure Workload Ingest appliance |
3 |
|
Maximum number of F5 connectors on one Tenant (rootscope) |
10 |
|
Maximum number of F5 connectors on Secure Workload |
100 |
NetScaler Connector
A NetScaler connector is a monitoring solution that
-
enables Secure Workload to ingest flow observations from Citrix ADCs
-
allows remote monitoring and stitching of client-side and server-side flows, and
-
removes the need for hosts to run software agents.
With this setup, configure Citrix ADCs to export IPFIX records directly to the NetScaler connector for processing.
What is Citrix NetScaler AppFlow
The Citrix NetScaler AppFlow is a traffic management feature that:
-
collects flow data for traffic moving through the NetScaler,
-
exports IPFIX records to flow collectors, and
-
operates using the IPFIX protocol supported in Citrix NetScaler load balancers.
Citrix AppFlow is supported in Citrix NetScaler load balancers.
For more information about Citrix NetScaler AppFlow, refer to Citrix NetScaler AppFlow.
The setup for Citrix NetScaler AppFlow involves these steps:
-
Enable the AppFlow feature on one or more Citrix NetScaler instances.
-
Configure the AppFlow collector endpoint information on remote network devices. This AppFlow collector listens on the configured endpoint to receive and process flow records.
-
Configure AppFlow actions and policies to export flow records to AppFlow collectors.
Note |
The NetScaler connector supports Citrix ADC software version 11.1.51.26 and higher. |
Flow Ingestion to Secure Workload
Flow ingestion is a network process that
-
gathers data from Citrix ADC devices,
-
utilizes Docker containers on Cisco Ingest appliances, and
-
registers as a NetScaler agent with the secure workload platform for analysis.
NetScaler connector is essentially a Citrix AppFlow (IPFIX) collector receiving flow records, stitching NATed flows, and forwarding them to Secure Workload for flow analysis. A NetScaler connector can be enabled on a Cisco Secure Workload Ingest appliance and runs as a Docker container. The NetScaler connector registers with Secure Workload as a Secure Workload NetScaler agent.
Note |
NetScaler connector supports only IPFIX protocol. |
Note |
Each NetScaler connector should report flows only for one VRF. The flows exported by the connector are placed in the VRF based on the Agent VRF configuration in the Secure Workload cluster. To configure the VRF for the connector, perform these steps:
|
How to configure AppFlow on NetScaler
Set up AppFlow on Citrix NetScaler to enable traffic monitoring and reporting through IPFIX protocol packets.
Configure AppFlow on Citrix NetScaler by completing these steps:
Procedure
|
Step 1 |
Enable the AppFlow feature on your NetScaler.
|
|
Step 2 |
Add AppFlow collector endpoints to receive records. The collector receives the AppFlow records from NetScaler. Specify the IP and port of NetScaler connector enabled on a Secure Workload Ingest appliance as an AppFlow collector.
|
|
Step 3 |
Configure an AppFlow action. This lists the collectors that will get AppFlow records when the associated AppFlow policy matches.
|
|
Step 4 |
Configure an AppFlow policy. This rule must match for an AppFlow record to be generated.
|
|
Step 5 |
Bind AppFlow policy to virtual server. Evaluate whether the traffic hitting the IP of the virtual server (VIP) matches the AppFlow policy. On a match, a flow record is generated and sent to all collectors listed in the associated AppFlow action.
|
|
Step 6 |
Optionally, bind AppFlow policy globally (for all virtual servers). An AppFlow policy can also be bound globally to all virtual servers. This policy applies to all traffic that flows through Citrix ADC.
|
|
Step 7 |
Optionally, template refresh interval. These steps configure AppFlow on Citrix NetScaler load balancer to export IPFIX protocol packets for traffic going through NetScaler. The flow records will be sent to either 172.26.230.173:4739 (for traffic going through vserver lb1) and to 172.26.230.184:4739 (for all traffic going through the NetScaler). Each flow record includes 5 tuple information of the traffic and the byte/packet count of the flow.
For more information, refer to Configuring AppFlow. |
How to configure the connector
A connector is a network device that
-
allows specific log configurations,
-
update listening ports on the IPFIX protocol,
-
has identifiable connector IDs
For information about required virtual appliances, refer to Virtual Appliances for Connectors. The following configurations are allowed on the connector.
For more information, refer to Log Configuration .
To update the listening ports of IPFIX protocol on the connector, use the allowed command on the Docker container in Secure Workload Ingest appliance. This command is issued on the appliance by providing the connector ID, the type of port to be updated, and the new port information. The connector ID is available on the connector page in the Secure Workload user interface. For more information, see update-listening-ports.
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of NetScaler connectors on one Secure Workload Ingest appliance |
3 |
|
Maximum number of NetScaler connectors on one Tenant (rootscope) |
10 |
|
Maximum number of NetScaler connectors on Secure Workload |
100 |
Cisco Secure Firewall Connector
Definition:
The Cisco Secure Firewall Connector (formerly known as the ASA Connector) is a flow ingestion solution that
-
allows Secure Workload to ingest flow observations from Secure Firewall ASA (formerly Cisco ASA) and Secure Firewall Threat Defense (formerly Firepower Threat Defense or FTD),
-
eliminates the need for hosts to run software agents because Cisco switches relay NetFlow Secure Event Logging (NSEL) records to the connector for processing, and
-
is hosted in a Secure Workload Ingest appliance for processing.
Starting with Secure Workload Release 4.0, a second connector variant is available:
-
Cisco Secure Firewall Connector (On-Premises): The original connector that integrates with an on-premises FMC or directly with Secure Firewall ASA and FTD devices. Requires manual credential entry and Secure Connector deployment.
-
cdFMC Connector (Cloud-Delivered): A new cloud-based variant that integrates with a Cloud-Delivered FMC (cdFMC) managed through Cisco Security Cloud Control (SCC). Provides zero-touch onboarding with no credentials or Secure Connector required. See Cloud-Delivered Firewall Management Center (cdFMC) Connector.
NetFlow Secure Event Logging Details
Cisco Secure Firewall ASA NetFlow Secure Event Logging (NSEL) provides a stateful, IP flow monitoring that exports significant events in a flow to a NetFlow collector. When an event causes a state change on a flow, an NSEL event is triggered that sends the flow observation along with the event that caused the state change to the NetFlow collector. The flow collector receives these flow records and stores them in their flow storage for offline querying and analysis.
Typically, the setup involves the following steps:
-
Enable NSEL on Secure Firewall ASA and/or Secure Firewall Threat Defense (FTD).
-
Configure the connector endpoint information on Secure Firewall ASA and/or FTD. The connector listens on the configured endpoint to receive and process NSEL records.
Note |
For customers who have migrated their FMC to the cloud and use Cisco Security Cloud Control (SCC), the cdFMC Connector is the recommended choice. Customers with only on-premises FMC deployments should continue to use the Cisco Secure Firewall Connector. |
Cloud-Delivered Firewall Management Center Connector
Definition:
The Cloud-Delivered Firewall Management Center (cdFMC) connector is a cloud-native enhancement to Cisco Secure Workload that
-
integrates with a Cloud-Delivered Firewall Management Center (cdFMC) instance provisioned and managed through Cisco Security Cloud Control (SCC),
-
eliminates the need for manual credential entry, hostname configuration, or Secure Connector deployment because both and cdFMC operate within the same SCC organization, and
-
provides the same flow ingestion and enforcement functionality as the existing Cisco Secure Firewall Connector after onboarding is complete.
Cisco Security Cloud Control (SCC) and cdFMC
Cisco Security Cloud Control (SCC) is Cisco's unified cloud management platform. When both Secure Workload and Cisco Secure Firewall Management Center are subscribed and operational within the SCC organization, Secure Workload can automatically discover and connect to the cdFMC instance without requiring any additional credentials or network tunneling.
Note |
The cdFMC connector is available post Cisco Secure Workload Release 4.0.4.17. |
cdFMC connector vs. Cisco Secure Firewall connector
Definition:
The cdFMC Connector and the Cisco Secure Firewall Connector share identical post-onboarding functionality but differ in their deployment model and onboarding experience. The following table summarizes the key differences:
|
Attribute |
Cisco Secure Firewall Connector (On-Premises) |
cdFMC Connector (Cloud-Delivered) |
|---|---|---|
|
FMC Deployment |
On-premises FMC |
Cloud-hosted FMC via SCC |
|
Onboarding Method |
Manual—requires entering hostname, port, and credentials | Automatic—auto-discovered within the same SCC organization |
|
Credentials Required |
Yes | No |
|
Secure Connector Required |
Yes (for connectivity) | No (cloud-native connectivity) |
|
Supported Customers |
Customers with on-premises FMC who have not migrated to cloud | Customers with cdFMC enabled on SCC |
|
Post-Onboarding Functionality |
Full flow ingestion, enforcement, and policy management | Identical to on-premises FMC connector |
Choosing the Right Connector
Use the following guidance to select the appropriate connector for your deployment:
-
If your Firewall Management Center is deployed on-premises and you have not subscribed to Cisco Security Cloud Control (SCC), use the Cisco Secure Firewall Connector.
-
If your Firewall Management Center is cloud-delivered through SCC and is in the same SCC organization, use the cdFMC Connector for automated, zero-touch integration.
Note |
Both connectors can coexist within the same Cisco Secure Workload tenant to support hybrid deployments. |
How to configure the connector
Definition:
The configuration process differs between the two connector variants only during the initial onboarding step. All post-onboarding configuration options are identical. For information about required virtual appliances, refer the Virtual Appliances for Connectors section.
Cisco Secure Firewall Connector (On-Premises)
Use this procedure for customers with an on-premises Cisco Secure Firewall Management Center (FMC) who have not yet migrated to Cisco Security Cloud Control (SCC).
-
From the Secure Workload navigation pane, choose .
-
Click New Connector and select Cisco Secure Firewall.
-
Manually enter the FMC hostname or IP address, port number, and authentication credentials.
-
Deploy a Secure Connector client to establish connectivity between Secure Workload and the on-premises FMC.
-
Complete the configuration and click Apply.
After the onboarding, configure connector logging settings. For more information, refer Log Configuration.
In addition, the listening ports of the connector can be updated on the Docker container in the Secure Workload Ingest appliance using the allowed update-listening-ports command. Provide the connector ID (found on the connector page in the Secure Workload UI, the type of port to update, and
the new port information.
Use this procedure for customers with cdFMC enabled on Cisco Security Cloud Control (SCC). The onboarding is automated when both Secure Workload and cdFMC are in the same SCC organization.
-
From the Secure Workload navigation pane, choose .
-
Click New Connector and select Cisco Secure Firewall.
-
Click Create. Secure Workload automatically discovers the cdFMC instance within the same SCC organization and populates all connection details, including hostname and port. No credentials or manual network configuration are required.
-
Review the auto-populated configuration and confirm.
Note |
A Secure Connector client is not required for the cdFMC Connector. Because both Secure Workload and cdFMC are cloud services operating within the same SCC organization, connectivity is established natively within the cloud platform. |
After the onboarding, configure connector logging settings. For more information, refer the Log Configuration section.
In addition, the listening ports of the connector can be updated on the Docker container in the Secure Workload ingest appliance using the allowed update-listening-ports command. Provide the connector ID (found on the connector page in the Secure Workload UI, the type of port to update, and
the new port information.
Flow ingestion to Secure Workload
Definition:
Both the Cisco Secure Firewall Connector and the cdFMC Connector are essentially NetFlow collectors. Each connector
-
receives NSEL records from Secure Firewall ASA and/or Secure Firewall Threat Defense (FTD) devices,
-
forwards the flow observations to Cisco Secure Workload for flow analysis,
-
can be enabled on a Secure Workload Ingest appliance and runs as a Docker container,
-
registers with Secure Workload as a Secure Workload agent,
-
decapsulates the NSEL protocol packets (flow records) and processes and reports the flows like a regular Secure Workload agent, and
-
does not report any process or interface information, unlike a Deep Visibility Agent
.
Forward Flow Observation
Note |
Both the Cisco Secure Firewall Connector and the cdFMC Connector support the NetFlow v9 protocol. |
Note |
Each connector (Cisco Secure Firewall Connector or cdFMC Connector) should report only flows for one VRF. The flows exported by the connector are placed into the VRF based on the Agent VRF configuration in the Secure Workload cluster. To configure the VRF for the connector, navigate to and click the Configuration tab. Under the Agent Remote VRF Configurations section, click Create Config and provide the following details:
|
NSEL flow records are bidirectional. Each connector sends both a forward flow and a reverse flow to Secure Workload. The following table shows the NSEL element mappings for the forward flow:
| Field | NSEL Element ID | NSEL Element Name |
|---|---|---|
| Protocol | 4 | NF_F_PROTOCOL |
| Source Address (IPv4) | 8 | NF_F_SRC_ADDR_IPV4 |
| Source Address (IPv6) | 27 | NF_F_SRC_ADDR_IPV6 |
| Source Port | 7 | NF_F_SRC_PORT |
| Destination Address (IPv4) | 12 | NF_F_DST_ADDR_IPV4 |
| Destination Address (IPv6) | 28 | NF_F_DST_ADDR_IPV6 |
| Destination Port | 11 | NF_F_DST_PORT |
| Flow Start Time | 152 | NF_F_FLOW_CREATE_TIME_MSEC |
| Byte Count | 231 | NF_F_FWD_FLOW_DELTA_BYTES |
| Packet Count | 298 | NF_F_FWD_FLOW_DELTA_PACKETS |
| Field | NSEL Element ID | NSEL Element Name |
|---|---|---|
| Protocol | 4 | NF_F_PROTOCOL |
| Source Address (IPv4) | 12 | NF_F_DST_ADDR_IPV4 |
| Source Address (IPv6) | 28 | NF_F_DST_ADDR_IPV6 |
| Source Port | 11 | NF_F_DST_PORT |
| Destination Address (IPv4) | 8 | NF_F_SRC_ADDR_IPV4 |
| Destination Address (IPv6) | 27 | NF_F_SRC_ADDR_IPV6 |
| Destination Port | 7 | NF_F_SRC_PORT |
| Flow Start Time | 152 | NF_F_FLOW_CREATE_TIME_MSEC |
| Byte Count | 232 | NF_F_REV_FLOW_DELTA_BYTES |
| Packet Count | 299 | NF_F_REV_FLOW_DELTA_PACKETS |
Flow ingestion to Secure Workload
Definition:
Both the Cisco Secure Firewall Connector and the cdFMC Connector are essentially NetFlow collectors. Each connector
-
receives NSEL records from Secure Firewall ASA and/or Secure Firewall Threat Defense (FTD) devices,
-
forwards the flow observations to Cisco Secure Workload for flow analysis,
-
can be enabled on a Secure Workload Ingest appliance and runs as a Docker container,
-
registers with Secure Workload as a Secure Workload agent,
-
decapsulates the NSEL protocol packets (flow records) and processes and reports the flows like a regular Secure Workload agent, and
-
does not report any process or interface information, unlike a Deep Visibility Agent
.
Forward Flow Observation
Note |
Both the Cisco Secure Firewall Connector and the cdFMC Connector support the NetFlow v9 protocol. |
Note |
Each connector (Cisco Secure Firewall Connector or cdFMC Connector) should report only flows for one VRF. The flows exported by the connector are placed into the VRF based on the Agent VRF configuration in the Secure Workload cluster. To configure the VRF for the connector, navigate to and click the Configuration tab. Under the Agent Remote VRF Configurations section, click Create Config and provide the following details:
|
NSEL flow records are bidirectional. Each connector sends both a forward flow and a reverse flow to Secure Workload. The following table shows the NSEL element mappings for the forward flow:
| Field | NSEL Element ID | NSEL Element Name |
|---|---|---|
| Protocol | 4 | NF_F_PROTOCOL |
| Source Address (IPv4) | 8 | NF_F_SRC_ADDR_IPV4 |
| Source Address (IPv6) | 27 | NF_F_SRC_ADDR_IPV6 |
| Source Port | 7 | NF_F_SRC_PORT |
| Destination Address (IPv4) | 12 | NF_F_DST_ADDR_IPV4 |
| Destination Address (IPv6) | 28 | NF_F_DST_ADDR_IPV6 |
| Destination Port | 11 | NF_F_DST_PORT |
| Flow Start Time | 152 | NF_F_FLOW_CREATE_TIME_MSEC |
| Byte Count | 231 | NF_F_FWD_FLOW_DELTA_BYTES |
| Packet Count | 298 | NF_F_FWD_FLOW_DELTA_PACKETS |
| Field | NSEL Element ID | NSEL Element Name |
|---|---|---|
| Protocol | 4 | NF_F_PROTOCOL |
| Source Address (IPv4) | 12 | NF_F_DST_ADDR_IPV4 |
| Source Address (IPv6) | 28 | NF_F_DST_ADDR_IPV6 |
| Source Port | 11 | NF_F_DST_PORT |
| Destination Address (IPv4) | 8 | NF_F_SRC_ADDR_IPV4 |
| Destination Address (IPv6) | 27 | NF_F_SRC_ADDR_IPV6 |
| Destination Port | 7 | NF_F_SRC_PORT |
| Flow Start Time | 152 | NF_F_FLOW_CREATE_TIME_MSEC |
| Byte Count | 232 | NF_F_REV_FLOW_DELTA_BYTES |
| Packet Count | 299 | NF_F_REV_FLOW_DELTA_PACKETS |
Handle NetFlow records
Based on the NetFlow record, Meraki connector sends flow observation to Secure Workload. Meraki NetFlow flow records are bidirectional. So, Meraki connector sends 2 flows: forward flow and reverse flow to Secure Workload.
Here are the details about flow observation sent by Meraki connector to Secure Workload.
Forward flow observation
|
Field |
Element ID |
Element Name |
|---|---|---|
|
Protocol |
4 |
protocolIdentifier |
|
Source Address |
8 |
sourceIPv4Address |
|
Source Port |
7 |
sourceTransportPort |
|
Destination Address |
12 |
destinationIPv4Address |
|
Destination Port |
11 |
destinationTransportPort |
|
Byte Count |
1 |
octetDeltaCount |
|
Packet Count |
2 |
packetDeltaCount |
|
Flow Start Time |
Set based on when the NetFlow record for this flow is received on the connector |
Reverse flow information
|
Field |
Element ID |
|
|---|---|---|
|
Protocol |
4 |
protocolIdentifier |
|
Source Address |
8 |
sourceIPv4Address |
|
Source Port |
7 |
sourceTransportPort |
|
Destination Address |
12 |
destinationIPv4Address |
|
Destination Port |
11 |
destinationTransportPort |
|
Byte Count |
23 |
postOctetDeltaCount |
|
Packet Count |
24 |
postPacketDeltaCount |
|
Flow Start Time |
Set based on when the NetFlow record for this flow is received on the connector |
Handle NetFlow records
Based on the NetFlow record, Meraki connector sends flow observation to Secure Workload. Meraki NetFlow flow records are bidirectional. So, Meraki connector sends 2 flows: forward flow and reverse flow to Secure Workload.
Here are the details about flow observation sent by Meraki connector to Secure Workload.
Forward flow observation
|
Field |
Element ID |
Element Name |
|---|---|---|
|
Protocol |
4 |
protocolIdentifier |
|
Source Address |
8 |
sourceIPv4Address |
|
Source Port |
7 |
sourceTransportPort |
|
Destination Address |
12 |
destinationIPv4Address |
|
Destination Port |
11 |
destinationTransportPort |
|
Byte Count |
1 |
octetDeltaCount |
|
Packet Count |
2 |
packetDeltaCount |
|
Flow Start Time |
Set based on when the NetFlow record for this flow is received on the connector |
Reverse flow information
|
Field |
Element ID |
|
|---|---|---|
|
Protocol |
4 |
protocolIdentifier |
|
Source Address |
8 |
sourceIPv4Address |
|
Source Port |
7 |
sourceTransportPort |
|
Destination Address |
12 |
destinationIPv4Address |
|
Destination Port |
11 |
destinationTransportPort |
|
Byte Count |
23 |
postOctetDeltaCount |
|
Packet Count |
24 |
postPacketDeltaCount |
|
Flow Start Time |
Set based on when the NetFlow record for this flow is received on the connector |
Configure the connector
For information about required virtual appliances, see Virtual Appliances for Connectors. This reference provides configuration options available on the connector. For more information, refer Log Configuration .
In addition, the listening ports of IPFIX protocol on the connector can be updated on the Docker container in Secure Workload Ingest appliance using a an allowed command. This command can be issued on the appliance by providing the connector ID of the connector, type of the port to be update, and the new port information. The connector ID can be found on the connector page in Secure Workload UI. For more information, see update-listening-ports.
Meraki connector
A Meraki connector is a network device that:
-
Enables Secure Workload to ingest flow observations from Meraki firewalls.
-
Facilitates the process without the need for software agents on hosts.
-
Relays NetFlow records to an Ingest appliance for processing.
What is NetFlow
A NetFlow protocol is a network monitoring standard that:
-
allows aggregation of traffic data by network devices,
-
enables export of flow data to collectors for storage, and
-
assists in offline querying and analysis of network traffic.
For more information, refer to Meraki Firewall.
Set up the system by completing these steps:
-
Enable NetFlow statistics reporting on Meraki Firewall.
-
Configure the Meraki Firewall with the endpoint information for NetFlow collectors.
Flow ingestion to Secure Workload
A Meraki connector is a NetFlow collector that:
-
Receives flow records from the configured Meraki firewalls to export NetFlow traffic statistics.
-
Processes the NetFlow records.
-
Sends the flow observations reported by Meraki firewalls to Secure Workload for flow analysis.
You can enable a Meraki connector on a Secure Workload Ingest appliance and run it as a Docker container.
The Meraki connector registers with Secure Workload as a Secure Workload Meraki agent. It decapsulates the NetFlow protocol packets, processes and reports flows as a regular Secure Workload agent. Unlike a Deep Visibility Agent, it does not report any process or interface information.
Note |
The Meraki connector supports the NetFlow v9 protocol. |
Note |
Each Meraki connector should report flows for a single VRF. The flows exported by the connector are placed in the VRF based on the Agent VRF configuration in Secure Workload cluster. To configure the VRF for the connector, complete these steps:
|
Handling NetFlow Records
Based on the NetFlow record, Meraki connector sends flow observation to Secure Workload. Meraki NetFlow flow records are bidirectional. So, Meraki connector sends 2 flows: forward flow and reverse flow to Secure Workload.
Here are the details about flow observation sent by Meraki connector to Secure Workload.
Forward Flow observation
|
Field |
Element ID |
Element Name |
|---|---|---|
|
Protocol |
4 |
protocolIdentifier |
|
Source Address |
8 |
sourceIPv4Address |
|
Source Port |
7 |
sourceTransportPort |
|
Destination Address |
12 |
destinationIPv4Address |
|
Destination Port |
11 |
destinationTransportPort |
|
Byte Count |
1 |
octetDeltaCount |
|
Packet Count |
2 |
packetDeltaCount |
|
Flow Start Time |
Set based on when the NetFlow record for this flow is received on the connector |
Reverse Flow Information
|
Field |
Element ID |
|
|---|---|---|
|
Protocol |
4 |
protocolIdentifier |
|
Source Address |
8 |
sourceIPv4Address |
|
Source Port |
7 |
sourceTransportPort |
|
Destination Address |
12 |
destinationIPv4Address |
|
Destination Port |
11 |
destinationTransportPort |
|
Byte Count |
23 |
postOctetDeltaCount |
|
Packet Count |
24 |
postPacketDeltaCount |
|
Flow Start Time |
Set based on when the NetFlow record for this flow is received on the connector |
How to configure NetFlow on Meraki firewall
you set up NetFlow traffic reporting on the Meraki Firewall by configuring specific settings via the Meraki UI console.
Follow these steps to configure NetFlow reporting on the Meraki firewall.
Procedure
|
Step 1 |
Log in to the Meraki UI console. |
||
|
Step 2 |
Choose . In Reporting settings, enable NetFlow traffic reporting and ensure that it is set to Enabled: send NetFlow traffic statistics. |
||
|
Step 3 |
Configure the NetFlow collector IP and NetFlow collector port to point to the IP and port where the Meraki connector listens on the Secure Workload Ingest appliance.
|
||
|
Step 4 |
Save the changes.
|
How to configure the connector
A connector is a configuration tool that
-
allows specific authorized configurations,
-
enables updates to listening ports, and
-
provides necessary integration with virtual appliances.
For information about required virtual appliances, refer to Virtual Appliances for Connectors.
For more information, refer to Log Configuration .
Listening ports of NetFlow v9 protocol on the connector can be updated on the Docker container in Secure Workload Ingest appliance using authorized command. This involves providing the connector ID, type of the port to be update, and the new port information. You can find the connector ID on the connector page in the Secure Workload user interface. For more information, see update-listening-ports.
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of Meraki connectors on one Secure Workload Ingest appliance |
1 |
|
Maximum number of Meraki connectors on one Tenant (rootscope) |
10 |
|
Maximum number of Meraki connectors on Secure Workload |
100 |
ERSPAN Connector
An ERSPAN connector is a network tool that
-
Enables Cisco Secure Workload to ingest flow observations.
-
Eliminates the need for hosts to run software agents.
-
Relies on Cisco switches to relay host traffic for processing.
ERSPAN connectors streamline the flow observation process by efficiently ingesting network traffic from hosts without additional software layers. This approach enhances network efficiency and reduces dependency on host configurations.
The development of ERSPAN connectors also supports better traffic management, enabling seamless integration with existing Cisco systems.
What is ERSPAN
A ERSPAN is a network feature that
-
mirrors frames observed by network devices,
-
encapsulates them into IP packets, and
-
sends the packets to a remote traffic analyzer.
Encapsulated Remote Switch Port Analyzers typically involve these steps:
-
Configure monitoring sessions for source ERSPAN on network devices.
-
Use a remote network device that is directly connected to a traffic analyzer for destination monitoring.
The Secure Workload ERSPAN connector provides destination ERSPAN session and traffic analyzer functionalities, negating the need to configure destination sessions on the switches with the Secure Workload solution.
What are the SPAN agents
A SPAN agent is a network monitoring component that
-
registers with each ERSPAN connector within a cluster,
-
processes only ERSPAN packets, and
-
performs traffic analysis without interface or process reporting like regular agents do.
Like Cisco destination ERSPAN sessions, SPAN agents decapsulate the mirrored frames. Then, they process and report the flows like a regular Secure Workload agent. SPAN agents differ from Deep Visibility Agents by not reporting process or interface information.
What is the ingest appliance for ERSPAN
An ingest appliance for ERSPAN is a virtual machine (VM) that
-
internally runs three ERSPAN Secure Workload connectors
-
uses the same OVA or QCOW2 as a standard Ingest appliance
-
assigns one vNIC and two vCPU cores to each connector without a limiting quota.
Each connector operates inside a dedicated Docker container to register a SPAN agent with the cluster. The container hostname is formatted as <VM hostname>-<interface IP address>. Connectors and agents are maintained upon VM, Docker daemon, or Docker container crashes/reboots.
Note |
The ERSPAN connector’s status is reported on the Connector page. Check to the Agent List page and review the corresponding SPAN agent's state. |
For more information on the required virtual appliances, refer to Virtual Appliances for Connectors. ERSPAN connectors support IPv4 and IPv6 addresses in dual stack mode, though dual stack support is currently a beta feature.
How to configure the source ERSPAN session
A source ERSPAN session is a network feature that
-
allows the mirroring of ingress and egress frames on an interface,
-
uses GRE packets to transport mirrored frames,
-
and requires a source and destination IP address.
When configuring a source ERSPAN session on a Cisco Nexus 9000 switch, follow platform-specific configurations which you can find in the Cisco Secure Workload User Guide. Ensure that the L3 interface on the switch is the source and matches the IP address on the ERSPAN VM.
You create a source ERSPAN session with ID 10. The switch mirrors the frames ingressing and egressing (both) the interface eth1/23 and those on VLANs 315 and 512. The outer GRE packet carrying the mirrored frame will have source IP 172.28.126.1 (must be the address of a L3 interface on this switch) and destination IP 172.28.126.194. This is one of the IP addresses configured on the ERSPAN VM.
Supported ERSPAN formats
The Secure Workload SPAN Agents can process ERSPAN type I, II, and III packets as described in the proposed ERSPAN RFC. SPAN agents process ERSPAN packets generated by Cisco devices and, among non-RFC compliant formats, those generated by VMware vSphere Distributed Switch (VDS).
Performance considerations when configuring ERSPAN source
An ERSPAN source is a configuration aspect of ERSPAN that:
-
Selects port/VLAN lists carefully to avoid overwhelming the SPAN agent.
-
Utilizes Access Control List (ACL) policies for fine-grained frame selection.
-
Allows for MTU modifications to manage bandwidth without affecting SPAN agent processing load.
The ERSPAN source session can modify the Maximum Transport Unit (MTU) of the ERSPAN packet, which commonly defaults to 1500 bytes. Decreasing the MTU will limit ERSPAN bandwidth usage without affecting the SPAN Agent load, as the agent’s workload is on a per-packet basis. Reduce the MTU to make a 160-byte allowance for the mirrored frame. For more information on ERSPAN header overhead, review the proposed ERSPAN RFC.
Three versions of ERSPAN exist, each providing varying overhead and functionalities such as QOS policies on versions II and III. The smaller the version, the lower the ERSPAN header overhead. Version II and III allow for applying QOS policies to the ERSPAN packets, and provide some VLAN info. Version III carries even more settings. Cisco switches default to Version II, while Secure Workload SPAN Agents support all versions, although they do not utilize extra information from ERSPAN versions II and III packets.
Security considerations
The Ingest Virtual Machine for ERSPAN uses CentOS 7.9, from which OpenSSL server/clients packages were removed.
Note |
CentOS 7.9 is the guest operating system for Ingest and Edge virtual appliances in Secure Workload 3.8.1.19 and earlier releases. For releases starting from 3.8.1.36, it transitions to AlmaLinux 9.2. |
After booting the VM and deploying the SPAN agent containers, all network interfaces except the loopback are unavailable, so the console remains the only access method.
Agent and Container Configuration
The VM network interfaces are encapsulated within Docker containers that use a centos:7.9.2009 based Docker image with no open TCP/UDP ports.
Containers run with base privileges, have added NET_ADMIN capabilities, and do not use the --privileged option.
Security Implications
In a container is compromised, guest OS security remains intact.
The same security measures applicable to other Agents in Secure Workload apply to the Secure Workload SPAN Agents within Docker containers.
Troubleshooting
When SPAN Agents show as active in the cluster Monitoring/Agent Overview page, no action is needed on the ERSPAN Virtual Machine. Users do not need to log in to it. If the SPAN Agents do not show as active or the flows are not reported to the cluster, this information will help pinpoint deployment problems.
Under normal conditions on the VM, these conditions should be verified:
-
systemctl status tet_vm_setupreports an inactive service with SUCCESS exit status; -
systemctl status tet-nic-driverreports an active service; -
docker network lsreports five networks includinghost, noneand threeerspan-<iface name>; -
ip linkonly reports the loopback interface; -
docker psreports three running containers; -
docker logs <cid>for each container contains the message:INFO success: tet-sensor entered RUNNING state, process has stayed up for > than 1 seconds (startsecs) -
docker exec <cid> ifconfigreports only one interface, besides the loopback; -
docker exec <cid> route -nreports the default gateway; -
docker exec <cid> iptables -t raw -S PREROUTINGreports the rule:-A PREROUTING -p gre -j DROP;
In the case of discrepancies, check the deployment script logs in /local/tetration/logs/ tet_vm_setup.log.
For further agent troubleshooting:
-
Use
docker exec <cid> ps -ef, which reports two instances oftet-engine, tet-engine check_confand two/usr/local/tet/tet-sensor -f /usr/local/tet/conf/.sensor_configinstances, one with root user and other with tet-sensor user, along with the process manager/usr/bin/ python /usr/bin/supervisord -c /etc/supervisord.conf -ninstance. -
Use
docker exec <cid> cat /usr/local/tet/log/tet-sensor.logto view the agent’s logs; -
Use
docker exec <cid> cat /usr/local/tet/log/fetch_sensor_id.logto view the agent’s registration logs; -
Use
docker exec <cid> cat /usr/local/tet/log/check_conf_update.logto view the configuration update polling logs;Use
tcpdumpin the container’s network namespace to monitor traffic.To monitor specific container traffic:
-
Retrieve the container’s network namespace (SandboxKey) using
docker inspect <cid> | grep SandboxKey; -
Enter the container’s network namespace with
nsenter --net=/var/run/docker/netns/...; -
Use
tcpdump -i eth0 -nto monitor eth0 traffic.
-
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of ERSPAN connectors on one Secure Workload Ingest appliance |
3 |
|
Maximum number of ERSPAN connectors on one Tenant (rootscope) |
24 (12 for TaaS) |
|
Maximum number of ERSPAN connectors on Secure Workload |
450 |
Connectors for endpoints
Connectors for endpoints provide endpoint context for Secure Workload.
|
Connector |
Description |
Deployed on Virtual Appliance |
|---|---|---|
|
AnyConnect |
Collects telemetry data from Cisco AnyConnect Network Visibility Module (NVM) and enriches endpoint inventories with user attributes |
Secure Workload Ingest |
|
ISE |
Collects information about endpoints and inventories managed by Cisco ISE appliances and enriches endpoint inventories with user attributes and secure group labels (SGL). |
Secure Workload Edge |
For more information about required virtual appliances, refer to Virtual Appliances for Connectors.
AnyConnect connector
AnyConnect connector monitors endpoints that run Cisco AnyConnect Secure Mobility Client with Network Visibility Module (NVM). With this solution, hosts do not need to run any software agents on endpoints, because NVM sends host, interface, and flow records in IPFIX format to a collector, for example, AnyConnect connector.
The AnyConnect connector performs these high-level functions:
-
Register each endpoint: Supported user devices such as desktops, laptops, or smartphones on Cisco Secure Workload as an AnyConnect agent.
-
Update interface snapshots from these endpoints with Secure Workload.
-
Send flow information exported by these endpoints to Secure Workload collectors.
-
Periodically send snapshots of processes that generate flows on the endpoints tracked by the AnyConnect connector.
-
Label endpoint interface IP addresses with Lightweight Directory Access Protocol (LDAP) attributes corresponding to the logged-in-user at each endpoint.
Figure 10. AnyConnect connector
What is AnyConnect NVM
The Network Visibility Module (NVM) is a software component that
-
provides visibility and monitoring of endpoint and user behavior,
-
collects context information from endpoints, and
-
supports multiple contexts such as device, user, application, location, and destination.
AnyConnect NVM collects various contexts:
-
Device/Endpoint Context: Device/endpoint specific information.
-
User Context: Users associated with data flows.
-
Application Context: Processes associated with data flows.
-
Location Context: Available location specific attributes.
-
Destination Context: FQDN of the destination.
AnyConnect NVM generates three types of records.
NVM Record
Description
Endpoint Record
Device/endpoint information including unique device identifier (UDID), hostname, OS name, OS version and manufacturer.
Interface Record
Information about each interface in the endpoint including the endpoint UDID, interface unique identifier (UID), interface index, interface type, interface name, and MAC address.
Flow Record
Information about flows seen on the endpoint including endpoint UDID, interface UID, 5-tuple (source/destination IP/port and protocol), in/out byte counts, process information, user information, and FQDN of the destination.
Each record is generated and exported in IPFIX protocol format. When the device is in a trusted network (on- premise/VPN), AnyConnect NVM exports records to a configured collector. The AnyConnect connector is an example of an IPFIX collector that can receive and process IPFIX stream from AnyConnect NVM.
Note |
AnyConnect connector supports AnyConnect NVM from version 4.2 and later of the Cisco AnyConnect Secure Mobility Client. |
How to configure AnyConnect NVM
For step-by-step instructions on how to implement AnyConnect NVM using either Cisco Secure Firewall ASA or Cisco Identity Services engine (ISE), refer to How to Implement AnyConnect NVM. Once the NVM module is deployed, the NVM profile should be specified, pushed to, and installed on endpoints running Cisco AnyConnect Secure Mobility Client. When specifying NVM profile, the IPFIX collector should be configured to point to the AnyConnect connector on port 4739.
AnyConnect connector registers with Secure Workload as a Secure Workload AnyConnect Proxy agent.
Processing NVM records
The AnyConnect connector processes AnyConnect NVM records by registering endpoints, determining interface IP addresses, and translating flow records to ensure effective network operations in Secure Workload.
The key components involved in the process are:
-
AnyConnect connector: Registers endpoints and processes records for Secure Workload.
-
NVM record: Contains endpoint-specific information used to enable communication.
-
Secure Workload: The platform where all interactions from AnyConnect inputs are integrated and monitored.
The process involves these stages:
-
Endpoint Record Processing:
-
Upon receiving an endpoint record, it registers the endpoint on Secure Workload using specific information and certificate.
-
It enables data-plane by connecting to a Secure Workload collector and periodically checks the endpoint status.
-
-
Interface Record Processing:
-
IP address for an interface is recognized when flow records arrive.
-
Sends a snapshot of interfaces once the IP is defined, integrating VRF with incoming interface data.
-
-
Flow Record Processing:
-
Translates and transmits flow records in a compatible format to Secure Workload.
-
Associates LDAP attributes to endpoint IP if configured, ensuring all data is correlated for network monitoring.
-
Endpoint Record
Starting with version 4.9, AnyConnect NVM begins to send the agent version. By default, Secure Workload registers the AnyConnect endpoint as version 4.2.x. This version indicates the minimum supported AnyConnect NVM version. For the AnyConnect endpoints with version 4.9 or newer, the corresponding AnyConnect agent on Secure Workload would show the actual version installed.
Note |
Secure Workload does not control the installed version of the AnyConnect agent. Upgrading the AnyConnect endpoint agent via Secure Workload user interface has no effect. |
Flow Record
Note |
Each AnyConnect connector will report only endpoints/interfaces/ flows for one VRF. The endpoints and interfaces reported by AnyConnect connector are associated with the VRF based on the Agent VRF configuration in Secure Workload. The flows exported by the AnyConnect connector agent on behalf of the AnyConnect endpoint belong to the same VRF. To configure the VRF for the agent, go to: and click the Configuration tab. In this page, under “Agent Remote VRF Configurations” section, click “Create Config” and provide the details about the AnyConnect connector. The form requests the user to provide: the name of the VRF, IP subnet of the host on which the agent is installed, and range of port numbers that can potentially send flow records to the cluster. |
Duplicate UDIDs in Windows endpoints
A duplicate UDID in Windows endpoints is a cloning issue where:
-
All cloned endpoints from the same golden image have identical UDIDs.
-
This identical UDID limits the AnyConnect connectors' ability to differentiate records.
-
Makes data association to the correct AnyConnect agent indeterministic.
To solve this, AnyConnect NVM 4.8 provides a tool named dartcli.exe to find and regenerate UDID on the endpoint.
-
dartcli.exe -u retrieves the UDID of the endpoint.
-
dartcli.exe -nu regenerates the UDID of the endpoint. To run this tool, use these steps.
C:\Program Files (x86)\Cisco\Cisco AnyConnect Secure Mobility Client\DART>dartcli.exe -u
UDID : 8D0D1E8FA0AB09BE82599F10068593E41EF1BFFF
C:\Program Files (x86)\Cisco\Cisco AnyConnect Secure Mobility Client\DART>dartcli.exe -nu
Are you sure you want to re-generate UDID [y/n]: y
Adding nonce success
UDID : 29F596758941E606BD0AFF49049216ED5BB9F7A5
C:\Program Files (x86)\Cisco\Cisco AnyConnect Secure Mobility Client\DART>dartcli.exe -u
UDID : 29F596758941E606BD0AFF49049216ED5BB9F7A5
Periodic tasks
A periodic task is a scheduled activity that:
-
runs at defined intervals,
-
executes automatically without manual intervention, and
-
involves processing to update various operational parameters.
Periodically, the AnyConnect connector sends process snapshots and user labels on AnyConnect endpoint inventories.
-
Process Snapshots: Every five minutes, the AnyConnect connector walks through the processes maintained locally, and sends a process snapshot for all endpoints with flows during that interval.
-
User Labels: Every two minutes, the AnyConnect connector walks through the LDAP user labels maintained locally and updates User Labels on those IP addresses.
For user labels, the AnyConnect connector creates a local snapshot of LDAP attributes of all users. With the AnyConnect connector enabled, provide LDAP configuration. This includes server/port information, required attributes, and the username attribute. In addition, the LDAP user credentials to access LDAP server may be provided. LDAP user credentials are encrypted and never revealed in the AnyConnect connector. Optionally, a certificate for the LDAP may be provided for secure access.
Note |
AnyConnect connector creates a new local LDAP snapshot every 24 hours. This interval is configurable in LDAP configuration of the connector. |
How to configure the connector
For information about required virtual appliances, refer to Virtual Appliances for Connectors. These configurations can be applied to the connector.
-
LDAP: LDAP configuration supports discovery of LDAP attributes and provides a workflow to select the attribute that corresponds to the username and a list of up to six attributes to fetch for each user. For more information, refer to Discovery .
-
Endpoint: For more information, refer to Endpoint Configuration.
-
Log: For more information, refer to Log Configuration.
Additionally, the listening ports of IPFIX protocol on the connector can be updated on the Docker container in Secure Workload Ingest appliance using an allowed command. This command can be issued on the appliance by providing the connector ID of the connector, type of the port to be update, and the new port information. The connector ID can be found on the connector page in Secure Workload UI. For more information, see update-listening-ports.
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of AnyConnect connectors on one Secure Workload Ingest appliance |
1 |
|
Maximum number of AnyConnect connectors on one Tenant (rootscope) |
50 |
|
Maximum number of AnyConnect connectors on Secure Workload |
500 |
ISE connector
The ISE connector in Secure Workload connects with Cisco Identity Services Engine (ISE) and ISE Passive Identity Connector (ISE-PIC) using the Cisco Platform Exchange Grid (pxGrid), to retrieve contextual information, such as metadata, for endpoints reported by ISE.
An ISE connector performs these functions:
-
Registers each endpoint on Secure Workload that is identified as an ISE endpoint
-
Updates metadata information on Secure Workload regarding the endpoints, such as MDM details, authentication, Security Group labels, ISE group name, and ISE group type.
-
Periodically, the cluster is updated with active endpoints visible on the ISE. Figure 11. ISE connector
Note |
Each ISE connector registers only endpoints and interfaces for a single VRF. The endpoints and interfaces reported by ISE connectors are associated with the VRF based on the Agent VRF configuration in Secure Workload. |
Configure the VRF for the agent using these steps:
-
Choose .
-
Click the Configuration tab.
-
Under the Agent Remote VRF Configurations section, click Create Config.
-
Provide the details about the ISE connector, including the VRF name, the IP subnet of the host on which the agent is installed, and the range of port numbers that can register ISE endpoints and interfaces on Secure Workload.
Note |
ISE endpoint agents are not listed on the Agents List page; instead ISE endpoints with the attributes can be viewed on the Inventory page. |
How to configure the connector
Note |
ISE version 2.4 or higher and ISE PIC version 3.1 or higher are required for this integration. |
For information about required virtual appliances, refer to Virtual Appliances for Connectors. For ISE connectors, IPv4 and IPv6 dual-stack mode addresses are supported. Dual stack support is available as a beta feature.
You can configure the connector with these options:
-
ISE Instance: The ISE connector connects to multiple instances of ISE using the provided configurations. Each instance requires ISE certificate credentials, a hostname, and a node name for connection. For more information, refer to ISE Instance Configuration.
-
LDAP: LDAP configuration supports discovery of LDAP attributes, allows the selection of the username attribute, enables the fetching of up to six attributes for each user. For more information, refer to Discovery .
-
Log: For more information, refer to Log Configuration.
Note
ISE connector connects with the getSessions API call to fetch all active endpoints during the timeframe. The ISE connector also has a listener that subscribes to session topic in PxGrid that provides all the new endpoints updates.
ISE instance configuration
Note |
Cisco Secure Workload version 3.7 requires Subject Alternative Names (SAN) for the SSL certificate of Cisco ISE pxGrid node for this integration. Ensure the certification configuration of the ISE nodes is done by your ISE administrator prior to performing the integration with Secure Workload. |
To verify your pxGrid node’s certificate and confirm if SAN is configured, perform the verification steps for the certificate from ISE.
Procedure
|
Step 1 |
Navigate to Certificates and choose . |
||||||||||||||||||||||
|
Step 2 |
Under Certificate Management, select System Certificates, select your “Used by” pxGrid certificate and choose View to review the pxGrid node cert. |
||||||||||||||||||||||
|
Step 3 |
Review the certificate to ensure that the Subject Alternative Names are configured. |
||||||||||||||||||||||
|
Step 4 |
Ensure that this certificate is signed by a valid Certificate Authority (CA), which is also used to sign the pxGrid client certificate for the Secure Workload ISE connector.
|
||||||||||||||||||||||
|
Step 5 |
You can now generate the pxGrid client certificate signing request using the following template on any host installed with OpenSSL.
Save the file as
|
||||||||||||||||||||||
|
Step 6 |
Sign the Certificate Signing Request (CSR) by your CA using a Windows CA server. If you are also using a Windows CA server, run this command to sign the CSR of the pxGrid client.
|
||||||||||||||||||||||
|
Step 7 |
Copy the signed client certificate and root CA in the PEM format onto your host. This is the same host that generates the client CSR and private key. Use OpenSSL to ensure the client certificate is in X.509 PEM format. Run the following command using OpenSSL to convert the signed client certificate to the X.509 PEM format.
|
||||||||||||||||||||||
|
Step 8 |
You can also confirm the PEM that is signed by the CA, use this command.
|
||||||||||||||||||||||
|
Step 9 |
Using this example’s file names, copy the ISE client cert—
|
Note |
|
Processing ISE records
Processing of ISE records involves integrating endpoint information and security group details into Secure Workload for timely updates and accurate content management.
The key components of the process are:
-
ISE connector: Connects to the ISE instance to monitor updates and manage record registration.
-
Secure Workload: Manages inventory enrichment using the registered endpoints.
-
Local Database: Maintains mapping details for security groups.
The process involves the following stages:
-
Connect and Subscribe: The ISE connector connects to the ISE instance and subscribes for updates on endpoints and security groups over pxGrid.
-
Endpoint Record Handling: Upon receiving an endpoint record, the ISE connector registers the endpoint on Secure Workload using endpoint-specific information and its certificate, enriching the inventory.
-
Security Group Management: ISE connector updates its local database with any Security Group Label changes and aligns these with endpoint records in Secure Workload.
Periodic Tasks
ISE connector periodically updates user labels on ISE endpoint inventories.
-
Endpoint Snapshots: Every 20 hours, ISE connector fetches a snapshot of endpoints and security group labels from the ISE instance and updates the cluster if any change is detected. This call cannot handle disconnected endpoints if they are not visible in the ISE system.
-
User Labels: Every two minutes, ISE connector scans through the LDAP user and ISE endpoint labels maintained locally and updates user labels on those IP addresses.
For user labels, the ISE connector generates a local snapshot of LDAP attributes for all users. When ISE connector is enabled, configuration for LDAP may be provided, including server and port information, attributes to fetch for a user, and the attribute containing the username. Additionally, provide LDAP user credentials for LDAP server access. LDAP user credentials are encrypted and never revealed in the ISE connector. Optionally, provide an LDAP certificate for securely LDAP server access.
Note |
ISE connector generates a new local LDAP snapshot every 24 hours. This interval is configurable in the LDAP configuration of the connector. |
Note |
After upgrading the Cisco ISE device, the ISE connector must be reconfigured with the new certificates generated by ISE. |
Limits
|
Metric |
Limit |
|---|---|
|
Maximum number of ISE instances that can be configured on one ISE connector |
20 |
|
Maximum number of ISE connectors on one Secure Workload Edge appliance |
1 |
|
Maximum number of ISE connectors on one Tenant (rootscope) |
1 |
|
Maximum number of ISE connectors on Secure Workload |
150 |
Note |
Maximum number of ISE agents supported per connector is 20000. If there is a use case that requires support for more ISE agents, please contact Secure Workload support. |
Connectors for Inventory Enrichment
Connectors for inventory enrichment provide additional metadata and context about the inventories (IP addresses) monitored by Secure Workload.
|
Connector |
Description |
Deployed on Virtual Appliance |
|---|---|---|
|
ServiceNow |
Collects endpoint information from ServiceNow instance and enriches the inventory with ServiceNow attributes. |
Secure Workload Edge |
|
See also: |
– |
For more information about required virtual appliances, refer to Virtual Appliances for Connector.
ServiceNow Connector
ServiceNow connector connects with ServiceNow Instance to get all the ServiceNow CMDB related labels for the endpoints in ServiceNow inventory. Using this solution, we can get enriched metadata for the endpoints in Cisco Secure Workload.
ServiceNow connector does the following high-level functions.
-
Update ServiceNow metadata in Secure Workload’s inventory for these endpoints.
-
Periodically take snapshot and update the labels on these endpoints.
Figure 17. ServiceNow connector
How to Configure the ServiceNow Connector
For information about required virtual appliances, see Virtual Appliances for Connectors. The following configurations are allowed on the connector.
-
ServiceNow Tables: ServiceNow Tables configures the ServiceNow instance with it’s credentials, and the information about ServiceNow tables to fetch the data from.
-
Scripted REST api: ServiceNow scripted REST API tables can be configured similar to ServiceNow tables.
-
Sync Interval: Sync Interval configuration allows to make change the periodicity at which Secure Workload should query ServiceNow instance for updated data. The default sync interval is set to 60 minutes.
-
Log: For more information, see Log Configuration .
ServiceNow Instance Configuration
You will need the following items to successfully configure a ServiceNow instance.
-
ServiceNow username
-
ServiceNow password
-
ServiceNow Instance URL
-
Scripted APIs
-
(Optional) Additional URL parameters (per-table)
Subsequently, Secure Workload performs a discovery of all the tables from the ServiceNow Instance and Scripted REST API’s (only if Include Scripted APIs check box is enabled). It presents user with the list of tables to choose from, once a user selects table, Secure Workload fetches all the list of attributes from that table for the user to select. User has to chose the ip_address attribute from the table as the key. Subsequently, user can chose upto 10 unique attributes from the table. See the following figures for each step.
Note |
ServiceNow Connector can only support integrating with tables having IP Address field. |
Note |
To integrate with ServiceNow Scripted REST API’s you need to enable the Scripted APIs check box, which would give you a similar workflow to any other table. |
Note |
For scripted REST APIs to integrate with aServiceNow Connector, the scripted REST APIs cannot have path parameters. Also, the scripted REST APIs must support sysparm_limit, sysparm_fields, and sysparm_offset as query parameters. |
Note |
The ServiceNow user roles must include cmdb_read for tables and web_service_admin for scripted REST APIs to integrate with Cisco Secure Workload. |
Processing ServiceNow records
Based on the instance url you gives in configuration, ServiceNow connector connects to ServiceNow Instance. ServiceNow Instance uses HTTP calls using https://{Instance URL}/api/now/doc/table/schema, to obtain the initial table schema from the ServiceNow Table API. Based on the configured Tables, it queries those tables to fetch the ServiceNow labels/metadata. Secure Workload annotates the ServiceNow labels to IP addresses in its inventory. ServiceNow connector periodically fetches new labels and updates Secure Workload inventory.
Note |
Secure Workload fetches records from ServiceNow tables periodically. This is configurable under SyncInterval tab in the ServiceNow connector. The default sync interval is 60 minutes. For cases where integrating with ServiceNow table with large number of entries, this sync interval should be set to a higher value. |
Note |
Secure Workload will delete any entry not seen for 10 continuous sync intervals. In case the connection to ServiceNow instance is down for that long that could result in cleaning up of all labels for that instance. |
Sync Interval Configuration
Secure Workload ServiceNow connector provides a way to configure the frequency of sync between Secure Workload and ServiceNow instance. By default the sync interval is set to 60 minutes, but it can be changed under the sync interval configuration as Data fetch frequency.
-
For detecting deletion of a record, Secure Workload ServiceNow connector relies on syncs from ServiceNow instances. If an entry is not seen in 48 consecutive sync intervals, we go ahead and delete the entry. This can be configured under sync interval config as Delete entry interval.
-
If any additional parameters are to be passed when calling REST APIs for ServiceNow tables, you can configure them as part of Additional Rest API url params. This configuration is optional. For example, to get a reference lookup from ServiceNow, use sysparm_exclude_reference_link=true&sysparm_display_value=true URL parameter.
Explore Command to Delete the Labels
In case user wants to cleanup the labels for a particular IP for a given instance immediately, without waiting for delete interval, they can do so using an explore command. Here are the steps to run the command.
-
Finding vrf ID for a Tenant
-
Getting to Explore command UI
-
Running the commands
For TaaS cluster, contact TaaS Operation team to cleanup labels for ServiceNow labels.
Finding VRF ID for a Tenant
Site Admins and Customer Support users can access the Tenant page under the Platform menu in the navigation bar at the left side of the window. This page displays all of the currently configured Tenants and VRFs. For more information, see the Tenants section for more details.
On Tenants page, ID field of Tenants table is vrf ID for the Tenant.
Getting to Explore Command UI
To reach the Maintenance Explorer command interface, choose from the left navigation bar in the Secure Workload web interface.
Note |
Customer Support privileges are required to access explore menu. If explore tab does not show up, the account may not have needed permissions. |
Click on explore tab in the drop down menu to get to the Maintenance Explorer page.
Running the Commands
-
Choose the action as
POST -
Enter snapshot host as
orchestrator.service.consul -
Enter snapshot path
To delete the labels for a particular IP for a
servicenow instance: servicenow_cleanup_annotations?args=<vrf-id> <ip_address> <instance_url> <table_name> -
Click Send
Note
If after deleting using explore command, we see the record show up in ServiceNow instance, it will be repopulated
Frequently Asked Questions
-
What if a ServiceNow CMDB table does not have IP address?
In such case, the recommendation is to create a View on ServiceNow which will have desired fields from current table along with IP address (potentially coming from a JOIN operation with another table). Once such a view is created, it can be used in place of table name.
-
What if a ServiceNow instance requires MFA?
Currently we do not support integrating with ServiceNow instance with MFA.
Limitations of ServiceNow Connectors
|
Metric |
Limit |
|---|---|
|
Maximum number of ServiceNow instances configured on one ServiceNow connector |
20 |
|
Maximum number of attributes that can be fetched from one ServiceNow instance |
15 |
|
Maximum number of ServiceNow connectors on one Secure Workload Edge appliance |
1 |
|
Maximum number of ServiceNow connectors on one Tenant (rootscope) |
1 |
|
Maximum number of ServiceNow connectors on Secure Workload |
150 |
Connector Alerts
An appliance or service creates a connector alert when it experiences abnormal behavior.
Alert Configuration
The alert configuration for appliances and connectors enables you to generate alerts for various events. In the 3.4 release, this configuration enables all types of alerts that are potentially possible for the configured appliance/connector.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
Enable Alert |
check box |
Should alert be enabled? |
Note |
The default value for Enable Alert is true. |
Alert Type
The Info Tab on the appliance and connector pages contains various alert types specific to each appliance and connector.
Appliance/Connector down
An alert generates when an appliance (or a connector) is potentially down due to missing heartbeats from the appliance/connector.
Alert text: Missing <Appliance/Connector> heartbeats, it might be down.
Severity: High
Allowed Secure Workload virtual appliances: Secure Workload Ingest and Secure Workload Edge
Allowed connectors: All
Appliance/Connector system usage
When system usage (CPU, memory, and disk) is more than 90% on an appliance (and a connector). The appliance (and/or connector) generates an informational alert to indicate that it’s currently handling an increased system load.
It’s normal for appliances and connectors to consume more than 90% of system resources during heavy processing activity.
Alert text: <Number> of CPU/Memory/Disk usage on <Appliance/Connector> is too high.
Severity: High
Allowed Secure Workload virtual appliances: Secure Workload Ingest and Secure Workload Edge
Allowed connectors: All
Connector Configuration Error
When you try to connect a configured connector to a configured server and the configuration fails, the system generates an alert to indicate a potential issue with the configuration after accepting and deploying it.
For example, The AnyConnect connector can take an LDAP configuration, validate and accept the configuration. However, during the normal operation, it is possible that the configuration is no longer valid.
Alert captures the scenario and indicates that you have to take corrective action to update the configuration.
Alert text: Cannot connect to <Appliance/Connector> server, check <Appliance/Connector> config.
Severity: High, Low
|
Server |
Connector |
|---|---|
|
LDAP server |
AnyConnect, F5, ISE, WDC |
|
ISE server |
ISE |
|
ServiceNow server |
ServiceNow |
Allowed Secure Workload virtual appliances: Secure Workload Ingest and Secure Workload Edge.
Allowed connectors: AnyConnect, F5, ISE, WDC, and ServiceNow.
Connector UI Alert Details
Alert Details
See Common Alert Structure for general alert structure and information about fields. The alert_details fields structure contains the following subfields for connector alerts.
|
Field |
Type |
Description |
|---|---|---|
|
Appliance ID |
String |
Appliance ID |
|
Appliance IP |
String |
Appliance IP |
|
Connector ID |
String |
Connector ID |
|
Connector IP |
String |
Connector IP |
|
Deep Link |
Hyperlink |
Redirect to appliance/connector page |
|
Last CheckIn At |
String |
Last checkin time |
|
Name |
String |
Appliance/Connector name |
|
Reason |
String |
The reason that Appliance/Connector can’t connect to Secure Workload |
|
Type |
String |
Appliance/Connector type |
Example of Alert Details
After parsing alert_details as JSON (unstringified), it will display as follows.
{
"Appliance ID": "5f1f3d26d674b01832c6792a",
"Connector ID": "5f1f3e47baba512a70abee43",
"Connector IP": "172.29.142.22",
"Deep Link": "bingo.tetrationanalytics.com/#/connectors/details/F5?id=5f1f3e47baba512a70abee43",
"Last checkin at": "Aug 04 2020 20.37.33 PM UTC",
"Name": "F5",
"Reason": "Invalid Credentials (Original error text: LDAP Result Code 49 \"Invalid Credentials\": )",
"Type": "F5"
}
Virtual Appliances for Connectors
Most connectors are deployed on Secure Workload virtual appliances. You will deploy required virtual appliances on an ESXi host in VMware vCenter using the OVA templates or on other KVM-based hypervisors using the QCOW2 image. For information on how to deploy virtual appliances, refer to Deploying a Virtual Appliance.
Types of Virtual Appliances
Each connector that requires a virtual appliance can be deployed on one of two types of virtual appliances.
Secure Workload Ingest
Secure Workload Ingest appliance is a software appliance that can export flow observations to Secure Workload from various connectors.
Specification
-
Number of CPU cores: 8
-
Memory: 8 GB
-
Storage: 250 GB
-
Number of network interfaces: 3
-
Number of connectors on one appliance: 3
-
Operating System: CentOS 7.9 (Secure Workload 3.8.1.19 and earlier), AlmaLinux 9.2 (Secure Workload 3.8.1.36 and later)
See important limits at Secure Workload Virtual Appliances for Connectors.
Note |
Each root scope on Secure Workload can have at most 100 Secure Workload Ingest appliances deployed. |
Secure Workload Ingest appliance allows at most 3 connectors to be enabled on an appliance. There can be more than one instance of the same connector enabled on the same appliance. For the ERSPAN Ingest appliance three ERSPAN connectors are always automatically provisioned. Many of the connectors deployed on Ingest appliance collects telemetry from various points in the network, these connectors need to listen on specific ports on the appliance. Each connector is therefore bound to one of the IP address and the default ports on which the connector should be listening to collect telemetry data. As a result, each IP address is essentially a slot that a connector occupies on the appliance. When a connector is enabled, a slot is taken (thereby, the IP corresponding to the slot). And, when a connector is disabled, the slot occupied by the connector is released (thereby, the IP corresponding to the slot). See the Secure Workload Ingest appliance slots for how to ingest appliance maintains the state of the slots.
Allowed Configurations
-
NTP: Configure NTP on the appliance. For more information, see NTP Configuration .
-
Log: Configure Logging on the appliance. For more information, see Log Configuration .
Note |
If there is a need to update the OS and packages to minimize vulnerabilities, redeploy both the Edge and Ingest appliances using the latest ingest OVA. For more information, see the Secure Workload Upgrade Guide. |
Secure Workload Edge
Secure Workload Edge is a control appliance that streams alerts to various notifiers and collects inventory metadata from network access controllers such as Cisco ISE. In a Secure Workload Edge appliance, all alert notifier connectors (such as Syslog, Email, Slack, PagerDuty, and Kinesis), ServiceNow connector, Workload AD connector, and ISE connector can be deployed.
Specification
-
Number of CPU cores: 8
-
Memory: 8 GB
-
Storage: 250 GB
-
Number of network interfaces: 1
-
Number of connectors on one appliance: 8
-
Operating System: CentOS 7.9 (Secure Workload 3.8.1.19 and earlier), AlmaLinux 9.2 (Secure Workload 3.8.1.36 and later)
See important limits at Secure Workload Virtual Appliances for Connectors.
Note |
Each root scope on Secure Workload can have at most one Secure Workload Edge appliance deployed. |
The connectors deployed on Secure Workload Edge appliance do not listen on ports. Therefore, the Docker containers instantiated for the connectors on Secure Workload Edge appliance do not expose any ports to the host.
Allowed Configurations
-
NTP: Configure NTP on the appliance. For more information, see NTP Configuration .
-
Log: Configure Logging on the appliance. For more information, see Log Configuration .
Note |
If there is a need to update the OS and packages to minimize vulnerabilities, redeploy both the Edge and Ingest appliances using the latest ingest OVA. For more information, see the Secure Workload Upgrade Guide. |
Deploying a Virtual Appliance
Deploy virtual appliances on an ESXi host in VMware vCenter or other KVM-based hypervisors such as Red Hat Virtualization. This procedure prompts you to download a virtual appliance OVA template or QCOW2 image from the Cisco Software Download page.
Attention |
To deploy a Secure Workload external appliance, the ESXi host where the appliance is created should have the following specifications:
|
To deploy a virtual appliance to collect data from connectors:
Procedure
|
Step 1 |
In the Secure Workload web portal, from the navigation pane, choose . |
||||
|
Step 2 |
Click Enable a Connector. The type of virtual appliance you must deploy depends on the type of connector you are enabling. |
||||
|
Step 3 |
Click the type of connector for which you must create the virtual appliance. For example, click the NetFlow connector. |
||||
|
Step 4 |
On the connector page, click Enable.
|
||||
|
Step 5 |
Click the link to download the OVA template or QCOW2 image for the virtual appliance. Leave the wizard open on your screen without clicking anything else. |
||||
|
Step 6 |
Use the downloaded:
|
||||
|
Step 7 |
After the VM is deployed, but before you power it on, return to the virtual appliance deployment wizard in the Secure Workload web portal. |
||||
|
Step 8 |
Click Next in the virtual appliance deployment wizard. |
||||
|
Step 9 |
Configure the virtual appliance by providing IP addresses, gateways, hostname, DNS, proxy server settings and docker bridge subnet configuration. See the screenshot for Configuring the VM with network parameters.
|
||||
|
Step 10 |
Click Next. |
||||
|
Step 11 |
In the next step, a VM configuration bundle will be generated and available for download. Download the VM configuration bundle. See the screenshot for Download the VM configuration bundle. |
||||
|
Step 12 |
Upload the VM configuration bundle to the datastore corresponding to the target ESXi host or other virtualization host. |
||||
|
Step 13 |
[Applicable only when using QCOW2 image] Complete the following configurations on the other virtualization host where you have uploaded the VM configuration bundle:
|
||||
|
Step 14 |
Edit the VM settings and mount the VM configuration bundle from the datastore to the CD/DVD drive. Make sure to select Connect at Power On check box. |
||||
|
Step 15 |
Power on the deployed VM. |
||||
|
Step 16 |
When the VM boots up and configures itself, it connects back to Secure Workload. This may take a few minutes. The appliance status on Secure Workload should transition from Pending Registration to Active. See the screenshot for Secure Workload Ingest appliance in Pending Registration state.
When the appliance is Active, connectors can be enabled and deployed on it.
When a virtual appliance is deployed and booted up for the first time, tet-vm-setup service executes and sets up the appliance. This service is responsible for the following tasks.
When tet-controller is instantiated, it takes over the management of the appliance. This service is responsible for the following functions:
The list of deployed virtual appliances can be found at:
|
Decommissioning a Virtual Appliance
A virtual appliance can be decommissioned from Secure Workload. When an appliance is decommissioned, the following actions are triggered.
-
All configurations on the appliance and the connectors enabled on the appliance are removed.
-
All the connectors enabled on the appliance are deleted.
-
The appliance is marked Pending Delete.
-
When the appliance replies back with a successful delete response, appliance Kafka topic and certs are deleted.
Note
Decommissioning an appliance cannot be undone. To restore the appliance and the connectors, a new appliance should be deployed and the connectors should be enabled on the new appliance.
Monitoring a Virtual Appliance
Secure Workload virtual appliances periodically send heartbeats and statistics to Secure Workload. The heartbeat interval is 5 minutes. The heartbeat messages include statistics about the health of the appliance include system statistics, process statistics, and statistics about how many messages sent/received/error-ed over the Kafka topic that is used for the appliance management.
All metrics are available in Digger (OpenTSDB) and are labelled with appliance ID and root scope name. Additionally, Grafana dashboards for Appliance Controller are also available for important metrics from the appliance.
Security Considerations
The Ingest/Edge Virtual Machine’s guest Operating System is CentOS 7.9, from which OpenSSL server/clients packages were removed. Therefore, the only way to access the appliance is via its console.
Note |
CentOS 7.9 is the guest operating system for Ingest and Edge virtual appliances in Secure Workload 3.8.1.19 and earlier releases. Starting Secure Workload 3.8.1.36, the operating system is AlmaLinux 9.2. |
The containers run a centos:7.9.2009 based Docker image. Most the containers are run with the base privileges (no-privileged option), except for ERSPAN container, which has the NET_ADMIN capability.
Note |
Starting Secure Workload 3.8.1.36, the containers run almalinux/9-base:9.2. |
In the unlikely case a container is compromised, the VM guest OS should not be compromisable from inside the container.
Configuration Management on Connectors and Virtual Appliances
Configuration updates can be pushed to appliances and connectors from Secure Workload. The appliance should have registered successfully with Secure Workload and be Active before configuration updates can be initiated. Similarly, the connectors should have registered with Secure Workload before configuration updates can be initiated on the connector services.
There are three modes of configuration updates possible in appliances and connectors.
-
Test and Apply: Test the configuration and on successful test, commit the configuration.
-
Discovery: Test the configuration, and on successful test, discovery additional properties that can be enabled for the configuration.
-
Remove: Remove the configuration.
Note
ERSPAN appliance and connector do not support configuration updates.
Test and Apply
Configurations that support Test and Apply mode verify the configuration before applying (committing) the configuration on the desired appliance and/or connector.
NTP Configuration
NTP configuration allows the appliance to synchronize the clock with the specified NTP server(s).
|
Parameter Name |
Type |
Description |
|---|---|---|
|
Enable NTP |
checkbox |
Should NTP sync be enabled? |
|
NTP Servers |
listof strings |
List of NTP servers. At least one server should be given and at most 5 servers may be provided. |
Test: Test if a UDP connection can be made to the given NTP servers on port 123. If an error occurs for any of the NTP servers, do not accept the configuration.
/etc/ntp.conf and restart ntpd service using systemctl restart ntpd.service. Here is the template for generating the ntp.conf
# --- GENERAL CONFIGURATION ---
server <ntp-server>
...
server 127.127.1.0
fudge 127.127.1.0 stratum 10
# Drift file
driftfile /etc/ntp/driftNote |
Applicable to Secure Workload 3.8.1.19 and earlier. |
/etc/chrony.conf and restart chronyd service using systemctl restart chronyd.service. Here is the template for generating the chrony.conf
# Secure Workload appliance chrony.conf.
server <ntp-server> iburst
...
driftfile /var/lin/chrony/drift
makestep 1.0 3
rtcsyncAllowed Cisco Secure Workload virtual appliances: All
Allowed connectors: None
Log Configuration
Log configuration updates the log levels, maximum size of the log files, and log rotation parameters on the appliance and/or connector. If the configuration update is triggered on the appliance, appliance controller log settings are updated. On the other hand, if the configuration update is triggered on a connector, service controller and service log settings are updated.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
Logging level |
dropdown |
Logging level to be set |
|
Debug log level |
|
|
Informational log level |
|
|
Warning log level |
|
|
Error log level |
|
|
Max log file size (in MB) |
number |
Maximum size of a log file before log rotation kicks in |
|
Log rotation (in days) |
number |
Maximum age of a log file before log rotation kicks in |
|
Log rotation (in instances) |
number |
Maximum instances of log files kept |
Test: No op.
Apply: If the configuration is trigged on an appliance, update the configuration file of tet-controller on the appliance. If the configuration is triggered on a connector, update the configuration files of tet-controller and the service managed by the controller on the Docker container responsible for the connector.
Allowed Secure Workload virtual appliances: All
Allowed connectors: NetFlow, NetScaler, F5, AnyConnect, ISE, ASA, and Meraki.
Note |
Since all alert notifier Connectors (Syslog, Email, Slack, PagerDuty, and Kinesis) run on a single Docker service (Secure Workload Alert Notifier) on Secure Workload Edge, it is not possible to update the log config of a connector without impacting the config of another alert notifier connector. The log configurations of Secure Workload Alert Notifier (TAN) Docker service on Secure Workload Edge appliance can be updated using an allowed command. |
See Update Alert Notifier Connector Log Configuration for more details.
Endpoint Configuration
Endpoint configuration specifies the inactivity timeout for endpoints on AnyConnect and ISE connectors. When an endpoint times out, the connector stops checking in with Secure Workload and purges the local state for the endpoint on the connector.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
InactivityTimeout for Endpoints(in minutes) |
number |
Inactivity timeout for endpoints published by AnyConnect / ISE connectors. On timeout, the endpoint will not longer checkin Secure Workload. Default is 30 minutes. |
Test : No op.
Apply : Update the configuration file of the connector with the new value
Allowed Secure Workload virtual appliances: None
Allowed connectors: AnyConnect and ISE
Slack Notifier Configuration
By default, the Secure Workload alerts are published to the Slack connector.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
Slack Webhook URL |
string |
Slack webhook on which Secure Workload alerts should be published |
Test: To test the configuration, send a test alert to Slack using the webhook. If the alert is posted successfully, the test passes.
Apply: Update the configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: Slack
PagerDuty Notifier Configuration
By default, the Secure Workload alerts are published to the PagerDuty connector.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
PagerDuty Service Key |
string |
PagerDuty service key for pushing Secure Workload alerts on PagerDuty |
Test: To test the configuration, send a test alert to PagerDuty using the service key. If the alert is published successfully, the test passes.
Apply: Update the configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: PagerDuty
Kinesis Notifier Configuration
By default, the Secure Workload alerts are published to the Amazon Kinesis connector.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
AWS Access Key ID |
string |
AWS access key ID to communicate with AWS |
|
AWS Secret Access Key |
string |
AWS secret access key to communicate with AWS |
|
AWS Region |
dropdown of AWS regions |
Name of the AWS region where Kinesis stream is configured |
|
Kinesis Stream |
string |
Name of the Kinesis stream |
|
Stream Partition |
string |
Partition Name of the stream |
Test: To test the configuration, send a test alert to the Kinesis stream. If the alert is published successfully, the test passes.
Apply: Update the configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: Kinesis
Email Notifier Configuration
The process of alert email transmission using TAN service in Secure Workload Edge Appliance enables Secure Workload to integrate alerting seamlessly with email systems by notifying recipients directly through email:
-
Email connector configuration–The Email Connector is set up with SMTP server details, including optional authentication mechanisms (basic SMTP authentication or modern Microsoft authentication). It also defines default recipient email addresses for alert delivery. This configuration can be customized for alerts, if needed.
-
TAN service activation–When the Email connector is enabled on the Secure Workload Edge appliance, the TAN service is configured to handle alert notifications through email.
-
Alert generation–The Secure Workload system continuously monitors workload security and generates alerts based on detected events or anomalies.
-
Alert dispatch–After alert generation, the TAN service uses the Email connector configuration to format and send alert emails. The service acts as an alert publisher that pushes these notifications from the Edge appliance to the configured SMTP server.
Configure the SMTP Email connector using one of the authentication methods:
-
Basic SMTP authentication
-
Modern Microsoft authentication
Basic SMTP Authentication
The Basic SMTP authentication method uses SMTP username and password for authentication.
The following parameters are configured for Basic SMTP authentication:
|
Parameter Name |
Type |
Description |
|---|---|---|
|
SMTP Username |
String |
(Optional) SMTP server username |
|
SMTP Password |
String |
(Optional) SMTP server password for the user (if given) |
|
SMTP Server |
String |
IP address or hostname of the SMTP server |
|
SMTP Port |
Number |
Listening port of the SMTP server |
|
Secure Connection |
Check box |
Option to use SSL for SMTP server connection |
|
From Email Address |
String |
Email address from which alerts are sent. |
|
Default Recipients |
String |
Comma-separated list of recipient email addresses. |
Modern Microsoft Authentication
The modern Microsoft authentication (OAuth 2.0 authentication) method uses Microsoft client ID, Microsoft tenant ID, and client secret for authentication instead of username and password.
The following parameters are configured for modern Microsoft authentication:
|
Parameter Name |
Type |
Description |
|---|---|---|
|
Tenant ID |
String |
Unique identifier for your Microsoft Entra ID domain. |
|
Client ID |
String |
Unique identifier of the registered application or client. |
| Client Secret |
String |
Application secret that you created in Microsoft Entra ID domain for your application. |
|
SMTP Server |
String |
IP address or hostname of the SMTP server. The mandatory value supported is smtp.office365.com. |
|
SMTP Port |
Number |
Listening port of the SMTP server. The mandatory value supported is 587. |
|
Secure Connection |
Check box |
Option to use SSL for SMTP server connection. |
|
From Email Address |
String |
Email addresst from which alerts are sent. |
|
Default Recipients |
String |
Comma-separated list of recipient email addresses. |
By default, Secure Workload alerts are published to the Email connector.
Test: To test the configuration, send a test email.
Apply: Update the configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: Email
Syslog Notifier Configuration
Default configuration for publishing Secure Workload alerts on Syslog.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
Protocol |
dropdown |
Protocol to use to connect to server |
| •UDP | ||
| • TCP | ||
|
Server Address |
string |
IP address or hostname of the Syslog server |
|
Port |
number |
Listening port of Syslog server. Default port value is 514. |
Test: Send a test alert to Syslog server using the given configuration. If the alert is published successfully, the test passes.
Apply: Update configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: Syslog
Syslog Severity Mapping Configuration
The following table shows the default severity mapping for Secure Workload alerts on Syslog
|
Secure Workload Alerts Severity |
Syslog Severity |
|---|---|
|
LOW |
LOG_DEBUG |
|
MEDIUM |
LOG_WARNING |
|
HIGH |
LOG_ERR |
|
CRITICAL |
LOG_CRIT |
|
IMMEDIATE ACTION |
LOG_EMERG |
You can modify this setting using this configuration.
|
Parameter Name |
Dropdown of mappings |
|---|---|
|
IMMEDIATE_ACTION |
|
|
CRITICAL |
|
|
HIGH |
|
|
MEDIUM |
|
|
LOW |
Test: No op.
Apply: Update configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: Syslog
ISE Instance Configuration
This configuration provides the parameters required to connect to the Cisco Identity Services Engine (ISE). By providing multiple instances of this configuration, the ISE connector can connect and pull metadata about endpoints from multiple ISE appliances. Up to 20 instances of ISE configuration may be provided.
|
Parameter Name |
Type |
Description |
|---|---|---|
|
ISE Client Certificate |
string |
ISE client certificate to connect to ISE using pxGrid |
|
ISE Client Key |
string |
ISE client key to connect to ISE |
|
ISE Server CA Certificate |
string |
CA certificate of ISE |
|
ISE Hostname |
string |
FQDN of ISE pxGrid |
|
ISE Nodename |
string |
Node name of ISE pxGrid |
Test: Connect to ISE using the given parameters. On successful connection, accept the configuration.
Apply: Update configuration file of the connector with the specified parameters.
Allowed Secure Workload virtual appliances: None
Allowed connectors: ISE
Discovery
Configurations that support Discovery mode do the following.
-
Collect a basic configuration from the user.
-
Verify the basic configuration.
-
Discovery additional properties about the configuration and present them to the user.
-
Let the user enhance the configuration using the discovered properties.
-
Verify and apply the enhanced configuration.
In the 3.3.1.x release, LDAP configuration supports discovery mode.
LDAP Configuration
LDAP configuration specifies how to connect to LDAP, what is the base Distinguished Name (DN) to use, what is the attribute that corresponds to username, and what attributes to fetch for each username. LDAP attributes are properties of LDAP that are specific to that environment.
Given the configuration of how to connect to LDAP and the base DN, it is possible to discover the attributes of users in LDAP. These discovered attributes can then be presented to the user in the UI. From these discovered attributes, the user selects the attribute that corresponds to the username and a list of up to six attributes to collect for each username from LDAP. As a result, this eliminates the manual configuration of the LDAP attributes and reduces errors.
Here are the detailed steps for creating LDAP configuration through discovery.
Procedure
|
Step 1 |
Start the LDAP Configuration Initiate an LDAP configuration for the connector.
|
||||||||||||||||||||||||||||||||||||||||||
|
Step 2 |
Provide Basic LDAP Configuration Specify the basic configuration for connecting to LDAP. In this configuration, the users provide the LDAP Bind DN or username to connect to LDAP server, LDAP password to use to connect to LDAP server, LDAP server address, LDAP server port, Base DN to connect to, and a filter string to fetch users that match this filer.
Minimum user permissions needed to configure LDAP on Connectors is a standard domain User.
|
||||||||||||||||||||||||||||||||||||||||||
|
Step 3 |
Discovery in Progress Once the user clicks Next, this configuration is send to the connector. The connector establishes a connection with LDAP server using the given configuration. It fetches up to 1000 users from LDAP server and identifies all the attributes. Furthermore, it computes a list of all the single-valued attributes are common across all 1000 users. The connector returns this result back to Secure Workload.
|
||||||||||||||||||||||||||||||||||||||||||
|
Step 4 |
Enhance the Configuration with Discovered Attributes The user has to pick which attribute corresponds to username and select up to six attributes that the connector has to fetch and snapshot for each user in the organization (i.e., users matching the filter string). This action is performed using a dropdown of list of discovered attributes. Thus, eliminating manual errors and misconfiguration.
|
||||||||||||||||||||||||||||||||||||||||||
|
Step 5 |
Finalize, Save, and Apply the Configuration Finally, the configuration is completed by clicking Save and Apply Changes.
The connector receives the completed configuration. It creates a local snapshot of all users matching the filter string and fetches only the selected attributes. Once the snapshot is completed, the connector services can start using the snapshot for annotating users and their LDAP attributes in inventories. Allowed Secure Workload virtual appliances: None Allowed connectors: AnyConnect, ISE, and F5.
|
Remove
You can remove all the configurations that you have added from the connectors and/or appliances using the Delete button available for each configuration.

Feedback