Skip to content

Commit

Permalink
Updated 2.x DSL Action File Transfer Download (markdown)
Browse files Browse the repository at this point in the history
  • Loading branch information
jmonteiro committed Nov 22, 2011
1 parent c5cba60 commit 7d1978e
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions 2.x-DSL-Action-File-Transfer-Download.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ The options hash can be used to modify the default behavior of download. Recogni
* `:only` Specifies a condition limiting which hosts will be selected to receive the download. This should refer to values set in the role. For example, if a role is defined with :primary => true, then you could select only hosts with that setting by specifying `:only => { :primary => true }`.
* `:except` Specifies a condition limiting which hosts will be selected to receive the download. This is the inverse of :only (hosts that do not match the condition will be selected).
* `:once` If true, only the first matching server will be selected. The default is false (all matching servers will be selected).
* `:recursive` If true, a recursive download will be made. Use it with `:via => :scp`. The default is false.
* `:max_hosts` Specifies the maximum number of hosts that should be selected at a time. If this value is less than the number of hosts that are selected to receive the download, then the hosts will be downloaded to in groups of max_hosts. The default is nil, which indicates that there is no maximum host limit. **Warning: this setting will probably be removed in a future release.**

Note that the options are also passed directly through to the `Net::SFTP` (for `:sftp`) and `Net::SCP` (for `:scp`) libraries. Options exposed by those libraries are documented in those libraries. (For `SFTP`, see the `Net::SFTP::Operations::download` module. For `SCP`, see the `Net::SCP#download` method.)
Expand Down

0 comments on commit 7d1978e

Please sign in to comment.