Module: Capistrano::Configuration::Servers

Module | Capistrano::Configuration::Servers
In: | lib/capistrano/configuration/servers.rb

### Methods

build_list filter_server_list find_servers find_servers_for_task role_list_from server_list_from

### Public Instance methods

find_servers(options={})

Attempts to find all defined servers that match the given criteria. The options hash may include a :hosts option (which should specify an array of host names or ServerDefinition instances), a :roles option (specifying an array of roles), an :only option (specifying a hash of key/value pairs that any matching server must match), an :exception option (like :only, but the inverse), and a :skip_hostfilter option to ignore the HOSTFILTER environment variable described below.

Additionally, if the HOSTS environment variable is set, it will take precedence over any other options. Similarly, the ROLES environment variable will take precedence over other options. If both HOSTS and ROLES are given, HOSTS wins.

Yet additionally, if the HOSTFILTER environment variable is set, it will limit the result to hosts found in that (comma-separated) list.

Usage:

      # return all known servers
      servers = find_servers

      # find all servers in the app role that are not exempted from
      # deployment
      servers = find_servers :roles => :app,
                   :except => { :no_release => true }

      # returns the given hosts, translated to ServerDefinition objects
      servers = find_servers :hosts => "jamis@example.host.com"

find_servers_for_task(task, options={})

Identifies all servers that the given task should be executed on. The options hash accepts the same arguments as find_servers, and any preexisting options there will take precedence over the options in the task.

### Protected Instance methods

build_list(list)
filter_server_list(servers)
role_list_from(roles)
server_list_from(hosts)

[Validate]