AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter
Join our community

Actions277

Overview

This node operation, User Agents Counts, retrieves counts of user agents filtered by various criteria such as state, type, tags, organization, and more. It is useful for monitoring and reporting on the status and distribution of user agents within an organization or network. For example, it can be used to quickly get the number of online vs offline agents, count agents by release channel, or filter by specific tags or MSP IDs.

Practical scenarios include:

  • Generating dashboards showing active vs inactive user agents.
  • Filtering user agents by organizational units or networks to assess deployment coverage.
  • Tracking new agent states like Protected, Unprotected, or Offline for security compliance.
  • Searching user agents by hostname, friendly name, or logged-in user for targeted audits.

Properties

Name Meaning
Additional Query Parameters Optional filters to refine the user agents count query. Includes:
- Msp Id Numeric MSP ID to scope query to all sub-organizations.
- Name Search Text search term for client name fields (hostname, friendly name).
- Network Ids JSON array of network IDs to filter by; defaults to all networks.
- New Agent States Boolean to include counts for new agent states: Protected, Unprotected, Offline.
- Organization Ids JSON array of organization IDs to filter by; defaults to user's organization ID.
- Release Channels JSON object to filter by release channels with operators (e.g., stable, beta, preview).
- Search Keyword(s) space-delimited to search tags, status, hostname, friendly name, current logged user.
- State Filter by user agent online/offline state. Options: Online, Offline.
- Status Filter by user agent status attributes: active, disabled, uninstalled.
- Tags JSON array of tags to filter user agents by.
- Type User agent type filter. Options: Proxy, Agents. Defaults to Proxy.

Output

The node outputs a JSON object containing counts of user agents matching the specified filters. The exact structure depends on the API response but typically includes numeric counts categorized by the applied filters (e.g., counts per state, type, or tag).

If binary data were supported, it would represent downloadable reports or files, but this node focuses on JSON data output only.

Dependencies

  • Requires an API key credential for authentication with the external service managing user agents.
  • The node sends HTTP requests to a predefined base URL endpoint (not explicitly shown in the snippet).
  • No additional environment variables are indicated from the provided code.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid JSON format in properties like network_ids, organization_ids, or tags may cause request errors.
    • Using unsupported filter values (e.g., invalid release channel names) might result in empty responses or errors.
  • Error messages:
    • Authentication errors: Verify that the API key credential is correctly configured.
    • Validation errors: Check that JSON inputs are well-formed and options match allowed values.
    • Network errors: Ensure connectivity to the external API endpoint.

Links and References

  • Refer to the external API documentation for detailed descriptions of query parameters and response formats.
  • n8n documentation on creating and using custom nodes for further customization guidance.

Discussion