chef 13.11.3 → 13.12.3

data/distro/common/man/man1/knife-exec.1

@@ -1,362 +0,0 @@
-.\" Man page generated from reStructuredText.
-.
-.TH "KNIFE-EXEC" "1" "Chef 12.0" "" "knife exec"
-.SH NAME
-knife-exec \- The man page for the knife exec 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 exec\fP subcommand uses the knife configuration file to execute Ruby scripts in the context of a fully configured chef\-client\&. This subcommand is most often used to run scripts that will only access Chef server one time (or otherwise very infrequently). Use this subcommand any time that an operation does not warrant full usage of the knife subcommand library.
-.sp
-\fBAuthenticated API Requests\fP
-.sp
-The \fBknife exec\fP subcommand can be used to make authenticated API requests to the Chef server using the following methods:
-.TS
-center;
-|l|l|.
-_
-T{
-Method
-T}	T{
-Description
-T}
-_
-T{
-\fBapi.delete\fP
-T}	T{
-Use to delete an object from the Chef server\&.
-T}
-_
-T{
-\fBapi.get\fP
-T}	T{
-Use to get the details of an object on the Chef server\&.
-T}
-_
-T{
-\fBapi.post\fP
-T}	T{
-Use to add an object to the Chef server\&.
-T}
-_
-T{
-\fBapi.put\fP
-T}	T{
-Use to update an object on the Chef server\&.
-T}
-_
-.TE
-.sp
-These methods are used with the \fB\-E\fP option, which executes that string locally on the workstation using chef\-shell\&. These methods have the following syntax:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec \-E \(aqapi.method(/endpoint)\(aq
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-where:
-.INDENT 0.0
-.IP \(bu 2
-\fBapi.method\fP is the corresponding authentication method \-\-\- \fBapi.delete\fP, \fBapi.get\fP, \fBapi.post\fP, or \fBapi.put\fP
-.IP \(bu 2
-\fB/endpoint\fP is an endpoint in the Chef server API
-.UNINDENT
-.sp
-For example, to get the data for a node named "Example_Node":
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec \-E \(aqputs api.get("/nodes/Example_Node")\(aq
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-and to ensure that the output is visible in the console, add the \fBputs\fP in front of the API authorization request:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec \-E \(aqputs api.get("/nodes/Example_Node")\(aq
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-where \fBputs\fP is the shorter version of the \fB$stdout.puts\fP predefined variable in Ruby\&.
-.sp
-The following example shows how to add a client named "IBM305RAMAC" and the \fB/clients\fP endpoint, and then return the private key for that user in the console:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ client_desc = {
-    "name"  => "IBM305RAMAC",
-    "admin" => false
-  }
-
-  new_client = api.post("/clients", client_desc)
-  puts new_client["private_key"]
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-\fBSyntax\fP
-.sp
-This subcommand has the following syntax:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec SCRIPT (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 CODE\fP, \fB\-\-exec CODE\fP
-A string of code that will be executed.
-.TP
-.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
-The $EDITOR that is used for all interactive commands.
-.TP
-.B \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\-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\-p PATH:PATH\fP, \fB\-\-script\-path PATH:PATH\fP
-A colon\-separated path at which Ruby scripts are located.
-.TP
-.B \fB\-\-print\-after\fP
-Use to show data after a destructive operation.
-.TP
-.B \fB\-s URL\fP, \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
-There are three ways to use \fBknife exec\fP to run Ruby script files. For example:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec /path/to/script_file
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-or:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec \-E \(aqRUBY CODE\(aq
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-or:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec
-RUBY CODE
-^D
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-To check the status of knife using a Ruby script named \fBstatus.rb\fP (which looks like):
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-printf "%\-5s %\-12s %\-8s %s\en", "Check In", "Name", "Ruby", "Recipes"
-nodes.all do |n|
-   checkin = Time.at(n[\(aqohai_time\(aq]).strftime("%F %R")
-   rubyver = n[\(aqlanguages\(aq][\(aqruby\(aq][\(aqversion\(aq]
-   recipes = n.run_list.expand(_default).recipes.join(", ")
-   printf "%\-20s %\-12s %\-8s %s\en", checkin, n.name, rubyver, recipes
-end
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-and is located in a directory named \fBscripts/\fP, enter:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec scripts/status.rb
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-To show the available free memory for all nodes, enter:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec \-E \(aqnodes.all {|n| puts "#{n.name} has #{n.memory.total} free memory"}\(aq
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-To list all of the available search indexes, enter:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife exec \-E \(aqputs api.get("search").keys\(aq
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-To query a node for multiple attributes using a Ruby script named \fBsearch_attributes.rb\fP (which looks like):
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-% cat scripts/search_attributes.rb
-query = ARGV[2]
-attributes = ARGV[3].split(",")
-puts "Your query: #{query}"
-puts "Your attributes: #{attributes.join(" ")}"
-results = {}
-search(:node, query) do |n|
-   results[n.name] = {}
-   attributes.each {|a| results[n.name][a] = n[a]}
-end
-
-puts results
-exit 0
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-enter:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-% knife exec scripts/search_attributes.rb "hostname:test_system" ipaddress,fqdn
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-to return something like:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-Your query: hostname:test_system
-Your attributes: ipaddress fqdn
-{"test_system.example.com"=>{"ipaddress"=>"10.1.1.200", "fqdn"=>"test_system.example.com"}}
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-Chef
-.\" Generated by docutils manpage writer.
-.

data/distro/common/man/man1/knife-index-rebuild.1

@@ -1,63 +0,0 @@
-.\" Man page generated from reStructuredText.
-.
-.TH "KNIFE-INDEX-REBUILD" "1" "Chef 12.0" "" "knife index rebuild"
-.SH NAME
-knife-index-rebuild \- The man page for the knife index rebuild 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 index rebuild\fP subcommand is used to rebuild the search indexes for the open source Chef server\&. This operation is destructive and may take some time.
-.sp
-\fBNOTE:\fP
-.INDENT 0.0
-.INDENT 3.5
-This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef\&.
-.UNINDENT
-.UNINDENT
-.sp
-\fBSyntax\fP
-.sp
-This subcommand has the following syntax:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife index rebuild
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-\fBOptions\fP
-.sp
-This command does not have any specific options.
-.SH AUTHOR
-Chef
-.\" Generated by docutils manpage writer.
-.

data/distro/common/man/man1/knife-list.1

@@ -1,174 +0,0 @@
-.\" Man page generated from reStructuredText.
-.
-.TH "KNIFE-LIST" "1" "Chef 12.0" "" "knife list"
-.SH NAME
-knife-list \- The man page for the knife list 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 list\fP subcommand is used to view a list of objects on the Chef server\&. This subcommand works similar to \fBknife cookbook list\fP, \fBknife data bag list\fP, \fBknife environment list\fP, \fBknife node list\fP, and \fBknife role list\fP, but with a single verb (and a single action).
-.sp
-\fBSyntax\fP
-.sp
-This subcommand has the following syntax:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife list [PATTERN...] (options)
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-\fBOptions\fP
-.sp
-This subcommand has the following options:
-.INDENT 0.0
-.TP
-.B \fB\-1\fP
-Use to show only one column of results. Default: \fBfalse\fP\&.
-.TP
-.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
-The configuration file to use.
-.TP
-.B \fB\-\-chef\-repo\-path PATH\fP
-The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb.
-.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\-\-concurrency\fP
-The number of allowed concurrent connections. Default: \fB10\fP\&.
-.TP
-.B \fB\-d\fP
-Use to prevent a directory\(aqs children from showing when a directory matches a pattern. Default value: \fBfalse\fP\&.
-.TP
-.B \fB\-\-defaults\fP
-Use to have knife use the default value instead of asking a user to provide one.
-.TP
-.B \fB\-\-disable\-editing\fP
-Use to prevent the $EDITOR from being opened and to accept data as\-is.
-.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\fP, \fB\-\-flat\fP
-Use to show a list of file names. Set to \fBfalse\fP to view ls\-like output. Default: \fBfalse\fP\&.
-.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 Chef server\&.
-.TP
-.B \fB\-\-local\fP
-Use to return only the contents of the local directory. Default: \fBfalse\fP\&.
-.TP
-.B \fB\-p\fP
-Use to show directories with trailing slashes (/). Default: \fBfalse\fP\&.
-.TP
-.B \fB\-\-print\-after\fP
-Use to show data after a destructive operation.
-.TP
-.B \fB\-R\fP
-Use to list directories recursively. Default: \fBfalse\fP\&.
-.TP
-.B \fB\-\-repo\-mode MODE\fP
-The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&.
-.TP
-.B \fB\-s URL\fP, \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
-For example, to view a list of roles on the Chef server:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife list roles/
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-To view a list of roles and environments on the Chef server:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife list roles/ environments/
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-To view a list of absolutely everything on the Chef server:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ knife list \-R /
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-Chef
-.\" Generated by docutils manpage writer.
-.