chef-courier-cli reference
chef-courier-cli
Chef Courier CLI
Options
-h
--help
help for chef-courier-cli
Default value:
false
chef-courier-cli completion
Generate the autocompletion script for the specified shell
Synopsis
Generate the autocompletion script for chef-courier-cli for the specified shell. See each sub-command’s help for details on how to use the generated script.
Options
-h
--help
help for completion
Default value:
false
See also
- chef-courier-cli completion bash
- chef-courier-cli completion fish
- chef-courier-cli completion powershell
- chef-courier-cli completion zsh
chef-courier-cli completion bash
Generate the autocompletion script for bash
Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.
To load completions in your current shell session:
source <(chef-courier-cli completion bash)
To load completions for every new session, execute once:
Linux:
chef-courier-cli completion bash > /etc/bash_completion.d/chef-courier-cli
macOS:
chef-courier-cli completion bash > $(brew --prefix)/etc/bash_completion.d/chef-courier-cli
You will need to start a new shell for this setup to take effect.
completion-bash package
You must have the bash-completion package installed on your workstation to run the completion bash
subcommand.
To install and configure the package, see the Chef 360 Platform CLI documentation.
Usage
chef-courier-cli completion bash
Options
-h
--help
help for bash
Default value:
false
--no-descriptions
disable completion descriptions
Default value:
false
See also
chef-courier-cli completion fish
Generate the autocompletion script for fish
Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
chef-courier-cli completion fish | source
To load completions for every new session, execute once:
chef-courier-cli completion fish > ~/.config/fish/completions/chef-courier-cli.fish
You will need to start a new shell for this setup to take effect.
Usage
chef-courier-cli completion fish [flags]
Options
-h
--help
help for fish
Default value:
false
--no-descriptions
disable completion descriptions
Default value:
false
See also
chef-courier-cli completion powershell
Generate the autocompletion script for powershell
Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
chef-courier-cli completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your powershell profile.
Usage
chef-courier-cli completion powershell [flags]
Options
-h
--help
help for powershell
Default value:
false
--no-descriptions
disable completion descriptions
Default value:
false
See also
chef-courier-cli completion zsh
Generate the autocompletion script for zsh
Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(chef-courier-cli completion zsh)
To load completions for every new session, execute once:
Linux:
chef-courier-cli completion zsh > "${fpath[1]}/_chef-courier-cli"
macOS:
chef-courier-cli completion zsh > $(brew --prefix)/share/zsh/site-functions/_chef-courier-cli
You will need to start a new shell for this setup to take effect.
Usage
chef-courier-cli completion zsh [flags]
Options
-h
--help
help for zsh
Default value:
false
--no-descriptions
disable completion descriptions
Default value:
false
See also
chef-courier-cli delivery
Commands related to delivery service
Options
-h
--help
help for delivery
Default value:
false
See also
chef-courier-cli delivery channel
Commands related to channel
Options
-h
--help
help for channel
Default value:
false
See also
- chef-courier-cli delivery
- chef-courier-cli delivery channel get-url
- chef-courier-cli delivery channel send-run
chef-courier-cli delivery channel get-url
Fetches connection queue string for a node
Synopsis
Fetches the connection string for a give nodeID. Connection string will be used by courier runner to connect the queue.
Usage
chef-courier-cli delivery channel get-url [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for get-url
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli delivery channel send-run
Deliver a run to a node in order that it be executed
Synopsis
Deliver a run to a node in order that it be executed. Delivery may be queued. Note that delivery does not track or report on delivery status at this time. If no delivery channel exists, one will be created.
Usage
chef-courier-cli delivery channel send-run [flags]
Options
--body
Job to run on the node.
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--channelId
channel to receive delivery. Currently maps to node identifier.
--format
to print response in format
Default value:
json
-h
--help
help for send-run
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli deregister-device
De-register a device
Synopsis
Use this operation to de-register a device
Usage
chef-courier-cli deregister-device [flags]
Options
--force
force remove profile from local list of profiles, even on error from server
Default value:
false
-f
--format
to print response in format
Default value:
json
-h
--help
help for deregister-device
Default value:
false
--profile
name for the profile of the new api-token
Default value:
default
-v
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli get-default-profile
Get default profile for request
Usage
chef-courier-cli get-default-profile [flags]
Options
-h
--help
help for get-default-profile
Default value:
false
See also
chef-courier-cli list-profile-names
Get the list of profile names available
Usage
chef-courier-cli list-profile-names [flags]
Options
-h
--help
help for list-profile-names
Default value:
false
See also
chef-courier-cli orchestrator
Commands related to orchestrator
Options
-h
--help
help for orchestrator
Default value:
false
See also
chef-courier-cli orchestrator add-jobinstance
Submit a job instance for execution
Usage
chef-courier-cli orchestrator add-jobinstance [flags]
Options
--body
a job instance to be executed by nodes
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for add-jobinstance
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli register-device
register a device and get api-token for device login
Usage
chef-courier-cli register-device [flags]
Options
--cafile
path to ca file
--device-name
name of the device
Default value:
device
-f
--format
to print response in format
Default value:
json
-h
--help
help for register-device
Default value:
false
-i
--insecure
insecure skip verify
Default value:
false
--overwrite
this flag is used to overwrite the old profile if the profile for profile name provided already exists
Default value:
false
--profile-name
name for the profile of the new api-token
--url
tenant url
-v
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler
Commands related to scheduler service
Options
-h
--help
help for scheduler
Default value:
false
See also
chef-courier-cli scheduler exceptions
Commands related to exceptions
Options
-h
--help
help for exceptions
Default value:
false
See also
- chef-courier-cli scheduler
- chef-courier-cli scheduler exceptions add-rule
- chef-courier-cli scheduler exceptions delete-rule
- chef-courier-cli scheduler exceptions get-rule
- chef-courier-cli scheduler exceptions list-rules
- chef-courier-cli scheduler exceptions update-rule
chef-courier-cli scheduler exceptions add-rule
Add scheduling exception window.
Synopsis
Add a scheduling exception window. Jobs will not run during exception windows. All future job run schedules are recalculated when an exception is added.
Usage
chef-courier-cli scheduler exceptions add-rule [flags]
Options
--body
a new exception rule
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for add-rule
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler exceptions delete-rule
Delete scheduling exception rule
Synopsis
Delete scheduling exception rule. Causes recalculation of all future job execution times.
Usage
chef-courier-cli scheduler exceptions delete-rule [flags]
Options
--exceptionId
ID of a exception
--format
to print response in format
Default value:
json
-h
--help
help for delete-rule
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler exceptions get-rule
Get scheduling exception rule with exception rule identifier
Usage
chef-courier-cli scheduler exceptions get-rule [flags]
Options
--exceptionId
ID of a exception
--format
to print response in format
Default value:
json
-h
--help
help for get-rule
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler exceptions list-rules
Get scheduling exception rules
Synopsis
Get paginated list of all scheduling exception rules
Usage
chef-courier-cli scheduler exceptions list-rules [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for list-rules
Default value:
false
--pagination.page
what page of the pagination
Default value:
1
--pagination.size
items per page
Default value:
10
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler exceptions update-rule
Update a scheduling exception rule.
Synopsis
Update a scheduling exception rule. Causes recalculation of all future job execution times.
Usage
chef-courier-cli scheduler exceptions update-rule [flags]
Options
--body
The updated exception rule.
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--exceptionId
ID of a exception
--format
to print response in format
Default value:
json
-h
--help
help for update-rule
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs
Commands related to jobs
Options
-h
--help
help for jobs
Default value:
false
See also
- chef-courier-cli scheduler
- chef-courier-cli scheduler jobs activated-job
- chef-courier-cli scheduler jobs add-job
- chef-courier-cli scheduler jobs cancel-job
- chef-courier-cli scheduler jobs delete-job
- chef-courier-cli scheduler jobs estimate-run-times
- chef-courier-cli scheduler jobs get-head
- chef-courier-cli scheduler jobs get-job
- chef-courier-cli scheduler jobs get-pastDueJobs
- chef-courier-cli scheduler jobs list-jobs
- chef-courier-cli scheduler jobs update-job
chef-courier-cli scheduler jobs activated-job
marks the specified job as having been activated.
Synopsis
Internal use only. Invoked when a job has been activated. Updates run count and pre-calculates next execution time.
Usage
chef-courier-cli scheduler jobs activated-job [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for activated-job
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs add-job
Create a new job.
Synopsis
Create a new new job.
Usage
chef-courier-cli scheduler jobs add-job [flags]
Options
--body
The job to be created
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for add-job
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs cancel-job
cancel all future occurrences of a job
Synopsis
prevents future instances of this job from running by updating the job status to ‘canceled’. Note that this will not affect any job instance running at the time of this request.
Usage
chef-courier-cli scheduler jobs cancel-job [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for cancel-job
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs delete-job
Deletes the specified job
Synopsis
Deletes the job identified by jobId
Usage
chef-courier-cli scheduler jobs delete-job [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for delete-job
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs estimate-run-times
get future execution times for a job
Synopsis
get one or more estimated run times for the specified job
Usage
chef-courier-cli scheduler jobs estimate-run-times [flags]
Options
--count
number of future runs to retrieve
Default value:
0
--format
to print response in format
Default value:
json
-h
--help
help for estimate-run-times
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs get-head
Retrieve request headers for a job by its identifier.
Synopsis
this can be used to verify that a job does (or does not) exist, without retrieving the job itself.
Usage
chef-courier-cli scheduler jobs get-head [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for get-head
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs get-job
Retrieve the job by identifier
Synopsis
Returns the specific job
Usage
chef-courier-cli scheduler jobs get-job [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for get-job
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs get-pastDueJobs
Retrieve the jobs that are due to run as of the given ‘deadline’
Synopsis
Fetches jobs that are expected to run at or before ‘deadline’ passes.
Usage
chef-courier-cli scheduler jobs get-pastDueJobs [flags]
Options
--deadline
filter by job instances initiated before the given time.
--format
to print response in format
Default value:
json
-h
--help
help for get-pastDueJobs
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs list-jobs
List all jobs.
Synopsis
Lists all jobs. If a filter is provided and no results match, an empty list will be returned.
Usage
chef-courier-cli scheduler jobs list-jobs [flags]
Options
--active
Filter by active jobs. An active job is defined as one with an 'active' status that is also scheduled for at least one future execution.
Default value:
false
--format
to print response in format
Default value:
json
-h
--help
help for list-jobs
Default value:
false
--pagination.page
what page of the pagination
Default value:
1
--pagination.size
items per page
Default value:
10
--profile
name of the profile to be used for cmd
Default value:
default
--status
The Status to filter the jobs list by
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli scheduler jobs update-job
replace the job with the new job provided.
Synopsis
Updates the job and recalculates its next scheduled run. This update will have no effect previous or in-flight executions of this job. == NOTE == This operation is not currently supported
Usage
chef-courier-cli scheduler jobs update-job [flags]
Options
--body
The job to be updated
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for update-job
Default value:
false
--jobId
ID of a Job
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli set-default-profile
Set default profile for request
Usage
chef-courier-cli set-default-profile [flags]
Options
-h
--help
help for set-default-profile
Default value:
false
See also
chef-courier-cli state
Commands related to state service
Options
-h
--help
help for state
Default value:
false
See also
chef-courier-cli state instance
Commands related to instance
Options
-h
--help
help for instance
Default value:
false
See also
- chef-courier-cli state
- chef-courier-cli state instance complete-instance
- chef-courier-cli state instance create-instance
- chef-courier-cli state instance get-instance
- chef-courier-cli state instance list-all
- chef-courier-cli state instance list-instance-runs
chef-courier-cli state instance complete-instance
Update a Job Instance’s state to complete.
Synopsis
Update the job instance state to complete, with the provided status. A Job Instance is expected to marked as ‘failure’ or ‘success’ as soon as the determination is made, which can occur while some nodes are still performing actions. These updates will be captured but will not affect the final status of the Job Instance. An Instance is considered successful only if all of its Success Criteria have been met.
Usage
chef-courier-cli state instance complete-instance [flags]
Options
--body
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for complete-instance
Default value:
false
--instanceId
The unique identifier of a Job Instance
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state instance create-instance
Capture the state of a job that is about to be started.
Synopsis
Captures the Job Instance and its expanded job-run list to state. This request will fail with a 500 response if both operations are not completed successfully. This allows the system to track the nodes it is expecting to hear in from, without relying on those nodes checking in to be visible. Typically invoked by Orchestrator when it is preparing to run a job instance.
Usage
chef-courier-cli state instance create-instance [flags]
Options
--body
The Job Instance to capture
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for create-instance
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state instance get-instance
get the requested Job Instance
Synopsis
This retrieves a Job Instance record for the given instance-id. The run records associated with the Job Instance are not included in the results.
Note that instances that have been moved to history will not be available with this API.
Usage
chef-courier-cli state instance get-instance [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for get-instance
Default value:
false
--instanceId
The unique identifier of a Job Instance
--profile
name of the profile to be used for cmd
Default value:
default
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state instance list-all
retrieve job instances
Synopsis
Fetch a list of job instances, filtered by the provided query parameters. Results will contain only those records matching all provided filters.
Usage
chef-courier-cli state instance list-all [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for list-all
Default value:
false
--job-id
filter by job instances originating from the given job
--pagination.page
what page of the pagination
Default value:
1
--pagination.size
items per page
Default value:
10
--profile
name of the profile to be used for cmd
Default value:
default
--run-after
filter by job instances initiated after the given time.
--run-before
filter by job instances initiated before the given time.
--status
filter by the provided instance status
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state instance list-instance-runs
list all job runs for the given job instance
Synopsis
Retrieves all runs in the given job instance, filtered by the provided query parameters. Results returned will meet all filter criteria provided.
Usage
chef-courier-cli state instance list-instance-runs [flags]
Options
--format
to print response in format
Default value:
json
--groupNum
filter results to include only those in the specified group
Default value:
0
-h
--help
help for list-instance-runs
Default value:
false
--instanceId
The unique identifier of a Job Instance
--pagination.page
what page of the pagination
Default value:
1
--pagination.size
items per page
Default value:
10
--profile
name of the profile to be used for cmd
Default value:
default
--run-after
filter results to include only job runs last updated after this date
--run-before
filter results to include only job runs last updated prior to this date
--status
filters results to include only job runs with this status
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run
Commands related to run
Options
-h
--help
help for run
Default value:
false
See also
- chef-courier-cli state
- chef-courier-cli state run attach-step-attempt-evidence
- chef-courier-cli state run complete-run
- chef-courier-cli state run get-run
- chef-courier-cli state run get-step-attempt-evidence
- chef-courier-cli state run list-steps
- chef-courier-cli state run received-run
- chef-courier-cli state run timeout-run
- chef-courier-cli state run update-step
chef-courier-cli state run attach-step-attempt-evidence
Synopsis
Upload evidence (artifacts) related to completion of the step, such as command output. Content is expected to be uploaded as multipart/form-data in gzipped format. Evidence upload does not affect the status of an action within the job run. Client must PUT to state/run/{runId}/step/{stepId} prior to uploading evidence. Future: The capture of evidence will be processed asynchronously
Usage
chef-courier-cli state run attach-step-attempt-evidence [flags]
Options
--attemptNo
the attempt number for a given step/action within a job run.
Default value:
0
--file
Takes path of file.
--format
to print response in format
Default value:
json
-h
--help
help for attach-step-attempt-evidence
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--stepNo
a single step/action within a job run.
Default value:
0
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run complete-run
Update a run to indicate it is complete.
Synopsis
Updates the run’s state reflect that the job run has been completed. Generally used by the client to indicate it has completed processing all steps of a run.
Usage
chef-courier-cli state run complete-run [flags]
Options
--body
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for complete-run
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run get-run
provides job run details for any job run id
Synopsis
this is intended as an endpoint to provide job run details for provided job run id. Results will not include any steps. For those, use the endpoint run/{runId}/steps. Note that job runs that have been moved to history will not be available via this API.
Usage
chef-courier-cli state run get-run [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for get-run
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run get-step-attempt-evidence
Synopsis
This provides a signed expiring download URL to the artifact associated with this job run step attempt. == COMPATIBILITY NOTE == This will be changing for GA to provide direct download of the artifact.
Usage
chef-courier-cli state run get-step-attempt-evidence [flags]
Options
--attemptNo
the attempt number for a given step/action within a job run.
Default value:
0
--format
to print response in format
Default value:
json
-h
--help
help for get-step-attempt-evidence
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--stepNo
a single step/action within a job run.
Default value:
0
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run list-steps
retrieve all step results for the given run
Synopsis
Fetch paginated step results for a given run. Does not include artifacts, which must be queried separately.
Usage
chef-courier-cli state run list-steps [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for list-steps
Default value:
false
--pagination.page
what page of the pagination
Default value:
1
--pagination.size
items per page
Default value:
10
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run received-run
Notify the State system that a job run has been received.
Synopsis
Updates the job run state to reflect that the job run has been received by the client. This will also update the last-update time, delaying timeout in orchestrator.
Usage
chef-courier-cli state run received-run [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for received-run
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run timeout-run
Update a run to indicate that it has timed out
Synopsis
Updates the run’s state to reflect that the job run has been timed out by Orchestrator. Intended for internal use by chef-orchestrator-watchdog. A timeout will not update the last-updated time, so that there remains record of the last time Courier Server heard from the node. IMPORTANT> Even though orchestrator considers the run-timed out and will no longer be tracking it, the can still check in and complete the run. In this case, the timeout status will be replaced with the final status as long as the instance has not been migrated to history.
Usage
chef-courier-cli state run timeout-run [flags]
Options
--format
to print response in format
Default value:
json
-h
--help
help for timeout-run
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli state run update-step
Synopsis
Status endpoint used by a node to update the status and state of the given step. These messages will be are processed asynchronously by the State Service. Receipt timestamp will be captured at server-side as the last-update/alive time received. Client is expected to invoke this API endpoint at the start and completion of the step (with appropriate status/state values); and if a reboot is required it should also perform an interim update with ‘active’ status.
Usage
chef-courier-cli state run update-step [flags]
Options
--body
--body-file
Path to file in the local system containing valid body parameter value
--body-format
Format of the --body or --body-file, options: json, yaml, toml
Default value:
json
--format
to print response in format
Default value:
json
-h
--help
help for update-step
Default value:
false
--profile
name of the profile to be used for cmd
Default value:
default
--runId
The unique identifier of a job run in GUID format.
--stepNo
a single step/action within a job run.
Default value:
0
--verbose
to show debug logs
Default value:
false
See also
chef-courier-cli version
Chef Courier cli
Usage
chef-courier-cli version [flags]
Options
-h
--help
help for version
Default value:
false