cordial

package module
v1.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

README

Cordial

Cordial is a practical toolkit for the day-to-day operation of ITRS Geneos. It brings common work, such as managing deployments, reviewing monitoring coverage, sharing Dataviews, and routing alerts, into ready-made commands, reports, and integrations.

Cordial works alongside your Geneos environment; it does not replace its monitoring components. Use it to make routine work more consistent and reduce one-off scripts, manual exports, and hand-offs. This can leave you and your team with more time to review monitoring results and act on them.

Operational workflows

Manage Geneos with one command

The geneos command brings common management tasks into one consistent interface. You can use it across local and remote hosts, including with existing installations. Its main benefits include:

  • Consistent operations: View, install, update, configure, start, and stop Geneos components with repeatable commands instead of maintaining separate scripts for each task.

  • Security by default: New deployments use TLS. Unless you provide your own certificates or choose insecure mode, geneos establishes a private certificate authority and issues certificates for Geneos components. This gives you a consistent foundation for protected communications without building a separate certificate workflow.

  • Faster common setups: Ready-made Gateway include files based on Geneos best practices, together with profiles, help you deploy common monitoring scenarios without building each configuration from scratch.

  • Operational audit: Selected command invocations and instance actions are recorded in global and per-instance logs. You can review who ran a command, what action it took, and whether it succeeded. Recognized sensitive values are redacted from logged command details.

  • Monitor-Of-The-Monitors (MOTM, preview): The supplied profile can configure a Self-Announcing Netprobe to report installed Geneos components to a central MOTM Gateway. This gives you a consolidated view without defining every managed entity by hand. Rebuild the profile after estate changes to refresh that view.

Review monitoring coverage with GDNA

Geneos licence data can be detailed and spread across many Gateways and Netprobes. GDNA turns data from Geneos Licence Daemons (licd) into dashboards and reports that show monitoring coverage across servers; it does not collect monitoring data from other sources. You and your team can use these reports to find potential gaps, compare plugin use with your coverage goals, and plan improvements. GDNA can also email reports on a schedule, so you can share regular updates without running them manually. Results depend on the licence data available and the coverage policies in use.

Share Dataviews with dv2email

dv2email turns Geneos Dataview snapshots into email reports or files such as HTML and Excel workbooks. A Gateway Action or Effect can start a report when an alert occurs. This avoids repeated manual exports and copy-and-paste for incident reviews, handovers, and other operational reports.

Connect alerts to ServiceNow

The servicenow2 integration maps Geneos alert data to ServiceNow incident fields. Based on its configured rules and correlation values, it can create an incident or update an existing one. It removes the need for a separate wrapper script to translate Gateway event data. This reduces manual ticket entry and keeps alerts in your service-management workflow.

Low-overhead deployment

The pre-built Linux command-line programs are statically linked for compatible 64-bit x86 Linux systems. You do not need to install a separate language runtime, interpreter, or helper utility to run them. The exception is libemail.so: it is a shared library that uses the host's standard C runtime and must be loaded by a compatible Geneos Gateway. Each program still needs the configuration, network access, and external services required for its work.

The geneos command also includes tools for many tasks that might otherwise need separate scripts or diagnostic utilities. For example, geneos package install can download and unpack releases; geneos ps can inspect running instances, open files, and sockets; geneos logs can read, filter, and follow local or remote logs; and geneos snapshot can fetch Gateway Dataviews. These built-in tools can reduce software setup and maintenance on your Geneos hosts.

Integrations

Integration Purpose
servicenow2 Creates or updates ServiceNow incidents from Geneos alerts.
pagerduty Sends Geneos alerts to PagerDuty as events.

Libraries

Library Purpose
libalert Geneos notification library with enhanced email support and Microsoft Teams notifications.
libemail Geneos email library with support for authenticated SMTP, TLS, and templates.

Other tools

Tool Purpose
files2dv Builds Geneos Toolkit-compatible Dataview data from files. Its background push mode is not implemented.
ims-gateway Connects Geneos incident commands to ServiceNow or ServiceDesk Plus.
san-config Serves inventory-based configuration to Self-Announcing Netprobes.

Go packages

If you build your own tools, Cordial also provides Go packages that work with Geneos:

Package Purpose
config Load configuration and expand values such as environment variables and encrypted credentials.
geneos Build Geneos Gateway and Netprobe configuration using Go data structures.
geneos/api Send data to Netprobes through their REST and XML-RPC APIs.
geneos/commands Run Gateway REST commands and retrieve Dataview snapshots.
geneos/plugins, samplers, streams, xmlrpc Build integrations with the Geneos XML-RPC API.
geneos/xpath Work with XPath expressions used by Geneos configuration and APIs.
host Perform file and process operations on local and remote SSH hosts.
email Send Geneos-aware email through SMTP, including TLS and authentication.

Other packages support certificates, logging, reporting, REST clients, process management, IMS, Capacity Planner, and Gateway Hub. For the full package list, see the package overview.

Documentation

Overview

Package cordial is a collection of tools, packages and integrations for Geneos written primarily in Go

Index

Constants

This section is empty.

Variables

View Source
var VERSION string

VERSION is the Cordial version embedded in the binary at build time.

Functions

func ExecutableName added in v1.11.0

