NAME¶
knife-list - The man page for the knife list subcommand.
The
knife list subcommand is used to view a list of objects on the
server. This subcommand works similar to
knife cookbook list,
knife
data bag list,
knife environment list,
knife node list, and
knife role list, but with a single verb (and a single action).
Syntax
This argument has the following syntax:
$ knife list [PATTERN...] (options)
Options
This subcommand has the following options:
- -1
- Indicates that only one column of results will be shown. Default:
false.
- -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
config.rb.
- --chef-zero-port PORT
- The port on which chef-zero will listen.
- --[no-]color
- Indicates whether colored output will be used.
- --concurrency
- The number of allowed concurrent connections. Default: 10.
- -d
- Indicates that a directory's children will not be shown when a directory
matches a pattern. Default value: false.
- --defaults
- Indicates that Knife will use the default value, instead of asking a user
to provide one.
- --disable-editing
- Indicates that $EDITOR will not be opened; data will be accepted
as-is.
- -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, --flat
- Indicates that a list of file names will be shown. Set to false to
view ls-like output. Default: false.
- -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 server.
- --local
- Indicates that only contents of the local directory will be returned.
Default: false.
- -p
- Indicates that trailing slashes (/) will be shown for directories.
Default: false.
- --print-after
- Indicates that data will be shown after a destructive operation.
- -R
- Indicates that directories will be listed recursively. Default:
false.
- --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 /
hosted_everything.
- -s URL, --server-url URL
- The URL for the server.
- -u USER, --user USER
- The user name used by Knife to sign requests made by the API client to the
server. Authentication will fail if the user name does not match the
private key.
- -v, --version
- The version of the chef-client.
- -V, --verbose
- Set for more verbose outputs. Use -VV for maximum verbosity.
- -y, --yes
- Indicates that the response to all confirmation prompts will be
"Yes" (and that Knife will not ask for confirmation).
- -z, --local-mode
- Indicates that the chef-client will be run in local mode, which allows all
commands that work against the server to also work against the local
chef-repo.
Examples
For example, to view a list of roles on the server:
$ knife list roles/
To view a list of roles and environments on the server:
$ knife list roles/ environments/
To view a list of absolutely everything on the server:
$ knife list -R /
AUTHOR¶
Chef
