Receive

Description

Receive data via SSH or TN3270 during an interactive session with a remote asset.

Parameters

Parameter Name	Description	Type	Resolved Type	Required
ConnectionObjectName	The variable name that identifies the connection object created by the Connect command	String	String	Yes
BufferName	The name of the variable that will receive the content	String	String	No
Append	Indicates that the data received should be added to the data already in buffer	Boolean	Boolean	No
ExpectTimeout	The time to wait, in milliseconds, for the ExpectRegex condition to match	Value	String	No
ExpectRegex	A regular expression string used to determine if we are done receiving. The receive continues until the pattern is matched in the received data or the ExpectTimeout time is reached.	Value	String	No
ContainsSecret	Set to true to suppress logging in the platform task comms log if the buffer contains sensitive data. Default=false.	Boolean	Boolean	No
ExpectOptions	An optional array of options to apply to the regex. Valid values are Singleline Multiline IgnoreCase IgnorePatternWhiteSpace RightToLeft . Added in Safeguard v6.13	Array	Array	No
TimeoutResultVariableName	The name of a variable to store the result if a timeout occurs without a match. Added in Safeguard v6.13	String	String	No

Examples

Example wait maximum of 3 seconds for either a sudo prompt, an expected prompt string, or an error:

{
  "Receive": {
    "ConnectionObjectName": "ConnectSsh",
    "Buffer": "OutputBuffer"
    "ExpectTimeout": 3000,
    "ExpectRegex": "(sudo password)|(myprompt)|(error)"
  }
}