chef-client8

Use to cause a chef-client run to fail when the chef-client does not have administrator privileges in Microsoft Windows.

The port on which chef-zero will listen. If a port is not specified---individually, as range of ports, or from the chef_zero.port setting in the client.rb file---the chef-client will scan for ports between 8889-9999 and will pick the first port that is available.

The output format: doc (default) or min.

Use doc to print the progress of the chef-client run using full strings that display a summary of updates as they occur.

Use min to print the progress of the chef-client run using single characters. A summary of updates is printed at the end of the chef-client run. A dot (.) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (.) is printed when the resource is up to date, an S is printed when the resource is skipped by not_if or only_if, and a U is printed when the resource is updated.

Other formatting options are available when those formatters are configured in the client.rb file using the add_formatter option.

Use to show formatter output instead of logger output.

Use to show logger output instead of formatter output.

The name of the group that owns a process. This is required when starting any executable as a daemon.

Shows help for the command.

The frequency (in seconds) at which the chef-client runs. When the chef-client is run at intervals, --splay and --interval values are applied before the chef-client run. Default value: 1800.

The path to a file that contains JSON data.

Use this option to define a run_list object. For example, a JSON file similar to:

"run_list": [
  "recipe[base]",
  "recipe[foo]",
  "recipe[bar]",
  "role[webserver]"
],

may be used by running chef-client -j path/to/file.json.

In certain situations this option may be used to update normal attributes.

WARNING:

{
  "name": "dev-99",
  "description": "Install some stuff",
  "override_attributes": {
    "apptastic": {
      "enable_apptastic": "false",
      "apptastic_tier_name": "dev-99.bomb.com"
    }
  }
}

{
  "name": "maybe-dev-99",
  "normal": {
  "name": "dev-99",
    "description": "Install some stuff",
    "override_attributes": {
      "apptastic": {
        "enable_apptastic": "false",
        "apptastic_tier_name": "dev-99.bomb.com"
      }
    }
  }
}

The location of the file which contains the client key. Default value: /etc/chef/client.pem.

The location of the file which contains the key used when a chef-client is registered with a Chef server. A validation key is signed using the validation_client_name for authentication. Default value: /etc/chef/validation.pem.

The level of logging that will be stored in a log file.

The location in which log file output files will be saved. If this location is set to something other than STDOUT, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. Default value: STDOUT.

The name of the node.

Replace the current run list with the specified items. This option will not clear the list of cookbooks (and related files) that is cached on the node.

Use to run the chef-client only once and to cancel interval and splay options.

The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: /tmp/name-of-executable.pid.

Use to permanently replace the current run-list with the specified run-list items.

Use to enable Chef reporting, which performs data collection during a chef-client run.

The amount of time (in seconds) to wait for a chef-client run to finish. Default value: not set (indefinite). Set to 0 to cause a second chef-client to exit immediately.

A number (in seconds) to add to the interval that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef-client is run at intervals, --splay and --interval values are applied before the chef-client run.

The URL for the Chef server.

The user that owns a process. This is required when starting any executable as a daemon.

The version of the chef-client.

Use to run the executable in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system.

Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo.