Configure Geneos commands and data for Obcerv

Overview Copied

ITRS Geneos provides comprehensive monitoring through integration with Obcerv. This integration involves configuring Geneos commands and data to seamlessly interact with Obcerv (commands are accessed through the Entity Viewer app UI). By doing so, you can effectively collect, process, and visualize data from various systems within the Obcerv environment.

This page provides a clear overview of the prerequisites, commands behavior, and general considerations for configuring commands in Geneos to work with Obcerv. For more information on establishing connection between Geneos and Obcerv, see Connect Geneos to Obcerv.

Prerequisites Copied

Before configuring Geneos commands to work with Obcerv, perform the following:

In Obcerv Copied

  1. Install the Commands App.

  2. Create the following users via Keycloak (refer to the Keycloak User Guide for further guidance):

    • Ingestion user
    • Data access user for the Gateway (which must be assigned a user role)

In the Gateway Copied

  1. In the Obcerv connection section of the GSE, configure the following settings (refer to Basic Configuration - Connect Geneos to Obcerv User Guide):

    • Connection > Publishing settings
    • Connection > Data Access settings

  2. In the Authentication section of the GSE:

    • Create a Role that has permissions to execute all available commands.
    • Add the user role created in Obcerv in the Role properties setting. Adding a user role

Note

  • The user role created in Obcerv can be added to an existing Gateway role that has permissions to execute commands.
  • The example above gives Obcerv access to all available Gateway commands. You can limit this access to specific Gateway commands by configuring Role > Permissions > Options > Command. See Command permissions - Gateway Authentication Technical Reference.

Understand the Commands behavior Copied

When a Gateway starts, it connects to Obcerv using the data access token provided in the Obcerv Connection section. If the Commands app is installed on the Obcerv instance, the Gateway publishes available commands to Obcerv and subscribes to a channel for command execution from Obcerv. Dimensions and attributes filter the commands, ensuring only relevant commands are available for each entity.

The mapping of commands to Obcerv entities and metrics is not as complex as the mapping of commands to Geneos Directory components in Active Console. Therefore, some commands that should not be available to the user may be presented as available in Obcerv. These commands will be rejected at the Gateway if a user attempts to run them.

Currently, commands are not published with associated permissions in Obcerv. As a result, all available commands are displayed to users, regardless of their individual permissions. However, any attempt by a user to execute a command for which they lack permissions will be blocked by the Gateway.

Unpublished Geneos Commands Copied

The attached list outlines commands that are currently unpublished for Obcerv. For Geneos command details, please refer to the Gateway Commands documentation.

Unpublished Geneos Commands
  • “/PROBE:suspend”,
  • “/PROBE:unsuspend”,
  • “/PROBE:suspendImported”,
  • “/PROBE:unsuspendImported”,
  • “/PLUGIN:GL-SLE:accept”,
  • “/PLUGIN:WTS-SESSIONS:viewProcesses”,
  • “/PLUGIN:WTS-SESSIONS:send”,
  • “/PLUGIN:WTS-SESSIONS:logoff”,
  • “/PLUGIN:WTS-SESSIONS:ping”,
  • “/PLUGIN:WTS-SESSIONS:tracert”,
  • “/PLUGIN:WTS-PROCESSES:killProcess”,
  • “/PLUGIN:CITRIX-SESSIONS:send”,
  • “/PLUGIN:CITRIX-SESSIONS:logoff”,
  • “/PLUGIN:CITRIX-SESSIONS:ping”,
  • “/PLUGIN:CITRIX-SESSIONS:tracert”,
  • “/PLUGIN:CITRIX-PROCESSES:killProcess”,
  • “/PLUGIN:LATENCY-RTT:clearLostMessages”,
  • “/PLUGIN:LATENCY-RTT:clearMisdirectedMessages”,
  • “/PLUGIN:LATENCY-RTT:clearCyclicMessages”,
  • “/PLUGIN:PATS-TRADING-BREACHES:acknowledge”,
  • “/PLUGIN:PATS-TRADING-BREACHES:remove”,
  • “/PLUGIN:PATS-TRADING-BREACHES:details”,
  • “/PLUGIN:TIB-RV:acceptError”,
  • “/PLUGIN:TIB-RV:acceptInfo”,
  • “/PLUGIN:TIB-RV:acceptWarning”,
  • “/PLUGIN:TIB-RV:acceptRvdDown”,
  • “/RMS:putFile”,
  • “/RMS:getFile”,
  • “/RMS:putProbe”,
  • “/RMS:restart”,
  • “/RMS:rollback”,
  • /RMS:upgrade",
  • /RMS:shutdown",
  • /RMS:launch",
  • /RMS:exec",
  • /GATEWAY:broadcastMessage",
  • /GATEWAY:reloadSetup",
  • /GATEWAY:reloadSetupFile",
  • /GATEWAY:SCHEDULEDCOMMANDDATA:VIEWLOG",
  • /GATEWAY:SCHEDULEDCOMMANDSHISTORYDATA:VIEWLOG",
  • /GATEWAY:SCHEDULEDCOMMANDDATA:VIEWTARGETS:last",
  • /GATEWAY:SCHEDULEDCOMMANDDATA:VIEWTARGETS:running",
  • /GATEWAY:SCHEDULEDCOMMANDDATA:VIEWTARGETS:scheduled",
  • /GATEWAY:SCHEDULEDCOMMANDSHISTORYDATA:VIEWTARGETS",
  • /GATEWAY:Database:suspend",
  • /DATABASELOGGING:itemValues:log",
  • /DATABASELOGGING:itemValues:discard",
  • /DATABASELOGGING:connection:pause",
  • /DATABASELOGGING:connection:resume",
  • /PROBE:disableSelfAnnouncing",
  • /PROBE:disassociate",
  • /GATEWAY:rebalanceSANs",
  • /LMSTATS:startLMStatsCollectionNow",
  • /LMSTATS:startLMStatsCollectionForTimePeriod",
  • /LMSTATS:stopLMStatsCollection",
  • /LMSTATS:resetLMStats",
  • /LMSTATS:writeLMStats",
  • /GATEWAY:failback",
  • /GATEWAYHUB:ProposeSchema",
  • /GATEWAYHUB:ShowCurrentSchema",
  • /LICENSING:licenceInfo",
  • /PROBE:viewCAConfig",
  • /PROBE:viewCALog",

Publish Geneos data to Obcerv Copied

All data pushed from Geneos into Obcerv will use some or all of the following dimensions to identify the data: probe, managedEntity, sampler, type, dataview, and row. This applies to both data generated by the Netprobe and data generated by the Collection Agent and passed to the Netprobe as Dynamic Entities. The original dimensions published by the Collection Agent to the Netprobe will not be passed on to Obcerv.

How Obcerv Commands work Copied

For detailed information on how Commands function and are set up within Obcerv platform, refer to the following documentation:

["Geneos"] ["Geneos > Gateway"] ["Technical Reference"]

Was this topic helpful?