osquery 5.13.1, your OS as a high-performance relational database
Usage: osqueryi [OPTION]... [SQL STATEMENT]
osquery command line flags:
--flagfile PATH Line-delimited file of additional flags
--D Run as a daemon process
--S Run as a shell process
--alarm_timeout VALUE Seconds to allow for shutdown. Minimum is 10
--aws_enforce_fips Whether to enforce AWS FIPS endpoints for all services or not
--carver_block_size VALUE Size of blocks used for POSTing data back to remote endpoints
--carver_compression Compress archives using zstd prior to upload (default false)
--carver_continue_endpoint VALUE TLS/HTTPS endpoint that receives carved content after session creation
--carver_disable_function Disable the osquery file carver function (default true)
--carver_expiry VALUE Seconds to store successful carve result metadata (in carves table)
--carver_start_endpoint VALUE TLS/HTTPS init endpoint for forensic carver
--config_accelerated_refresh VALUE Interval to wait if reading a configuration fails
--config_check Check the format of an osquery config and exit
--config_dump Dump the contents of the configuration, then exit
--config_enable_backup Backup config and use it when refresh fails
--config_path VALUE Path to JSON config file
--config_plugin VALUE Config plugin name
--config_refresh VALUE Optional interval in seconds to re-read configuration
--config_tls_endpoint VALUE TLS/HTTPS endpoint for config retrieval
--config_tls_max_attempts VALUE Number of attempts to retry a TLS config request
--daemonize Attempt to daemonize (POSIX only)
--database_dump Dump the contents of the backing store
--database_path VALUE If using a disk-based backing store, specify a path
--disable_carver Disable the osquery file carver (default true)
--disable_enrollment Disable enrollment functions on related config/logger plugins
--disable_extensions Disable extension API
--disable_reenrollment Disable re-enrollment attempts if related plugins return invalid
--disable_tables VALUE Comma-delimited list of table names to be disabled
--disable_watchdog Disable userland watchdog process
--enable_extensions_watchdog Enable userland watchdog for extensions processes
--enable_tables VALUE Comma-delimited list of table names to be enabled
--enable_watchdog_debug Enable logging of CPU and memory footprint of watched processes
--enroll_always On startup, send a new enrollment request
--enroll_secret_env VALUE Name of environment variable holding enrollment-auth secret
--enroll_secret_path VALUE Path to an optional client enrollment-auth secret
--enroll_tls_endpoint VALUE TLS/HTTPS endpoint for client enrollment
--experiments_linuxevents_circular_buffer_size VALUE Size of the circular buffer used by tables to store events
--experiments_linuxevents_perf_output_size VALUE Perf ouput size (must be a power of two)
--extensions_autoload VALUE Optional path to a list of autoloaded & managed extensions
--extensions_interval VALUE Seconds delay between connectivity checks
--extensions_require VALUE Comma-separated list of required extensions
--extensions_socket VALUE Path to the extensions UNIX domain socket
--extensions_timeout VALUE Seconds to wait for autoloaded extensions
--force Force osqueryd to kill previously-running daemons
--install Install osqueryd as a service
--keep_container_worker_open Keep the container worker running to be reused instead of closing it after each query
--logger_mode VALUE Octal mode for log files (default '0640')
--logger_plugin VALUE Logger plugin name
--logger_stderr Write status logs to stderr
--logtostderr Log messages to stderr in addition to the logger plugin(s)
--pidfile VALUE Path to the daemon pidfile mutex
--proxy_hostname VALUE Optional HTTP proxy hostname
--stderrthreshold VALUE Stderr log level threshold
--tls_client_cert VALUE Optional path to a TLS client-auth PEM certificate
--tls_client_key VALUE Optional path to a TLS client-auth PEM private key
--tls_enroll_max_attempts VALUE The total number of attempts that will be made to the enroll endpoint if a request fails, 0 for infinite
--tls_enroll_max_interval VALUE Maximum wait time in seconds between enroll retry attempts
--tls_hostname VALUE TLS/HTTPS hostname for Config, Logger, and Enroll plugins
--tls_server_certs VALUE Optional path to a TLS server PEM certificate(s) bundle
--tls_session_reuse Reuse TLS session sockets
--tls_session_timeout VALUE TLS session keep alive timeout in seconds
--uninstall Uninstall osqueryd as a service
--watchdog_delay VALUE Initial delay in seconds before watchdog starts
--watchdog_forced_shutdown_delay VALUE Seconds that the watchdog will wait to do a forced shutdown after a graceful shutdown request, when a resource limit is hit
--watchdog_latency_limit VALUE Override watchdog profile CPU utilization latency limit
--watchdog_level VALUE Performance limit level (0=normal, 1=restrictive, -1=off)
--watchdog_memory_limit VALUE Override watchdog profile memory limit (e.g., 300, for 300MB)
--watchdog_utilization_limit VALUE Override watchdog profile CPU utilization limit
osquery configuration options (set by config or CLI flags):
--audit_allow_accept_socket_events Include rows for accept socket events
--audit_allow_apparmor_events Allow the publisher to process audit events
--audit_allow_config Allow the audit publisher to change auditing configuration
--audit_allow_failed_socket_events Include rows for socket events that have failed
--audit_allow_fim_events Allow the audit publisher to install filesystem-related rules
--audit_allow_fork_process_events Allow the audit publisher to install process event monitoring rules to capture fork/vfork/clone system calls
--audit_allow_kill_process_events Allow the audit publisher to install process event monitoring rules to capture kill/tkill/tgkill system calls
--audit_allow_null_accept_socket_events Allow non-blocking accept() syscalls that returned EAGAIN/EWOULDBLOCK
--audit_allow_process_events Allow the audit publisher to install process-related rules
--audit_allow_seccomp_events Allow the audit publisher to process seccomp events
--audit_allow_selinux_events Allow the audit publisher to process audit events
--audit_allow_sockets Allow the audit publisher to install socket-related rules
--audit_allow_user_events Allow the audit publisher to install user-related rules
--audit_backlog_limit VALUE The audit backlog limit
--audit_backlog_wait_time VALUE The audit backlog wait time
--audit_force_reconfigure Configure the audit subsystem from scratch
--audit_force_unconfigure Always uninstall all rules, regardless of whether they were already installed or not
--audit_persist Attempt to retain control of audit
--augeas_lenses VALUE Directory that contains augeas lenses files
--aws_access_key_id VALUE AWS access key ID
--aws_debug Enable AWS SDK debug logging
--aws_disable_imdsv1_fallback Whether to disable support for IMDSv1 and fail if an IMDSv2 token could not be retrieved
--aws_enable_proxy Enable proxying of HTTP/HTTPS requests in AWS client config
--aws_firehose_endpoint VALUE Custom Firehose endpoint
--aws_firehose_period VALUE Seconds between flushing logs to Firehose (default 10)
--aws_firehose_region VALUE Region to use for Firehose instead of the default. This takes precedence over the aws_region flag
--aws_firehose_stream VALUE Name of Firehose stream for logging
--aws_imdsv2_request_attempts VALUE How many attempts to do at requesting an IMDSv2 token
--aws_imdsv2_request_interval VALUE Base seconds to wait between attempts at requesting an IMDSv2 token. Scales quadratically with the number of attempts
--aws_kinesis_disable_log_status Disable status logs processing
--aws_kinesis_endpoint VALUE Custom Kinesis endpoint
--aws_kinesis_period VALUE Seconds between flushing logs to Kinesis (default 10)
--aws_kinesis_random_partition_key Enable random kinesis partition keys
--aws_kinesis_region VALUE Region to use for Kinesis instead of the default. This takes precedence over the aws_region flag
--aws_kinesis_stream VALUE Name of Kinesis stream for logging
--aws_profile_name VALUE AWS profile for authentication and region configuration
--aws_proxy_host VALUE Proxy host for use in AWS client config
--aws_proxy_password VALUE Proxy password for use in AWS client config
--aws_proxy_port VALUE Proxy port for use in AWS client config
--aws_proxy_scheme VALUE Proxy HTTP scheme for use in AWS client config (http or https, default https)
--aws_proxy_username VALUE Proxy username for use in AWS client config
--aws_region VALUE Default AWS region for all services
--aws_secret_access_key VALUE AWS secret access key
--aws_session_token VALUE AWS STS session token
--aws_sts_arn_role VALUE AWS STS ARN role
--aws_sts_region VALUE AWS STS region
--aws_sts_session_name VALUE AWS STS session name
--aws_sts_timeout VALUE AWS STS assume role credential validity in seconds (default 3600)
--bpf_buffer_storage_size VALUE How many slots each buffer storage should have
--bpf_perf_event_array_exp VALUE Size of the perf event array as a power of 2
--buffered_log_max VALUE Maximum number of logs in buffered output plugins (0 = unlimited)
--decorations_top_level Add decorators as top level JSON object members
--disable_audit Disable receiving events from the audit subsystem
--disable_caching Disable scheduled query caching
--disable_database Disable the persistent RocksDB storage
--disable_decorators Disable log result decoration
--disable_distributed Disable distributed queries (default true)
--disable_events Disable osquery publish/subscribe system
--disable_hash_cache Cache calculated file hashes, re-calculate only if inode times change
--disable_logging Disable ERROR/INFO logging
--disable_memory Disable physical memory reads
--distributed_denylist_duration VALUE Seconds to denylist distributed queries (default 1 day)
--distributed_interval VALUE Seconds between polling for new queries (default 60)
--distributed_loginfo Log the running distributed queries name at INFO level
--distributed_plugin VALUE Distributed plugin name
--distributed_tls_max_attempts VALUE Number of times to attempt a request
--distributed_tls_read_endpoint VALUE TLS/HTTPS endpoint for distributed query retrieval
--distributed_tls_write_endpoint VALUE TLS/HTTPS endpoint for distributed query results
--docker_socket VALUE Docker UNIX domain socket path
--enable_bpf_events Enables the bpf_process_events publisher
--enable_file_events Enables the file_events publisher
--enable_foreign Enable no-op foreign virtual tables
--enable_numeric_monitoring Enable numeric monitoring system
--enable_syslog Enable the syslog ingestion event publisher
--ephemeral Skip pidfile and database state checks
--events_expiry VALUE Timeout to expire event subscriber results
--events_max VALUE Maximum number of event batches per type to buffer
--events_optimize Optimize subscriber select queries (scheduler only)
--experiment_list VALUE Comma-separated list of experiments to enable
--extensions_default_index Enable INDEX on all extension table columns (default true)
--hardware_disabled_types VALUE List of disabled hardware event types
--hash_cache_max VALUE Size of LRU file hash cache
--host_identifier VALUE Field used to identify the host running osquery (hostname, uuid, instance, ephemeral, specified)
--ignore_table_exceptions Ignore exceptions thrown by tables. osquery and extensions default to true.
--logger_event_type Log scheduled results as events
--logger_kafka_acks VALUE The number of acknowledgments the leader has to receive (0, 1, 'all')
--logger_kafka_brokers VALUE Bootstrap broker(s) as a comma-separated list of host or host:port (default port 9092)
--logger_kafka_compression VALUE Compression codec to use for compressing message sets ('none' or 'gzip')
--logger_kafka_topic VALUE Kafka topic to publish logs under
--logger_min_status VALUE Minimum level for status log recording
--logger_min_stderr VALUE Minimum level for statuses written to stderr
--logger_numerics Use numeric JSON syntax for numeric values
--logger_path VALUE Directory path for ERROR/WARN/INFO and results logging
--logger_rotate Use filesystem log rotation
--logger_rotate_max_files VALUE Max number of files to keep in rotation
--logger_rotate_size VALUE Size for each filesystem log in bytes
--logger_snapshot_event_type Log scheduled snapshot results as events
--logger_syslog_facility VALUE Syslog facility for status and results logs (0-23, default 19)
--logger_syslog_prepend_cee Prepend @cee: tag to logged JSON messages
--logger_tls_backoff_max VALUE Maximum seconds to wait before flushing logs over TLS/HTTPS. Backoff kicks in when regular flush fails. Should be a multiple of logger_tls_period. 0 disables backoff
--logger_tls_compress GZip compress TLS/HTTPS request body
--logger_tls_endpoint VALUE TLS/HTTPS endpoint for results logging
--logger_tls_max_lines VALUE Max number of logs to send per period
--logger_tls_max_linesize VALUE Max size in bytes allowed per log line
--logger_tls_period VALUE Seconds between flushing logs over TLS/HTTPS
--lxd_socket VALUE LXD UNIX domain socket path
--malloc_trim_threshold VALUE Memory threshold in MB used to decide when a malloc_trim will be called to reduce the retained memory (Linux only)
--nullvalue VALUE Set string for NULL values, default ''
--numeric_monitoring_filesystem_path VALUE File to dump numeric monitoring records one per line. The format of the line is <PATH><TAB><VALUE><TAB><TIMESTAMP>.
--numeric_monitoring_plugins VALUE Comma separated numeric monitoring plugins names
--numeric_monitoring_pre_aggregation_time VALUE Time period in seconds for numeric monitoring pre-aggregation buffer.
--pack_delimiter VALUE Delimiter for pack and query names
--pack_refresh_interval VALUE Cache expiration for a packs discovery queries
--read_max VALUE Maximum file read size
--schedule_default_interval VALUE Query interval to use if none is provided
--schedule_epoch VALUE Epoch for scheduled queries
--schedule_lognames Log the running scheduled query name at INFO level
--schedule_max_drift VALUE Max time drift in seconds
--schedule_reload VALUE Interval in seconds to reload database arenas
--schedule_splay_percent VALUE Percent to splay config times
--schedule_timeout VALUE Limit the schedule to a duration in seconds, 0 for no limit
--specified_identifier VALUE Field used to specify the host_identifier when set to "specified"
--syslog_events_expiry VALUE Timeout to expire event subscriber results
--syslog_events_max VALUE Maximum number of events per type to buffer
--syslog_pipe_path VALUE Path to the named pipe used for forwarding rsyslog events
--syslog_rate_limit VALUE Maximum number of logs to ingest per run (~200ms between runs)
--table_delay VALUE Add an optional millisecond delay between table scans
--thrift_string_size_limit VALUE Sets the maximum string size allowed in a thrift message, use 0 for unlimited
--thrift_timeout VALUE Timeout for thrift socket operations
--thrift_verbose Enable the thrift log handler
--tls_disable_status_log Disable sending status logs
--verbose Enable verbose informational messages
--yara_delay VALUE Time in ms to sleep after scan of each file (default 50) to reduce memory spikes
osquery shell-only CLI flags:
--A VALUE Select all from a table
--L List all table names
--connect VALUE Connect to an extension socket
--csv Set output mode to 'csv'
--extension VALUE Path to a single extension to autoload
--header Toggle column headers true/false
--json Set output mode to 'json'
--json_pretty Set output mode to 'json_pretty'
--line Set output mode to 'line'
--list Set output mode to 'list'
--pack VALUE Run all queries in a pack
--planner Enable osquery runtime planner output
--profile VALUE Enable profile mode when non-0, set number of iterations
--separator VALUE Set output field separator, default '|'
osquery project page <https://osquery.io>.
Options (215)
| Option | Description | Source |
|---|---|---|
--flagfile PATH | Line-delimited file of additional flags | help |
--D | Run as a daemon process | help |
--S | Run as a shell process | help |
--alarm_timeout VALUE | Seconds to allow for shutdown. | help |
--aws_enforce_fips | Whether to enforce AWS FIPS endpoints for all services or not | help |
--carver_block_size VALUE | Size of blocks used for POSTing data back to remote endpoints | help |
--carver_compression | Compress archives using zstd prior to upload (default false) | help |
--carver_continue_endpoint VALUE | TLS/HTTPS endpoint that receives carved content after session creation | help |
--carver_disable_function | Disable the osquery file carver function (default true) | help |
--carver_expiry VALUE | Seconds to store successful carve result metadata (in carves table) | help |
--carver_start_endpoint VALUE | TLS/HTTPS init endpoint for forensic carver | help |
--config_accelerated_refresh VALUE | Interval to wait if reading a configuration fails | help |
--config_check | Check the format of an osquery config and exit | help |
--config_dump | Dump the contents of the configuration, then exit | help |
--config_enable_backup | Backup config and use it when refresh fails | help |
--config_path VALUE | Path to JSON config file | help |
--config_plugin VALUE | Config plugin name | help |
--config_refresh VALUE | Optional interval in seconds to re-read configuration | help |
--config_tls_endpoint VALUE | TLS/HTTPS endpoint for config retrieval | help |
--config_tls_max_attempts VALUE | Number of attempts to retry a TLS config request | help |
--daemonize | Attempt to daemonize (POSIX only) | help |
--database_dump | Dump the contents of the backing store | help |
--database_path VALUE | If using a disk-based backing store, specify a path | help |
--disable_carver | Disable the osquery file carver (default true) | help |
--disable_enrollment | Disable enrollment functions on related config/logger plugins | help |
--disable_extensions | Disable extension API | help |
--disable_reenrollment | Disable re-enrollment attempts if related plugins return invalid | help |
--disable_tables VALUE | Comma-delimited list of table names to be disabled | help |
--disable_watchdog | Disable userland watchdog process | help |
--enable_extensions_watchdog | Enable userland watchdog for extensions processes | help |
--enable_tables VALUE | Comma-delimited list of table names to be enabled | help |
--enable_watchdog_debug | Enable logging of CPU and memory footprint of watched processes | help |
--enroll_always | On startup, send a new enrollment request | help |
--enroll_secret_env VALUE | Name of environment variable holding enrollment-auth secret | help |
--enroll_secret_path VALUE | Path to an optional client enrollment-auth secret | help |
--enroll_tls_endpoint VALUE | TLS/HTTPS endpoint for client enrollment | help |
--experiments_linuxevents_circular_buffer_size VALUE | Size of the circular buffer used by tables to store events | help |
--experiments_linuxevents_perf_output_size VALUE | Perf ouput size (must be a power of two) | help |
--extensions_autoload VALUE | Optional path to a list of autoloaded & managed extensions | help |
--extensions_interval VALUE | Seconds delay between connectivity checks | help |
--extensions_require VALUE | Comma-separated list of required extensions | help |
--extensions_socket VALUE | Path to the extensions UNIX domain socket | help |
--extensions_timeout VALUE | Seconds to wait for autoloaded extensions | help |
--force | Force osqueryd to kill previously-running daemons | help |
--install | Install osqueryd as a service | help |
--keep_container_worker_open | Keep the container worker running to be reused instead of closing it after each query | help |
--logger_mode VALUE | Octal mode for log files (default '0640') | help |
--logger_plugin VALUE | Logger plugin name | help |
--logger_stderr | Write status logs to stderr | help |
--logtostderr | Log messages to stderr in addition to the logger plugin(s) | help |
--pidfile VALUE | Path to the daemon pidfile mutex | help |
--proxy_hostname VALUE | Optional HTTP proxy hostname | help |
--stderrthreshold VALUE | Stderr log level threshold | help |
--tls_client_cert VALUE | Optional path to a TLS client-auth PEM certificate | help |
--tls_client_key VALUE | Optional path to a TLS client-auth PEM private key | help |
--tls_enroll_max_attempts VALUE | The total number of attempts that will be made to the enroll endpoint if a request fails, 0 for infinite | help |
--tls_enroll_max_interval VALUE | Maximum wait time in seconds between enroll retry attempts | help |
--tls_hostname VALUE | TLS/HTTPS hostname for Config, Logger, and Enroll plugins | help |
--tls_server_certs VALUE | Optional path to a TLS server PEM certificate(s) bundle | help |
--tls_session_reuse | Reuse TLS session sockets | help |
--tls_session_timeout VALUE | TLS session keep alive timeout in seconds | help |
--uninstall | Uninstall osqueryd as a service | help |
--watchdog_delay VALUE | Initial delay in seconds before watchdog starts | help |
--watchdog_forced_shutdown_delay VALUE | Seconds that the watchdog will wait to do a forced shutdown after a graceful shutdown request, when a resource limit is hit | help |
--watchdog_latency_limit VALUE | Override watchdog profile CPU utilization latency limit | help |
--watchdog_level VALUE | Performance limit level (0=normal, 1=restrictive, -1=off) | help |
--watchdog_memory_limit VALUE | Override watchdog profile memory limit (e.g., 300, for 300MB) | help |
--watchdog_utilization_limit VALUE | Override watchdog profile CPU utilization limit | help |
--audit_allow_accept_socket_events | Include rows for accept socket events | help |
--audit_allow_apparmor_events | Allow the publisher to process audit events | help |
--audit_allow_config | Allow the audit publisher to change auditing configuration | help |
--audit_allow_failed_socket_events | Include rows for socket events that have failed | help |
--audit_allow_fim_events | Allow the audit publisher to install filesystem-related rules | help |
--audit_allow_fork_process_events | Allow the audit publisher to install process event monitoring rules to capture fork/vfork/clone system calls | help |
--audit_allow_kill_process_events | Allow the audit publisher to install process event monitoring rules to capture kill/tkill/tgkill system calls | help |
--audit_allow_null_accept_socket_events | Allow non-blocking accept() syscalls that returned EAGAIN/EWOULDBLOCK | help |
--audit_allow_process_events | Allow the audit publisher to install process-related rules | help |
--audit_allow_seccomp_events | Allow the audit publisher to process seccomp events | help |
--audit_allow_selinux_events | Allow the audit publisher to process audit events | help |
--audit_allow_sockets | Allow the audit publisher to install socket-related rules | help |
--audit_allow_user_events | Allow the audit publisher to install user-related rules | help |
--audit_backlog_limit VALUE | The audit backlog limit | help |
--audit_backlog_wait_time VALUE | The audit backlog wait time | help |
--audit_force_reconfigure | Configure the audit subsystem from scratch | help |
--audit_force_unconfigure | Always uninstall all rules, regardless of whether they were already installed or not | help |
--audit_persist | Attempt to retain control of audit | help |
--augeas_lenses VALUE | Directory that contains augeas lenses files | help |
--aws_access_key_id VALUE | AWS access key ID | help |
--aws_debug | Enable AWS SDK debug logging | help |
--aws_disable_imdsv1_fallback | Whether to disable support for IMDSv1 and fail if an IMDSv2 token could not be retrieved | help |
--aws_enable_proxy | Enable proxying of HTTP/HTTPS requests in AWS client config | help |
--aws_firehose_endpoint VALUE | Custom Firehose endpoint | help |
--aws_firehose_period VALUE | Seconds between flushing logs to Firehose (default 10) | help |
--aws_firehose_region VALUE | Region to use for Firehose instead of the default. | help |
--aws_firehose_stream VALUE | Name of Firehose stream for logging | help |
--aws_imdsv2_request_attempts VALUE | How many attempts to do at requesting an IMDSv2 token | help |
--aws_imdsv2_request_interval VALUE | Base seconds to wait between attempts at requesting an IMDSv2 token. | help |
--aws_kinesis_disable_log_status | Disable status logs processing | help |
--aws_kinesis_endpoint VALUE | Custom Kinesis endpoint | help |
--aws_kinesis_period VALUE | Seconds between flushing logs to Kinesis (default 10) | help |
--aws_kinesis_random_partition_key | Enable random kinesis partition keys | help |
--aws_kinesis_region VALUE | Region to use for Kinesis instead of the default. | help |
--aws_kinesis_stream VALUE | Name of Kinesis stream for logging | help |
--aws_profile_name VALUE | AWS profile for authentication and region configuration | help |
--aws_proxy_host VALUE | Proxy host for use in AWS client config | help |
--aws_proxy_password VALUE | Proxy password for use in AWS client config | help |
--aws_proxy_port VALUE | Proxy port for use in AWS client config | help |
--aws_proxy_scheme VALUE | Proxy HTTP scheme for use in AWS client config (http or https, default https) | help |
--aws_proxy_username VALUE | Proxy username for use in AWS client config | help |
--aws_region VALUE | Default AWS region for all services | help |
--aws_secret_access_key VALUE | AWS secret access key | help |
--aws_session_token VALUE | AWS STS session token | help |
--aws_sts_arn_role VALUE | AWS STS ARN role | help |
--aws_sts_region VALUE | AWS STS region | help |
--aws_sts_session_name VALUE | AWS STS session name | help |
--aws_sts_timeout VALUE | AWS STS assume role credential validity in seconds (default 3600) | help |
--bpf_buffer_storage_size VALUE | How many slots each buffer storage should have | help |
--bpf_perf_event_array_exp VALUE | Size of the perf event array as a power of 2 | help |
--buffered_log_max VALUE | Maximum number of logs in buffered output plugins (0 = unlimited) | help |
--decorations_top_level | Add decorators as top level JSON object members | help |
--disable_audit | Disable receiving events from the audit subsystem | help |
--disable_caching | Disable scheduled query caching | help |
--disable_database | Disable the persistent RocksDB storage | help |
--disable_decorators | Disable log result decoration | help |
--disable_distributed | Disable distributed queries (default true) | help |
--disable_events | Disable osquery publish/subscribe system | help |
--disable_hash_cache | Cache calculated file hashes, re-calculate only if inode times change | help |
--disable_logging | Disable ERROR/INFO logging | help |
--disable_memory | Disable physical memory reads | help |
--distributed_denylist_duration VALUE | Seconds to denylist distributed queries (default 1 day) | help |
--distributed_interval VALUE | Seconds between polling for new queries (default 60) | help |
--distributed_loginfo | Log the running distributed queries name at INFO level | help |
--distributed_plugin VALUE | Distributed plugin name | help |
--distributed_tls_max_attempts VALUE | Number of times to attempt a request | help |
--distributed_tls_read_endpoint VALUE | TLS/HTTPS endpoint for distributed query retrieval | help |
--distributed_tls_write_endpoint VALUE | TLS/HTTPS endpoint for distributed query results | help |
--docker_socket VALUE | Docker UNIX domain socket path | help |
--enable_bpf_events | Enables the bpf_process_events publisher | help |
--enable_file_events | Enables the file_events publisher | help |
--enable_foreign | Enable no-op foreign virtual tables | help |
--enable_numeric_monitoring | Enable numeric monitoring system | help |
--enable_syslog | Enable the syslog ingestion event publisher | help |
--ephemeral | Skip pidfile and database state checks | help |
--events_expiry VALUE | Timeout to expire event subscriber results | help |
--events_max VALUE | Maximum number of event batches per type to buffer | help |
--events_optimize | Optimize subscriber select queries (scheduler only) | help |
--experiment_list VALUE | Comma-separated list of experiments to enable | help |
--extensions_default_index | Enable INDEX on all extension table columns (default true) | help |
--hardware_disabled_types VALUE | List of disabled hardware event types | help |
--hash_cache_max VALUE | Size of LRU file hash cache | help |
--host_identifier VALUE | Field used to identify the host running osquery (hostname, uuid, instance, ephemeral, specified) | help |
--ignore_table_exceptions | Ignore exceptions thrown by tables. | help |
--logger_event_type | Log scheduled results as events | help |
--logger_kafka_acks VALUE | The number of acknowledgments the leader has to receive (0, 1, 'all') | help |
--logger_kafka_brokers VALUE | Bootstrap broker(s) as a comma-separated list of host or host:port (default port 9092) | help |
--logger_kafka_compression VALUE | Compression codec to use for compressing message sets ('none' or 'gzip') | help |
--logger_kafka_topic VALUE | Kafka topic to publish logs under | help |
--logger_min_status VALUE | Minimum level for status log recording | help |
--logger_min_stderr VALUE | Minimum level for statuses written to stderr | help |
--logger_numerics | Use numeric JSON syntax for numeric values | help |
--logger_path VALUE | Directory path for ERROR/WARN/INFO and results logging | help |
--logger_rotate | Use filesystem log rotation | help |
--logger_rotate_max_files VALUE | Max number of files to keep in rotation | help |
--logger_rotate_size VALUE | Size for each filesystem log in bytes | help |
--logger_snapshot_event_type | Log scheduled snapshot results as events | help |
--logger_syslog_facility VALUE | Syslog facility for status and results logs (0-23, default 19) | help |
--logger_syslog_prepend_cee | Prepend @cee: tag to logged JSON messages | help |
--logger_tls_backoff_max VALUE | Maximum seconds to wait before flushing logs over TLS/HTTPS. | help |
--logger_tls_compress | GZip compress TLS/HTTPS request body | help |
--logger_tls_endpoint VALUE | TLS/HTTPS endpoint for results logging | help |
--logger_tls_max_lines VALUE | Max number of logs to send per period | help |
--logger_tls_max_linesize VALUE | Max size in bytes allowed per log line | help |
--logger_tls_period VALUE | Seconds between flushing logs over TLS/HTTPS | help |
--lxd_socket VALUE | LXD UNIX domain socket path | help |
--malloc_trim_threshold VALUE | Memory threshold in MB used to decide when a malloc_trim will be called to reduce the retained memory (Linux only) | help |
--nullvalue VALUE | Set string for NULL values, default '' | help |
--numeric_monitoring_filesystem_path VALUE | File to dump numeric monitoring records one per line. | help |
--numeric_monitoring_plugins VALUE | Comma separated numeric monitoring plugins names | help |
--numeric_monitoring_pre_aggregation_time VALUE | Time period in seconds for numeric monitoring pre-aggregation buffer. | help |
--pack_delimiter VALUE | Delimiter for pack and query names | help |
--pack_refresh_interval VALUE | Cache expiration for a packs discovery queries | help |
--read_max VALUE | Maximum file read size | help |
--schedule_default_interval VALUE | Query interval to use if none is provided | help |
--schedule_epoch VALUE | Epoch for scheduled queries | help |
--schedule_lognames | Log the running scheduled query name at INFO level | help |
--schedule_max_drift VALUE | Max time drift in seconds | help |
--schedule_reload VALUE | Interval in seconds to reload database arenas | help |
--schedule_splay_percent VALUE | Percent to splay config times | help |
--schedule_timeout VALUE | Limit the schedule to a duration in seconds, 0 for no limit | help |
--specified_identifier VALUE | Field used to specify the host_identifier when set to "specified" | help |
--syslog_events_expiry VALUE | Timeout to expire event subscriber results | help |
--syslog_events_max VALUE | Maximum number of events per type to buffer | help |
--syslog_pipe_path VALUE | Path to the named pipe used for forwarding rsyslog events | help |
--syslog_rate_limit VALUE | Maximum number of logs to ingest per run (~200ms between runs) | help |
--table_delay VALUE | Add an optional millisecond delay between table scans | help |
--thrift_string_size_limit VALUE | Sets the maximum string size allowed in a thrift message, use 0 for unlimited | help |
--thrift_timeout VALUE | Timeout for thrift socket operations | help |
--thrift_verbose | Enable the thrift log handler | help |
--tls_disable_status_log | Disable sending status logs | help |
--verbose | Enable verbose informational messages | help |
--yara_delay VALUE | Time in ms to sleep after scan of each file (default 50) to reduce memory spikes | help |
--A VALUE | Select all from a table | help |
--L | List all table names | help |
--connect VALUE | Connect to an extension socket | help |
--csv | Set output mode to 'csv' | help |
--extension VALUE | Path to a single extension to autoload | help |
--header | Toggle column headers true/false | help |
--json | Set output mode to 'json' | help |
--json_pretty | Set output mode to 'json_pretty' | help |
--line | Set output mode to 'line' | help |
--list | Set output mode to 'list' | help |
--pack VALUE | Run all queries in a pack | help |
--planner | Enable osquery runtime planner output | help |
--profile VALUE | Enable profile mode when non-0, set number of iterations | help |
--separator VALUE | Set output field separator, default '|' | help |