action rudder_get_all_settings { label: "List all settings" description: "Get the current value of all the settings" provider: rudder method: GET path: "/settings" encoding: json output: { type: "object" required: ["action", "data", "result"] properties: { action: { type: "string" description: "The id of the action" enum: ["getAllSettings"] } data: { type: "object" description: "Information about the setting" required: ["settings"] properties: { settings: { properties: { allowed_networks: { type: "array" description: "List of allowed networks for each policy server (root and relays)" items: { type: "object" properties: { allowed_networks: { type: "array" description: "List of allowed networks" items: { type: "string" format: "CIDR network" description: "Allowed network (`0.0.0.0/0` for no restriction `a.b.c.d/32` for one IP)" } } id: { type: "string" description: "Rudder id of the policy server" } } } } change_message_prompt: { type: "string" description: "Explanation to display" } display_recent_changes_graphs: { type: "boolean" description: "Display changes graphs" } enable_change_message: { type: "boolean" description: "Enable change audit logs" } enable_change_request: { type: "boolean" description: "Enable Change Requests" } enable_javascript_directives: { type: "string" description: "Enable script evaluation in Directives" } enable_self_deployment: { type: "boolean" description: "Allow self deployment" } enable_self_validation: { type: "boolean" description: "Allow self validation" } first_run_hour: { type: "integer" description: "First agent run time - hour" } first_run_minute: { type: "integer" description: "First agent run time - minute" } global_policy_mode: { type: "string" description: "Define the default setting for global policy mode" enum: ["enforce", "audit"] } global_policy_mode_overridable: { type: "boolean" description: "Allow overrides on this default setting" } heartbeat_frequency: { type: "integer" description: "Send heartbeat every heartbeat_frequency runs (only on **changes-only** compliance mode)" } mandatory_change_message: { type: "boolean" description: "Make message mandatory" } modified_file_ttl: { type: "integer" description: "Number of days to retain modified files" } node_accept_duplicated_hostname: { type: "boolean" description: "Allow acceptation of a pending node when another one with the same hostname is already accepted" } node_onaccept_default_policyMode: { type: "string" description: "Default policy mode for accepted node" enum: ["default", "enforce", "audit"] } node_onaccept_default_state: { type: "string" description: "Set default state for node when they are accepted within Rudder" enum: ["enabled", "ignored", "empty-policies", "initializing", "preparing-eol"] } output_file_ttl: { type: "integer" description: "Number of days to retain agent output files" } relay_server_synchronization_method: { type: "string" description: "Method used to synchronize data between server and relays, either \"classic\" (agent protocol, default), \"rsync\" (use rsync to synchronize, that you'll need to be manually set up), or \"disabled\" (use third party system to transmit data)" enum: ["classic", "rsync", "disabled"] } relay_server_synchronize_policies: { type: "boolean" description: "If **rsync** is set as a synchronization method, use rsync to synchronize policies between Rudder server and relays. If false, you'll have to synchronize policies yourself." } relay_server_synchronize_shared_files: { type: "boolean" description: "If **rsync** is set as a synchronization method, use rsync to synchronize shared files between Rudder server and relays. If false, you'll have to synchronize shared files yourself." } reporting_mode: { type: "string" description: "Compliance reporting mode" enum: ["full-compliance", "changes-only", "reports-disabled"] } require_time_synchronization: { type: "boolean" description: "Require time synchronization between nodes and policy server" } rudder_compute_changes: { type: "boolean" description: "Compute list of changes (repaired reports) per rule" } rudder_compute_dyngroups_max_parallelism: { type: "string" description: "Set the parallelism to compute dynamic group, as a number of thread (i.e. 4), or a multiplicative of the number of core (x0.5)" } rudder_generation_compute_dyngroups: { type: "boolean" description: "Recompute all dynamic groups at the start of policy generation" } rudder_generation_continue_on_error: { type: "boolean" description: "Policy generation continues on error during NodeConfiguration evaluation" } rudder_generation_delay: { type: "string" description: "Set a delay before starting policy generation, this will allow you to accumulate changes before they are deployed to Nodes, and can also lessen webapp resources needs. The value is a number followed by the time unit needed (seconds/s, minutes/m, hours/h ...), ie \"5m\" for 5 minutes" } rudder_generation_js_timeout: { type: "integer" description: "Policy generation JS evaluation of directive parameter timeout in seconds" } rudder_generation_max_parallelism: { type: "string" description: "Set the policy generation parallelism, either as an number of thread (i.e. 4), or a multiplicative of the number of core (x0.5)" } rudder_generation_policy: { type: "string" description: "Should policy generation be triggered automatically after a change (value 'all'), or should we wait until a manual launch (through api or UI, value 'onlyManual') or even no policy generation at all (value \"none\")" } rudder_report_protocol_default: { type: "string" description: "Default reporting protocol used" enum: ["HTTPS", "SYSLOG"] } rudder_save_db_compliance_details: { type: "boolean" description: "Store all compliance details in database" } rudder_save_db_compliance_levels: { type: "boolean" description: "Store all compliance levels in database" } rudder_verify_certificates: { type: "boolean" description: "Enforce certificate validation in all HTTPS calls" } run_frequency: { type: "integer" description: "Agent run schedule - time between agent runs (in minutes)" } send_metrics: { type: "string" description: "Send anonymous usage statistics" } splay_time: { type: "integer" description: "Maximum delay after scheduled run time (random interval)" } unexpected_unbound_var_values: { type: "boolean" description: "Allows multiple reports for configuration based on a multivalued variable" } } } } } result: { type: "string" description: "Result of the request" enum: ["success", "error"] } } } }