func ExecutableName(version ...string) (execname string)

ExecutableName returns a processed executable name. Symlinks are resolved and the basename of the resulting file has, at most, one extension removed and then if there is a '-' followed by the matching cordial version string. Note this final version string must match first version argument or the cordial one compiled into the binary.

For example:

`geneos.exe` -> `geneos`
`dv2email-v1.10.0` -> `dv2email`

func RenderHelpAsMD added in v1.7.0

func RenderHelpAsMD(command *cobra.Command)

RenderHelpAsMD sets the help template of the given cobra.Command to render the long description and short description as Markdown, using the src.elv.sh/pkg/md package.

Types

This section is empty.

Directories

Path Synopsis
_examples
api command
api2 command
cliauth command
dockerlogs command
examples
api module
cmd
integrations
pagerduty command
Standalone pagerduty integration executable
Standalone pagerduty integration executable
servicenow command
servicenow2 command
libraries
libalert command
libemail command
pkg
certs
The certs package provides functions for handling TLS certificates and keys.
The certs package provides functions for handling TLS certificates and keys.
config
Package config adds local extensions to viper as well as supporting Geneos encryption key files and basic encryption and decryption.
Package config adds local extensions to viper as well as supporting Geneos encryption key files and basic encryption and decryption.
email
The email package provides Geneos specific email processing to support libemail and other email senders using Geneos formatted parameters.
The email package provides Geneos specific email processing to support libemail and other email senders using Geneos formatted parameters.
geneos/commands
Package commands wraps the Geneos Gateway REST Command API in Go
Package commands wraps the Geneos Gateway REST Command API in Go
geneos/xpath
Package to handle Geneos Gateway specific XPaths
Package to handle Geneos Gateway specific XPaths
host
Provides remote file and command functions
Provides remote file and command functions
icp
Package icp provides binding the the ITRS Capacity Planner data model
Package icp provides binding the the ITRS Capacity Planner data model
ims
package ims provides basic support for Incident Management System (IMS) integration, such as ServiceDesk Plus, ServiceNow, etc.
package ims provides basic support for Incident Management System (IMS) integration, such as ServiceDesk Plus, ServiceNow, etc.
reporter
The reporter package provides a simple interface to generating Geneos dataviews, with headlines and a data table, either though the XML-RPC API, as Toolkit compatible CSV, XLSX workbooks or a number of other formats.
The reporter package provides a simple interface to generating Geneos dataviews, with headlines and a data table, either though the XML-RPC API, as Toolkit compatible CSV, XLSX workbooks or a number of other formats.
rest
Package rest provides a JSON-oriented HTTP client with configurable authentication and request setup.
Package rest provides a JSON-oriented HTTP client with configurable authentication and request setup.
tools
dv2email command
files2dv command
geneos command
geneos/cmd
Package cmd contains all the main commands for the `geneos` program
Package cmd contains all the main commands for the `geneos` program
geneos/cmd/adbcmd
package adbcmd implements a subsystem for manipulating exported dashboard (.adb) files
package adbcmd implements a subsystem for manipulating exported dashboard (.adb) files
geneos/cmd/aescmd
Package aescmd groups related AES256 keyfile and crypto commands
Package aescmd groups related AES256 keyfile and crypto commands
geneos/cmd/cfgcmd
Package cfgcmd groups config commands in their own package
Package cfgcmd groups config commands in their own package
geneos/cmd/hostcmd
Package hostcmd contains all the host subsystem commands
Package hostcmd contains all the host subsystem commands
geneos/cmd/initcmd
Package initcmd contains all the init subsystem commands
Package initcmd contains all the init subsystem commands
geneos/cmd/pkgcmd
Package pkgcmd contains all the package subsystem commands
Package pkgcmd contains all the package subsystem commands
geneos/cmd/tlscmd
Package tlscmd contains all the TLS subsystem commands
Package tlscmd contains all the TLS subsystem commands
geneos/internal/component/ac2
Package ac2 supports installation and control of the Active Console
Package ac2 supports installation and control of the Active Console
geneos/internal/component/profile
profile is a pseudo component representing a Geneos profile instance
profile is a pseudo component representing a Geneos profile instance
geneos/internal/geneos
Package geneos provides internal features to manage a typical `Best Practice` installation layout and the conventions that have formed around that structure over many years.
Package geneos provides internal features to manage a typical `Best Practice` installation layout and the conventions that have formed around that structure over many years.
geneos/internal/values
package values manages types for common repeatable flag types, such as gateways, includes, variables and attributes.
package values manages types for common repeatable flag types, such as gateways, includes, variables and attributes.
geneos/utils/docs command
The docs utility builds markdown documentation from the geneos program sources and writes to the `docs` directory.
The docs utility builds markdown documentation from the geneos program sources and writes to the `docs` directory.
ims-gateway command
ims-gateway/internal/snow
package snow provides the ServiceNow integration for the IMS Gateway.
package snow provides the ServiceNow integration for the IMS Gateway.
san-config command
sso-diag command
utils
docs command
docs creates documentation from the tools and integrations in the repo (except `geneos` which has it's own copy of this with custom mods)
docs creates documentation from the tools and integrations in the repo (except `geneos` which has it's own copy of this with custom mods)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL