Method: Falcon::RealTimeResponseApi#r_tr_init_session

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

#r_tr_init_session(body, opts = {}) ⇒ DomainInitResponseWrapper

Initialize a new session with the RTR cloud.

Parameters:

  • body (DomainInitRequest) —

    **`device_id`** The host agent ID to initialize the RTR session on. RTR will retrieve an existing session for the calling user on this host **`queue_offline`** If we should queue this session if the host is offline. Any commands run against an offline-queued session will be queued up and executed when the host comes online.

  • 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’)

Returns:



1162
1163
1164
1165
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1162

def r_tr_init_session(body, opts = {})
  data, _status_code, _headers = r_tr_init_session_with_http_info(body, opts)
  data
end