knife-delete - The man page for the knife delete subcommand.
The knife delete
subcommand is used to delete an object from a Chef
server. This subcommand works similar to knife cookbook delete
knife data bag delete
, knife environment delete
, knife node
, and knife role delete
, but with a single verb (and a single
This subcommand has the following syntax:
$ knife delete [PATTERN...] (options)
This subcommand has the following options:
- Use to delete both local and remote copies of an object. Default:
- -c CONFIG_FILE, --config CONFIG_FILE
- The configuration file to use.
- --chef-repo-path PATH
- The path to the chef-repo. This setting will override the default path to
the chef-repo. Default: same as specified by chef_repo_path in
- --chef-zero-port PORT
- The port on which chef-zero will listen.
- Use to view colored output.
- The number of allowed concurrent connections. Default: 10.
- -d, --disable-editing
- Use to prevent the $EDITOR from being opened and to accept data
- Use to have knife use the default value instead of asking a user to
- -e EDITOR, --editor EDITOR
- The $EDITOR that is used for all interactive commands.
- -E ENVIRONMENT, --environment ENVIRONMENT
- The name of the environment. When this option is added to a command, the
command will run only against the named environment.
- -F FORMAT, --format FORMAT
- The output format: summary (default), text, json,
yaml, and pp.
- -h, --help
- Shows help for the command.
- -k KEY, --key KEY
- The private key that knife will use to sign requests made by the API
client to the Chef server.
- Use to delete only the local copy of an object. (A remote copy will not be
deleted.) Default: false.
- Use to show data after a destructive operation.
- -r, --[no-]recurse
- Use --recurse to delete directories recursively. Default:
- --repo-mode MODE
- The layout of the local chef-repo. Possible values: static,
everything, or hosted_everything. Use static for just
roles, environments, cookbooks, and data bags. By default,
everything and hosted_everything are dynamically selected
depending on the server type. Default: everything /
- -s URL, --server-url URL
- The URL for the Chef server.
- -u USER, --user USER
- The user name used by knife to sign requests made by the API client to the
Chef server. Authentication will fail if the user name does not match the
- -v, --version
- The version of the chef-client.
- -V, --verbose
- Set for more verbose outputs. Use -VV for maximum verbosity.
- -y, --yes
- Use to respond to all confirmation prompts with "Yes". knife
will not ask for confirmation.
- -z, --local-mode
- 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