GET /api/settings
200
{
"total": 0,
"subtotal": 0,
"page": 1,
"per_page": 0,
"search": null,
"sort": {
"by": null,
"order": null
},
"results": [
{
"description": "The default administrator email address",
"settings_type": "string",
"default": "root@example.com",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "administrator",
"name": "administrator",
"full_name": "Administrator email address",
"value": "root@some.host.fqdn",
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "URL where your Foreman instance is reachable (see also Provisioning > unattended_url)",
"settings_type": "string",
"default": "http://foreman.example.com",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "foreman_url",
"name": "foreman_url",
"full_name": "Foreman URL",
"value": "http://foreman.some.host.fqdn",
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Number of records shown per page in Foreman",
"settings_type": "integer",
"default": 20,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "entries_per_page",
"name": "entries_per_page",
"full_name": "Entries per page",
"value": 20,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Fix DB cache on next Foreman restart",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "fix_db_cache",
"name": "fix_db_cache",
"full_name": "Fix DB cache",
"value": false,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Should the `foreman-rake db:seed` be executed on the next run of the installer modules?",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "db_pending_seed",
"name": "db_pending_seed",
"full_name": "DB pending seed",
"value": true,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Open and read timeout for HTTP requests from Foreman to Smart Proxy (in seconds)",
"settings_type": "integer",
"default": 60,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "proxy_request_timeout",
"name": "proxy_request_timeout",
"full_name": "Smart Proxy request timeout",
"value": 60,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Text to be shown in the login-page footer",
"settings_type": "text",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "login_text",
"name": "login_text",
"full_name": "Login page footer text",
"value": null,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Show power status on host index page. This feature calls to compute resource providers which may lead to decreased performance on host listing page.",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "host_power_status",
"name": "host_power_status",
"full_name": "Show host power status",
"value": true,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Set a proxy for all outgoing HTTP(S) connections from Foreman. System-wide proxies must be configured at the operating system level.",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "http_proxy",
"name": "http_proxy",
"full_name": "HTTP(S) proxy",
"value": null,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Set hostnames to which requests are not to be proxied. Requests to the local host are excluded by default.",
"settings_type": "array",
"default": [],
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "http_proxy_except_list",
"name": "http_proxy_except_list",
"full_name": "HTTP(S) proxy except hosts",
"value": [],
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Whether or not to show a menu to access experimental lab features (requires reload of page)",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "lab_features",
"name": "lab_features",
"full_name": "Show Experimental Labs",
"value": false,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will append domain names when new hosts are provisioned",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "append_domain_name_for_hosts",
"name": "append_domain_name_for_hosts",
"full_name": "Append domain names to the host",
"value": true,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Duration in minutes after servers are classed as out of sync. You can override this on hosts by adding a parameter \"outofsync_interval\".",
"settings_type": "integer",
"default": 30,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "outofsync_interval",
"name": "outofsync_interval",
"full_name": "Out of sync interval",
"value": 5,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman instance ID, uniquely identifies this Foreman instance.",
"settings_type": "string",
"default": "uuid",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "instance_id",
"name": "instance_id",
"full_name": "Foreman UUID",
"value": "2abbbe02-4ace-4269-9e20-2753f3206cc2",
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Language to use for new users",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "default_locale",
"name": "default_locale",
"full_name": "Default language",
"value": null,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"": "Browser locale",
"en": "en"
}
},
{
"description": "Timezone to use for new users",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "default_timezone",
"name": "default_timezone",
"full_name": "Default timezone",
"value": null,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"": "Browser timezone",
"International Date Line West": "(GMT -12:00) International Date Line West",
"American Samoa": "(GMT -11:00) American Samoa",
"Midway Island": "(GMT -11:00) Midway Island",
"Hawaii": "(GMT -10:00) Hawaii",
"Alaska": "(GMT -09:00) Alaska",
"Pacific Time (US & Canada)": "(GMT -08:00) Pacific Time (US & Canada)",
"Tijuana": "(GMT -08:00) Tijuana",
"Arizona": "(GMT -07:00) Arizona",
"Chihuahua": "(GMT -07:00) Chihuahua",
"Mazatlan": "(GMT -07:00) Mazatlan",
"Mountain Time (US & Canada)": "(GMT -07:00) Mountain Time (US & Canada)",
"Central America": "(GMT -06:00) Central America",
"Central Time (US & Canada)": "(GMT -06:00) Central Time (US & Canada)",
"Guadalajara": "(GMT -06:00) Guadalajara",
"Mexico City": "(GMT -06:00) Mexico City",
"Monterrey": "(GMT -06:00) Monterrey",
"Saskatchewan": "(GMT -06:00) Saskatchewan",
"Bogota": "(GMT -05:00) Bogota",
"Eastern Time (US & Canada)": "(GMT -05:00) Eastern Time (US & Canada)",
"Indiana (East)": "(GMT -05:00) Indiana (East)",
"Lima": "(GMT -05:00) Lima",
"Quito": "(GMT -05:00) Quito",
"Atlantic Time (Canada)": "(GMT -04:00) Atlantic Time (Canada)",
"Caracas": "(GMT -04:00) Caracas",
"Georgetown": "(GMT -04:00) Georgetown",
"La Paz": "(GMT -04:00) La Paz",
"Puerto Rico": "(GMT -04:00) Puerto Rico",
"Santiago": "(GMT -04:00) Santiago",
"Newfoundland": "(GMT -03:30) Newfoundland",
"Brasilia": "(GMT -03:00) Brasilia",
"Buenos Aires": "(GMT -03:00) Buenos Aires",
"Greenland": "(GMT -03:00) Greenland",
"Montevideo": "(GMT -03:00) Montevideo",
"Mid-Atlantic": "(GMT -02:00) Mid-Atlantic",
"Azores": "(GMT -01:00) Azores",
"Cape Verde Is.": "(GMT -01:00) Cape Verde Is.",
"Casablanca": "(GMT +00:00) Casablanca",
"Dublin": "(GMT +00:00) Dublin",
"Edinburgh": "(GMT +00:00) Edinburgh",
"Lisbon": "(GMT +00:00) Lisbon",
"London": "(GMT +00:00) London",
"Monrovia": "(GMT +00:00) Monrovia",
"UTC": "(GMT +00:00) UTC",
"Amsterdam": "(GMT +01:00) Amsterdam",
"Belgrade": "(GMT +01:00) Belgrade",
"Berlin": "(GMT +01:00) Berlin",
"Bern": "(GMT +01:00) Bern",
"Bratislava": "(GMT +01:00) Bratislava",
"Brussels": "(GMT +01:00) Brussels",
"Budapest": "(GMT +01:00) Budapest",
"Copenhagen": "(GMT +01:00) Copenhagen",
"Ljubljana": "(GMT +01:00) Ljubljana",
"Madrid": "(GMT +01:00) Madrid",
"Paris": "(GMT +01:00) Paris",
"Prague": "(GMT +01:00) Prague",
"Rome": "(GMT +01:00) Rome",
"Sarajevo": "(GMT +01:00) Sarajevo",
"Skopje": "(GMT +01:00) Skopje",
"Stockholm": "(GMT +01:00) Stockholm",
"Vienna": "(GMT +01:00) Vienna",
"Warsaw": "(GMT +01:00) Warsaw",
"West Central Africa": "(GMT +01:00) West Central Africa",
"Zagreb": "(GMT +01:00) Zagreb",
"Zurich": "(GMT +01:00) Zurich",
"Athens": "(GMT +02:00) Athens",
"Bucharest": "(GMT +02:00) Bucharest",
"Cairo": "(GMT +02:00) Cairo",
"Harare": "(GMT +02:00) Harare",
"Helsinki": "(GMT +02:00) Helsinki",
"Jerusalem": "(GMT +02:00) Jerusalem",
"Kaliningrad": "(GMT +02:00) Kaliningrad",
"Kyiv": "(GMT +02:00) Kyiv",
"Pretoria": "(GMT +02:00) Pretoria",
"Riga": "(GMT +02:00) Riga",
"Sofia": "(GMT +02:00) Sofia",
"Tallinn": "(GMT +02:00) Tallinn",
"Vilnius": "(GMT +02:00) Vilnius",
"Baghdad": "(GMT +03:00) Baghdad",
"Istanbul": "(GMT +03:00) Istanbul",
"Kuwait": "(GMT +03:00) Kuwait",
"Minsk": "(GMT +03:00) Minsk",
"Moscow": "(GMT +03:00) Moscow",
"Nairobi": "(GMT +03:00) Nairobi",
"Riyadh": "(GMT +03:00) Riyadh",
"St. Petersburg": "(GMT +03:00) St. Petersburg",
"Tehran": "(GMT +03:30) Tehran",
"Abu Dhabi": "(GMT +04:00) Abu Dhabi",
"Baku": "(GMT +04:00) Baku",
"Muscat": "(GMT +04:00) Muscat",
"Samara": "(GMT +04:00) Samara",
"Tbilisi": "(GMT +04:00) Tbilisi",
"Volgograd": "(GMT +04:00) Volgograd",
"Yerevan": "(GMT +04:00) Yerevan",
"Kabul": "(GMT +04:30) Kabul",
"Ekaterinburg": "(GMT +05:00) Ekaterinburg",
"Islamabad": "(GMT +05:00) Islamabad",
"Karachi": "(GMT +05:00) Karachi",
"Tashkent": "(GMT +05:00) Tashkent",
"Chennai": "(GMT +05:30) Chennai",
"Kolkata": "(GMT +05:30) Kolkata",
"Mumbai": "(GMT +05:30) Mumbai",
"New Delhi": "(GMT +05:30) New Delhi",
"Sri Jayawardenepura": "(GMT +05:30) Sri Jayawardenepura",
"Kathmandu": "(GMT +05:45) Kathmandu",
"Almaty": "(GMT +06:00) Almaty",
"Astana": "(GMT +06:00) Astana",
"Dhaka": "(GMT +06:00) Dhaka",
"Urumqi": "(GMT +06:00) Urumqi",
"Rangoon": "(GMT +06:30) Rangoon",
"Bangkok": "(GMT +07:00) Bangkok",
"Hanoi": "(GMT +07:00) Hanoi",
"Jakarta": "(GMT +07:00) Jakarta",
"Krasnoyarsk": "(GMT +07:00) Krasnoyarsk",
"Novosibirsk": "(GMT +07:00) Novosibirsk",
"Beijing": "(GMT +08:00) Beijing",
"Chongqing": "(GMT +08:00) Chongqing",
"Hong Kong": "(GMT +08:00) Hong Kong",
"Irkutsk": "(GMT +08:00) Irkutsk",
"Kuala Lumpur": "(GMT +08:00) Kuala Lumpur",
"Perth": "(GMT +08:00) Perth",
"Singapore": "(GMT +08:00) Singapore",
"Taipei": "(GMT +08:00) Taipei",
"Ulaanbaatar": "(GMT +08:00) Ulaanbaatar",
"Osaka": "(GMT +09:00) Osaka",
"Sapporo": "(GMT +09:00) Sapporo",
"Seoul": "(GMT +09:00) Seoul",
"Tokyo": "(GMT +09:00) Tokyo",
"Yakutsk": "(GMT +09:00) Yakutsk",
"Adelaide": "(GMT +09:30) Adelaide",
"Darwin": "(GMT +09:30) Darwin",
"Brisbane": "(GMT +10:00) Brisbane",
"Canberra": "(GMT +10:00) Canberra",
"Guam": "(GMT +10:00) Guam",
"Hobart": "(GMT +10:00) Hobart",
"Melbourne": "(GMT +10:00) Melbourne",
"Port Moresby": "(GMT +10:00) Port Moresby",
"Sydney": "(GMT +10:00) Sydney",
"Vladivostok": "(GMT +10:00) Vladivostok",
"Magadan": "(GMT +11:00) Magadan",
"New Caledonia": "(GMT +11:00) New Caledonia",
"Solomon Is.": "(GMT +11:00) Solomon Is.",
"Srednekolymsk": "(GMT +11:00) Srednekolymsk",
"Auckland": "(GMT +12:00) Auckland",
"Fiji": "(GMT +12:00) Fiji",
"Kamchatka": "(GMT +12:00) Kamchatka",
"Marshall Is.": "(GMT +12:00) Marshall Is.",
"Wellington": "(GMT +12:00) Wellington",
"Chatham Is.": "(GMT +12:45) Chatham Is.",
"Nuku'alofa": "(GMT +13:00) Nuku'alofa",
"Samoa": "(GMT +13:00) Samoa",
"Tokelau Is.": "(GMT +13:00) Tokelau Is."
}
},
{
"description": "The instance title is shown on the top navigation bar (requires a page reload).",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "instance_title",
"name": "instance_title",
"full_name": "Instance title",
"value": null,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Duration in days to preserve audits for. Leave empty to disable the audits cleanup.",
"settings_type": "integer",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "audits_period",
"name": "audits_period",
"full_name": "Saved audits interval",
"value": null,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will load the new UI for host details",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "host_details_ui",
"name": "host_details_ui",
"full_name": "New host details UI",
"value": false,
"category": "general",
"category_name": "General",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will use OAuth for API authorization",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oauth_active",
"name": "oauth_active",
"full_name": "OAuth active",
"value": true,
"category": "auth",
"category_name": "Authentication",
"readonly": true,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "OAuth consumer key",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oauth_consumer_key",
"name": "oauth_consumer_key",
"full_name": "OAuth consumer key",
"value": "*****",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": true,
"select_values": null
},
{
"description": "OAuth consumer secret",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oauth_consumer_secret",
"name": "oauth_consumer_secret",
"full_name": "OAuth consumer secret",
"value": "*****",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": true,
"select_values": null
},
{
"description": "When enabled, Foreman will map users by username in request-header. If this is disabled, OAuth requests will have admin rights.",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oauth_map_users",
"name": "oauth_map_users",
"full_name": "OAuth map users",
"value": true,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will block user logins from an IP address after this number of failed login attempts for 5 minutes. Set to 0 to disable bruteforce protection",
"settings_type": "integer",
"default": 30,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "failed_login_attempts_limit",
"name": "failed_login_attempts_limit",
"full_name": "Failed login attempts limit",
"value": 30,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Only known Smart Proxies may access features that use Smart Proxy authentication",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "restrict_registered_smart_proxies",
"name": "restrict_registered_smart_proxies",
"full_name": "Restrict registered smart proxies",
"value": true,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Client SSL certificates are used to identify Smart Proxies (:require_ssl should also be enabled)",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "require_ssl_smart_proxies",
"name": "require_ssl_smart_proxies",
"full_name": "Require SSL for smart proxies",
"value": true,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "List of hostnames, IPv4, IPv6 addresses or subnets to be trusted in addition to Smart Proxies for access to fact/report importers and ENC output",
"settings_type": "array",
"default": [],
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "trusted_hosts",
"name": "trusted_hosts",
"full_name": "Trusted hosts",
"value": [],
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "SSL Certificate path that Foreman would use to communicate with its proxies",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssl_certificate",
"name": "ssl_certificate",
"full_name": "SSL certificate",
"value": "/var/lib/puppet/ssl/certs/some.host.fqdn",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "SSL CA file path that Foreman will use to communicate with its proxies",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssl_ca_file",
"name": "ssl_ca_file",
"full_name": "SSL CA file",
"value": "/var/lib/puppet/ssl/certs/ca.pem",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "SSL Private Key path that Foreman will use to communicate with its proxies",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssl_priv_key",
"name": "ssl_priv_key",
"full_name": "SSL private key",
"value": "/var/lib/puppet/ssl/private_keys/super.some.host.fqdn.pem",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Environment variable containing the subject DN from a client SSL certificate",
"settings_type": "string",
"default": "SSL_CLIENT_S_DN",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssl_client_dn_env",
"name": "ssl_client_dn_env",
"full_name": "SSL client DN env",
"value": "SSL_CLIENT_S_DN",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Environment variable containing the verification status of a client SSL certificate",
"settings_type": "string",
"default": "SSL_CLIENT_VERIFY",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssl_client_verify_env",
"name": "ssl_client_verify_env",
"full_name": "SSL client verify env",
"value": "SSL_CLIENT_VERIFY",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Environment variable containing a client's SSL certificate",
"settings_type": "string",
"default": "SSL_CLIENT_CERT",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssl_client_cert_env",
"name": "ssl_client_cert_env",
"full_name": "SSL client cert env",
"value": "SSL_CLIENT_CERT",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "SSL CA file path that will be used in templates (to verify the connection to Foreman)",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "server_ca_file",
"name": "server_ca_file",
"full_name": "Server CA file",
"value": "/var/lib/puppet/ssl/certs/ca.pem",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Private key file path that Foreman will use to encrypt websockets",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "websockets_ssl_key",
"name": "websockets_ssl_key",
"full_name": "Websockets SSL key",
"value": null,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Certificate path that Foreman will use to encrypt websockets",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "websockets_ssl_cert",
"name": "websockets_ssl_cert",
"full_name": "Websockets SSL certificate",
"value": null,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "VNC/SPICE websocket proxy console access encryption (websockets_ssl_key/cert setting required)",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "websockets_encrypt",
"name": "websockets_encrypt",
"full_name": "Websockets encryption",
"value": false,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Redirect your users to this url on logout (authorize_login_delegation should also be enabled)",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "login_delegation_logout_url",
"name": "login_delegation_logout_url",
"full_name": "Login delegation logout URL",
"value": null,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Name of the external auth source where unknown externally authentication users (see authorize_login_delegation) should be created. Empty means no autocreation.",
"settings_type": "string",
"default": "External",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "authorize_login_delegation_auth_source_user_autocreate",
"name": "authorize_login_delegation_auth_source_user_autocreate",
"full_name": "Authorize login delegation auth source user autocreate",
"value": "External",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Authorize login delegation with REMOTE_USER HTTP header",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "authorize_login_delegation",
"name": "authorize_login_delegation",
"full_name": "Authorize login delegation",
"value": false,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Authorize login delegation with REMOTE_USER HTTP header for API calls too",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "authorize_login_delegation_api",
"name": "authorize_login_delegation_api",
"full_name": "Authorize login delegation API",
"value": false,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Log out idle users after a certain number of minutes",
"settings_type": "integer",
"default": 60,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "idle_timeout",
"name": "idle_timeout",
"full_name": "Idle timeout",
"value": 5,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Cost value of bcrypt password hash function for internal auth-sources (4-30). A higher value is safer but verification is slower, particularly for stateless API calls and UI logins. A password change is needed effect existing passwords.",
"settings_type": "integer",
"default": 4,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "bcrypt_cost",
"name": "bcrypt_cost",
"full_name": "BCrypt password cost",
"value": 4,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Permits access to BMC interface passwords through ENC YAML output and in templates",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "bmc_credentials_accessible",
"name": "bmc_credentials_accessible",
"full_name": "BMC credentials access",
"value": true,
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "OpenID Connect JSON Web Key Set(JWKS) URL. Typically https://keycloak.example.com/auth/realms/<realm name>/protocol/openid-connect/certs when using Keycloak as an OpenID provider",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oidc_jwks_url",
"name": "oidc_jwks_url",
"full_name": "OIDC JWKs URL",
"value": "https://keycloak.example.com/auth/realms/foreman/protocol/openid-connect/certs",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Name of the OpenID Connect Audience that is being used for Authentication. In case of Keycloak this is the Client ID.",
"settings_type": "array",
"default": [],
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oidc_audience",
"name": "oidc_audience",
"full_name": "OIDC Audience",
"value": "rest-client",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "The iss (issuer) claim identifies the principal that issued the JWT, which exists at a `/.well-known/openid-configuration` in case of most of the OpenID providers.",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oidc_issuer",
"name": "oidc_issuer",
"full_name": "OIDC Issuer",
"value": "127.0.0.1",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "The algorithm used to encode the JWT in the OpenID provider.",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "oidc_algorithm",
"name": "oidc_algorithm",
"full_name": "OIDC Algorithm",
"value": "RS512",
"category": "auth",
"category_name": "Authentication",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Email reply address for emails that Foreman is sending",
"settings_type": "string",
"default": "foreman-noreply@example.com",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "email_reply_address",
"name": "email_reply_address",
"full_name": "Email reply address",
"value": "foreman-noreply@#{SETTINGS[:domain]}",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Prefix to add to all outgoing email",
"settings_type": "string",
"default": "[foreman]",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "email_subject_prefix",
"name": "email_subject_prefix",
"full_name": "Email subject prefix",
"value": [
"foreman"
],
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Send a welcome email including username and URL to new users",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "send_welcome_email",
"name": "send_welcome_email",
"full_name": "Send welcome email",
"value": false,
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Method used to deliver email",
"settings_type": "string",
"default": "sendmail",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "delivery_method",
"name": "delivery_method",
"full_name": "Delivery method",
"value": "test",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"sendmail": "Sendmail",
"smtp": "SMTP"
}
},
{
"description": "SMTP automatic STARTTLS",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "smtp_enable_starttls_auto",
"name": "smtp_enable_starttls_auto",
"full_name": "SMTP enable StartTLS auto",
"value": true,
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "When using TLS, you can set how OpenSSL checks the certificate",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "smtp_openssl_verify_mode",
"name": "smtp_openssl_verify_mode",
"full_name": "SMTP OpenSSL verify mode",
"value": "",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"": "Default verification mode",
"none": "none",
"peer": "peer",
"client_once": "client_once",
"fail_if_no_peer_cert": "fail_if_no_peer_cert"
}
},
{
"description": "SMTP address to connect to",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "smtp_address",
"name": "smtp_address",
"full_name": "SMTP address",
"value": "smtp@example.com",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "SMTP port to connect to",
"settings_type": "integer",
"default": 25,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "smtp_port",
"name": "smtp_port",
"full_name": "SMTP port",
"value": 25,
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "HELO/EHLO domain",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "smtp_domain",
"name": "smtp_domain",
"full_name": "SMTP HELO/EHLO domain",
"value": "",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Username to use to authenticate, if required",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "smtp_user_name",
"name": "smtp_user_name",
"full_name": "SMTP username",
"value": "",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Password to use to authenticate, if required",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "smtp_password",
"name": "smtp_password",
"full_name": "SMTP password",
"value": "*****",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": true,
"select_values": null
},
{
"description": "Specify authentication type, if required",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "smtp_authentication",
"name": "smtp_authentication",
"full_name": "SMTP authentication",
"value": "none",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"plain": "plain",
"login": "login",
"cram_md5": "cram_md5",
"": "none"
}
},
{
"description": "Specify additional options to sendmail. Only used when the delivery method is set to sendmail.",
"settings_type": "string",
"default": "-i",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "sendmail_arguments",
"name": "sendmail_arguments",
"full_name": "Sendmail arguments",
"value": "args",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "The location of the sendmail executable. Only used when the delivery method is set to sendmail.",
"settings_type": "string",
"default": "/usr/sbin/sendmail",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "sendmail_location",
"name": "sendmail_location",
"full_name": "Sendmail location",
"value": "/usr/sbin/sendmail",
"category": "email",
"category_name": "Email",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"/usr/sbin/sendmail": "/usr/sbin/sendmail",
"/usr/bin/sendmail": "/usr/bin/sendmail",
"/usr/local/sbin/sendmail": "/usr/local/sbin/sendmail",
"/usr/local/bin/sendmail": "/usr/local/bin/sendmail"
}
},
{
"description": "Whether to pull RSS notifications or not",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "rss_enable",
"name": "rss_enable",
"full_name": "RSS enable",
"value": "t",
"category": "notification",
"category_name": "Notifications",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "URL to fetch RSS notifications from",
"settings_type": "string",
"default": "https://theforeman.org/feed.xml",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "rss_url",
"name": "rss_url",
"full_name": "RSS URL",
"value": "http://theforeman.org/feed.xml",
"category": "notification",
"category_name": "Notifications",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Default owner on provisioned hosts, if empty Foreman will use current user",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "host_owner",
"name": "host_owner",
"full_name": "Host owner",
"value": "nil",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": [
{
"value": null,
"label": "Select an owner"
},
{
"group_label": "Users",
"children": [
{
"label": "secret_admin",
"value": "135138680-Users"
},
{
"label": "apiadmin",
"value": "886836129-Users"
},
{
"label": "external",
"value": "408068537-Users"
},
{
"label": "one",
"value": "980190962-Users"
},
{
"label": "restricted",
"value": "130842698-Users"
},
{
"label": "scoped",
"value": "117925625-Users"
},
{
"label": "system_admin",
"value": "482449135-Users"
},
{
"label": "test",
"value": "200482051-Users"
},
{
"label": "two",
"value": "298486374-Users"
},
{
"label": "view_hosts",
"value": "988725676-Users"
}
]
},
{
"group_label": "Usergroups",
"children": []
}
]
},
{
"description": "Default encrypted root password on provisioned hosts",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "root_pass",
"name": "root_pass",
"full_name": "Root password",
"value": "*****",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": true,
"select_values": null
},
{
"description": "URL hosts will retrieve templates from during build, when it starts with https unattended/userdata controllers cannot be accessed via HTTP",
"settings_type": "string",
"default": "http://foreman.example.com",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "unattended_url",
"name": "unattended_url",
"full_name": "Unattended URL",
"value": "http://foreman.some.host.fqdn",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Enable safe mode config templates rendering (recommended)",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "safemode_render",
"name": "safemode_render",
"full_name": "Safemode rendering",
"value": true,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Allow access to unattended URLs without build mode being used",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "access_unattended_without_build",
"name": "access_unattended_without_build",
"full_name": "Access unattended without build",
"value": false,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will query the locally configured resolver instead of the SOA/NS authorities",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "query_local_nameservers",
"name": "query_local_nameservers",
"full_name": "Query local nameservers",
"value": false,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Time in minutes installation tokens should be valid for, 0 to disable token generation",
"settings_type": "integer",
"default": 360,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "token_duration",
"name": "token_duration",
"full_name": "Installation token lifetime",
"value": 0,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Time in seconds before SSH provisioning times out",
"settings_type": "integer",
"default": 120,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ssh_timeout",
"name": "ssh_timeout",
"full_name": "SSH timeout",
"value": 120,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "The IP address that should be used for the console listen address when provisioning new virtual machines via Libvirt",
"settings_type": "string",
"default": "0.0.0.0",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "libvirt_default_console_address",
"name": "libvirt_default_console_address",
"full_name": "Libvirt default console address",
"value": "0.0.0.0",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will update the host IP with the IP that made the built request",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "update_ip_from_built_request",
"name": "update_ip_from_built_request",
"full_name": "Update IP from built request",
"value": true,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will use the short hostname instead of the FQDN for creating new virtual machines",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "use_shortname_for_vms",
"name": "use_shortname_for_vms",
"full_name": "Use short name for VMs",
"value": false,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "List of timeouts (in seconds) for DNS lookup attempts such as the dns_lookup macro and DNS record conflict validation",
"settings_type": "array",
"default": [
5,
10,
15,
20
],
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "dns_timeout",
"name": "dns_timeout",
"full_name": "DNS timeout",
"value": [
5,
10,
15,
20
],
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will delete virtual machine if provisioning script ends with non zero exit code",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "clean_up_failed_deployment",
"name": "clean_up_failed_deployment",
"full_name": "Clean up failed deployment",
"value": true,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Random gives unique names, MAC-based are longer but stable (and only works with bare-metal)",
"settings_type": "string",
"default": "Random-based",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "name_generator_type",
"name": "name_generator_type",
"full_name": "Type of name generator",
"value": "Random-based",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"Off": "Off",
"Random-based": "Random-based",
"MAC-based": "MAC-based"
}
},
{
"description": "Default PXE menu item in global template - 'local', 'discovery' or custom, use blank for template default",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "default_pxe_item_global",
"name": "default_pxe_item_global",
"full_name": "Default PXE global template entry",
"value": "nil",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Default PXE menu item in local template - 'local', 'local_chain_hd0' or custom, use blank for template default",
"settings_type": "string",
"default": null,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "default_pxe_item_local",
"name": "default_pxe_item_local",
"full_name": "Default PXE local template entry",
"value": "nil",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Intermediate iPXE script for unattended installations",
"settings_type": "string",
"default": "iPXE intermediate script",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "intermediate_ipxe_script",
"name": "intermediate_ipxe_script",
"full_name": "iPXE intermediate script",
"value": "nil",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"MyString": "MyString",
"iPXE Dummy Menu": "iPXE Dummy Menu"
}
},
{
"description": "Destroy associated VM on host delete. When enabled, VMs linked to Hosts will be deleted on Compute Resource. When disabled, VMs are unlinked when the host is deleted, meaning they remain on Compute Resource and can be re-associated or imported back to Foreman again. This does not automatically power off the VM",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "destroy_vm_on_host_delete",
"name": "destroy_vm_on_host_delete",
"full_name": "Destroy associated VM on host delete",
"value": "t",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Maximum amount of keys in structured subtree, statistics stored in foreman::dropped_subtree_facts",
"settings_type": "integer",
"default": 100,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "maximum_structured_facts",
"name": "maximum_structured_facts",
"full_name": "Maximum structured facts",
"value": 100,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Global Registration template",
"settings_type": "string",
"default": "Global Registration",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "default_global_registration_item",
"name": "default_global_registration_item",
"full_name": "Default Global registration template",
"value": "Global Registration",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Default 'Host initial configuration' template, automatically assigned when a new operating system is created",
"settings_type": "string",
"default": "Linux host_init_config default",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "default_host_init_config_template",
"name": "default_host_init_config_template",
"full_name": "Default 'Host initial configuration' template",
"value": "Linux host initial configuration",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Global default PXEGrub2 template. This template gets deployed to all configured TFTP servers. It will not be affected by upgrades.",
"settings_type": "string",
"default": "PXEGrub2 global default",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "global_PXEGrub2",
"name": "global_PXEGrub2",
"full_name": "Global default PXEGrub2 template",
"value": "PXEGrub2 global default",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"PXEGrub2 global default": "PXEGrub2 global default"
}
},
{
"description": "Global default PXELinux template. This template gets deployed to all configured TFTP servers. It will not be affected by upgrades.",
"settings_type": "string",
"default": "PXELinux global default",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "global_PXELinux",
"name": "global_PXELinux",
"full_name": "Global default PXELinux template",
"value": "PXELinux global default",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"centos5_3_pxelinux": "centos5_3_pxelinux",
"suse_pxelinux": "suse_pxelinux",
"PXE Default Menu": "PXE Default Menu",
"PXELinux global default": "PXELinux global default",
"PXELinux default local boot": "PXELinux default local boot"
}
},
{
"description": "Global default PXEGrub template. This template gets deployed to all configured TFTP servers. It will not be affected by upgrades.",
"settings_type": "string",
"default": "PXEGrub global default",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "global_PXEGrub",
"name": "global_PXEGrub",
"full_name": "Global default PXEGrub template",
"value": "PXEGrub global default",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"PXEGrub Dummy Menu": "PXEGrub Dummy Menu",
"PXEGrub global default": "PXEGrub global default"
}
},
{
"description": "Global default iPXE template. This template gets deployed to all configured TFTP servers. It will not be affected by upgrades.",
"settings_type": "string",
"default": "iPXE global default",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "global_iPXE",
"name": "global_iPXE",
"full_name": "Global default iPXE template",
"value": "iPXE global default",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"MyString": "MyString",
"iPXE Dummy Menu": "iPXE Dummy Menu"
}
},
{
"description": "Template that will be selected as PXEGrub2 default for local boot.",
"settings_type": "string",
"default": "PXEGrub2 default local boot",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "local_boot_PXEGrub2",
"name": "local_boot_PXEGrub2",
"full_name": "Local boot PXEGrub2 template",
"value": "PXEGrub2 default local boot",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"PXEGrub2 global default": "PXEGrub2 global default"
}
},
{
"description": "Template that will be selected as PXELinux default for local boot.",
"settings_type": "string",
"default": "PXELinux default local boot",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "local_boot_PXELinux",
"name": "local_boot_PXELinux",
"full_name": "Local boot PXELinux template",
"value": "PXELinux default local boot",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"centos5_3_pxelinux": "centos5_3_pxelinux",
"suse_pxelinux": "suse_pxelinux",
"PXE Default Menu": "PXE Default Menu",
"PXELinux global default": "PXELinux global default",
"PXELinux default local boot": "PXELinux default local boot"
}
},
{
"description": "Template that will be selected as PXEGrub default for local boot.",
"settings_type": "string",
"default": "PXEGrub default local boot",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "local_boot_PXEGrub",
"name": "local_boot_PXEGrub",
"full_name": "Local boot PXEGrub template",
"value": "PXEGrub default local boot",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"PXEGrub Dummy Menu": "PXEGrub Dummy Menu",
"PXEGrub global default": "PXEGrub global default"
}
},
{
"description": "Template that will be selected as iPXE default for local boot.",
"settings_type": "string",
"default": "iPXE default local boot",
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "local_boot_iPXE",
"name": "local_boot_iPXE",
"full_name": "Local boot iPXE template",
"value": "iPXE default local boot",
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"MyString": "MyString",
"iPXE Dummy Menu": "iPXE Dummy Menu"
}
},
{
"description": "Foreman will automate certificate signing upon provision of new host",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "manage_puppetca",
"name": "manage_puppetca",
"full_name": "Manage PuppetCA",
"value": true,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will use random UUIDs for certificate signing instead of hostnames",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "use_uuid_for_certificates",
"name": "use_uuid_for_certificates",
"full_name": "Use UUID for certificates",
"value": false,
"category": "provisioning",
"category_name": "Provisioning",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will create the host when new facts are received",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "create_new_host_when_facts_are_uploaded",
"name": "create_new_host_when_facts_are_uploaded",
"full_name": "Create new host when facts are uploaded",
"value": true,
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Hosts created after a puppet run will be placed in the location this fact dictates. The content of this fact should be the full label of the location.",
"settings_type": "string",
"default": "foreman_location",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "location_fact",
"name": "location_fact",
"full_name": "Location fact",
"value": "foreman_location",
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Hosts created after a puppet run will be placed in the organization this fact dictates. The content of this fact should be the full label of the organization.",
"settings_type": "string",
"default": "foreman_organization",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "organization_fact",
"name": "organization_fact",
"full_name": "Organization fact",
"value": "foreman_organization",
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Hosts created after a puppet run that did not send a location fact will be placed in this location",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "default_location",
"name": "default_location",
"full_name": "Default location",
"value": "Location 1",
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"loc9": "loc9",
"Location 1": "Location 1",
"Location 2": "Location 2"
}
},
{
"description": "Hosts created after a puppet run that did not send a organization fact will be placed in this organization",
"settings_type": "string",
"default": "",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "default_organization",
"name": "default_organization",
"full_name": "Default organization",
"value": "Organization 1",
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"Empty Organization": "Empty Organization",
"org6": "org6",
"Organization 1": "Organization 1",
"Organization 2": "Organization 2"
}
},
{
"description": "Foreman will update a host's hostgroup from its facts",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "update_hostgroup_from_facts",
"name": "update_hostgroup_from_facts",
"full_name": "Update hostgroup from facts",
"value": "t",
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Stop updating Operating System from facts",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ignore_facts_for_operatingsystem",
"name": "ignore_facts_for_operatingsystem",
"full_name": "Ignore facts for operating system",
"value": false,
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Stop updating domain values from facts",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ignore_facts_for_domain",
"name": "ignore_facts_for_domain",
"full_name": "Ignore facts for domain",
"value": false,
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will update a host's subnet from its facts",
"settings_type": "string",
"default": "none",
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "update_subnets_from_facts",
"name": "update_subnets_from_facts",
"full_name": "Update subnets from facts",
"value": "none",
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": {
"all": "All",
"provisioning": "Provisioning only",
"none": "None"
}
},
{
"description": "Stop updating IP and MAC address values from facts (affects all interfaces)",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "ignore_puppet_facts_for_provisioning",
"name": "ignore_puppet_facts_for_provisioning",
"full_name": "Ignore interfaces facts for provisioning",
"value": false,
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Skip creating or updating host network interfaces objects with identifiers matching these values from incoming facts. You can use * wildcard to match identifiers with indexes e.g. macvtap*. The ignored interfaces raw facts will be still stored in the DB, see the 'Exclude pattern' setting for more details.",
"settings_type": "array",
"default": [
"lo",
"en*v*",
"usb*",
"vnet*",
"macvtap*",
";vdsmdummy;",
"veth*",
"docker*",
"tap*",
"qbr*",
"qvb*",
"qvo*",
"qr-*",
"qg-*",
"vlinuxbr*",
"vovsbr*",
"br-int"
],
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "ignored_interface_identifiers",
"name": "ignored_interface_identifiers",
"full_name": "Ignore interfaces with matching identifier",
"value": [
"lo",
"en*v*",
"usb*",
"vnet*",
"macvtap*",
"_vdsmdummy_",
"veth*",
"docker*",
"tap*",
"qbr*",
"qvb*",
"qvo*",
"qr-*",
"qg-*",
"vlinuxbr*",
"vovsbr*"
],
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Exclude pattern for all types of imported facts (puppet, ansible, rhsm). Those facts won't be stored in foreman's database. You can use * wildcard to match names with indexes e.g. ignore* will filter out ignore, ignore123 as well as a::ignore or even a::ignore123::b",
"settings_type": "array",
"default": [
"lo",
"en*v*",
"usb*",
"vnet*",
"macvtap*",
";vdsmdummy;",
"veth*",
"docker*",
"tap*",
"qbr*",
"qvb*",
"qvo*",
"qr-*",
"qg-*",
"vlinuxbr*",
"vovsbr*",
"br-int",
"load_averages::*",
"memory::swap::available*",
"memory::swap::capacity",
"memory::swap::used*",
"memory::system::available*",
"memory::system::capacity",
"memory::system::used*",
"memoryfree",
"memoryfree_mb",
"swapfree",
"swapfree_mb",
"uptime_hours",
"uptime_days"
],
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "excluded_facts",
"name": "excluded_facts",
"full_name": "Exclude pattern for facts stored in foreman",
"value": [
"lo",
"en*v*",
"usb*",
"vnet*",
"macvtap*",
"_vdsmdummy_",
"veth*",
"docker*",
"tap*",
"qbr*",
"qvb*",
"qvo*",
"qr-*",
"qg-*",
"vlinuxbr*",
"vovsbr*",
"load_averages::*",
"memory::system::capacity",
"memory::system::used*",
"memory::system::available*",
"memory::swap::capacity",
"memory::swap::used*",
"memory::swap::available*"
],
"category": "facts",
"category_name": "Facts",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will create the host when a report is received",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "create_new_host_when_report_is_uploaded",
"name": "create_new_host_when_report_is_uploaded",
"full_name": "Create new host when report is uploaded",
"value": true,
"category": "cfgmgmt",
"category_name": "Config Management",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman matchers will be inherited by children when evaluating smart class parameters for hostgroups, organizations and locations",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:13 UTC",
"id": "matchers_inheritance",
"name": "matchers_inheritance",
"full_name": "Matchers inheritance",
"value": true,
"category": "cfgmgmt",
"category_name": "Config Management",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will evaluate host smart class parameters in this order by default",
"settings_type": "array",
"default": [
"fqdn",
"hostgroup",
"os",
"domain"
],
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "Default_parameters_Lookup_Path",
"name": "Default_parameters_Lookup_Path",
"full_name": "Default parameters lookup path",
"value": [
"fqdn",
"hostgroup",
"os",
"domain"
],
"category": "cfgmgmt",
"category_name": "Config Management",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "Foreman will parse ERB in parameters value in the ENC output",
"settings_type": "boolean",
"default": true,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "interpolate_erb_in_parameters",
"name": "interpolate_erb_in_parameters",
"full_name": "Interpolate ERB in parameters",
"value": true,
"category": "cfgmgmt",
"category_name": "Config Management",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
},
{
"description": "All hosts will show a configuration status even when a Puppet smart proxy is not assigned",
"settings_type": "boolean",
"default": false,
"updated_at": "2021-11-26 07:26:06 UTC",
"id": "always_show_configuration_status",
"name": "always_show_configuration_status",
"full_name": "Always show configuration status",
"value": false,
"category": "cfgmgmt",
"category_name": "Config Management",
"readonly": false,
"config_file": null,
"encrypted": false,
"select_values": null
}
]
}
| Param name | Description |
|---|---|
|
location_id optional |
Set the current location context for the request Validations:
|
|
organization_id optional |
Set the current organization context for the request Validations:
|
|
search optional |
filter results Validations:
|
|
order optional |
Sort and order by a searchable field, e.g. ‘id DESC’ Validations:
|
|
page optional |
Page number, starting at 1 Validations:
|
|
per_page optional |
Number of results per page to return, ‘all’ to return all results Validations:
|
| Field name | Type | Possible values |
|---|---|---|
| description | text | |
| name | string |