Application patterns for the Agent Client Collector

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 3 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Application Patterns for the Agent Client Collector

    Application patterns for the Agent Client Collector (ACC) facilitate the collection of details about applications running on ACC hosts. These patterns are specifically supported for servers and activated post-Discovery of the ACC host.

    Show full answer Show less

    Prerequisites

    • Install the Agent Client Collector Framework and Agent Client Collector for Visibility Discovery.
    • Set the snagent.applclassificationbehavior property to full and restart any connected MID Servers.
    • Ensure Windows environments use Powershell 3.0 or higher.
    • Required roles:
      • Linux: sudoers user with standard Discovery commands.
      • Windows: servicenow user with Logon As a Service and Debug Programs privileges.

    Using the Allowlist Feature

    To enable pattern execution, set the enable-patterns-on-agent parameter to true in the acc.yml file.

    Viewing Supported Application Patterns

    To view supported application patterns, navigate to All > Pattern Designer > Supported Patterns for ACC. You can also check executed patterns by selecting an agent and viewing the Application Pattern logs, where executed patterns are marked with true.

    Unsupported Operations

    Application patterns do not support the following operations:

    • WMI method invocation
    • Change/unchange user
    • All custom operations
    • SNMP query
    • Put file

    Configuration Properties

    Maximize the use of application patterns by configuring the following properties:

    • snagent.applclassificationbehavior: Set to full to enable all pattern commands.
    • mid.discovery.agent.command.mid.timeout: Duration in seconds for MID Server response wait time (default: 60 seconds).
    • mid.discovery.agent.command.timeout: Time allowed for command execution on the agent (default: 60 seconds).

    Debugging in ACC Mode

    To debug application patterns in ACC mode, enable the debug option in the Pattern Designer and select Use ACC connection. Logs can provide detailed execution information by setting MID Server logs to DEBUG and searching ACC logs for PatternOnTheFlyCheck.

    Oracle Global License Advisory Services (GLAS) Data Collection

    Oracle Java process discovery is compatible with both MID Servers and ACC. Ensure all users have the Oracle GLAS store app (version 1.8.4 or higher) and, for enhanced data, the Agent Client Collector Framework store plugin is installed. Note that Oracle GLAS data collection supports Linux environments and is partially supported in Desktop settings.

    Application patterns gather details on the applications that run on the Agent Client Collector (ACC) host. Application patterns are supported only for servers, and are triggered after the Agent Client Collector host Discovery is complete.

    Prerequisites for using application patterns

    To enable application patterns on the Agent Client Collector, install the following:

    • Agent Client Collector Framework
    • Agent Client Collector for Visibility
    • Discovery

    Set the sn_agent.appl_classification_behavior property to full, and restart any MID Servers connected to the agent.

    When working in a Windows environment, ensure that you are working with Powershell 3.0 or higher.

    Role required:
    • In a Linux environment: sudoers user (with standard Discovery commands)
    • In a Windows environment: servicenow user (added to the ServiceNow users group, with Logon As a Service and Debug Programs privileges)

    Using the allowlist feature for pattern execution

    Set the enable-patterns-on-agent parameter to true in the acc.yml file. For more details, see the KB1585764 knowledge base article.

    Viewing supported application patterns

    To view the list of patterns supported for Agent Client Collector, navigate to All > Pattern Designer > Supported Patterns for ACC. Application patterns are the only pattern types supported for use with Agent Client Collector.

    You can view the application patterns that were executed on a given agent.
    1. Navigate to All > Pattern Designer > Supported Patterns for ACC.
    2. Select an agent.
    3. Select and hold the name of the agent Agent name to be selected and select View > Discovery.
    4. Select the Application Pattern logs tab on the bottom of the page.

      The list of patterns executed on the agent appears. Executed patterns are indicated with the value true in the Executed On Agent column.

    Unsupported application pattern operations

    Application patterns are not supported in the following pattern operations:

    • WMI method invocation
    • Change/unchange user
    • All custom operations
    • SNMP query
    • Put file

    Agent Client Collector pattern execution properties

    Configure the following properties (All > System Properties > All Properties) to maximize the use of application patterns with Agent Client Collector:
    Table 1. Application pattern properties
    Property Description
    sn_agent.appl_classification_behavior Set value to full to enable working with applications patterns and to access pattern commands in the allow-list.

    Default: simple

    Note:
    To enable application pattern execution with the allow-list, use the allow-list template for application patterns. For details, see the Pattern execution on ACC: Sample Allowlist for Pattern Content article in the Now Support Knowledge Base.
    Table 2. MID Server configuration parameter properties
    mid.discovery.agent.command.mid.timeout The maximum duration, in seconds, that the MID Server waits for a response from the agent before timing out.

    Default: 60 seconds

    mid.discovery.agent.command.timeout The maximum amount of time, in seconds, that the command is given to execute on the agent host.

    Default: 60 seconds

    Using pattern designer debugging in ACC mode

    You can debug application patterns that are configured in ACC mode.

    1. Set the sn_agent.appl_classification_behavior property to full.
    2. In the Pattern Designer, enable the debug option and select Use ACC connection in the Debug identification section. For details on the Pattern Designer, refer to KB1698521: Create or customize patterns.

    The pattern log indicates whether the pattern was successfully executed on the agent.

    You can also receive pattern details in the following logs:

    • MID Server logs: Set mid.log.level to DEBUG for the mid agent log to display details on the pattern step, ACC check, and the pattern response.
    • ACC logs: Search for the string PatternOnTheFlyCheck for details on pattern checks.

    Oracle Global License Advisory Services (GLAS) data collection

    Oracle Java process discovery works either with patterns (when using either a MID Server or Agent Client Collector).

    When performing Discovery with Agent Client Collector, ensure that you have the following settings:
    • All users must have the Oracle GLAS store app, starting with version 1.8.4.
    • Agent Client Collector users:
      • Must have the Agent Client Collector Framework store plugin.
      • Can have the Agent Client Collector for Visibility - Content store plugin, for extra data.

      For information about privileged user access, see KB1705845.

      Note:
      Oracle Java discovery with ACC is applicable in all server environments. However, currently, it's partially supported for different Desktop environments. For a Windows Desktop update set, see the KB article KB1705845.

    Application patterns support Oracle GLAS data collection in a Linux environment. For details on using patterns, see Oracle Global License Advisory Services (GLAS) data collection using patterns.

    Although Oracle GLAS supports Put file operations, the related files are deployed using Agent Client Collector plugins instead of SSH or WMI.