config

type AppType struct {

	// Plugin represents an application used as a Nagios plugin.
	Plugin bool

	// Inspector represents an application used for one-off or isolated
	// checks. Unlike a Nagios plugin which is focused on specific attributes
	// resulting in a severity-based outcome, an Inspector application is
	// intended for examining a small set of targets for
	// informational/troubleshooting purposes.
	Inspector bool
}

type Config struct {

	// LoggingLevel is the supported logging level for this application.
	LoggingLevel string

	// NetworkType indicates whether an attempt should be made to connect to
	// only IPv4, only IPv6 or SSH servers listening on either of IPv4 or IPv6
	// addresses ("auto").
	NetworkType string

	// Server is the SSH server FQDN or IP Address.
	Server string

	// Username is the valid user for the given SSH server.
	Username string

	// Password is the valid password for the specified user.
	Password string

	// SSHCommand is the valid shell command to execute via SSH after a
	// successful connection and session is established.
	SSHCommand string

	// LoginSuccessState is the plugin state to be used when a SSH login
	// attempt is successful.
	LoginSuccessState string

	// LoginFailureState is the plugin state to be ued when a SSH login
	// attempt is unsuccessful.
	LoginFailureState string

	// TCPPort is the port used by the SSH service.
	TCPPort int

	// Log is an embedded zerolog Logger initialized via config.New().
	Log zerolog.Logger

	// EmitBranding controls whether "generated by" text is included at the
	// bottom of application output. This output is included in the Nagios
	// dashboard and notifications. This output may not mix well with branding
	// output from other tools such as atc0005/send2teams which also insert
	// their own branding output.
	EmitBranding bool

	// EmitSSHCommandOutput controls whether SSH command output is emitted by
	// the plugin *if* a SSH command was specified and executed.
	EmitSSHCommandOutput bool

	// ShowVersion is a flag indicating whether the user opted to display only
	// the version string and then immediately exit the application.
	ShowVersion bool

	// ShowVerbose is a flag indicating whether the user opted to display
	// verbose details in the final plugin output.
	ShowVerbose bool

	// ShowHelp indicates whether the user opted to display usage information
	// and exit the application.
	ShowHelp bool
	// contains filtered or unexported fields
}