Method: Falcon::RealTimeResponseApi#batch_get_cmd

Defined in:
lib/crimson-falcon/api/real_time_response_api.rb

#batch_get_cmd(body, opts = {}) ⇒ DomainBatchGetCommandResponse

Batch executes ‘get` command across hosts to retrieve files. After this call is made `GET /real-time-response/combined/batch-get-command/v1` is used to query for the results.

Parameters:

  • body (DomainBatchGetCommandRequest) —

    **`batch_id`** Batch ID to execute the command on. Received from `/real-time-response/combined/batch-init-session/v1`. **`file_path`** Full path to the file that is to be retrieved from each host in the batch. **`optional_hosts`** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. (default to ‘tiny bit less than overall request timeout’)

Returns:



196
197
198
199
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 196

def batch_get_cmd(body, opts = {})
  data, _status_code, _headers = batch_get_cmd_with_http_info(body, opts)
  data
end