netprobe

README

geneos Netprobes

https://docs.itrsgroup.com/docs/geneos/current/Netprobe/index.html

Configuration

binary

Default: netprobe.linux_64

The Netprobe program filename. Should not be changed.

home

Default: ${GENEOS_HOME}/netprobe/netprobes/NAME

This parameter is special in that even though it can be changed it is re-evaluated based on the instance's directory

install

Default: ${GENEOS_HOME}/packages/netprobe

The installation directory for Netprobe releases

version

Default: active_prod

The version of the Netprobe in the the install directory above.

program

Default: ${config:install}/${config:version}/${config:binary}

The full path to the Netprobe executable. The items in the default of the form ${config:NAME} refer other configuration parameters above.

logdir

Default: none

If set, it is used as the directory for the log file below. If not set (the default) then the home directory of the instance is used.

logfile

Default: gateway.log

The file name of the Gateway log file.

port

Default: First available from 7036,7100+

The default port to listen on. The actual default is selected from the first available port in the range defined in NetprobePortRange in the program settings.

libpaths

Default: ${config:install}/${config:version}/lib64:${config:install}/${config:version}

This parameter is combined with any LD_LIBRARY_PATH environment variable.

autostart

Default: true

Netprobe instances are set to be started with the default geneos start command. Setting autostart to false is different to using geneos disable to stop an instance from running.

protected

Default: false

Documentation

Index

• Variables
• type Netprobes
  • func (n *Netprobes) Add(tmpl string, port uint16) (err error)
  • func (n *Netprobes) Command() (args, env []string, home string)
  • func (n *Netprobes) Config() *config.Config
  • func (n *Netprobes) Home() string
  • func (n *Netprobes) Host() *geneos.Host
  • func (n *Netprobes) Load() (err error)
  • func (n *Netprobes) Loaded() time.Time
  • func (n *Netprobes) Name() string
  • func (n *Netprobes) Rebuild(initial bool) error
  • func (n *Netprobes) Reload() (err error)
  • func (n *Netprobes) SetLoaded(t time.Time)
  • func (n *Netprobes) String() string
  • func (n *Netprobes) Type() *geneos.Component
  • func (n *Netprobes) Unload() (err error)

Variables

var Netprobe = geneos.Component{
	Name:         "netprobe",
	Aliases:      []string{"probe", "netprobes", "probes"},
	LegacyPrefix: "netp",
	UsesKeyfiles: true,
	DownloadBase: geneos.DownloadBases{Resources: "Netprobe", Nexus: "geneos-netprobe"},
	PortRange:    "NetprobePortRange",
	CleanList:    "NetprobeCleanList",
	PurgeList:    "NetprobePurgeList",
	LegacyParameters: map[string]string{
		"binsuffix": "binary",
		"netphome":  "home",
		"netpbins":  "install",
		"netpbase":  "version",
		"netpexec":  "program",
		"netplogd":  "logdir",
		"netplogf":  "logfile",
		"netpport":  "port",
		"netplibs":  "libpaths",
		"netpcert":  "certificate",
		"netpkey":   "privatekey",
		"netpuser":  "user",
		"netpopts":  "options",
	},
	Defaults: []string{
		`binary=netprobe.linux_64`,
		`home={{join .root "netprobe" "netprobes" .name}}`,
		`install={{join .root "packages" "netprobe"}}`,
		`version=active_prod`,
		`program={{join "${config:install}" "${config:version}" "${config:binary}"}}`,
		`logfile=netprobe.log`,
		`calogfile=collection-agent.log`,
		`libpaths={{join "${config:install}" "${config:version}" "lib64"}}:{{join "${config:install}" "${config:version}"}}`,
		`autostart=true`,
	},
	GlobalSettings: map[string]string{
		"NetprobePortRange": "7036,7100-",
		"NetprobeCleanList": "*.old",
		"NetprobePurgeList": "netprobe.log:netprobe.txt:*.snooze:*.user_assignment:collection-agent.log",
	},
	Directories: []string{
		"packages/netprobe",
		"netprobe/netprobes",
		"netprobe/netprobes_shared",
	},
}

Types

type Netprobes

type Netprobes instance.Instance

func (*Netprobes) Add

func (n *Netprobes) Add(tmpl string, port uint16) (err error)

func (*Netprobes) Command

func (n *Netprobes) Command() (args, env []string, home string)

func (*Netprobes) Config

func (n *Netprobes) Config() *config.Config

func (*Netprobes) Home

func (n *Netprobes) Home() string

func (*Netprobes) Host

func (n *Netprobes) Host() *geneos.Host

func (*Netprobes) Load

func (n *Netprobes) Load() (err error)

func (*Netprobes) Loaded

func (n *Netprobes) Loaded() time.Time

func (*Netprobes) Name

func (n *Netprobes) Name() string

func (*Netprobes) Rebuild

func (n *Netprobes) Rebuild(initial bool) error

func (*Netprobes) Reload

func (n *Netprobes) Reload() (err error)

func (*Netprobes) SetLoaded

func (n *Netprobes) SetLoaded(t time.Time)

func (*Netprobes) String

func (n *Netprobes) String() string

func (*Netprobes) Type

func (n *Netprobes) Type() *geneos.Component

Return the Component for an Instance

func (*Netprobes) Unload

func (n *Netprobes) Unload() (err error)