HomeDocumentationAPI Reference
Log In
These docs are for v17. Click to read the latest docs for v33.

PrivX Settings

SCOPESECTIONPROPERTYDESCRIPTION
GLOBALauditdata_folderFolder for audit trail data.
timeout_when_no_connmgrTimeout for connections when no connection manager, in seconds.
trail_expiryNumber of days a trail is available before removed from storage.
GLOBALldapconnectionsenable_ldap_custom_root_certificatesSpecifies if PrivX should use custom root certificates.
enable_ldap_system_roots_cert_poolSpecifies if PrivX should use the system certificates pool
insecure_skip_verify_tlsSpecifies whether the client should accept any certificate presented by the server. It makes TLS susceptible to man-in-the-middle attacks.
ldap_retry_attemptsLDAP query connection timeout, in seconds.
ldap_root_ca_pemCustom root certificate in PEM format, which will be added to cert pool for LDAP connections.
GLOBALdisclaimerprivx_disclaimerSpecify disclaimers in JSON format as an array of disclaimer objects.
HOST-STOREhealth-check-optionsservice_health_check_max_requests_per_secondMaximum service health check requests per second per worker.
service_health_check_max_workersMaximum concurrent health check workers.
service_health_check_waitInterval between health check runs, in seconds.
service_health_checks_enabledSpecifies whether PrivX should perform network connectivity health checks for services.
HOST-STOREhost-house-keepinghost_housekeeping_run_intervalInterval between housekeeping runs, in hours.
hosts_deleted_ageThe delay (in hours) between when a host has been deleted to when it will be permanently removed.
HOST-STOREinitial-host-service-options-sshexecSet true to enable exec as default for all the hosts.
file_transferSet true to enable file_transfer as default for all the hosts.
shellSet true to enable shell operations as default for all the hosts.
tunnelsSet true to enable tunnels as default for all the hosts.
x11Set true to enable x11 as default for all the hosts.
otherSet true to enable all the other ssh operations as default for all the hosts.
HOST-STOREinitial-host-service-options-rdpaudioSet true to enable audio as default for all the hosts.
clipboardSet true to enable clipboard as default for all the hosts.
file_transferSet true to enable file_transfer as default for all the hosts.
HOST-STOREinitial-host-service-options-webaudioSet true to enable audio as default for all the hosts.
clipboardSet true to enable clipboard as default for all the hosts.
file_transferSet true to enable file_transfer as default for all the hosts.
ROLE-STOREauthorizedkeysexpired_purge_interval_hoursExpired authorized keys purge interval, in hours.
max_validity_daysAuthorized key maximum validity period length in days
min_rsa_key_sizeMinimum key size in bits for ssh-rsa keys.
supported_key_typesSpecifies the supported authorized key types for logging in to PrivX with user specific authorized keys.
ROLE-STOREawsenabledSpecifies whether AWS support is enabled.
default_regionDefault AWS region to use for fetching access tokens.
enable_assume_roleEnable assume-role temporary session credentials.
assume_role_default_ttlExpiration time in seconds for assume-role temporary credentials.
enable_federated_tokensEnable federation token access.
federated_tokens_default_ttlExpiration time in seconds for federation token
force_mfaForce Multi Factor Authentication. MFA is supported by default with assume-role level access. But, federated tokens do not support MFA.
max_aws_rolesMaximum number of AWS roles to fetch for role federation
ROLE-STOREcachingenableSpecifies whether caching of user role memberships, rule evaluation results, user settings and AWS role descriptions is enabled
max_entriesMaximum entries in the local LRU cache. If cache exceeds this size, the least recently used entries are purged
rule_evaluation_cache_enabledSpecifies whether role rule evaluation results should be cached.
sync_interval_secondsInternal in-mem cache periodic synchronization interval in seconds
ttlCache TTL in seconds.
typeCache type
user_cache_refresh_ttlCache TTL for user caching, in seconds.
ROLE-STOREdirectoryblacklisted_host_tag_prefixesBlacklisted host tag prefixes
ROLE-STOREldapenable_cacheEnable LDAP query cache
default_cache_ttlDefault LDAP cache TTL (in seconds).
attributesLDAP attributes filter
default_user_filterDefault pre-filter to use when searching users.
enable_nested_groupsEnable nested groups for role mappings.
global_ad_user_filterfilter to AD users or mapping roles
paging_sizeLDAP query paging size
ROLE-STOREscanningfirst_host_scanning_delayHost scanning delay after starting the service in seconds.
first_role_scanning_delayAWS role scanning delay after starting the service
host_scanning_frequencyHost scanning frequency default value in seconds.
MONITOR-SERVICEhousekeepinghousekeeping_intervalInterval between audit events housekeeping runs, in hours
data_retention_periodNumber of days that audit events must be kept in the database.
status_check_intervalInterval between status checks, in seconds.
system_health_check_intervalInterval between system health check, in hours.
cache_db_expiry_intervalInterval for removing expired keys from the database cache, in seconds.
TRAIL-INDEXhousekeepinghousekeeping_intervalInterval between housekeeping runs, in minutes, for clearing up expired audit trail files.
TRAIL-INDEXworkersno_of_workersMaximum audit trail indexing concurrency.