Module: Wazuh::Api::Endpoints::Experimental

Included in:
Wazuh::Api::Endpoints, V4::Experimental
Defined in:
lib/wazuh/api/endpoints/experimental.rb

Instance Method Summary collapse

Instance Method Details

#experimental_ciscat_results(options = {}) ⇒ Object

Get CIS-CAT results Returns the agent’s ciscat results info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id) —

    ID to agent

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :benchmark (benchmark)
  • :profile (profile)
  • :pass (pass)
  • :fail (fail)
  • :error (error)
  • :notchecked (notchecked)
  • :unkown (unknown)
  • :score (score)

See Also:



303
304
305
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 303

def experimental_ciscat_results(options = {})
  offset_request('get', '/experimental/ciscat/results', options)
end

#experimental_clear_syscheck_database ⇒ Object

Clear syscheck database Clears the syscheck database for all agents.



12
13
14
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 12

def experimental_clear_syscheck_database
  delete '/experimental/syscheck'
end

#experimental_hardware(options = {}) ⇒ Object

Get hardware info of all agents Returns the agent’s hardware info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id) —

    Agent ID

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :ram_free (ram_free) —

    Filters by ram_free.

  • :ram_total (ram_total) —

    Filters by ram_total.

  • :cpu_cores (cpu_cores) —

    Filters by cpu_cores.

  • :cpu_mhz (cpu_mhz) —

    Filters by cpu_mhz.

  • :cpu_name (cpu_name) —

    Filters by cpu_name.

  • :board_serial (board_serial) —

    Filters by board_serial.

See Also:



44
45
46
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 44

def experimental_hardware(options = {})
  offset_request('get', '/experimental/syscollector/hardware', options)
end

#experimental_netaddr(options = {}) ⇒ Object

Get network address info of all agents Returns the agent’s network address info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id)
  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :iface (iface) —

    Filters by interface name.

  • :proto (proto) —

    Filters by proto.

  • :address (address) —

    Filters by address.

  • :broadcast (broadcast) —

    Filters by broadcast.

  • :netmask (netmask) —

    Filters by netmask.

See Also:



73
74
75
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 73

def experimental_netaddr(options = {})
  offset_request('get', '/experimental/syscollector/netaddr', options)
end

#experimental_netiface(options = {}) ⇒ Object

Get network interface info of all agents Returns the agent’s network interface info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :name (name) —

    Filters by name.

  • :adapter (adapter) —

    Filters by adapter.

  • :type (type) —

    Filters by type.

  • :state (state) —

    Filters by state.

  • :mtu (mtu) —

    Filters by mtu.

  • :tx_packets (tx_packets)
  • :rx_packets (rx_packets)
  • :tx_bytes (tx_bytes)
  • :rx_bytes (rx_bytes)
  • :tx_errors (tx_errors)
  • :rx_errors (rx_errors)
  • :tx_dropped (tx_dropped)
  • :rx_dropped (rx_dropped)

See Also:



109
110
111
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 109

def experimental_netiface(options = {})
  offset_request('get', '/experimental/syscollector/netiface', options)
end

#experimental_netproto(options = {}) ⇒ Object

Get network protocol info of all agents Returns the agent’s network protocol info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id)
  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :iface (iface) —

    Filters by interface name.

  • :type (type) —

    Filters by type.

  • :gateway (gateway) —

    Filters by gateway.

  • :dhcp (dhcp) —

    Filters by dhcp.

See Also:



136
137
138
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 136

def experimental_netproto(options = {})
  offset_request('get', '/experimental/syscollector/netproto', options)
end

#experimental_os(options = {}) ⇒ Object

Get os info of all agents Returns the agent’s os info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id) —

    ID to agent

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :offset (offset) —

    First element to return in the collection.

  • :select (select) —

    List of selected fields separated by commas.

  • :os_name (os_name) —

    Filters by os_name.

  • :architecture (architecture) —

    Filters by architecture.

  • :os_version (os_version) —

    Filters by os_version.

  • :version (version) —

    Filters by version.

  • :release (release) —

    Filters by release.

See Also:



166
167
168
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 166

def experimental_os(options = {})
  offset_request('get', '/experimentalsyscollector/os', options)
end

#experimental_packages(options = {}) ⇒ Object

Get packages info of all agents Returns the agent’s packages info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id)
  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :vendor (vendor) —

    Filters by vendor.

  • :name (name) —

    Filters by name.

  • :architecture (architecture) —

    Filters by architecture.

  • :format (format) —

    Filters by format.

  • :version (version) —

    Filters by format.

See Also:



195
196
197
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 195

def experimental_packages(options = {})
  offset_request('get', '/experimental/syscollector/packages', options)
end

#experimental_ports(options = {}) ⇒ Object

Get ports info of all agents Returns the agent’s ports info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id)
  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :pid (pid) —

    Filters by pid.

  • :protocol (protocol) —

    Filters by protocol.

  • :local_ip (local_ip) —

    Filters by local_ip.

  • :local_port (local_port) —

    Filters by local_port.

  • :remote_ip (remote_ip) —

    Filters by remote_ip.

  • :tx_queue (tx_queue) —

    Filters by tx_queue.

  • :state (state) —

    Filters by state.

See Also:



228
229
230
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 228

def experimental_ports(options = {})
  offset_request('get', '/experimental/syscollector/ports', options)
end

#experimental_processes(options = {}) ⇒ Object

Get processes info of all agents Returns the agent’s processes info.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :agent_id (agent_id)
  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :select (select) —

    List of selected fields separated by commas.

  • :pid (pid) —

    Filters by pid.

  • :state (state) —

    Filters by process state.

  • :ppid (ppid) —

    Filters by process parent pid.

  • :egroup (egroup) —

    Filters by process egroup.

  • :euser (euser) —

    Filters by process euser.

  • :fgroup (fgroup) —

    Filters by process fgroup.

  • :name (name) —

    Filters by process name.

  • :nlwp (nlwp) —

    Filters by process nlwp.

  • :pgrp (pgrp) —

    Filters by process pgrp.

  • :priority (priority) —

    Filters by process priority.

  • :rgroup (rgroup) —

    Filters by process rgroup.

  • :ruser (ruser) —

    Filters by process ruser.

  • :sgroup (sgroup) —

    Filters by process sgroup.

  • :suser (suser) —

    Filters by process suser.

See Also:



275
276
277
 
# File 'lib/wazuh/api/endpoints/experimental.rb', line 275

def experimental_processes(options = {})
  offset_request('get', '/experimental/syscollector/processes', options)
end