Node group property reference
Properties hold the configuration that Puppet applies to your nodes. You can set a property on a node group, and depending on the property, also on a node, server, or site.
Platform Manager has more than 2,000 properties, but most of them were created for a single customer and are rarely used. This page covers the properties that are most commonly added to node groups:
- Platform configuration properties. These are the structured (hash) properties that configure a service through its Puppet profile.
- Common standard properties. These are single-value properties that are widely used across node groups.
To see every property, including its scope, type, and the nodes and node groups that use it, go to Administration > Properties in SC//Reliant™ Platform Manager. To see the keys of a hash property, open the property.
Note: A property only takes effect when the Puppet profile that reads it is also added to the node group. Where it is known, the Puppet profile is listed in the tables.
Platform configuration properties
All of the following properties are of type Hash. The Applies to column lists the resources the property can be set on.
Networking
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Network Configurations | network_configurations | Node, Server, Node group | - | Manages network interfaces and routes. Supported since Profiles 7.12.0, and replaces the Network interfaces and Static Routes properties. Top-level keys: network_interfaces, network_routes |
| Host Name Overrides | host_names | Node, Node group | profiles::hosts | Host name entries to add to /etc/hosts.Top-level keys: one key per host name |
| DNS | dns | Node, Server, Node group | - | Configures a DNS server on the node, including ACLs, forwarders, DNSSEC validation, and zones. Top-level keys: acl, allow_query, allow_recursion, listen_on, domain_forwarders, dnssec_validation, zone, zonefile |
| Connection Failover | failover | Node, Node group | profiles::failover | Configures failover between network connections. Top-level keys: network |
| Network interfaces (deprecated) | network_interfaces | Node, Node group | - | Configures the network interfaces of the edge appliance. Deprecated since Profiles 7.12.0. Use Network Configurations instead. Top-level keys: one key per interface |
| Static Routes (deprecated) | network_route | Node, Node group | - | Routes to add to the edge appliance. Deprecated since Profiles 7.12.0. Use Network Configurations instead. Top-level keys: one key per interface |
Clustering
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Cluster Virtual IPs | cluster_vips | Node, Node group | profiles::cluster | Virtual IP addresses to assign to the cluster. Top-level keys: vip |
| Cluster Interfaces | cluster_interfaces | Node, Node group | profiles::cluster | Network interfaces to monitor as part of the cluster. Top-level keys: one key per interface |
| Cluster Mount Points | cluster_mount_points | Node, Server, Node group | profiles::cluster | Additional volumes to mount and synchronize across the nodes in the cluster that are not tied to a virtual machine or container. Top-level keys: one key per mount |
| Cluster Docker Resources | cluster_docker_resources | Node, Node group | profiles::cluster | Docker configuration for clustered containers, with DRBD volume sharing. Requires Profiles 6.5.0 or later. For containers that are not clustered, use Docker. Top-level keys: registries, networks, shared_mounts, containers, proxy, image_management |
| Cluster KVM Resources | cluster_kvm_resources | Node, Node group | profiles::cluster | KVM virtual machines that are managed by the cluster. Top-level keys: one key per virtual machine |
| Cluster LXC | cluster_lxc | Node, Node group | - | LXC containers that are shared between the nodes in the cluster. Top-level keys: one key per container |
Virtualization and containers
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Docker | docker | Node, Server, Node group, Site | profiles::docker | Docker service configuration for containers on a single node. For clustered containers, use Cluster Docker Resources. Top-level keys: registries, networks, volumes, containers, proxy, version |
| KVM Resources | virt_kvm | Node, Node group | profiles::kvm | KVM virtual machines that are not managed by the cluster. Top-level keys: one key per virtual machine |
| LXC Containers | virt_lxc | Node, Node group | profiles::lxc | LXC containers that are not shared with a cluster. Top-level keys: one key per container |
| Logical Volume Groups | logical_volume_groups | Node, Server, Node group | - | LVM volume group configuration. Top-level keys: one key per volume group |
Monitoring and logging
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Sensu Go Agent Configurations | sensugo_agent | Node, Server, Node group, Site | profiles::sensugo::agent | Configures the Sensu Go agent. These options can also override the Sensu Go Check Configurations. Top-level keys: config_hash |
| Sensu Go Common Configurations | sensu_go_common_configurations | Node, Server, Node group, Site | - | Settings shared by Sensu Go agents and servers, such as the version and backends. Top-level keys: version, backends, ssl_enabled, password |
| Sensu Go Check Configurations | sensu_go_checks_configurations | Node, Server, Node group | - | Sensu Go checks and handlers. Top-level keys: checks, handlers, custom_checks |
| Sensu Go Server Configurations | sensu_go_server_configurations | Node, Server, Node group | profiles::sensugo::server | Configures a Sensu Go server. For a standalone server, disable the cluster configuration. Top-level keys: general_configurations, cluster_configurations |
SC//Reliant services
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Reliant Virtual Controller Configurations | rvc_configurations | Node, Server, Node group | profiles::rvc | Configures the SC//Reliant™ Virtual Controller (RVC) on the node. Top-level keys: version, port, backup_location, scheduling, ssl_enabled, command_timeout, maintained_snapshots |
| Reliant Local Status Interface Configurations | rlsi_configurations | Node, Node group | profiles::rlsi | Options and controls for the SC//Reliant Local Status Interface (RLSI). Changes are applied during the next Puppet run. Top-level keys: backups, cluster, vms, music_player_options |
| Edge Install Monitor Configurations | edge_install_monitor | Node, Node group | profiles::edge_install_monitor | Configures the edge install monitor, including the Platform Manager address, connection test, and NTP server. Top-level keys: rpm_address, conn_test, backoff_min_wait, backoff_max_wait, ntp_server |
| Reliant Web Display | rwd_data | Node, Node group | profiles::rwd | Settings for the Reliant Web Display module. Top-level keys: site_url, chrome_flags, service_enabled, package_list |
| EVDI Configurations | evdi_configurations | Node, Server, Node group | profiles::evdi_server | Edge Virtual Desktop Infrastructure (EVDI) configuration. Top-level keys: version, server_options, remmina |
Configuration management
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Choria | choria | Node, Server, Node group | profiles::choria | Deploys and configures Choria as a server, client, or broker. Top-level keys: server, client, broker_settings, version, server_config |
| Puppetserver Configurations | puppetserver_configurations | Server, Node group | profiles::puppetserver | Configures a Puppet server. Top-level keys: version, instances, java_args, certificates, autosign_conf, log_level |
| Managed Files Utility | managed_files | Node, Server, Node group | - | Creates files on the node that are enforced by the automation framework, such as scripts that combine Platform Manager and system data or JSON files built from Platform Manager hashes. The files are created but not run. Top-level keys: directories |
System settings
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| Chrony | chrony | Node, Server, Node group | profiles::chrony | Configures Chrony, which manages the system clock. Top-level keys: package_ensure, servers, server |
| APT Configurations | apt | Node, Server, Node group | profiles::apt | Configures APT, including the proxy, package sources, and pins. Top-level keys: proxy, sources, pins |
| Sudo Configuration | sudo | Node, Server, Node group, Site | profiles::sudo | Configures sudo access. Top-level keys: admin |
| GRUB settings | grub_settings | Node, Server, Node group | - | Manages the kernel command line, so that the node boots with consistent settings for hardware, power management, and resource control. Top-level keys: boot_delay, kernel_parameters |
| Systemd | systemd | Node, Server, Node group | - | Custom systemd settings, such as udev rules, drop-ins, and journald settings. Top-level keys: udev_rules, manage_dropins, journald_settings |
| Unattended upgrades | unattended_upgrades | Node, Server, Node group | - | Configures automatic security upgrades on Debian nodes, run by cron: the archives to upgrade from, packages that must never be upgraded automatically, and the schedule. Top-level keys: enabled, origin_archives, blacklist, cron_entry, jitter |
VPN, proxy, and web services
| Property | Template name | Applies to | Puppet profile | Description |
|---|---|---|---|---|
| OpenVPN Clients Configurations | openvpn_clients_configurations | Node, Server, Node group | profiles::openvpn_client | Configures OpenVPN clients. Top-level keys: version, ovpn_dco, clients, log_size, log_maxage |
| OpenVPN Servers Configurations | openvpn_servers_configurations | Server, Node group | profiles::openvpn_server | Configures OpenVPN servers. Top-level keys: version, ovpn_dco, servers, log_size, log_maxage |
| OpenVPN Client | openvpn_client | Node, Server, Node group | - | Older single-client OpenVPN configuration. Top-level keys: mgmt |
| OpenVPN Servers | openvpn_servers | Server, Node group | - | Older OpenVPN server configuration. Top-level keys: mgmt |
| squid | squid | Node, Server, Node group | profile::squid | Configures the Squid proxy. Top-level keys: acl, http_access, http_ports, https_ports, cache_mem, version |
| Nginx Servers | nginx_servers | Node, Server, Node group | profiles::nginx | Creates and manages Nginx web servers. Top-level keys: server |
| Redis Configurations | redis | Node, Server, Node group, Site | profiles::redis | Configures Redis masters and replicas. Top-level keys: package_ensure, redis_servers |
| Redis master servers | redis_master | Server, Node group | profiles::redis_master | Defines one or more Redis master services. Top-level keys: one key per service |
Common standard properties
The following single-value properties are each used by many node groups. Related properties are grouped into one row.
Hardening
| Property | Template name | Type | Description |
|---|---|---|---|
| Hardening Controls | my_hardening | Hash | Options for the hardening profile, including passwords, wanted and unwanted packages, disabled services, mount options, kernel options, and SSH daemon settings. |
| Hardening Password Root | my_hardening_password_root | Password | The root password set by the hardening profile. |
| Hardening Password Install | my_hardening_password_install | Password | The password of the install user set by the hardening profile. |
Puppet and orchestration
| Property | Template name | Type | Description |
|---|---|---|---|
| Hostname Puppet | my_hostname_puppet | Hostname | The host name of the Puppet server. |
| Hostname PuppetCA | my_hostname_puppetca | Hostname | The host name of the Puppet certificate authority. |
| Hostip Puppet, Hostip Puppet Netmask | my_hostip_puppet, my_hostip_puppet_netmask | IP, Netmask | The IP address and netmask of the Puppet server. |
| Puppet Client Version | my_puppet_client_version | Text | The Puppet agent version to install. |
| Cron Puppet Client Hours, Cron Puppet Client Minutes | my_cron_puppet_client_hours, my_cron_puppet_client_minutes | Number | When the Puppet agent runs from cron. See Configuring automated Puppet runs. |
| Puppet Maxwait | my_puppet_maxwait | Number | The maximum random delay, in seconds, before a scheduled Puppet run. A value of 0 doesn't mean no delay. See Configuring automated Puppet runs. |
| DNS Alt Names | my_dns_alt_names | Text | Alternative DNS names for the node. |
| mcollective clients, mCollective Agents, mcollective rabbitmq host | my_mcollective_clients, my_mcollective_agents, my_mcollective_rabbitmq_host | Text, Hostname | MCollective clients, agents, and RabbitMQ host. |
Versions
| Property | Template name | Type | Description |
|---|---|---|---|
| RVC Version | my_rvc_version | Text | The SC//Reliant Virtual Controller (RVC) version to install. |
| Rlsi Version | my_rlsi_version | Text | The SC//Reliant Local Status Interface (RLSI) version to install. |
Network interfaces
| Property | Template name | Type | Description |
|---|---|---|---|
| Lan1 to Lan6, Bridge0 to Bridge2, Vlan10, Interface External, Ddns Interface | my_lan1 … my_lan6, my_bridge0 … my_bridge2, my_vlan10, my_interface_external, my_ddns_interface | Network interface | The configuration of a network interface. For nodes on Profiles 7.12.0 or later, network interfaces are managed with Network Configurations. |
| <Interface> Ip, <Interface> Netmask, <Interface> Gateway | for example my_lan1_ip, my_lan1_netmask, my_lan1_gateway, my_bridge0_ip | IP, Netmask | The static IP address, netmask, and gateway of an interface. |
| <Interface> Vip, <Interface> Vip Netmask | for example my_bridge0_vip, my_lan1_vip | IP, Netmask | A virtual IP address and netmask on an interface. |
| Bridge0 Interfaces, Bridge1 Interfaces | my_bridge0_interfaces, my_bridge1_interfaces | Text | The physical interfaces that make up a bridge. |
Domain and DNS
| Property | Template name | Type | Description |
|---|---|---|---|
| Domain | my_domain | Text | The domain of the node. |
| Domain Reverse | my_domain_reverse | Text | The reverse DNS zone. |
| Hostips Dns, Hostips Dns Netmask | my_hostips_dns, my_hostips_dns_netmask | IP, Netmask | The IP addresses and netmask of the DNS servers. Puppet writes these servers to /etc/resolv.conf on each node, followed by the Puppet server's IP address, and the node queries them in that order. If a public DNS server such as 8.8.8.8 is listed first, the node can't resolve internal SC//Reliant host names, such as the Sensu servers. See Troubleshooting a node that shows as offline. |
Logging
| Property | Template name | Type | Description |
|---|---|---|---|
| Rsyslog Client | my_rsyslog_client | Hash | Rsyslog client settings, including log forwarders and Elasticsearch, Datadog, and New Relic destinations. |
| Rsyslog Retention | my_rsyslog_retention | Number | The maximum number of days to keep logs. |
| Hostip Log | my_hostip_log | IP | The IP address of the log server. |
| logservers | my_logservers | Text | The log servers to send logs to. |
| logserver store logs | my_logserver_store_logs | Boolean | Whether an rsyslog server stores all logs. |
| logserver relay | my_logserver_relay | Boolean | Whether an rsyslog server relays logs. |
Monitoring
| Property | Template name | Type | Description |
|---|---|---|---|
| hostip sensu, hostip sensu Netmask | my_hostip_sensu, my_hostip_sensu_netmask | IP, Netmask | The IP address and netmask of the Sensu server. |
| Sensu Subscriptions | my_sensu_subscriptions | Text | The Sensu subscriptions for the node. |
| Arpwatch Interfaces | my_arpwatch_interfaces | Text | The interfaces that arpwatch monitors. |
| interface monitor interval, interface monitor timeout | my_interface_monitor_interval, my_interface_monitor_timeout | Number | How often, and with what timeout, interfaces are monitored. |
IPMI
| Property | Template name | Type | Description |
|---|---|---|---|
| IPMI | my_ipmi | Hash | The configuration of the IPMI interface, including users and networks. Does not work properly with Profiles earlier than 6.0.0. |
| ipmi ip, ipmi gateway | my_ipmi_ip, my_ipmi_gateway | IP | The IP address and gateway of the IPMI interface. |
| IPMI Password | my_ipmi_password | Password | The password for the IPMI interface. |
RLSI
| Property | Template name | Type | Description |
|---|---|---|---|
| Rlsi Enabled Tabs, Rlsi Publicly Available Tabs, Rlsi Enabled Checks | my_rlsi_enabled_tabs, my_rlsi_publicly_available_tabs, my_rlsi_enabled_checks | Text | The RLSI tabs and checks that are enabled, and the tabs that can be viewed without signing in. |
| Rlsi Music Enable | my_rlsi_music_enable | Boolean | Whether the RLSI music player is enabled. |
Other
| Property | Template name | Type | Description |
|---|---|---|---|
| apt client proxy | my_apt_client_proxy | Text | The proxy that APT uses. |
| Docker dnsmasq config | my_docker_dnsmasq_config | Hash | The dnsmasq configuration used with Docker. |
| Environment File Content | my_environment_file_content | Text area | The contents of an environment file on the node. |
| KVM Template Path 1, KVM Template Path 2, Optional VM 1 | my_kvm_template_path_1, my_kvm_template_path_2, my_optional_vm_1 | Text | KVM virtual machine template paths and optional virtual machines. |
Other properties
Properties that are not listed on this page are either rarely used or were created for a specific customer. Their template names usually start with my_. To find one, search the Properties page in Platform Manager by name or template name.