diff options
Diffstat (limited to 'distro/common/man/man1/knife-status.1')
| -rw-r--r-- | distro/common/man/man1/knife-status.1 | 234 |
1 files changed, 0 insertions, 234 deletions
diff --git a/distro/common/man/man1/knife-status.1 b/distro/common/man/man1/knife-status.1 deleted file mode 100644 index 038cf3a0f0..0000000000 --- a/distro/common/man/man1/knife-status.1 +++ /dev/null @@ -1,234 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-STATUS" "1" "Chef 12.0" "" "knife status" -.SH NAME -knife-status \- The man page for the knife status subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife status\fP subcommand is used to display a brief summary of the nodes on a Chef server, including the time of the most recent successful chef\-client run. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.TP -.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP -The name of the environment. When this option is added to a command, the command will run only against the named environment. -.TP -.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP -The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&. -.TP -.B \fB\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP -.B \fB\-H\fP, \fB\-\-hide\-healthy\fP -Use to hide nodes on which a chef\-client run has occurred within the previous hour. -.TP -.B \fB\-k KEY\fP, \fB\-\-key KEY\fP -The private key that knife will use to sign requests made by the API client to the Chef server\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fBSEARCH_QUERY\fP -The search query used to identify a a list of items on a Chef server\&. This option uses the same syntax as the \fBsearch\fP sub\-command. -.TP -.B \fB\-r RUN_LIST\fP, \fB\-\-run\-list RUN_LIST\fP -A comma\-separated list of roles and/or recipes to be applied. -.TP -.B \fB\-s\fP, \fB\-\-sort\-reverse\fP -Use to sort a list by last run time, descending. -.TP -.B \fB\-\-server\-url URL\fP -The URL for the Chef server\&. -.TP -.B \fB\-u USER\fP, \fB\-\-user USER\fP -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 private key. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-y\fP, \fB\-\-yes\fP -Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation. -.TP -.B \fB\-z\fP, \fB\-\-local\-mode\fP -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\&. -.UNINDENT -.sp -\fBExamples\fP -.sp -To include run lists in the status, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status \-\-run\-list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -20 hours ago, dev\-vm.chisamore.com, ubuntu 10.04, dev\-vm.chisamore.com, 10.66.44.126, role[lb]. -3 hours ago, i\-225f954f, ubuntu 10.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102, role[web]. -3 hours ago, i\-a45298c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 174.129.127.206, role[web]. -3 hours ago, i\-5272a43f, ubuntu 10.04, ec2\-184\-73\-9\-250.compute\-1.amazonaws.com, 184.73.9.250, role[web]. -3 hours ago, i\-226ca64f, ubuntu 10.04, ec2\-75\-101\-240\-230.compute\-1.amazonaws.com, 75.101.240.230, role[web]. -3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141, role[web]. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the status for nodes on which the chef\-client did not run successfully within the past hour, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status \-\-hide\-healthy -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -1 hour ago, i\-256f884f, ubuntu 12.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102, role[web]. -1 hour ago, i\-a47823c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 184.129.143.111, role[lb]. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To show the status of a subset of nodes that are returned by a specific query, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status "role:web" \-\-run\-list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -3 hours ago, i\-225f954f, ubuntu 10.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102, role[web]. -3 hours ago, i\-a45298c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 174.129.127.206, role[web]. -3 hours ago, i\-5272a43f, ubuntu 10.04, ec2\-184\-73\-9\-250.compute\-1.amazonaws.com, 184.73.9.250, role[web]. -3 hours ago, i\-226ca64f, ubuntu 10.04, ec2\-75\-101\-240\-230.compute\-1.amazonaws.com, 75.101.240.230, role[web]. -3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141, role[web]. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view the status of all nodes in the organization, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife status -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -20 hours ago, dev\-vm.chisamore.com, ubuntu 10.04, dev\-vm.chisamore.com, 10.66.44.126 -3 hours ago, i\-225f954f, ubuntu 10.04, ec2\-67\-202\-63\-102.compute\-1.amazonaws.com, 67.202.63.102 -3 hours ago, i\-a45298c9, ubuntu 10.04, ec2\-174\-129\-127\-206.compute\-1.amazonaws.com, 174.129.127.206 -3 hours ago, i\-5272a43f, ubuntu 10.04, ec2\-184\-73\-9\-250.compute\-1.amazonaws.com, 184.73.9.250 -3 hours ago, i\-226ca64f, ubuntu 10.04, ec2\-75\-101\-240\-230.compute\-1.amazonaws.com, 75.101.240.230 -3 hours ago, i\-f65c969b, ubuntu 10.04, ec2\-184\-73\-60\-141.compute\-1.amazonaws.com, 184.73.60.141 -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. |