diff options
Diffstat (limited to 'distro/common/man/man1/knife-status.1')
| -rw-r--r-- | distro/common/man/man1/knife-status.1 | 228 |
1 files changed, 24 insertions, 204 deletions
diff --git a/distro/common/man/man1/knife-status.1 b/distro/common/man/man1/knife-status.1 index b61f877b71..9b040c22ca 100644 --- a/distro/common/man/man1/knife-status.1 +++ b/distro/common/man/man1/knife-status.1 @@ -1,209 +1,29 @@ -.TH "KNIFE-STATUS" "1" "Chef 11.8" "" "knife status" -.SH NAME -knife-status \- The man page for the knife status subcommand. +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.nr rst2man-indent-level 0 +.TH "KNIFE\-STATUS" "1" "October 2013" "Chef 11.10.0.alpha.0" "Chef Manual" . -.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 -.. -.\" Man page generated from reStructuredText. +.SH "NAME" +\fBknife\-status\fR \- Display status information for the nodes in your infrastructure +. +.SH "SYNOPSIS" +\fBknife\fR \fBstatus\fR \fI(options)\fR . -.sp -The \fBknife status\fP subcommand is used to display a brief summary of the nodes on a server, including the time of the most recent successful chef\-client run. -.sp -\fBCommon Options\fP -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that colored output will be used. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. -.TP -.B \fB\-\-defaults\fP -Indicates that Knife will 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 FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.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\-k KEY\fP, \fB\-\-key KEY\fP -The private key that Knife will use to sign requests made by the API client to the server. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. -.TP -.B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the 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 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 -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife status (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fBQUERY\fP -The search query used to identify a a list of items on a server. This option uses the same syntax as the \fBsearch\fP sub\-command. -.TP -.B \fB\-H\fP, \fB\-\-hide\-healthy\fP -Indicates that nodes on which a chef\-client run has occurred within the previous hour will be hidden. -.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 -Indicates that the list will be sorted by last run time, descending. -.UNINDENT -.sp -\fBExamples\fP -.sp -To include run lists in the status, enter: -.sp -.nf -.ft C -$ knife status \-\-run\-list -.ft P -.fi -.sp -to return something like: -.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 -.sp -To show only the status nodes on which the chef\-client ran within the past hour, enter: -.sp -.nf -.ft C -$ knife status \-\-hide\-healthy -.ft P -.fi -.sp -to return something like: -.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 -.sp -To show the status of a subset of nodes that are returned by a specific query, enter: -.sp -.nf -.ft C -$ knife status "role:web" \-\-run\-list -.ft P -.fi -.sp -to return something like: -.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 -.sp -To view the status of all nodes in the organization, enter: -.sp -.nf -.ft C -$ knife status -.ft P -.fi -.sp -to return something like: -.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 -.SH AUTHOR -Opscode -.SH COPYRIGHT -This work is licensed under a Creative Commons Attribution 3.0 Unported License -.\" Generated by docutils manpage writer. +\fB\-r\fR, \fB\-\-run\-list RUN_LIST\fR +Show the run list +. +.SH "DESCRIPTION" +The \fIstatus\fR sub\-command searches the Chef Server for all nodes and displays information about the last time the node checked into the server and executed a \fBnode\.save\fR\. The fields displayed are the relative checkin time, the node name, it\'s operating system platform and version, the fully\-qualified domain name and the default IP address\. If the \fB\-r\fR option is given, the node\'s run list will also be displayed\. Note that depending on the configuration of the nodes, the FQDN and IP displayed may not be publicly reachable\. +. +.SH "SEE ALSO" +\fBknife\-search\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. . +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR |