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 ¶
var VERSION string
VERSION is the Cordial version embedded in the binary at build time.
Functions ¶
func ExecutableName ¶ added in v1.11.0
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
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
|
|
|
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
|
|
|
gateway-reporter
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) |