Enum RunOptions

Enumerates the possible options to use when executing a remote command on a LinuxSshProxy<TMetadata>. These options may be combined using the bitwise OR operator.

Namespace: Neon.SSH
Assembly: Neon.SSH.dll
Syntax
[Flags]
public enum RunOptions

Fields

Name Description
Audit

Used to mark commands whose execution should be logged for auditing.
BinaryOutput

Return the standard output from remote command as binary data rather than intrepreting it as text.
Defaults

Bitwise ORs any specific option flags with those specified by DefaultRunOptions. This is handy for setting or resetting flags like FaultOnError on a global basis for a node proxy instance.
FaultOnError

Puts the LinuxSshProxy<TMetadata> into the faulted state when the command returns a non-zero exit code.
IgnoreRemotePath

Ignore the RemotePath property.
LogBundle

Used internally to prevent logging of the command "START: *" line at lower levels because this has already been logged.
LogOnErrorOnly

Logs command output only if the command returns a non-zero exit code.
LogOutput

Logs the command standard output (standard error output is logged by default).
None

No options are set.
Redact

Use for commands that may include sensitive secrets as command arguments and/or results. Only limited information about commands run with this flag will be logged.
RunWhenFaulted

Runs the command even if the LinuxSshProxy<TMetadata> is in the faulted state.
Shutdown

Indicates that the command will shutdown or restart or reboot the target server. Commands with this flag will not be retried on the server.

note

IMPORTANT: You must specify this flag if your command shutdown down the machine to prevent causing an infinite reboot loop.

Extension Methods