gateway

README

geneos Gateway Component

• Gateway general

The gateway component type represents a Geneos Gateway.

• Configuration

• Gateway templates

  When creating a new Gateway instance a default gateway.setup.xml file is created from the template(s) installed in the gateway/templates directory. By default this file is only created once but can be re-created using the rebuild command with the -F option if required. In turn this can also be protected against by setting the Gateway configuration setting configrebuild to never.

• Gateway variables for templates

  Gateways support the setting of Include files for use in templated configurations. These are set similarly to the -e parameters:

  geneos gateway set example2 -i  100:/path/to/include
  

  The setting value is priority:path and path can be a relative or absolute path or a URL. In the case of a URL the source is NOT downloaded but instead the URL is written as-is in the template output.

Documentation

Index

• Variables
• func Init(r *geneos.Host, ct *geneos.Component)
• func New(name string) geneos.Instance
• type Gateways
  • func (g *Gateways) Add(template string, port uint16) (err error)
  • func (g *Gateways) Command() (args, env []string)
  • func (g *Gateways) Config() *config.Config
  • func (g *Gateways) Home() string
  • func (g *Gateways) Host() *geneos.Host
  • func (g *Gateways) Load() (err error)
  • func (g *Gateways) Loaded() bool
  • func (g *Gateways) Name() string
  • func (g *Gateways) Rebuild(initial bool) (err error)
  • func (g *Gateways) Reload(params []string) (err error)
  • func (g *Gateways) String() string
  • func (g *Gateways) Type() *geneos.Component
  • func (g *Gateways) Unload() (err error)

Variables

var Gateway = geneos.Component{
	Initialise:       Init,
	Name:             "gateway",
	LegacyPrefix:     "gate",
	RelatedTypes:     nil,
	ComponentMatches: []string{"gateway", "gateways"},
	RealComponent:    true,
	UsesKeyfiles:     true,
	Templates: []geneos.Templates{
		{Filename: templateName, Content: template},
		{Filename: instanceTemplateName, Content: instanceTemplate},
	},
	DownloadBase: geneos.DownloadBases{Resources: "Gateway+2", Nexus: "geneos-gateway"},
	PortRange:    "GatewayPortRange",
	CleanList:    "GatewayCleanList",
	PurgeList:    "GatewayPurgeList",
	Aliases: map[string]string{
		"binsuffix": "binary",
		"gatehome":  "home",
		"gatebins":  "install",
		"gatebase":  "version",
		"gateexec":  "program",
		"gatelogd":  "logdir",
		"gatelogf":  "logfile",
		"gateport":  "port",
		"gatelibs":  "libpaths",
		"gatecert":  "certificate",
		"gatekey":   "privatekey",
		"gateaes":   "keyfile",
		"aesfile":   "keyfile",
		"gatename":  "gatewayname",
		"gatelich":  "licdhost",
		"gatelicp":  "licdport",
		"gatelics":  "licdsecure",
		"gateuser":  "user",
		"gateopts":  "options",
	},
	Defaults: []string{
		`binary=gateway2.linux_64`,
		`home={{join .root "gateway" "gateways" .name}}`,
		`install={{join .root "packages" "gateway"}}`,
		`version=active_prod`,
		`program={{join "${config:install}" "${config:version}" "${config:binary}"}}`,
		`logfile=gateway.log`,
		`port=7039`,
		`libpaths={{join "${config:install}" "${config:version}" "lib64"}}:/usr/lib64`,
		`gatewayname={{.name}}`,
	},
	GlobalSettings: map[string]string{
		"GatewayPortRange": "7039,7100-",
		"GatewayCleanList": "*.old:*.history",
		"GatewayPurgeList": "gateway.log:gateway.txt:gateway.snooze:gateway.user_assignment:licences.cache:cache/:database/",
	},
	Directories: []string{
		"packages/gateway",
		"gateway/gateways",
		"gateway/gateway_shared",
		"gateway/gateway_config",
		"gateway/templates",
	},
}

Functions

func Init

func Init(r *geneos.Host, ct *geneos.Component)

func New

func New(name string) geneos.Instance

Types

type Gateways

type Gateways instance.Instance

func (*Gateways) Add

func (g *Gateways) Add(template string, port uint16) (err error)

func (*Gateways) Command

func (g *Gateways) Command() (args, env []string)

func (*Gateways) Config

func (g *Gateways) Config() *config.Config

func (*Gateways) Home

func (g *Gateways) Home() string

func (*Gateways) Host

func (g *Gateways) Host() *geneos.Host

func (*Gateways) Load

func (g *Gateways) Load() (err error)

func (*Gateways) Loaded

func (g *Gateways) Loaded() bool

func (*Gateways) Name

func (g *Gateways) Name() string

func (*Gateways) Rebuild

func (g *Gateways) Rebuild(initial bool) (err error)

func (*Gateways) Reload

func (g *Gateways) Reload(params []string) (err error)

func (*Gateways) String

func (g *Gateways) String() string

func (*Gateways) Type

func (g *Gateways) Type() *geneos.Component

Return the Component for an Instance

func (*Gateways) Unload

func (g *Gateways) Unload() (err error)