TCP Monitoring with YAML

YAML parameters for TCP Monitoring

NameTypeDescription
action
Required
StringThe ID of the action.
destination
Required
StringThe target URL.
type
Required
StringThe type of the action. Should be set to TCP.
port
Required
StringThe port for the connection.
trigger_timeStringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
post_dataStringThe data that will be sent.
textStringText that should or should not be present in the response.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS.
trigger_condition_pathsString[]Required when trigger_condition is set to ON_CHANGE_AT_PATH.
trigger_variable_keyStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the name of the desired variable.
trigger_variable_valueStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the value of the desired variable which will be compared with its current value.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.
variablesVariable[]The list of variables defined for this action.

YAML example for TCP Monitoring

actions:
- action: "Check app.buddy.works status"
type: "TCP"
port: "4567"
post_data: "test"
text: "ok"
destination: "app.buddy.works"
variables:
- key: "ftp_login"
value: "userLogin123"
description: "The name of user to FTP."
- key: "ftp_password"
value: "secure!14ivLMxPgv7TX6c9+ITX/g=="
encrypted: true
description: "The password for ftp."