check-every

check-every

Specifies how often (in seconds) to check whether a long-running operation has returned the expected values. Use in conjunction with the expected-values and wait options.

Syntax

{--check-every | -c} seconds

Arguments

Argument	Description
seconds	Specifies the number of seconds the command waits before checking for expected output specified by the {--expected-values \| -e} option. If you omit the {--check-every \| -c} option, the command uses the value of the CC_CHECK_EVERY environment variable. If the CC_CHECK_EVERY environment variable is not set, the command uses 15 seconds.

Usage Notes

The {--check-every | -c} option is only needed when you specify the {--expected-values | -e} option.

The command is continually executed every {--check-every | -c} seconds until the command either returns the expected values or times out because the seconds specified by the {--wait | -w} option have elapsed.

If the time specified by the {--wait | -w} option elapses before the expected results are returned, the command fails.

The use of the {--expected-values | -e}, {--wait | -w}, and {--check-every | -c} options is helpful with commands that perform actions that might take several seconds or minutes to complete. Depending on your use case, these options might be helpful with any command. However, they are most helpful with the lifecycle and monitoring commands because they allow you to reliably execute the commands.

Example

To have a command check every 30 seconds for the expected results:

--check-every 30

Note:
To see an example that uses all of the {--expected-values | -e}, {--wait | -w}, and {--check-every | -c} options, see expected-values.