config.rb Optional Settings
In addition to the default settings in a knifeconfig.rb file, there are other subcommand-specific settings that can be added. When a subcommand is run, knife will use:
- A value passed via the command-line
- A value contained in the
config.rbfile - The default value
A value passed via the command line will override a value in the config.rbfile; a value in aconfig.rbfile will override a default value.
Warning
config.rb file. The reasons for not adding them can vary. For example, using --yes as a default in the config.rbfile will cause knife to always assume that “Y” is the response to any prompt, which may lead to undesirable outcomes. Other settings, such as --hide-by-mins (used only with the knife status subcommand) or --bare-directories (used only with the knife list subcommand) probably aren’t used often enough (and in the same exact way) to justify adding them to the config.rb file. In general, if the optional settings are not listed on the mainconfig.rbtopic, then add settings only after careful consideration. Do not use optional settings in a production environment until after the setting’s performance has been validated in a safe testing environment.The following list describes the optional settings that can be added to the configuration file:
knife[:admin]Create a client as an admin client.
knife[:admin_client_key]
knife[:admin_client_name]
knife[:after]Add a run-list item after the specified run-list item.
knife[:all]Indicates that all environments, cookbooks, cookbook versions, metadata, and/or data bags will be uploaded, deleted, generated, or tested. The context depends on which knife subcommand and argument is used.
knife[:all_versions]Return all available versions for every cookbook.
knife[:attribute]The attribute (or attributes) to show.
knife[:attribute_from_cli]
knife[:authentication_protocol_version]Sets the authentication protocol that is used to communicate with Chef Infra Server. For example, specify protocol version 1.3 to enable support for SHA-256 algorithms:
knife[:authentication_protocol_version] = '1.3'Note that authentication protocol 1.3 is only supported on Chef Server versions 12.4.0 and above.
knife[:bare_directories]Prevent a directory’s children from showing when a directory matches a pattern.
knife[:before]
knife[:bootstrap_curl_options]Arbitrary options to be added to the bootstrap command when using cURL. This option may not be used in the same command with
--bootstrap-install-command.knife[:bootstrap_install_command]Execute a custom installation command sequence for Chef Infra Client. This option may not be used in the same command with
--bootstrap-curl-options,--bootstrap-install-sh, or--bootstrap-wget-options.knife[:bootstrap_no_proxy]A URL or IP address that specifies a location that should not be proxied.
knife[:bootstrap_proxy]The proxy server for the node that is the target of a bootstrap operation.
knife[:bootstrap_template]The path to a template file to be used during a bootstrap operation.
knife[:bootstrap_vault_file]The path to a JSON file that contains a list of vaults and items to be updated.
knife[:bootstrap_vault_item]A single vault and item to update as
vault:item.knife[:bootstrap_vault_json]A JSON string that contains a list of vaults and items to be updated.
knife[:bootstrap_version]The version of the Chef Infra Client to install.
knife[:bootstrap_wget_options]Arbitrary options to be added to the bootstrap command when using GNU Wget. This option may not be used in the same command with
--bootstrap-install-command.knife[:both]Delete both local and remote copies of an object.
knife[:chef_node_name]
knife[:chef_repo_path]The path to the chef-repo.
knife[:chef_server_url]
knife[:chef_zero_host]Override the host on which chef-zero listens.
knife[:chef_zero_post]The port on which chef-zero listens.
knife[:client_key]
knife[:color]
knife[:concurrency]The number of allowed concurrent connections.
knife[:config_file]The configuration file to use.
knife[:cookbook_copyright]
knife[:cookbook_email]
knife[:cookbook_license]
knife[:cookbook_path]
knife[:delete_validators]
knife[:depends]Ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks are also uploaded.
knife[:description]The description for an environment and/or a role.
knife[:diff]
knife[:diff_filter]Select only files that have been added (
A), deleted (D), modified (M), and/or have had their type changed (T). Any combination of filter characters may be used, including no filter characters. Use*to select all paths if a file matches other criteria in the comparison.knife[:disable_editing]Prevent the $EDITOR from being opened and accept data as-is.
knife[:distro]
knife[:download_directory]The directory in which cookbooks are located.
knife[:dry_run]Take no action and only print out results.
knife[:editor]The $EDITOR that is used for all interactive commands.
knife[:encrypt]
knife[:env_run_list]
knife[:environment]The name of the environment.
knife[:exec]A string of code that to be executed.
knife[:file]Save a private key to the specified file name.
knife[:filter_result]
knife[:first_boot_attributes]
knife[:flat]Show a list of file names. Set to
falseto viewls-like output.knife[:force]Overwrite an existing directory.
knife[:format]
knife[:forward_agent]Enable SSH agent forwarding.
knife[:fqdn]FQDN
knife[:freeze]Require changes to a cookbook be included as a new version. Only the
--forceoption can override this setting.
knife[:help]
knife[:hide_healthy]Hide nodes on which a Chef Infra Client run has occurred within the previous hour.
knife[:hints]An Ohai hint to be set on the target node.
knife[:host_key_verify]Use
--no-host-key-verifyto disable host key verification.
knife[:id_only]
knife[:identity_file]The SSH identity file used for authentication. Key-based authentication is recommended.
knife[:initial]Create a API client, typically an administrator client on a newly installed Chef Infra Server.
knife[:input]The name of a file to be used with the
PUTor aPOSTrequest.knife[:latest]Download the most recent version of a cookbook.
knife[:local]Return only the contents of the local directory.
knife[:local_mode]
knife[:log_level]
knife[:log_location]
knife[:manual]Define a search query as a space-separated list of servers.
knife[:max_arguments_per_command]
knife[:max_command_line]
knife[:method]The request method:
DELETE,GET,POST, orPUT.
knife[:mismatch]
knife[:name_only]Show only the names of modified files.
knife[:name_status]Show only the names of files with a status of
Added,Deleted,Modified, orType Changed.knife[:no_deps]Ensure that all cookbooks to which the installed cookbook has a dependency are not installed.
knife[:node_name]The unique identifier of the node. This may be a username with permission to authenticate to the Chef Infra Server or it may be the name of the machine from which knife is run. For example:
node_name 'user_name'or:
node_name 'machine_name'
knife[:null_separator]
knife[:on_error]
knife[:one_column]Show only one column of results.
knife[:patterns]
knife[:platform]The platform for which a cookbook is designed.
knife[:platform_version]The version of the platform.
knife[:pretty]Use
--no-prettyto disable pretty-print output for JSON.knife[:print_after]Show data after a destructive operation.
knife[:proxy_auth]Enable proxy authentication to the Chef Infra Server web user interface.
knife[:purge]Entirely remove a cookbook (or cookbook version) from the Chef Infra Server. Use this action with care, because only one copy of any single file is stored on the Chef Infra Server. Consequently, purging a cookbook disables any other cookbook that references one or more files from the cookbook that has been purged.
knife[:query]
knife[:readme_format]The document format of the readme file:
md(markdown) andrdoc(Ruby docs).knife[:recurse]Use
--recurseto delete directories recursively.
knife[:recursive]
knife[:remote]
knife[:replace_all]
knife[:replace_first]
knife[:repo_mode]The layout of the local chef-repo. Possible values:
static,everything, orhosted_everything. Usestaticfor just roles, environments, cookbooks, and data bags. By default,everythingandhosted_everythingare dynamically selected depending on the server type.knife[:repository]The path to the chef-repo.
knife[:rows]
knife[:run_list]A comma-separated list of roles and/or recipes to be applied.
knife[:script_path]A colon-separated path at which Ruby scripts are located.
knife[:secret]The encryption key that is used for values contained within a data bag item.
knife[:secret_file]The path to the file that contains the encryption key.
knife[:server_name]Same as node_name. Recommended configuration is to allow Ohai to collect this value during each Chef Infra Client run.
knife[:ssh_attribute]The attribute used when opening an SSH connection.
knife[:ssh_gateway]The SSH tunnel or gateway that is used to run a bootstrap action on a machine that is not accessible from the workstation.
knife[:ssh_password]The SSH password. This can be used to pass the password directly on the command line. If this option is not specified (and a password is required) knife prompts for the password.
knife[:ssh_password_ng]
knife[:ssh_port]The SSH port.
knife[:ssh_user]The SSH user name.
knife[:start]
knife[:supermarket_site]The URL at which the Chef Supermarket is located. Default value: https://supermarket.chef.io.
knife[:template_file]
knife[:trailing_slashes]
knife[:tree]Show dependencies in a visual tree structure (including duplicates, if they exist).
knife[:use current_branch]Ensure that the current branch is used.
knife[:use_sudo]Execute a bootstrap operation with sudo.
knife[:use_sudo_password]
knife[:user]and/orknife[:user_home]The user name used by knife to sign requests made by the API client to the Chef Infra Server. Authentication fails if the user name does not match the private key.
knife[:user_key]Save a public key to the specified file name.
knife[:user_password]The user password.
knife[:validation_client_name]
knife[:validation_key]
knife[:validator]
knife[:verbose_commands]
knife[:verbosity]
knife[:with_uri]
knife[:yes]Respond to all confirmation prompts with “Yes”.
By Subcommand
The following sections show the optional settings for the config.rbfile, sorted by subcommand.
bootstrap
The following knife bootstrap settings can be added to the config.rb file:
knife[:bootstrap_curl_options]Adds the
--bootstrap-curl-optionsoption.knife[:bootstrap_install_command]Adds the
--bootstrap-install-commandoption.knife[:bootstrap_no_proxy]Adds the
--bootstrap-no-proxyoption.knife[:bootstrap_proxy]Adds the
--bootstrap-proxyoption.knife[:bootstrap_template]Adds the
--bootstrap-templateoption.knife[:bootstrap_url]Adds the
--bootstrap-urloption.knife[:bootstrap_vault_item]Adds the
--bootstrap-vault-itemoption.knife[:bootstrap_version]Adds the
--bootstrap-versionoption.knife[:bootstrap_wget_options]Adds the
--bootstrap-wget-optionsoption.knife[:run_list]Adds the
--run-listoption.knife[:template_file]Adds the
--bootstrap-templateoption.knife[:use_sudo]Adds the
--sudooption.
Note
knife bootstrap subcommand relies on a number of SSH-related
settings that are handled by the knife ssh subcommand.client create
The following knife client create settings can be added to the config.rb file:
knife[:file]Adds the
--fileoption.
client reregister
The following knife client reregister settings can be added to the config.rb file:
knife[:file]Adds the
--fileoption.
configure
The following knife configure settings can be added to the config.rb file:
knife[:admin_client_name]The name of the admin client that is passed as part of the command itself.
knife[:config_file]Adds the
--configoption.knife[:disable_editing]Adds the
--disable-editingoption.knife[:file]Adds the
--fileoption.knife[:initial]Adds the
--initialoption.knife[:repository]Adds the
--repositoryoption.knife[:user_home]Adds the
--useroption.knife[:user_password]Adds the
--passwordoption.knife[:yes]Adds the
--yesoption.
cookbook bulk delete
The following knife cookbook bulk delete settings can be added to the config.rb file:
knife[:purge]Adds the
--purgeoption.knife[:yes]Adds the
--yesoption.
cookbook create
The following knife cookbook create settings can be added to the config.rb file:
knife[:readme_format]Adds the
--readme-formatoption.
cookbook delete
The following knife cookbook delete settings can be added to the config.rb file:
knife[:all]Adds the
--alloption.knife[:print_after]Adds the
--print-afteroption.knife[:purge]Adds the
--purgeoption.
cookbook download
The following knife cookbook download settings can be added to the config.rb file:
knife[:download_directory]Adds the
--diroption.knife[:force]Adds the
--forceoption.knife[:latest]Adds the
--latestoption.
cookbook list
The following knife cookbook list settings can be added to the config.rb file:
knife[:all]Adds the
--alloption.knife[:environment]Adds the
--environmentoption.
cookbook metadata
The following knife cookbook metadata settings can be added to the config.rb file:
knife[:all]Adds the
--alloption.
cookbook show
The following knife cookbook show settings can be added to the config.rb file:
knife[:fqdn]Adds the
--fqdnoption.knife[:platform]Adds the
--platformoption.knife[:platform_version]Adds the
--platform-versionoption.
cookbook upload
The following knife cookbook upload settings can be added to the config.rb file:
knife[:all]Adds the
--alloption.knife[:depends]Adds the
--include-dependenciesoption.knife[:environment]Adds the
--environmentoption.knife[:force]Adds the
--forceoption.knife[:freeze]Adds the
--freezeoption.
supermarket download
The following knife supermarket download settings can be added to the config.rb file:
knife[:file]Adds the
--fileoption.knife[:force]Adds the
--forceoption.knife[:supermarket_site]The URL at which the Chef Supermarket is located. Default value: https://supermarket.chef.io.
supermarket install
The following knife supermarket install settings can be added to the config.rb file:
knife[:cookbook_path]Adds the
--cookbook-pathoption.knife[:file]Adds the
--fileoption.knife[:no_deps]Adds the
--skip-dependenciesoption.knife[:use_current_branch]Adds the
--use-current-branchoption.knife[:supermarket_site]The URL at which the Chef Supermarket is located. Default value: https://supermarket.chef.io.
supermarket share
The following knife supermarket share settings can be added to the config.rb file:
knife[:cookbook_path]Adds the
--cookbook-pathoption.knife[:supermarket_site]The URL at which the Chef Supermarket is located. Default value: https://supermarket.chef.io.
data bag create
The following knife data bag create settings can be added to the config.rb file:
knife[:secret]Adds the
--secretoption.knife[:secret_file]Adds the
--secret-fileoption.
data bag edit
The following knife data bag edit settings can be added to the config.rb file:
knife[:print_after]Adds the
--print-afteroption.knife[:secret]Adds the
--secretoption.knife[:secret_file]Adds the
--secret-fileoption.
data bag from file
The following knife data bag from file settings can be added to the config.rb file:
knife[:all]Adds the
--alloption.knife[:secret]Adds the
--secretoption.knife[:secret_file]Adds the
--secret-fileoption.
data bag show
The following knife data bag show settings can be added to the config.rb file:
knife[:secret]Adds the
--secretoption.knife[:secret_file]Adds the
--secret-fileoption.
delete
The following knife delete settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:recurse]Adds the
--recurseoption.knife[:repo_mode]Adds the
--repo-modeoption.
deps
The following knife deps settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:recurse]Adds the
--recurseoption.knife[:remote]Adds the
--remoteoption.knife[:repo_mode]Adds the
--repo-modeoption.knife[:tree]Adds the
--treeoption.
diff
The following knife diff settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:name_only]Adds the
--name-onlyoption.knife[:name_status]Adds the
--name-statusoption.knife[:recurse]Adds the
--recurseoption.knife[:repo_mode]Adds the
--repo-modeoption.
download
The following knife download settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:recurse]Adds the
--recurseoption.knife[:repo_mode]Adds the
--repo-modeoption.
edit
The following knife edit settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:disable_editing]Adds the
--disable-editingoption.knife[:editor]Adds the
--editoroption.knife[:local]Adds the
--localoption.knife[:repo_mode]Adds the
--repo-modeoption.
environment create
The following knife environment create settings can be added to the
config.rb file:
knife[:description]Adds the
--descriptionoption.
environment from file
The following knife environment from file settings can be added to the config.rb file:
knife[:all]Adds the
--alloption.knife[:print_after]Adds the
--print-afteroption.
exec
The following knife exec settings can be added to the config.rb file:
knife[:exec]Adds the
--execoption.knife[:script_path]Adds the
--script-pathoption.
list
The following knife list settings can be added to the config.rb file:
knife[:bare_directories]Adds the
-doption.knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:recursive]Adds the
-Roption.knife[:repo_mode]Adds the
--repo-modeoption.
node from file
The following knife node from file settings can be added to the config.rb file:
knife[:print_after]Adds the
--print-afteroption.
node list
The following knife node list settings can be added to the config.rb file:
knife[:environment]Adds the
--environmentoption.
node run list add
The following knife node run list add settings can be added to the config.rb file:
knife[:after]Adds the
--afteroption.knife[:run_list]The run-list that is passed as part of the command itself.
node run list remove
The following knife node run list remove settings can be added to the config.rb file:
knife[:run_list]The run-list that is passed as part of the command itself.
raw
The following knife raw settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:input]Adds the
--inputoption.knife[:method]Adds the
--methodoption.knife[:pretty]Adds the
--[no-]prettyoption.knife[:repo_mode]Adds the
--repo-modeoption.
role create
The following knife role create settings can be added to the config.rb file:
knife[:description]Adds the
--descriptionoption.
role from file
The following knife role from file settings can be added to the config.rb file:
knife[:print_after]Adds the
--print-afteroption.
role show
The following knife role show settings can be added to the config.rb file:
knife[:environment]Adds the
--environmentoption.
ssh
The following knife ssh settings can be added to the config.rb file:
knife[:concurrency]Adds the
--concurrencyoption.knife[:identity_file]Adds the
--identity-fileoption.knife[:host_key_verify]Adds the
--[no-]host-key-verifyoption.knife[:manual]Adds the
--manual-listoption.knife[:ssh_attribute]Adds the
--attributeoption.knife[:ssh_gateway]Adds the
--ssh-gatewayoption.knife[:ssh_password]Adds the
--ssh-passwordoption.knife[:ssh_port]Adds the
--ssh-portoption.knife[:ssh_user]Adds the
--ssh-useroption.
status
The following knife status settings can be added to the config.rb file:
knife[:hide_by_mins]Adds the
--hide-by-minsoption.knife[:run_list]Adds the
--run-listoption.knife[:sort_reverse]Adds the
--sort-reverseoption.
upload
The following knife upload settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:recurse]Adds the
--recurseoption.knife[:repo_mode]Adds the
--repo-modeoption.
user create
The following knife user create settings can be added to the config.rb file:
knife[:file]Adds the
--fileoption.knife[:user_key]Adds the
--user-keyoption.knife[:user_password]Adds the
--passwordoption.
user reregister
The following knife user reregister settings can be added to the config.rb file:
knife[:file]Adds the
--fileoption.
xargs
The following knife delete settings can be added to the config.rb file:
knife[:chef_repo_path]Adds the
--chef-repo-pathoption.knife[:concurrency]Adds the
--concurrencyoption.knife[:diff]Adds the
--diffoption.knife[:dry_run]Adds the
--dry-runoption.knife[:force]Adds the
--forceoption.knife[:local]Adds the
--localoption.knife[:max_arguments_per_command]Adds the
--max-argsoption.knife[:max_command_line]Adds the
--max-charsoption.knife[:null_separator]Adds the
-0option.knife[:patterns]Adds the
--patternoption.knife[:replace_all]Adds the
--replaceoption.knife[:replace_first]Adds the
--replace-firstoption.knife[:repo_mode]Adds the
--repo-modeoption.knife[:verbose_commands]Adds the
-toption.