# Functions
NewAnsibleWithConfigurationSettingsExecute return a new AnsibleWithConfigurationSettingsExecute.
WithAnsibleActionPlugins sets the value for the configuraion ANSIBLE_ACTION_PLUGINS (Colon separated paths in which Ansible will search for Action Plugins.).
WithAnsibleActionWarnings sets the option ANSIBLE_ACTION_WARNINGS to true (By default Ansible will issue a warning when received from a task action (module or action plugin) These warnings can be silenced by adjusting this setting to False.).
WithAnsibleAgnosticBecomePrompt sets the option ANSIBLE_AGNOSTIC_BECOME_PROMPT to true (Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method).
WithAnsibleAnyErrorsFatal sets the option ANSIBLE_ANY_ERRORS_FATAL to true (Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors.).
WithAnsibleAskPass sets the option ANSIBLE_ASK_PASS to true (This controls whether an Ansible playbook should prompt for a login password.
WithAnsibleAskVaultPass sets the option ANSIBLE_ASK_VAULT_PASS to true (This controls whether an Ansible playbook should prompt for a vault password.).
WithAnsibleBecome sets the option ANSIBLE_BECOME to true (Toggles the use of privilege escalation, allowing you to ‘become’ another user after login.).
WithAnsibleBecomeAllowSameUser sets the option ANSIBLE_BECOME_ALLOW_SAME_USER to true (This setting controls if become is skipped when remote user and become user are the same.
WithAnsibleBecomeAskPass sets the option ANSIBLE_BECOME_ASK_PASS to true (Toggle to prompt for privilege escalation password.).
WithAnsibleBecomeExe sets the value for the configuraion ANSIBLE_BECOME_EXE (executable to use for privilege escalation, otherwise Ansible will depend on PATH).
WithAnsibleBecomeFlags sets the value for the configuraion ANSIBLE_BECOME_FLAGS (Flags to pass to the privilege escalation executable.).
WithAnsibleBecomeMethod sets the value for the configuraion ANSIBLE_BECOME_METHOD (Privilege escalation method to use when become is enabled.).
WithAnsibleBecomePasswordFile sets the value for the configuraion ANSIBLE_BECOME_PASSWORD_FILE (The password file to use for the become plugin.
WithAnsibleBecomePlugins sets the value for the configuraion ANSIBLE_BECOME_PLUGINS (Colon separated paths in which Ansible will search for Become Plugins.).
WithAnsibleBecomeUser sets the value for the configuraion ANSIBLE_BECOME_USER (The user your login/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified.).
WithAnsibleCachePlugin sets the value for the configuraion ANSIBLE_CACHE_PLUGIN (Chooses which cache plugin to use, the default ‘memory’ is ephemeral.).
WithAnsibleCachePluginConnection sets the value for the configuraion ANSIBLE_CACHE_PLUGIN_CONNECTION (Defines connection or path information for the cache plugin).
WithAnsibleCachePluginPrefix sets the value for the configuraion ANSIBLE_CACHE_PLUGIN_PREFIX (Prefix to use for cache plugin files/tables).
WithAnsibleCachePlugins sets the value for the configuraion ANSIBLE_CACHE_PLUGINS (Colon separated paths in which Ansible will search for Cache Plugins.).
WithAnsibleCachePluginTimeout sets the value for the configuraion ANSIBLE_CACHE_PLUGIN_TIMEOUT (Expiration timeout for the cache plugin data).
WithAnsibleCallbackPlugins sets the value for the configuraion ANSIBLE_CALLBACK_PLUGINS (Colon separated paths in which Ansible will search for Callback Plugins.).
WithAnsibleCallbacksEnabled sets the value for the configuraion ANSIBLE_CALLBACKS_ENABLED (List of enabled callbacks, not all callbacks need enabling, but many of those shipped with Ansible do as we don’t want them activated by default.
WithAnsibleCliconfPlugins sets the value for the configuraion ANSIBLE_CLICONF_PLUGINS (Colon separated paths in which Ansible will search for Cliconf Plugins.).
WithAnsibleCollectionsOnAnsibleVersionMismatch sets the value for the configuraion ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH (When a collection is loaded that does not support the running Ansible version (with the collection metadata key requires_ansible).).
WithAnsibleCollectionsPaths sets the value for the configuraion ANSIBLE_COLLECTIONS_PATHS (Colon separated paths in which Ansible will search for collections content.
WithAnsibleCollectionsScanSysPath sets the option ANSIBLE_COLLECTIONS_SCAN_SYS_PATH to true (A boolean to enable or disable scanning the sys.path for installed collections).
WithAnsibleColorChanged sets the value for the configuraion ANSIBLE_COLOR_CHANGED (Defines the color to use on ‘Changed’ task status).
WithAnsibleColorConsolePrompt sets the value for the configuraion ANSIBLE_COLOR_CONSOLE_PROMPT (Defines the default color to use for ansible-console).
WithAnsibleColorDebug sets the value for the configuraion ANSIBLE_COLOR_DEBUG (Defines the color to use when emitting debug messages).
WithAnsibleColorDeprecate sets the value for the configuraion ANSIBLE_COLOR_DEPRECATE (Defines the color to use when emitting deprecation messages).
WithAnsibleColorDiffAdd sets the value for the configuraion ANSIBLE_COLOR_DIFF_ADD (Defines the color to use when showing added lines in diffs).
WithAnsibleColorDiffLines sets the value for the configuraion ANSIBLE_COLOR_DIFF_LINES (Defines the color to use when showing diffs).
WithAnsibleColorDiffRemove sets the value for the configuraion ANSIBLE_COLOR_DIFF_REMOVE (Defines the color to use when showing removed lines in diffs).
WithAnsibleColorError sets the value for the configuraion ANSIBLE_COLOR_ERROR (Defines the color to use when emitting error messages).
WithAnsibleColorHighlight sets the value for the configuraion ANSIBLE_COLOR_HIGHLIGHT (Defines the color to use for highlighting).
WithAnsibleColorOk sets the value for the configuraion ANSIBLE_COLOR_OK (Defines the color to use when showing ‘OK’ task status).
WithAnsibleColorSkip sets the value for the configuraion ANSIBLE_COLOR_SKIP (Defines the color to use when showing ‘Skipped’ task status).
WithAnsibleColorUnreachable sets the value for the configuraion ANSIBLE_COLOR_UNREACHABLE (Defines the color to use on ‘Unreachable’ status).
WithAnsibleColorVerbose sets the value for the configuraion ANSIBLE_COLOR_VERBOSE (Defines the color to use when emitting verbose messages.
WithAnsibleColorWarn sets the value for the configuraion ANSIBLE_COLOR_WARN (Defines the color to use when emitting warning messages).
WithAnsibleConnectionPasswordFile sets the value for the configuraion ANSIBLE_CONNECTION_PASSWORD_FILE (The password file to use for the connection plugin.
WithAnsibleConnectionPath sets the value for the configuraion ANSIBLE_CONNECTION_PATH (Specify where to look for the ansible-connection script.
WithAnsibleConnectionPlugins sets the value for the configuraion ANSIBLE_CONNECTION_PLUGINS (Colon separated paths in which Ansible will search for Connection Plugins.).
WithAnsibleCoverageRemoteOutput sets the value for the configuraion _ANSIBLE_COVERAGE_REMOTE_OUTPUT (Sets the output directory on the remote host to generate coverage reports to.
WithAnsibleCoverageRemotePathFilter sets the value for the configuraion _ANSIBLE_COVERAGE_REMOTE_PATH_FILTER (A list of paths for files on the Ansible controller to run coverage for when executing on the remote host.
WithAnsibleCowAcceptlist sets the value for the configuraion ANSIBLE_COW_ACCEPTLIST (Accept list of cowsay templates that are ‘safe’ to use, set to empty list if you want to enable all installed templates.
WithAnsibleCowPath sets the value for the configuraion ANSIBLE_COW_PATH (Specify a custom cowsay path or swap in your cowsay implementation of choice).
WithAnsibleCowSelection sets the value for the configuraion ANSIBLE_COW_SELECTION (This allows you to chose a specific cowsay stencil for the banners or use ‘random’ to cycle through them.).
WithAnsibleDebug sets the option ANSIBLE_DEBUG to true (Toggles debug output in Ansible.
WithAnsibleDeprecationWarnings sets the option ANSIBLE_DEPRECATION_WARNINGS to true (Toggle to control the showing of deprecation warnings).
WithAnsibleDevelWarning sets the option ANSIBLE_DEVEL_WARNING to true (Toggle to control showing warnings related to running devel).
WithAnsibleDiffAlways sets the value for the configuraion ANSIBLE_DIFF_ALWAYS (Configuration toggle to tell modules to show differences when in ‘changed’ status, equivalent to --diff.).
WithAnsibleDiffContext sets the value for the configuraion ANSIBLE_DIFF_CONTEXT (How many lines of context to show when displaying the differences between files.).
WithAnsibleDisplayArgsToStdout sets the option ANSIBLE_DISPLAY_ARGS_TO_STDOUT to true (Normally ansible-playbook will print a header for each task that is run.
WithAnsibleDisplaySkippedHosts sets the option ANSIBLE_DISPLAY_SKIPPED_HOSTS to true (Toggle to control displaying skipped task/host entries in a task in the default callback).
WithAnsibleDocFragmentPlugins sets the value for the configuraion ANSIBLE_DOC_FRAGMENT_PLUGINS (Colon separated paths in which Ansible will search for Documentation Fragments Plugins.).
WithAnsibleDuplicateYamlDictKey sets the value for the configuraion ANSIBLE_DUPLICATE_YAML_DICT_KEY (By default Ansible will issue a warning when a duplicate dict key is encountered in YAML.
WithAnsibleEnableTaskDebugger sets the option ANSIBLE_ENABLE_TASK_DEBUGGER to true (Whether or not to enable the task debugger, this previously was done as a strategy plugin.
WithAnsibleErrorOnMissingHandler sets the option ANSIBLE_ERROR_ON_MISSING_HANDLER to true (Toggle to allow missing handlers to become a warning instead of an error when notifying.).
WithAnsibleErrorOnUndefinedVars sets the option ANSIBLE_ERROR_ON_UNDEFINED_VARS to true (When True, this causes ansible templating to fail steps that reference variable names that are likely typoed.
WithAnsibleExecutable sets the value for the configuraion ANSIBLE_EXECUTABLE (This indicates the command to use to spawn a shell under for Ansible’s execution needs on a target.
WithAnsibleFactPath sets the value for the configuraion ANSIBLE_FACT_PATH (This option allows you to globally configure a custom path for ‘local_facts’ for the implied ansible_collections.ansible.builtin.setup_module task when using fact gathering.
WithAnsibleFactsModules sets the value for the configuraion ANSIBLE_FACTS_MODULES (Which modules to run during a play’s fact gathering stage, using the default of ‘smart’ will try to figure it out based on connection type.
WithAnsibleFilterPlugins sets the value for the configuraion ANSIBLE_FILTER_PLUGINS (Colon separated paths in which Ansible will search for Jinja2 Filter Plugins.).
WithAnsibleForceColor sets the option ANSIBLE_FORCE_COLOR to true (This option forces color mode even when running without a TTY or the “nocolor” setting is True.).
WithAnsibleForceHandlers sets the option ANSIBLE_FORCE_HANDLERS to true (This option controls if notified handlers run on a host even if a failure occurs on that host.
WithAnsibleForks sets the value for the configuraion ANSIBLE_FORKS (Maximum number of forks Ansible will use to execute tasks on target hosts.).
WithAnsibleGalaxyCacheDir sets the value for the configuraion ANSIBLE_GALAXY_CACHE_DIR (The directory that stores cached responses from a Galaxy server.
WithAnsibleGalaxyCollectionSkeleton sets the value for the configuraion ANSIBLE_GALAXY_COLLECTION_SKELETON (Collection skeleton directory to use as a template for the init action in ansible-galaxy collection, same as --collection-skeleton.).
WithAnsibleGalaxyCollectionSkeletonIgnore sets the value for the configuraion ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE (patterns of files to ignore inside a Galaxy collection skeleton directory).
WithAnsibleGalaxyCollectionsPathWarning sets the value for the configuraion ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING (whether ansible-galaxy collection install should warn about --collections-path missing from configured COLLECTIONS_PATHS).
WithAnsibleGalaxyDisableGpgVerify sets the value for the configuraion ANSIBLE_GALAXY_DISABLE_GPG_VERIFY (Disable GPG signature verification during collection installation.).
WithAnsibleGalaxyDisplayProgress sets the value for the configuraion ANSIBLE_GALAXY_DISPLAY_PROGRESS (Some steps in ansible-galaxy display a progress wheel which can cause issues on certain displays or when outputting the stdout to a file.
WithAnsibleGalaxyGpgKeyring sets the value for the configuraion ANSIBLE_GALAXY_GPG_KEYRING (Configure the keyring used for GPG signature verification during collection installation and verification.).
WithAnsibleGalaxyIgnore sets the option ANSIBLE_GALAXY_IGNORE to true (If set to yes, ansible-galaxy will not validate TLS certificates.
WithAnsibleGalaxyIgnoreSignatureStatusCodes sets the value for the configuraion ANSIBLE_GALAXY_IGNORE_SIGNATURE_STATUS_CODES (A list of GPG status codes to ignore during GPG signature verification.
WithAnsibleGalaxyRequiredValidSignatureCount sets the value for the configuraion ANSIBLE_GALAXY_REQUIRED_VALID_SIGNATURE_COUNT (The number of signatures that must be successful during GPG signature verification while installing or verifying collections.
WithAnsibleGalaxyRoleSkeleton sets the value for the configuraion ANSIBLE_GALAXY_ROLE_SKELETON (Role skeleton directory to use as a template for the init action in ansible-galaxy/ansible-galaxy role, same as --role-skeleton.).
WithAnsibleGalaxyRoleSkeletonIgnore sets the value for the configuraion ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE (patterns of files to ignore inside a Galaxy role or collection skeleton directory).
WithAnsibleGalaxyServer sets the value for the configuraion ANSIBLE_GALAXY_SERVER (URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source.).
WithAnsibleGalaxyServerList sets the value for the configuraion ANSIBLE_GALAXY_SERVER_LIST (A list of Galaxy servers to use when installing a collection.
WithAnsibleGalaxyServerTimeout sets the value for the configuraion ANSIBLE_GALAXY_SERVER_TIMEOUT (The default timeout for Galaxy API calls.
WithAnsibleGalaxyTokenPath sets the value for the configuraion ANSIBLE_GALAXY_TOKEN_PATH (Local path to galaxy access token file).
WithAnsibleGathering sets the value for the configuraion ANSIBLE_GATHERING (This setting controls the default policy of fact gathering (facts discovered about remote systems).
WithAnsibleGatherSubset sets the value for the configuraion ANSIBLE_GATHER_SUBSET (Set the gather_subset option for the ansible_collections.ansible.builtin.setup_module task in the implicit fact gathering.
WithAnsibleGatherTimeout sets the value for the configuraion ANSIBLE_GATHER_TIMEOUT (Set the timeout in seconds for the implicit fact gathering, see the module documentation for specifics.
WithAnsibleHashBehaviour sets the value for the configuraion ANSIBLE_HASH_BEHAVIOUR (This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible.
WithAnsibleHome sets the value for the configuraion ANSIBLE_HOME (The default root path for Ansible config files on the controller.).
WithAnsibleHostKeyChecking sets the option ANSIBLE_HOST_KEY_CHECKING to true (Set this to “False” if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host).
WithAnsibleHostPatternMismatch sets the value for the configuraion ANSIBLE_HOST_PATTERN_MISMATCH (This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it).
WithAnsibleHttpapiPlugins sets the value for the configuraion ANSIBLE_HTTPAPI_PLUGINS (Colon separated paths in which Ansible will search for HttpApi Plugins.).
WithAnsibleInjectFactVars sets the option ANSIBLE_INJECT_FACT_VARS to true (Facts are available inside the ansible_facts variable, this setting also pushes them as their own vars in the main namespace.
WithAnsibleInvalidTaskAttributeFailed sets the option ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED to true (If ‘false’, invalid attributes for a task will result in warnings instead of errors).
WithAnsibleInventory sets the value for the configuraion ANSIBLE_INVENTORY (Comma separated list of Ansible inventory sources).
WithAnsibleInventoryAnyUnparsedIsFailed sets the option ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED to true (If ‘true’, it is a fatal error when any given inventory source cannot be successfully parsed by any available inventory plugin; otherwise, this situation only attracts a warning.).
WithAnsibleInventoryCache sets the value for the configuraion ANSIBLE_INVENTORY_CACHE (Toggle to turn on inventory caching.
WithAnsibleInventoryCacheConnection sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_CONNECTION (The inventory cache connection.
WithAnsibleInventoryCachePlugin sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_PLUGIN (The plugin for caching inventory.
WithAnsibleInventoryCachePluginPrefix sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX (The table prefix for the cache plugin.
WithAnsibleInventoryCacheTimeout sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_TIMEOUT (Expiration timeout for the inventory cache plugin data.
WithAnsibleInventoryEnabled sets the value for the configuraion ANSIBLE_INVENTORY_ENABLED (List of enabled inventory plugins, it also determines the order in which they are used.).
WithAnsibleInventoryExport sets the value for the configuraion ANSIBLE_INVENTORY_EXPORT (Controls if ansible-inventory will accurately reflect Ansible’s view into inventory or its optimized for exporting.).
WithAnsibleInventoryIgnore sets the value for the configuraion ANSIBLE_INVENTORY_IGNORE (List of extensions to ignore when using a directory as an inventory source).
WithAnsibleInventoryIgnoreRegex sets the value for the configuraion ANSIBLE_INVENTORY_IGNORE_REGEX (List of patterns to ignore when using a directory as an inventory source).
WithAnsibleInventoryPlugins sets the value for the configuraion ANSIBLE_INVENTORY_PLUGINS (Colon separated paths in which Ansible will search for Inventory Plugins.).
WithAnsibleInventoryUnparsedFailed sets the value for the configuraion ANSIBLE_INVENTORY_UNPARSED_FAILED (If ‘true’ it is a fatal error if every single potential inventory source fails to parse, otherwise this situation will only attract a warning.).
WithAnsibleInventoryUnparsedWarning sets the option ANSIBLE_INVENTORY_UNPARSED_WARNING to true (By default Ansible will issue a warning when no inventory was loaded and notes that it will use an implicit localhost-only inventory.
WithAnsibleJinja2Extensions sets the value for the configuraion ANSIBLE_JINJA2_EXTENSIONS (This is a developer-specific feature that allows enabling additional Jinja2 extensions.
WithAnsibleJinja2Native sets the option ANSIBLE_JINJA2_NATIVE to true (This option preserves variable types during template operations.).
WithAnsibleJinja2NativeWarning sets the option ANSIBLE_JINJA2_NATIVE_WARNING to true (Toggle to control showing warnings related to running a Jinja version older than required for jinja2_native [:Deprecated in: 2.17 :Deprecated detail: This option is no longer used in the Ansible Core code base.]).
WithAnsibleKeepRemoteFiles sets the option ANSIBLE_KEEP_REMOTE_FILES to true (Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
WithAnsibleLibrary sets the value for the configuraion ANSIBLE_LIBRARY (Colon separated paths in which Ansible will search for Modules.).
WithAnsibleLibvirtLxcNoseclabel sets the option ANSIBLE_LIBVIRT_LXC_NOSECLABEL to true (This setting causes libvirt to connect to lxc containers by passing –noseclabel to virsh.
WithAnsibleLoadCallbackPlugins sets the option ANSIBLE_LOAD_CALLBACK_PLUGINS to true (Controls whether callback plugins are loaded when running /usr/bin/ansible.
WithAnsibleLocalhostWarning sets the option ANSIBLE_LOCALHOST_WARNING to true (By default Ansible will issue a warning when there are no hosts in the inventory.
WithAnsibleLocalTemp sets the value for the configuraion ANSIBLE_LOCAL_TEMP (Temporary directory for Ansible to use on the controller.).
WithAnsibleLogFilter sets the value for the configuraion ANSIBLE_LOG_FILTER (List of logger names to filter out of the log file).
WithAnsibleLogPath sets the value for the configuraion ANSIBLE_LOG_PATH (File to which Ansible will log on the controller.
WithAnsibleLookupPlugins sets the value for the configuraion ANSIBLE_LOOKUP_PLUGINS (Colon separated paths in which Ansible will search for Lookup Plugins.).
WithAnsibleMaxDiffSize sets the value for the configuraion ANSIBLE_MAX_DIFF_SIZE (Maximum size of files to be considered for diff display).
WithAnsibleModuleArgs sets the value for the configuraion ANSIBLE_MODULE_ARGS (This sets the default arguments to pass to the ansible adhoc binary if no -a is specified.).
WithAnsibleModuleIgnoreExts sets the value for the configuraion ANSIBLE_MODULE_IGNORE_EXTS (List of extensions to ignore when looking for modules to load This is for rejecting script and binary module fallback extensions).
WithAnsibleModuleStrictUtf8Response sets the value for the configuraion ANSIBLE_MODULE_STRICT_UTF8_RESPONSE (Enables whether module responses are evaluated for containing non UTF-8 data Disabling this may result in unexpected behavior Only ansible-core should evaluate this configuration).
WithAnsibleModuleUtils sets the value for the configuraion ANSIBLE_MODULE_UTILS (Colon separated paths in which Ansible will search for Module utils files, which are shared by modules.).
WithAnsibleNetconfPlugins sets the value for the configuraion ANSIBLE_NETCONF_PLUGINS (Colon separated paths in which Ansible will search for Netconf Plugins.).
WithAnsibleNetconfSshConfig sets the value for the configuraion ANSIBLE_NETCONF_SSH_CONFIG (This variable is used to enable bastion/jump host with netconf connection.
WithAnsibleNetworkGroupModules sets the value for the configuraion ANSIBLE_NETWORK_GROUP_MODULES ().
WithAnsibleNocows sets the option ANSIBLE_NOCOWS to true (If you have cowsay installed but want to avoid the ‘cows’ (why????), use this.).
WithAnsibleNoLog sets the option ANSIBLE_NO_LOG to true (Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures.).
WithAnsibleNoTargetSyslog sets the option ANSIBLE_NO_TARGET_SYSLOG to true (Toggle Ansible logging to syslog on the target when it executes tasks.
WithAnsibleNullRepresentation sets the value for the configuraion ANSIBLE_NULL_REPRESENTATION (What templating should return as a ‘null’ value.
WithAnsibleOldPluginCacheClear sets the option ANSIBLE_OLD_PLUGIN_CACHE_CLEAR to true (Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviours in which a plugin loaded in previous plays would be unexpectedly ‘sticky’.
WithAnsibleParamikoHostKeyAutoAdd sets the option ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD to true ().
WithAnsibleParamikoLookForKeys sets the option ANSIBLE_PARAMIKO_LOOK_FOR_KEYS to true ().
WithAnsiblePersistentCommandTimeout sets the value for the configuraion ANSIBLE_PERSISTENT_COMMAND_TIMEOUT (This controls the amount of time to wait for response from remote device before timing out persistent connection.).
WithAnsiblePersistentConnectRetryTimeout sets the value for the configuraion ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT (This controls the retry timeout for persistent connection to connect to the local domain socket.).
WithAnsiblePersistentConnectTimeout sets the value for the configuraion ANSIBLE_PERSISTENT_CONNECT_TIMEOUT (This controls how long the persistent connection will remain idle before it is destroyed.).
WithAnsiblePersistentControlPathDir sets the value for the configuraion ANSIBLE_PERSISTENT_CONTROL_PATH_DIR (Path to socket to be used by the connection persistence system.).
WithAnsiblePipelining sets the option ANSIBLE_PIPELINING to true (This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all.
WithAnsiblePlaybookDir sets the value for the configuraion ANSIBLE_PLAYBOOK_DIR (A number of non-playbook CLIs have a --playbook-dir argument; this sets the default value for it.).
WithAnsiblePlaybookVarsRoot sets the value for the configuraion ANSIBLE_PLAYBOOK_VARS_ROOT (This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars).
WithAnsiblePollInterval sets the value for the configuraion ANSIBLE_POLL_INTERVAL (For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how often to check back on the status of those tasks when an explicit poll interval is not supplied.
WithAnsiblePrecedence sets the value for the configuraion ANSIBLE_PRECEDENCE (Allows to change the group variable precedence merge order.).
WithAnsiblePrivateKeyFile sets the value for the configuraion ANSIBLE_PRIVATE_KEY_FILE (Option for connections using a certificate or key file to authenticate, rather than an agent or passwords, you can set the default value here to avoid re-specifying –private-key with every invocation.).
WithAnsiblePrivateRoleVars sets the option ANSIBLE_PRIVATE_ROLE_VARS to true (By default, imported roles publish their variables to the play and other roles, this setting can avoid that.
WithAnsiblePythonInterpreter sets the value for the configuraion ANSIBLE_PYTHON_INTERPRETER (Path to the Python interpreter to be used for module execution on remote targets, or an automatic discovery mode.
WithAnsiblePythonModuleRlimitNofile sets the value for the configuraion ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE (Attempts to set RLIMIT_NOFILE soft limit to the specified value when executing Python modules (can speed up subprocess usage on Python 2.x.
WithAnsibleRemotePort sets the value for the configuraion ANSIBLE_REMOTE_PORT (Port to use in remote connections, when blank it will use the connection plugin default.).
WithAnsibleRemoteUser sets the value for the configuraion ANSIBLE_REMOTE_USER (Sets the login user for the target machines When blank it uses the connection plugin’s default, normally the user currently executing Ansible.).
WithAnsibleRetryFilesEnabled sets the value for the configuraion ANSIBLE_RETRY_FILES_ENABLED (This controls whether a failed Ansible playbook should create a .retry file.).
WithAnsibleRetryFilesSavePath sets the value for the configuraion ANSIBLE_RETRY_FILES_SAVE_PATH (This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.
WithAnsibleRolesPath sets the value for the configuraion ANSIBLE_ROLES_PATH (Colon separated paths in which Ansible will search for Roles.).
WithAnsibleRunTags sets the value for the configuraion ANSIBLE_RUN_TAGS (default list of tags to run in your plays, Skip Tags has precedence.).
WithAnsibleRunVarsPlugins sets the value for the configuraion ANSIBLE_RUN_VARS_PLUGINS (This setting can be used to optimize vars_plugin usage depending on user’s inventory size and play selection.).
WithAnsibleSelinuxSpecialFs sets the value for the configuraion ANSIBLE_SELINUX_SPECIAL_FS (Some filesystems do not support safe operations and/or return inconsistent errors, this setting makes Ansible ‘tolerate’ those in the list w/o causing fatal errors.
WithAnsibleShowCustomStats sets the value for the configuraion ANSIBLE_SHOW_CUSTOM_STATS (This adds the custom stats set via the set_stats plugin to the default output).
WithAnsibleSkipTags sets the value for the configuraion ANSIBLE_SKIP_TAGS (default list of tags to skip in your plays, has precedence over Run Tags).
WithAnsibleStdoutCallback sets the value for the configuraion ANSIBLE_STDOUT_CALLBACK (Set the main callback used to display Ansible output.
WithAnsibleStrategy sets the value for the configuraion ANSIBLE_STRATEGY (Set the default strategy used for plays.).
WithAnsibleStrategyPlugins sets the value for the configuraion ANSIBLE_STRATEGY_PLUGINS (Colon separated paths in which Ansible will search for Strategy Plugins.).
WithAnsibleStringConversionAction sets the value for the configuraion ANSIBLE_STRING_CONVERSION_ACTION (Action to take when a module parameter value is converted to a string (this does not affect variables).
WithAnsibleStringTypeFilters sets the value for the configuraion ANSIBLE_STRING_TYPE_FILTERS (This list of filters avoids ‘type conversion’ when templating variables Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.).
WithAnsibleSu sets the option ANSIBLE_SU to true (Toggle the use of “su” for tasks.).
WithAnsibleSyslogFacility sets the value for the configuraion ANSIBLE_SYSLOG_FACILITY (Syslog facility to use when Ansible logs to the remote target).
WithAnsibleSystemWarnings sets the option ANSIBLE_SYSTEM_WARNINGS to true (Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts) These may include warnings about 3rd party packages or other conditions that should be resolved if possible.).
WithAnsibleTaskDebuggerIgnoreErrors sets the option ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS to true (This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True is specified.
WithAnsibleTaskTimeout sets the value for the configuraion ANSIBLE_TASK_TIMEOUT (Set the maximum time (in seconds) that a task can run for.
WithAnsibleTerminalPlugins sets the value for the configuraion ANSIBLE_TERMINAL_PLUGINS (Colon separated paths in which Ansible will search for Terminal Plugins.).
WithAnsibleTestPlugins sets the value for the configuraion ANSIBLE_TEST_PLUGINS (Colon separated paths in which Ansible will search for Jinja2 Test Plugins.).
WithAnsibleTimeout sets the value for the configuraion ANSIBLE_TIMEOUT (This is the default timeout for connection plugins to use.).
WithAnsibleTransformInvalidGroupChars sets the value for the configuraion ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS (Make ansible transform invalid characters in group names supplied by inventory sources.).
WithAnsibleTransport sets the value for the configuraion ANSIBLE_TRANSPORT (Can be any connection plugin available to your ansible installation.
WithAnsibleUsePersistentConnections sets the option ANSIBLE_USE_PERSISTENT_CONNECTIONS to true (Toggles the use of persistence for connections.).
WithAnsibleValidateActionGroupMetadata sets the value for the configuraion ANSIBLE_VALIDATE_ACTION_GROUP_METADATA (A toggle to disable validating a collection’s ‘metadata’ entry for a module_defaults action group.
WithAnsibleVarsEnabled sets the value for the configuraion ANSIBLE_VARS_ENABLED (Accept list for variable plugins that require it.).
WithAnsibleVarsPlugins sets the value for the configuraion ANSIBLE_VARS_PLUGINS (Colon separated paths in which Ansible will search for Vars Plugins.).
WithAnsibleVaultEncryptIdentity sets the value for the configuraion ANSIBLE_VAULT_ENCRYPT_IDENTITY (The vault_id to use for encrypting by default.
WithAnsibleVaultEncryptSalt sets the value for the configuraion ANSIBLE_VAULT_ENCRYPT_SALT (The salt to use for the vault encryption.
WithAnsibleVaultIdentity sets the value for the configuraion ANSIBLE_VAULT_IDENTITY (The label to use for the default vault id label in cases where a vault id label is not provided).
WithAnsibleVaultIdentityList sets the value for the configuraion ANSIBLE_VAULT_IDENTITY_LIST (A list of vault-ids to use by default.
WithAnsibleVaultIdMatch sets the value for the configuraion ANSIBLE_VAULT_ID_MATCH (If true, decrypting vaults with a vault id will only try the password from the matching vault-id).
WithAnsibleVaultPasswordFile sets the value for the configuraion ANSIBLE_VAULT_PASSWORD_FILE (The vault password file to use.
WithAnsibleVerboseToStderr sets the value for the configuraion ANSIBLE_VERBOSE_TO_STDERR (Force ‘verbose’ option to use stderr instead of stdout).
WithAnsibleVerbosity sets the value for the configuraion ANSIBLE_VERBOSITY (Sets the default verbosity, equivalent to the number of -v passed in the command line.).
WithAnsibleWinAsyncStartupTimeout sets the value for the configuraion ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT (For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how long, in seconds, to wait for the task spawned by Ansible to connect back to the named pipe used on Windows systems.
WithAnsibleWorkerShutdownPollCount sets the value for the configuraion ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT (The maximum number of times to check Task Queue Manager worker processes to verify they have exited cleanly.
WithAnsibleWorkerShutdownPollDelay sets the value for the configuraion ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY (The number of seconds to sleep between polling loops when checking Task Queue Manager worker processes to verify they have exited cleanly.
WithAnsibleYamlFilenameExt sets the value for the configuraion ANSIBLE_YAML_FILENAME_EXT (Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these.
WithEditor sets the value for the configuraion EDITOR ().
WithNoColor sets the option NO_COLOR to true (This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.).
WithoutAnsibleActionWarnings sets the option ANSIBLE_ACTION_WARNINGS to false.
WithoutAnsibleAgnosticBecomePrompt sets the option ANSIBLE_AGNOSTIC_BECOME_PROMPT to false.
WithoutAnsibleAnyErrorsFatal sets the option ANSIBLE_ANY_ERRORS_FATAL to false.
WithoutAnsibleAskPass sets the option ANSIBLE_ASK_PASS to false.
WithoutAnsibleAskVaultPass sets the option ANSIBLE_ASK_VAULT_PASS to false.
WithoutAnsibleBecome sets the option ANSIBLE_BECOME to false.
WithoutAnsibleBecomeAllowSameUser sets the option ANSIBLE_BECOME_ALLOW_SAME_USER to false.
WithoutAnsibleBecomeAskPass sets the option ANSIBLE_BECOME_ASK_PASS to false.
WithoutAnsibleCollectionsScanSysPath sets the option ANSIBLE_COLLECTIONS_SCAN_SYS_PATH to false.
WithoutAnsibleDebug sets the option ANSIBLE_DEBUG to false.
WithoutAnsibleDeprecationWarnings sets the option ANSIBLE_DEPRECATION_WARNINGS to false.
WithoutAnsibleDevelWarning sets the option ANSIBLE_DEVEL_WARNING to false.
WithoutAnsibleDisplayArgsToStdout sets the option ANSIBLE_DISPLAY_ARGS_TO_STDOUT to false.
WithoutAnsibleDisplaySkippedHosts sets the option ANSIBLE_DISPLAY_SKIPPED_HOSTS to false.
WithoutAnsibleEnableTaskDebugger sets the option ANSIBLE_ENABLE_TASK_DEBUGGER to false.
WithoutAnsibleErrorOnMissingHandler sets the option ANSIBLE_ERROR_ON_MISSING_HANDLER to false.
WithoutAnsibleErrorOnUndefinedVars sets the option ANSIBLE_ERROR_ON_UNDEFINED_VARS to false.
WithoutAnsibleForceColor sets the option ANSIBLE_FORCE_COLOR to false.
WithoutAnsibleForceHandlers sets the option ANSIBLE_FORCE_HANDLERS to false.
WithoutAnsibleGalaxyIgnore sets the option ANSIBLE_GALAXY_IGNORE to false.
WithoutAnsibleHostKeyChecking sets the option ANSIBLE_HOST_KEY_CHECKING to false.
WithoutAnsibleInjectFactVars sets the option ANSIBLE_INJECT_FACT_VARS to false.
WithoutAnsibleInvalidTaskAttributeFailed sets the option ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED to false.
WithoutAnsibleInventoryAnyUnparsedIsFailed sets the option ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED to false.
WithoutAnsibleInventoryUnparsedWarning sets the option ANSIBLE_INVENTORY_UNPARSED_WARNING to false.
WithoutAnsibleJinja2Native sets the option ANSIBLE_JINJA2_NATIVE to false.
WithoutAnsibleJinja2NativeWarning sets the option ANSIBLE_JINJA2_NATIVE_WARNING to false.
WithoutAnsibleKeepRemoteFiles sets the option ANSIBLE_KEEP_REMOTE_FILES to false.
WithoutAnsibleLibvirtLxcNoseclabel sets the option ANSIBLE_LIBVIRT_LXC_NOSECLABEL to false.
WithoutAnsibleLoadCallbackPlugins sets the option ANSIBLE_LOAD_CALLBACK_PLUGINS to false.
WithoutAnsibleLocalhostWarning sets the option ANSIBLE_LOCALHOST_WARNING to false.
WithoutAnsibleNocows sets the option ANSIBLE_NOCOWS to false.
WithoutAnsibleNoLog sets the option ANSIBLE_NO_LOG to false.
WithoutAnsibleNoTargetSyslog sets the option ANSIBLE_NO_TARGET_SYSLOG to false.
WithoutAnsibleOldPluginCacheClear sets the option ANSIBLE_OLD_PLUGIN_CACHE_CLEAR to false.
WithoutAnsibleParamikoHostKeyAutoAdd sets the option ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD to false.
WithoutAnsibleParamikoLookForKeys sets the option ANSIBLE_PARAMIKO_LOOK_FOR_KEYS to false.
WithoutAnsiblePipelining sets the option ANSIBLE_PIPELINING to false.
WithoutAnsiblePrivateRoleVars sets the option ANSIBLE_PRIVATE_ROLE_VARS to false.
WithoutAnsibleSu sets the option ANSIBLE_SU to false.
WithoutAnsibleSystemWarnings sets the option ANSIBLE_SYSTEM_WARNINGS to false.
WithoutAnsibleTaskDebuggerIgnoreErrors sets the option ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS to false.
WithoutAnsibleUsePersistentConnections sets the option ANSIBLE_USE_PERSISTENT_CONNECTIONS to false.
WithoutNoColor sets the option NO_COLOR to false.
WithPager sets the value for the configuraion PAGER ().
# Constants
AnsibleActionPlugins (pathspec) Colon separated paths in which Ansible will search for Action Plugins.
AnsibleActionWarnings (boolean) By default Ansible will issue a warning when received from a task action (module or action plugin) These warnings can be silenced by adjusting this setting to False.
AnsibleAgnosticBecomePrompt (boolean) Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method.
AnsibleAnyErrorsFatal (boolean) Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors.
AnsibleAskPass (boolean) This controls whether an Ansible playbook should prompt for a login password.
AnsibleAskVaultPass (boolean) This controls whether an Ansible playbook should prompt for a vault password.
AnsibleBecome (boolean) Toggles the use of privilege escalation, allowing you to ‘become’ another user after login.
AnsibleBecomeAllowSameUser (boolean) This setting controls if become is skipped when remote user and become user are the same.
AnsibleBecomeAskPass (boolean) Toggle to prompt for privilege escalation password.
AnsibleBecomeExe () executable to use for privilege escalation, otherwise Ansible will depend on PATH.
AnsibleBecomeFlags () Flags to pass to the privilege escalation executable.
AnsibleBecomeMethod () Privilege escalation method to use when become is enabled.
AnsibleBecomePasswordFile (path) The password file to use for the become plugin.
AnsibleBecomePlugins (pathspec) Colon separated paths in which Ansible will search for Become Plugins.
AnsibleBecomeUser () The user your login/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified.
AnsibleCachePlugin () Chooses which cache plugin to use, the default ‘memory’ is ephemeral.
AnsibleCachePluginConnection () Defines connection or path information for the cache plugin.
AnsibleCachePluginPrefix () Prefix to use for cache plugin files/tables.
AnsibleCachePlugins (pathspec) Colon separated paths in which Ansible will search for Cache Plugins.
AnsibleCachePluginTimeout (integer) Expiration timeout for the cache plugin data.
AnsibleCallbackPlugins (pathspec) Colon separated paths in which Ansible will search for Callback Plugins.
AnsibleCallbacksEnabled (list) List of enabled callbacks, not all callbacks need enabling, but many of those shipped with Ansible do as we don’t want them activated by default.
AnsibleCliconfPlugins (pathspec) Colon separated paths in which Ansible will search for Cliconf Plugins.
AnsibleCollectionsOnAnsibleVersionMismatch () When a collection is loaded that does not support the running Ansible version (with the collection metadata key requires_ansible).
AnsibleCollectionsPaths (pathspec) Colon separated paths in which Ansible will search for collections content.
AnsibleCollectionsScanSysPath (boolean) A boolean to enable or disable scanning the sys.path for installed collections.
AnsibleColorChanged () Defines the color to use on ‘Changed’ task status.
AnsibleColorConsolePrompt () Defines the default color to use for ansible-console.
AnsibleColorDebug () Defines the color to use when emitting debug messages.
AnsibleColorDeprecate () Defines the color to use when emitting deprecation messages.
AnsibleColorDiffAdd () Defines the color to use when showing added lines in diffs.
AnsibleColorDiffLines () Defines the color to use when showing diffs.
AnsibleColorDiffRemove () Defines the color to use when showing removed lines in diffs.
AnsibleColorError () Defines the color to use when emitting error messages.
AnsibleColorHighlight () Defines the color to use for highlighting.
AnsibleColorOk () Defines the color to use when showing ‘OK’ task status.
AnsibleColorSkip () Defines the color to use when showing ‘Skipped’ task status.
AnsibleColorUnreachable () Defines the color to use on ‘Unreachable’ status.
AnsibleColorVerbose () Defines the color to use when emitting verbose messages.
AnsibleColorWarn () Defines the color to use when emitting warning messages.
AnsibleConnectionPasswordFile (path) The password file to use for the connection plugin.
AnsibleConnectionPath (path) Specify where to look for the ansible-connection script.
AnsibleConnectionPlugins (pathspec) Colon separated paths in which Ansible will search for Connection Plugins.
AnsibleCoverageRemoteOutput (str) Sets the output directory on the remote host to generate coverage reports to.
AnsibleCoverageRemotePathFilter (str) A list of paths for files on the Ansible controller to run coverage for when executing on the remote host.
AnsibleCowAcceptlist (list) Accept list of cowsay templates that are ‘safe’ to use, set to empty list if you want to enable all installed templates.
AnsibleCowPath (string) Specify a custom cowsay path or swap in your cowsay implementation of choice.
AnsibleCowSelection () This allows you to chose a specific cowsay stencil for the banners or use ‘random’ to cycle through them.
AnsibleDebug (boolean) Toggles debug output in Ansible.
AnsibleDeprecationWarnings (boolean) Toggle to control the showing of deprecation warnings.
AnsibleDevelWarning (boolean) Toggle to control showing warnings related to running devel.
AnsibleDiffAlways (bool) Configuration toggle to tell modules to show differences when in ‘changed’ status, equivalent to --diff.
AnsibleDiffContext (integer) How many lines of context to show when displaying the differences between files.
AnsibleDisplayArgsToStdout (boolean) Normally ansible-playbook will print a header for each task that is run.
AnsibleDisplaySkippedHosts (boolean) Toggle to control displaying skipped task/host entries in a task in the default callback.
AnsibleDocFragmentPlugins (pathspec) Colon separated paths in which Ansible will search for Documentation Fragments Plugins.
AnsibleDuplicateYamlDictKey (string) By default Ansible will issue a warning when a duplicate dict key is encountered in YAML.
AnsibleEnableTaskDebugger (boolean) Whether or not to enable the task debugger, this previously was done as a strategy plugin.
AnsibleErrorOnMissingHandler (boolean) Toggle to allow missing handlers to become a warning instead of an error when notifying.
AnsibleErrorOnUndefinedVars (boolean) When True, this causes ansible templating to fail steps that reference variable names that are likely typoed.
AnsibleExecutable () This indicates the command to use to spawn a shell under for Ansible’s execution needs on a target.
AnsibleFactPath (string) This option allows you to globally configure a custom path for ‘local_facts’ for the implied ansible_collections.ansible.builtin.setup_module task when using fact gathering.
AnsibleFactsModules (list) Which modules to run during a play’s fact gathering stage, using the default of ‘smart’ will try to figure it out based on connection type.
AnsibleFilterPlugins (pathspec) Colon separated paths in which Ansible will search for Jinja2 Filter Plugins.
AnsibleForceColor (boolean) This option forces color mode even when running without a TTY or the “nocolor” setting is True.
AnsibleForceHandlers (boolean) This option controls if notified handlers run on a host even if a failure occurs on that host.
AnsibleForks (integer) Maximum number of forks Ansible will use to execute tasks on target hosts.
AnsibleGalaxyCacheDir (path) The directory that stores cached responses from a Galaxy server.
AnsibleGalaxyCollectionSkeleton (path) Collection skeleton directory to use as a template for the init action in ansible-galaxy collection, same as --collection-skeleton.
AnsibleGalaxyCollectionSkeletonIgnore (list) patterns of files to ignore inside a Galaxy collection skeleton directory.
AnsibleGalaxyCollectionsPathWarning (bool) whether ansible-galaxy collection install should warn about --collections-path missing from configured COLLECTIONS_PATHS.
AnsibleGalaxyDisableGpgVerify (bool) Disable GPG signature verification during collection installation.
AnsibleGalaxyDisplayProgress (bool) Some steps in ansible-galaxy display a progress wheel which can cause issues on certain displays or when outputting the stdout to a file.
AnsibleGalaxyGpgKeyring (path) Configure the keyring used for GPG signature verification during collection installation and verification.
AnsibleGalaxyIgnore (boolean) If set to yes, ansible-galaxy will not validate TLS certificates.
AnsibleGalaxyIgnoreSignatureStatusCodes (list) A list of GPG status codes to ignore during GPG signature verification.
AnsibleGalaxyRequiredValidSignatureCount (str) The number of signatures that must be successful during GPG signature verification while installing or verifying collections.
AnsibleGalaxyRoleSkeleton (path) Role skeleton directory to use as a template for the init action in ansible-galaxy/ansible-galaxy role, same as --role-skeleton.
AnsibleGalaxyRoleSkeletonIgnore (list) patterns of files to ignore inside a Galaxy role or collection skeleton directory.
AnsibleGalaxyServer () URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source.
AnsibleGalaxyServerList (list) A list of Galaxy servers to use when installing a collection.
AnsibleGalaxyServerTimeout (int) The default timeout for Galaxy API calls.
AnsibleGalaxyTokenPath (path) Local path to galaxy access token file.
AnsibleGathering () This setting controls the default policy of fact gathering (facts discovered about remote systems).
AnsibleGatherSubset (list) Set the gather_subset option for the ansible_collections.ansible.builtin.setup_module task in the implicit fact gathering.
AnsibleGatherTimeout (integer) Set the timeout in seconds for the implicit fact gathering, see the module documentation for specifics.
AnsibleHashBehaviour (string) This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible.
AnsibleHome (path) The default root path for Ansible config files on the controller.
AnsibleHostKeyChecking (boolean) Set this to “False” if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host.
AnsibleHostPatternMismatch () This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it.
AnsibleHttpapiPlugins (pathspec) Colon separated paths in which Ansible will search for HttpApi Plugins.
AnsibleInjectFactVars (boolean) Facts are available inside the ansible_facts variable, this setting also pushes them as their own vars in the main namespace.
AnsibleInvalidTaskAttributeFailed (boolean) If ‘false’, invalid attributes for a task will result in warnings instead of errors.
AnsibleInventory (pathlist) Comma separated list of Ansible inventory sources.
AnsibleInventoryAnyUnparsedIsFailed (boolean) If ‘true’, it is a fatal error when any given inventory source cannot be successfully parsed by any available inventory plugin; otherwise, this situation only attracts a warning.
AnsibleInventoryCache (bool) Toggle to turn on inventory caching.
AnsibleInventoryCacheConnection () The inventory cache connection.
AnsibleInventoryCachePlugin () The plugin for caching inventory.
AnsibleInventoryCachePluginPrefix () The table prefix for the cache plugin.
AnsibleInventoryCacheTimeout () Expiration timeout for the inventory cache plugin data.
AnsibleInventoryEnabled (list) List of enabled inventory plugins, it also determines the order in which they are used.
AnsibleInventoryExport (bool) Controls if ansible-inventory will accurately reflect Ansible’s view into inventory or its optimized for exporting.
AnsibleInventoryIgnore (list) List of extensions to ignore when using a directory as an inventory source.
AnsibleInventoryIgnoreRegex (list) List of patterns to ignore when using a directory as an inventory source.
AnsibleInventoryPlugins (pathspec) Colon separated paths in which Ansible will search for Inventory Plugins.
AnsibleInventoryUnparsedFailed (bool) If ‘true’ it is a fatal error if every single potential inventory source fails to parse, otherwise this situation will only attract a warning.
AnsibleInventoryUnparsedWarning (boolean) By default Ansible will issue a warning when no inventory was loaded and notes that it will use an implicit localhost-only inventory.
AnsibleJinja2Extensions () This is a developer-specific feature that allows enabling additional Jinja2 extensions.
AnsibleJinja2Native (boolean) This option preserves variable types during template operations.
AnsibleJinja2NativeWarning (boolean) Toggle to control showing warnings related to running a Jinja version older than required for jinja2_native [:Deprecated in: 2.17 :Deprecated detail: This option is no longer used in the Ansible Core code base.].
AnsibleKeepRemoteFiles (boolean) Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
AnsibleLibrary (pathspec) Colon separated paths in which Ansible will search for Modules.
AnsibleLibvirtLxcNoseclabel (boolean) This setting causes libvirt to connect to lxc containers by passing –noseclabel to virsh.
AnsibleLoadCallbackPlugins (boolean) Controls whether callback plugins are loaded when running /usr/bin/ansible.
AnsibleLocalhostWarning (boolean) By default Ansible will issue a warning when there are no hosts in the inventory.
AnsibleLocalTemp (tmppath) Temporary directory for Ansible to use on the controller.
AnsibleLogFilter (list) List of logger names to filter out of the log file.
AnsibleLogPath (path) File to which Ansible will log on the controller.
AnsibleLookupPlugins (pathspec) Colon separated paths in which Ansible will search for Lookup Plugins.
AnsibleMaxDiffSize (int) Maximum size of files to be considered for diff display.
AnsibleModuleArgs () This sets the default arguments to pass to the ansible adhoc binary if no -a is specified.
AnsibleModuleIgnoreExts (list) List of extensions to ignore when looking for modules to load This is for rejecting script and binary module fallback extensions.
AnsibleModuleStrictUtf8Response (bool) Enables whether module responses are evaluated for containing non UTF-8 data Disabling this may result in unexpected behavior Only ansible-core should evaluate this configuration.
AnsibleModuleUtils (pathspec) Colon separated paths in which Ansible will search for Module utils files, which are shared by modules.
AnsibleNetconfPlugins (pathspec) Colon separated paths in which Ansible will search for Netconf Plugins.
AnsibleNetconfSshConfig () This variable is used to enable bastion/jump host with netconf connection.
AnsibleNetworkGroupModules (list).
AnsibleNocows (boolean) If you have cowsay installed but want to avoid the ‘cows’ (why????), use this.
AnsibleNoLog (boolean) Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures.
AnsibleNoTargetSyslog (boolean) Toggle Ansible logging to syslog on the target when it executes tasks.
AnsibleNullRepresentation (raw) What templating should return as a ‘null’ value.
AnsibleOldPluginCacheClear (boolean) Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviours in which a plugin loaded in previous plays would be unexpectedly ‘sticky’.
AnsibleParamikoHostKeyAutoAdd (boolean).
AnsibleParamikoLookForKeys (boolean).
AnsiblePersistentCommandTimeout (int) This controls the amount of time to wait for response from remote device before timing out persistent connection.
AnsiblePersistentConnectRetryTimeout (integer) This controls the retry timeout for persistent connection to connect to the local domain socket.
AnsiblePersistentConnectTimeout (integer) This controls how long the persistent connection will remain idle before it is destroyed.
AnsiblePersistentControlPathDir (path) Path to socket to be used by the connection persistence system.
AnsiblePipelining (boolean) This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all.
AnsiblePlaybookDir (path) A number of non-playbook CLIs have a --playbook-dir argument; this sets the default value for it.
AnsiblePlaybookVarsRoot () This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars.
AnsiblePollInterval (integer) For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how often to check back on the status of those tasks when an explicit poll interval is not supplied.
AnsiblePrecedence (list) Allows to change the group variable precedence merge order.
AnsiblePrivateKeyFile (path) Option for connections using a certificate or key file to authenticate, rather than an agent or passwords, you can set the default value here to avoid re-specifying –private-key with every invocation.
AnsiblePrivateRoleVars (boolean) By default, imported roles publish their variables to the play and other roles, this setting can avoid that.
AnsiblePythonInterpreter () Path to the Python interpreter to be used for module execution on remote targets, or an automatic discovery mode.
AnsiblePythonModuleRlimitNofile () Attempts to set RLIMIT_NOFILE soft limit to the specified value when executing Python modules (can speed up subprocess usage on Python 2.x.
AnsibleRemotePort (integer) Port to use in remote connections, when blank it will use the connection plugin default.
AnsibleRemoteUser () Sets the login user for the target machines When blank it uses the connection plugin’s default, normally the user currently executing Ansible.
AnsibleRetryFilesEnabled (bool) This controls whether a failed Ansible playbook should create a .retry file.
AnsibleRetryFilesSavePath (path) This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.
AnsibleRolesPath (pathspec) Colon separated paths in which Ansible will search for Roles.
AnsibleRunTags (list) default list of tags to run in your plays, Skip Tags has precedence.
AnsibleRunVarsPlugins (str) This setting can be used to optimize vars_plugin usage depending on user’s inventory size and play selection.
AnsibleSelinuxSpecialFs (list) Some filesystems do not support safe operations and/or return inconsistent errors, this setting makes Ansible ‘tolerate’ those in the list w/o causing fatal errors.
AnsibleShowCustomStats (bool) This adds the custom stats set via the set_stats plugin to the default output.
AnsibleSkipTags (list) default list of tags to skip in your plays, has precedence over Run Tags.
AnsibleStdoutCallback () Set the main callback used to display Ansible output.
AnsibleStrategy () Set the default strategy used for plays.
AnsibleStrategyPlugins (pathspec) Colon separated paths in which Ansible will search for Strategy Plugins.
AnsibleStringConversionAction (string) Action to take when a module parameter value is converted to a string (this does not affect variables).
AnsibleStringTypeFilters (list) This list of filters avoids ‘type conversion’ when templating variables Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.
AnsibleSu (boolean) Toggle the use of “su” for tasks.
AnsibleSyslogFacility () Syslog facility to use when Ansible logs to the remote target.
AnsibleSystemWarnings (boolean) Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts) These may include warnings about 3rd party packages or other conditions that should be resolved if possible.
AnsibleTaskDebuggerIgnoreErrors (boolean) This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True is specified.
AnsibleTaskTimeout (integer) Set the maximum time (in seconds) that a task can run for.
AnsibleTerminalPlugins (pathspec) Colon separated paths in which Ansible will search for Terminal Plugins.
AnsibleTestPlugins (pathspec) Colon separated paths in which Ansible will search for Jinja2 Test Plugins.
AnsibleTimeout (integer) This is the default timeout for connection plugins to use.
AnsibleTransformInvalidGroupChars (string) Make ansible transform invalid characters in group names supplied by inventory sources.
AnsibleTransport () Can be any connection plugin available to your ansible installation.
AnsibleUsePersistentConnections (boolean) Toggles the use of persistence for connections.
AnsibleValidateActionGroupMetadata (bool) A toggle to disable validating a collection’s ‘metadata’ entry for a module_defaults action group.
AnsibleVarsEnabled (list) Accept list for variable plugins that require it.
AnsibleVarsPlugins (pathspec) Colon separated paths in which Ansible will search for Vars Plugins.
AnsibleVaultEncryptIdentity () The vault_id to use for encrypting by default.
AnsibleVaultEncryptSalt () The salt to use for the vault encryption.
AnsibleVaultIdentity () The label to use for the default vault id label in cases where a vault id label is not provided.
AnsibleVaultIdentityList (list) A list of vault-ids to use by default.
AnsibleVaultIdMatch () If true, decrypting vaults with a vault id will only try the password from the matching vault-id.
AnsibleVaultPasswordFile (path) The vault password file to use.
AnsibleVerboseToStderr (bool) Force ‘verbose’ option to use stderr instead of stdout.
AnsibleVerbosity (integer) Sets the default verbosity, equivalent to the number of -v passed in the command line.
AnsibleWinAsyncStartupTimeout (integer) For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how long, in seconds, to wait for the task spawned by Ansible to connect back to the named pipe used on Windows systems.
AnsibleWorkerShutdownPollCount (integer) The maximum number of times to check Task Queue Manager worker processes to verify they have exited cleanly.
AnsibleWorkerShutdownPollDelay (float) The number of seconds to sleep between polling loops when checking Task Queue Manager worker processes to verify they have exited cleanly.
AnsibleYamlFilenameExt (list) Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these.
Editor ().
NoColor (boolean) This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.
Pager ().
# Structs
AnsibleWithConfigurationSettingsExecute is a builder for Ansible Cmd.
# Interfaces
No description provided by the author
# Type aliases
ConfigurationSettingsFunc is a function to set the configuration settings.