Documentation ¶
Index ¶
- Constants
- type AnsibleWithConfigurationSettingsExecute
- type ConfigurationSettingsFunc
- func WithAnsibleActionPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleActionWarnings() ConfigurationSettingsFunc
- func WithAnsibleAgnosticBecomePrompt() ConfigurationSettingsFunc
- func WithAnsibleAnyErrorsFatal() ConfigurationSettingsFunc
- func WithAnsibleAskPass() ConfigurationSettingsFunc
- func WithAnsibleAskVaultPass() ConfigurationSettingsFunc
- func WithAnsibleBecome() ConfigurationSettingsFunc
- func WithAnsibleBecomeAllowSameUser() ConfigurationSettingsFunc
- func WithAnsibleBecomeAskPass() ConfigurationSettingsFunc
- func WithAnsibleBecomeExe(value string) ConfigurationSettingsFunc
- func WithAnsibleBecomeFlags(value string) ConfigurationSettingsFunc
- func WithAnsibleBecomeMethod(value string) ConfigurationSettingsFunc
- func WithAnsibleBecomePasswordFile(value string) ConfigurationSettingsFunc
- func WithAnsibleBecomePlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleBecomeUser(value string) ConfigurationSettingsFunc
- func WithAnsibleCachePlugin(value string) ConfigurationSettingsFunc
- func WithAnsibleCachePluginConnection(value string) ConfigurationSettingsFunc
- func WithAnsibleCachePluginPrefix(value string) ConfigurationSettingsFunc
- func WithAnsibleCachePluginTimeout(value int) ConfigurationSettingsFunc
- func WithAnsibleCachePlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleCallbackPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleCallbacksEnabled(value string) ConfigurationSettingsFunc
- func WithAnsibleCliconfPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleCollectionsOnAnsibleVersionMismatch(value string) ConfigurationSettingsFunc
- func WithAnsibleCollectionsPaths(value string) ConfigurationSettingsFunc
- func WithAnsibleCollectionsScanSysPath() ConfigurationSettingsFunc
- func WithAnsibleColorChanged(value string) ConfigurationSettingsFunc
- func WithAnsibleColorConsolePrompt(value string) ConfigurationSettingsFunc
- func WithAnsibleColorDebug(value string) ConfigurationSettingsFunc
- func WithAnsibleColorDeprecate(value string) ConfigurationSettingsFunc
- func WithAnsibleColorDiffAdd(value string) ConfigurationSettingsFunc
- func WithAnsibleColorDiffLines(value string) ConfigurationSettingsFunc
- func WithAnsibleColorDiffRemove(value string) ConfigurationSettingsFunc
- func WithAnsibleColorError(value string) ConfigurationSettingsFunc
- func WithAnsibleColorHighlight(value string) ConfigurationSettingsFunc
- func WithAnsibleColorOk(value string) ConfigurationSettingsFunc
- func WithAnsibleColorSkip(value string) ConfigurationSettingsFunc
- func WithAnsibleColorUnreachable(value string) ConfigurationSettingsFunc
- func WithAnsibleColorVerbose(value string) ConfigurationSettingsFunc
- func WithAnsibleColorWarn(value string) ConfigurationSettingsFunc
- func WithAnsibleConnectionPasswordFile(value string) ConfigurationSettingsFunc
- func WithAnsibleConnectionPath(value string) ConfigurationSettingsFunc
- func WithAnsibleConnectionPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleCoverageRemoteOutput(value string) ConfigurationSettingsFunc
- func WithAnsibleCoverageRemotePathFilter(value string) ConfigurationSettingsFunc
- func WithAnsibleCowAcceptlist(value string) ConfigurationSettingsFunc
- func WithAnsibleCowPath(value string) ConfigurationSettingsFunc
- func WithAnsibleCowSelection(value string) ConfigurationSettingsFunc
- func WithAnsibleDebug() ConfigurationSettingsFunc
- func WithAnsibleDeprecationWarnings() ConfigurationSettingsFunc
- func WithAnsibleDevelWarning() ConfigurationSettingsFunc
- func WithAnsibleDiffAlways(value string) ConfigurationSettingsFunc
- func WithAnsibleDiffContext(value int) ConfigurationSettingsFunc
- func WithAnsibleDisplayArgsToStdout() ConfigurationSettingsFunc
- func WithAnsibleDisplaySkippedHosts() ConfigurationSettingsFunc
- func WithAnsibleDocFragmentPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleDuplicateYamlDictKey(value string) ConfigurationSettingsFunc
- func WithAnsibleEnableTaskDebugger() ConfigurationSettingsFunc
- func WithAnsibleErrorOnMissingHandler() ConfigurationSettingsFunc
- func WithAnsibleErrorOnUndefinedVars() ConfigurationSettingsFunc
- func WithAnsibleExecutable(value string) ConfigurationSettingsFunc
- func WithAnsibleFactPath(value string) ConfigurationSettingsFunc
- func WithAnsibleFactsModules(value string) ConfigurationSettingsFunc
- func WithAnsibleFilterPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleForceColor() ConfigurationSettingsFunc
- func WithAnsibleForceHandlers() ConfigurationSettingsFunc
- func WithAnsibleForks(value int) ConfigurationSettingsFunc
- func WithAnsibleGalaxyCacheDir(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyCollectionSkeleton(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyCollectionSkeletonIgnore(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyCollectionsPathWarning(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyDisableGpgVerify(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyDisplayProgress(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyGpgKeyring(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyIgnore() ConfigurationSettingsFunc
- func WithAnsibleGalaxyIgnoreSignatureStatusCodes(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyRequiredValidSignatureCount(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyRoleSkeleton(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyRoleSkeletonIgnore(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyServer(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyServerList(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyServerTimeout(value string) ConfigurationSettingsFunc
- func WithAnsibleGalaxyTokenPath(value string) ConfigurationSettingsFunc
- func WithAnsibleGatherSubset(value string) ConfigurationSettingsFunc
- func WithAnsibleGatherTimeout(value int) ConfigurationSettingsFunc
- func WithAnsibleGathering(value string) ConfigurationSettingsFunc
- func WithAnsibleHashBehaviour(value string) ConfigurationSettingsFunc
- func WithAnsibleHome(value string) ConfigurationSettingsFunc
- func WithAnsibleHostKeyChecking() ConfigurationSettingsFunc
- func WithAnsibleHostPatternMismatch(value string) ConfigurationSettingsFunc
- func WithAnsibleHttpapiPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleInjectFactVars() ConfigurationSettingsFunc
- func WithAnsibleInvalidTaskAttributeFailed() ConfigurationSettingsFunc
- func WithAnsibleInventory(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryAnyUnparsedIsFailed() ConfigurationSettingsFunc
- func WithAnsibleInventoryCache(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryCacheConnection(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryCachePlugin(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryCachePluginPrefix(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryCacheTimeout(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryEnabled(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryExport(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryIgnore(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryIgnoreRegex(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryUnparsedFailed(value string) ConfigurationSettingsFunc
- func WithAnsibleInventoryUnparsedWarning() ConfigurationSettingsFunc
- func WithAnsibleJinja2Extensions(value string) ConfigurationSettingsFunc
- func WithAnsibleJinja2Native() ConfigurationSettingsFunc
- func WithAnsibleJinja2NativeWarning() ConfigurationSettingsFunc
- func WithAnsibleKeepRemoteFiles() ConfigurationSettingsFunc
- func WithAnsibleLibrary(value string) ConfigurationSettingsFunc
- func WithAnsibleLibvirtLxcNoseclabel() ConfigurationSettingsFunc
- func WithAnsibleLoadCallbackPlugins() ConfigurationSettingsFunc
- func WithAnsibleLocalTemp(value string) ConfigurationSettingsFunc
- func WithAnsibleLocalhostWarning() ConfigurationSettingsFunc
- func WithAnsibleLogFilter(value string) ConfigurationSettingsFunc
- func WithAnsibleLogPath(value string) ConfigurationSettingsFunc
- func WithAnsibleLookupPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleMaxDiffSize(value string) ConfigurationSettingsFunc
- func WithAnsibleModuleArgs(value string) ConfigurationSettingsFunc
- func WithAnsibleModuleIgnoreExts(value string) ConfigurationSettingsFunc
- func WithAnsibleModuleStrictUtf8Response(value string) ConfigurationSettingsFunc
- func WithAnsibleModuleUtils(value string) ConfigurationSettingsFunc
- func WithAnsibleNetconfPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleNetconfSshConfig(value string) ConfigurationSettingsFunc
- func WithAnsibleNetworkGroupModules(value string) ConfigurationSettingsFunc
- func WithAnsibleNoLog() ConfigurationSettingsFunc
- func WithAnsibleNoTargetSyslog() ConfigurationSettingsFunc
- func WithAnsibleNocows() ConfigurationSettingsFunc
- func WithAnsibleNullRepresentation(value string) ConfigurationSettingsFunc
- func WithAnsibleOldPluginCacheClear() ConfigurationSettingsFunc
- func WithAnsibleParamikoHostKeyAutoAdd() ConfigurationSettingsFunc
- func WithAnsibleParamikoLookForKeys() ConfigurationSettingsFunc
- func WithAnsiblePersistentCommandTimeout(value string) ConfigurationSettingsFunc
- func WithAnsiblePersistentConnectRetryTimeout(value int) ConfigurationSettingsFunc
- func WithAnsiblePersistentConnectTimeout(value int) ConfigurationSettingsFunc
- func WithAnsiblePersistentControlPathDir(value string) ConfigurationSettingsFunc
- func WithAnsiblePipelining() ConfigurationSettingsFunc
- func WithAnsiblePlaybookDir(value string) ConfigurationSettingsFunc
- func WithAnsiblePlaybookVarsRoot(value string) ConfigurationSettingsFunc
- func WithAnsiblePollInterval(value int) ConfigurationSettingsFunc
- func WithAnsiblePrecedence(value string) ConfigurationSettingsFunc
- func WithAnsiblePrivateKeyFile(value string) ConfigurationSettingsFunc
- func WithAnsiblePrivateRoleVars() ConfigurationSettingsFunc
- func WithAnsiblePythonInterpreter(value string) ConfigurationSettingsFunc
- func WithAnsiblePythonModuleRlimitNofile(value string) ConfigurationSettingsFunc
- func WithAnsibleRemotePort(value int) ConfigurationSettingsFunc
- func WithAnsibleRemoteUser(value string) ConfigurationSettingsFunc
- func WithAnsibleRetryFilesEnabled(value string) ConfigurationSettingsFunc
- func WithAnsibleRetryFilesSavePath(value string) ConfigurationSettingsFunc
- func WithAnsibleRolesPath(value string) ConfigurationSettingsFunc
- func WithAnsibleRunTags(value string) ConfigurationSettingsFunc
- func WithAnsibleRunVarsPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleSelinuxSpecialFs(value string) ConfigurationSettingsFunc
- func WithAnsibleShowCustomStats(value string) ConfigurationSettingsFunc
- func WithAnsibleSkipTags(value string) ConfigurationSettingsFunc
- func WithAnsibleStdoutCallback(value string) ConfigurationSettingsFunc
- func WithAnsibleStrategy(value string) ConfigurationSettingsFunc
- func WithAnsibleStrategyPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleStringConversionAction(value string) ConfigurationSettingsFunc
- func WithAnsibleStringTypeFilters(value string) ConfigurationSettingsFunc
- func WithAnsibleSu() ConfigurationSettingsFunc
- func WithAnsibleSyslogFacility(value string) ConfigurationSettingsFunc
- func WithAnsibleSystemWarnings() ConfigurationSettingsFunc
- func WithAnsibleTaskDebuggerIgnoreErrors() ConfigurationSettingsFunc
- func WithAnsibleTaskTimeout(value int) ConfigurationSettingsFunc
- func WithAnsibleTerminalPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleTestPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleTimeout(value int) ConfigurationSettingsFunc
- func WithAnsibleTransformInvalidGroupChars(value string) ConfigurationSettingsFunc
- func WithAnsibleTransport(value string) ConfigurationSettingsFunc
- func WithAnsibleUsePersistentConnections() ConfigurationSettingsFunc
- func WithAnsibleValidateActionGroupMetadata(value string) ConfigurationSettingsFunc
- func WithAnsibleVarsEnabled(value string) ConfigurationSettingsFunc
- func WithAnsibleVarsPlugins(value string) ConfigurationSettingsFunc
- func WithAnsibleVaultEncryptIdentity(value string) ConfigurationSettingsFunc
- func WithAnsibleVaultEncryptSalt(value string) ConfigurationSettingsFunc
- func WithAnsibleVaultIdMatch(value string) ConfigurationSettingsFunc
- func WithAnsibleVaultIdentity(value string) ConfigurationSettingsFunc
- func WithAnsibleVaultIdentityList(value string) ConfigurationSettingsFunc
- func WithAnsibleVaultPasswordFile(value string) ConfigurationSettingsFunc
- func WithAnsibleVerboseToStderr(value string) ConfigurationSettingsFunc
- func WithAnsibleVerbosity(value int) ConfigurationSettingsFunc
- func WithAnsibleWinAsyncStartupTimeout(value int) ConfigurationSettingsFunc
- func WithAnsibleWorkerShutdownPollCount(value int) ConfigurationSettingsFunc
- func WithAnsibleWorkerShutdownPollDelay(value string) ConfigurationSettingsFunc
- func WithAnsibleYamlFilenameExt(value string) ConfigurationSettingsFunc
- func WithEditor(value string) ConfigurationSettingsFunc
- func WithNoColor() ConfigurationSettingsFunc
- func WithPager(value string) ConfigurationSettingsFunc
- func WithoutAnsibleActionWarnings() ConfigurationSettingsFunc
- func WithoutAnsibleAgnosticBecomePrompt() ConfigurationSettingsFunc
- func WithoutAnsibleAnyErrorsFatal() ConfigurationSettingsFunc
- func WithoutAnsibleAskPass() ConfigurationSettingsFunc
- func WithoutAnsibleAskVaultPass() ConfigurationSettingsFunc
- func WithoutAnsibleBecome() ConfigurationSettingsFunc
- func WithoutAnsibleBecomeAllowSameUser() ConfigurationSettingsFunc
- func WithoutAnsibleBecomeAskPass() ConfigurationSettingsFunc
- func WithoutAnsibleCollectionsScanSysPath() ConfigurationSettingsFunc
- func WithoutAnsibleDebug() ConfigurationSettingsFunc
- func WithoutAnsibleDeprecationWarnings() ConfigurationSettingsFunc
- func WithoutAnsibleDevelWarning() ConfigurationSettingsFunc
- func WithoutAnsibleDisplayArgsToStdout() ConfigurationSettingsFunc
- func WithoutAnsibleDisplaySkippedHosts() ConfigurationSettingsFunc
- func WithoutAnsibleEnableTaskDebugger() ConfigurationSettingsFunc
- func WithoutAnsibleErrorOnMissingHandler() ConfigurationSettingsFunc
- func WithoutAnsibleErrorOnUndefinedVars() ConfigurationSettingsFunc
- func WithoutAnsibleForceColor() ConfigurationSettingsFunc
- func WithoutAnsibleForceHandlers() ConfigurationSettingsFunc
- func WithoutAnsibleGalaxyIgnore() ConfigurationSettingsFunc
- func WithoutAnsibleHostKeyChecking() ConfigurationSettingsFunc
- func WithoutAnsibleInjectFactVars() ConfigurationSettingsFunc
- func WithoutAnsibleInvalidTaskAttributeFailed() ConfigurationSettingsFunc
- func WithoutAnsibleInventoryAnyUnparsedIsFailed() ConfigurationSettingsFunc
- func WithoutAnsibleInventoryUnparsedWarning() ConfigurationSettingsFunc
- func WithoutAnsibleJinja2Native() ConfigurationSettingsFunc
- func WithoutAnsibleJinja2NativeWarning() ConfigurationSettingsFunc
- func WithoutAnsibleKeepRemoteFiles() ConfigurationSettingsFunc
- func WithoutAnsibleLibvirtLxcNoseclabel() ConfigurationSettingsFunc
- func WithoutAnsibleLoadCallbackPlugins() ConfigurationSettingsFunc
- func WithoutAnsibleLocalhostWarning() ConfigurationSettingsFunc
- func WithoutAnsibleNoLog() ConfigurationSettingsFunc
- func WithoutAnsibleNoTargetSyslog() ConfigurationSettingsFunc
- func WithoutAnsibleNocows() ConfigurationSettingsFunc
- func WithoutAnsibleOldPluginCacheClear() ConfigurationSettingsFunc
- func WithoutAnsibleParamikoHostKeyAutoAdd() ConfigurationSettingsFunc
- func WithoutAnsibleParamikoLookForKeys() ConfigurationSettingsFunc
- func WithoutAnsiblePipelining() ConfigurationSettingsFunc
- func WithoutAnsiblePrivateRoleVars() ConfigurationSettingsFunc
- func WithoutAnsibleSu() ConfigurationSettingsFunc
- func WithoutAnsibleSystemWarnings() ConfigurationSettingsFunc
- func WithoutAnsibleTaskDebuggerIgnoreErrors() ConfigurationSettingsFunc
- func WithoutAnsibleUsePersistentConnections() ConfigurationSettingsFunc
- func WithoutNoColor() ConfigurationSettingsFunc
- type ExecutorEnvVarSetter
Constants ¶
const ( // 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. AnsibleActionWarnings = "ANSIBLE_ACTION_WARNINGS" // AnsibleAgnosticBecomePrompt (boolean) Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method AnsibleAgnosticBecomePrompt = "ANSIBLE_AGNOSTIC_BECOME_PROMPT" // AnsibleConnectionPath (path) Specify where to look for the ansible-connection script. This location will be checked before searching $PATH. If null, ansible will start with the same directory as the ansible script. AnsibleConnectionPath = "ANSIBLE_CONNECTION_PATH" // AnsibleCowAcceptlist (list) Accept list of cowsay templates that are ‘safe’ to use, set to empty list if you want to enable all installed templates. [:Version Added: 2.11] AnsibleCowAcceptlist = "ANSIBLE_COW_ACCEPTLIST" // AnsibleCowPath (string) Specify a custom cowsay path or swap in your cowsay implementation of choice AnsibleCowPath = "ANSIBLE_COW_PATH" // AnsibleCowSelection () This allows you to chose a specific cowsay stencil for the banners or use ‘random’ to cycle through them. AnsibleCowSelection = "ANSIBLE_COW_SELECTION" // AnsibleForceColor (boolean) This option forces color mode even when running without a TTY or the “nocolor” setting is True. AnsibleForceColor = "ANSIBLE_FORCE_COLOR" // AnsibleHome (path) The default root path for Ansible config files on the controller. AnsibleHome = "ANSIBLE_HOME" // NoColor (boolean) This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information. NoColor = "NO_COLOR" // AnsibleNocows (boolean) If you have cowsay installed but want to avoid the ‘cows’ (why????), use this. AnsibleNocows = "ANSIBLE_NOCOWS" // AnsiblePipelining (boolean) This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all. Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfer. It can result in a very significant performance improvement when enabled. However this conflicts with privilege escalation (become). For example, when using ‘sudo:’ operations you must first disable ‘requiretty’ in /etc/sudoers on all managed hosts, which is why it is disabled by default. This setting will be disabled if ANSIBLE_KEEP_REMOTE_FILES is enabled. AnsiblePipelining = "ANSIBLE_PIPELINING" // AnsibleAnyErrorsFatal (boolean) Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors. AnsibleAnyErrorsFatal = "ANSIBLE_ANY_ERRORS_FATAL" // AnsibleBecomeAllowSameUser (boolean) This setting controls if become is skipped when remote user and become user are the same. I.E root sudo to root. If executable, it will be run and the resulting stdout will be used as the password. AnsibleBecomeAllowSameUser = "ANSIBLE_BECOME_ALLOW_SAME_USER" // AnsibleBecomePasswordFile (path) The password file to use for the become plugin. –become-password-file. If executable, it will be run and the resulting stdout will be used as the password. AnsibleBecomePasswordFile = "ANSIBLE_BECOME_PASSWORD_FILE" // AnsibleBecomePlugins (pathspec) Colon separated paths in which Ansible will search for Become Plugins. AnsibleBecomePlugins = "ANSIBLE_BECOME_PLUGINS" // AnsibleCachePlugin () Chooses which cache plugin to use, the default ‘memory’ is ephemeral. AnsibleCachePlugin = "ANSIBLE_CACHE_PLUGIN" // AnsibleCachePluginConnection () Defines connection or path information for the cache plugin AnsibleCachePluginConnection = "ANSIBLE_CACHE_PLUGIN_CONNECTION" // AnsibleCachePluginPrefix () Prefix to use for cache plugin files/tables AnsibleCachePluginPrefix = "ANSIBLE_CACHE_PLUGIN_PREFIX" // AnsibleCachePluginTimeout (integer) Expiration timeout for the cache plugin data AnsibleCachePluginTimeout = "ANSIBLE_CACHE_PLUGIN_TIMEOUT" // 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. [:Version Added: 2.11] AnsibleCallbacksEnabled = "ANSIBLE_CALLBACKS_ENABLED" // AnsibleCollectionsOnAnsibleVersionMismatch () When a collection is loaded that does not support the running Ansible version (with the collection metadata key requires_ansible). AnsibleCollectionsOnAnsibleVersionMismatch = "ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH" // AnsibleCollectionsPaths (pathspec) Colon separated paths in which Ansible will search for collections content. Collections must be in nested subdirectories, not directly in these directories. For example, if COLLECTIONS_PATHS includes '{{ ANSIBLE_HOME ~ "/collections" }}', and you want to add my.collection to that directory, it must be saved as '{{ ANSIBLE_HOME} ~ "/collections/ansible_collections/my/collection" }}'. AnsibleCollectionsPaths = "ANSIBLE_COLLECTIONS_PATHS" // AnsibleCollectionsScanSysPath (boolean) A boolean to enable or disable scanning the sys.path for installed collections AnsibleCollectionsScanSysPath = "ANSIBLE_COLLECTIONS_SCAN_SYS_PATH" // AnsibleColorChanged () Defines the color to use on ‘Changed’ task status AnsibleColorChanged = "ANSIBLE_COLOR_CHANGED" // AnsibleColorConsolePrompt () Defines the default color to use for ansible-console AnsibleColorConsolePrompt = "ANSIBLE_COLOR_CONSOLE_PROMPT" // AnsibleColorDebug () Defines the color to use when emitting debug messages AnsibleColorDebug = "ANSIBLE_COLOR_DEBUG" // AnsibleColorDeprecate () Defines the color to use when emitting deprecation messages AnsibleColorDeprecate = "ANSIBLE_COLOR_DEPRECATE" // AnsibleColorDiffAdd () Defines the color to use when showing added lines in diffs AnsibleColorDiffAdd = "ANSIBLE_COLOR_DIFF_ADD" // AnsibleColorDiffLines () Defines the color to use when showing diffs AnsibleColorDiffLines = "ANSIBLE_COLOR_DIFF_LINES" // AnsibleColorDiffRemove () Defines the color to use when showing removed lines in diffs AnsibleColorDiffRemove = "ANSIBLE_COLOR_DIFF_REMOVE" // AnsibleColorError () Defines the color to use when emitting error messages AnsibleColorError = "ANSIBLE_COLOR_ERROR" // AnsibleColorHighlight () Defines the color to use for highlighting AnsibleColorHighlight = "ANSIBLE_COLOR_HIGHLIGHT" // AnsibleColorOk () Defines the color to use when showing ‘OK’ task status AnsibleColorOk = "ANSIBLE_COLOR_OK" // AnsibleColorSkip () Defines the color to use when showing ‘Skipped’ task status AnsibleColorSkip = "ANSIBLE_COLOR_SKIP" // AnsibleColorUnreachable () Defines the color to use on ‘Unreachable’ status AnsibleColorUnreachable = "ANSIBLE_COLOR_UNREACHABLE" // AnsibleColorVerbose () Defines the color to use when emitting verbose messages. i.e those that show with ‘-v’s. AnsibleColorVerbose = "ANSIBLE_COLOR_VERBOSE" // AnsibleColorWarn () Defines the color to use when emitting warning messages AnsibleColorWarn = "ANSIBLE_COLOR_WARN" // AnsibleConnectionPasswordFile (path) The password file to use for the connection plugin. –connection-password-file. AnsibleConnectionPasswordFile = "ANSIBLE_CONNECTION_PASSWORD_FILE" // AnsibleCoverageRemoteOutput (str) Sets the output directory on the remote host to generate coverage reports to. Currently only used for remote coverage on PowerShell modules. This is for internal use only. AnsibleCoverageRemoteOutput = "_ANSIBLE_COVERAGE_REMOTE_OUTPUT" // AnsibleCoverageRemotePathFilter (str) A list of paths for files on the Ansible controller to run coverage for when executing on the remote host. Only files that match the path glob will have its coverage collected. Multiple path globs can be specified and are separated by :. Currently only used for remote coverage on PowerShell modules. This is for internal use only. AnsibleCoverageRemotePathFilter = "_ANSIBLE_COVERAGE_REMOTE_PATH_FILTER" // AnsibleActionPlugins (pathspec) Colon separated paths in which Ansible will search for Action Plugins. AnsibleActionPlugins = "ANSIBLE_ACTION_PLUGINS" // AnsibleAskPass (boolean) This controls whether an Ansible playbook should prompt for a login password. If using SSH keys for authentication, you probably do not need to change this setting. AnsibleAskPass = "ANSIBLE_ASK_PASS" // AnsibleAskVaultPass (boolean) This controls whether an Ansible playbook should prompt for a vault password. AnsibleAskVaultPass = "ANSIBLE_ASK_VAULT_PASS" // AnsibleBecome (boolean) Toggles the use of privilege escalation, allowing you to ‘become’ another user after login. AnsibleBecome = "ANSIBLE_BECOME" // AnsibleBecomeAskPass (boolean) Toggle to prompt for privilege escalation password. AnsibleBecomeAskPass = "ANSIBLE_BECOME_ASK_PASS" // AnsibleBecomeExe () executable to use for privilege escalation, otherwise Ansible will depend on PATH AnsibleBecomeExe = "ANSIBLE_BECOME_EXE" // AnsibleBecomeFlags () Flags to pass to the privilege escalation executable. AnsibleBecomeFlags = "ANSIBLE_BECOME_FLAGS" // AnsibleBecomeMethod () Privilege escalation method to use when become is enabled. AnsibleBecomeMethod = "ANSIBLE_BECOME_METHOD" // AnsibleBecomeUser () The user your login/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified. AnsibleBecomeUser = "ANSIBLE_BECOME_USER" // AnsibleCachePlugins (pathspec) Colon separated paths in which Ansible will search for Cache Plugins. AnsibleCachePlugins = "ANSIBLE_CACHE_PLUGINS" // AnsibleCallbackPlugins (pathspec) Colon separated paths in which Ansible will search for Callback Plugins. AnsibleCallbackPlugins = "ANSIBLE_CALLBACK_PLUGINS" // AnsibleCliconfPlugins (pathspec) Colon separated paths in which Ansible will search for Cliconf Plugins. AnsibleCliconfPlugins = "ANSIBLE_CLICONF_PLUGINS" // AnsibleConnectionPlugins (pathspec) Colon separated paths in which Ansible will search for Connection Plugins. AnsibleConnectionPlugins = "ANSIBLE_CONNECTION_PLUGINS" // AnsibleDebug (boolean) Toggles debug output in Ansible. This is very verbose and can hinder multiprocessing. Debug output can also include secret information despite no_log settings being enabled, which means debug mode should not be used in production. AnsibleDebug = "ANSIBLE_DEBUG" // AnsibleExecutable () This indicates the command to use to spawn a shell under for Ansible’s execution needs on a target. Users may need to change this in rare instances when shell usage is constrained, but in most cases it may be left as is. AnsibleExecutable = "ANSIBLE_EXECUTABLE" // 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. If not set, it will fallback to the default from the ansible.builtin.setup module: /etc/ansible/facts.d. This does not affect user defined tasks that use the ansible.builtin.setup module. The real action being created by the implicit task is currently ansible.legacy.gather_facts module, which then calls the configured fact modules, by default this will be ansible.builtin.setup for POSIX systems but other platforms might have different defaults. AnsibleFactPath = "ANSIBLE_FACT_PATH" // AnsibleFilterPlugins (pathspec) Colon separated paths in which Ansible will search for Jinja2 Filter Plugins. AnsibleFilterPlugins = "ANSIBLE_FILTER_PLUGINS" // AnsibleForceHandlers (boolean) This option controls if notified handlers run on a host even if a failure occurs on that host. When false, the handlers will not run if a failure has occurred on a host. This can also be set per play or on the command line. See Handlers and Failure for more details. AnsibleForceHandlers = "ANSIBLE_FORCE_HANDLERS" // AnsibleForks (integer) Maximum number of forks Ansible will use to execute tasks on target hosts. AnsibleForks = "ANSIBLE_FORKS" // AnsibleGatherSubset (list) Set the gather_subset option for the ansible_collections.ansible.builtin.setup_module task in the implicit fact gathering. See the module documentation for specifics. It does not apply to user defined ansible.builtin.setup tasks. AnsibleGatherSubset = "ANSIBLE_GATHER_SUBSET" // AnsibleGatherTimeout (integer) Set the timeout in seconds for the implicit fact gathering, see the module documentation for specifics. It does not apply to user defined ansible_collections.ansible.builtin.setup_module tasks. AnsibleGatherTimeout = "ANSIBLE_GATHER_TIMEOUT" // AnsibleGathering () This setting controls the default policy of fact gathering (facts discovered about remote systems). This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the cache plugin. AnsibleGathering = "ANSIBLE_GATHERING" // AnsibleHashBehaviour (string) This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible. This does not affect variables whose values are scalars (integers, strings) or arrays. WARNING, changing this setting is not recommended as this is fragile and makes your content (plays, roles, collections) non portable, leading to continual confusion and misuse. Don’t change this setting unless you think you have an absolute need for it. We recommend avoiding reusing variable names and relying on the combine filter and vars and varnames lookups to create merged versions of the individual variables. In our experience this is rarely really needed and a sign that too much complexity has been introduced into the data structures and plays. For some uses you can also look into custom vars_plugins to merge on input, even substituting the default host_group_vars that is in charge of parsing the host_vars/ and group_vars/ directories. Most users of this setting are only interested in inventory scope, but the setting itself affects all sources and makes debugging even harder. All playbooks and roles in the official examples repos assume the default for this setting. Changing the setting to merge applies across variable sources, but many sources will internally still overwrite the variables. For example include_vars will dedupe variables internally before updating Ansible, with ‘last defined’ overwriting previous definitions in same file. The Ansible project recommends you avoid “merge“ for new projects. It is the intention of the Ansible developers to eventually deprecate and remove this setting, but it is being kept as some users do heavily rely on it. New projects should avoid ‘merge’. AnsibleHashBehaviour = "ANSIBLE_HASH_BEHAVIOUR" // AnsibleInventory (pathlist) Comma separated list of Ansible inventory sources AnsibleInventory = "ANSIBLE_INVENTORY" // AnsibleHttpapiPlugins (pathspec) Colon separated paths in which Ansible will search for HttpApi Plugins. AnsibleHttpapiPlugins = "ANSIBLE_HTTPAPI_PLUGINS" // AnsibleInventoryPlugins (pathspec) Colon separated paths in which Ansible will search for Inventory Plugins. AnsibleInventoryPlugins = "ANSIBLE_INVENTORY_PLUGINS" // AnsibleJinja2Extensions () This is a developer-specific feature that allows enabling additional Jinja2 extensions. See the Jinja2 documentation for details. If you do not know what these do, you probably don’t need to change this setting :) AnsibleJinja2Extensions = "ANSIBLE_JINJA2_EXTENSIONS" // AnsibleJinja2Native (boolean) This option preserves variable types during template operations. AnsibleJinja2Native = "ANSIBLE_JINJA2_NATIVE" // AnsibleKeepRemoteFiles (boolean) Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote. If this option is enabled it will disable ANSIBLE_PIPELINING. AnsibleKeepRemoteFiles = "ANSIBLE_KEEP_REMOTE_FILES" // AnsibleLibvirtLxcNoseclabel (boolean) This setting causes libvirt to connect to lxc containers by passing –noseclabel to virsh. This is necessary when running on systems which do not have SELinux. AnsibleLibvirtLxcNoseclabel = "ANSIBLE_LIBVIRT_LXC_NOSECLABEL" // AnsibleLoadCallbackPlugins (boolean) Controls whether callback plugins are loaded when running /usr/bin/ansible. This may be used to log activity from the command line, send notifications, and so on. Callback plugins are always loaded for ansible-playbook. AnsibleLoadCallbackPlugins = "ANSIBLE_LOAD_CALLBACK_PLUGINS" // AnsibleLocalTemp (tmppath) Temporary directory for Ansible to use on the controller. AnsibleLocalTemp = "ANSIBLE_LOCAL_TEMP" // AnsibleLogFilter (list) List of logger names to filter out of the log file AnsibleLogFilter = "ANSIBLE_LOG_FILTER" // AnsibleLogPath (path) File to which Ansible will log on the controller. When empty logging is disabled. AnsibleLogPath = "ANSIBLE_LOG_PATH" // AnsibleLookupPlugins (pathspec) Colon separated paths in which Ansible will search for Lookup Plugins. AnsibleLookupPlugins = "ANSIBLE_LOOKUP_PLUGINS" // AnsibleModuleArgs () This sets the default arguments to pass to the ansible adhoc binary if no -a is specified. AnsibleModuleArgs = "ANSIBLE_MODULE_ARGS" // AnsibleLibrary (pathspec) Colon separated paths in which Ansible will search for Modules. AnsibleLibrary = "ANSIBLE_LIBRARY" // AnsibleModuleUtils (pathspec) Colon separated paths in which Ansible will search for Module utils files, which are shared by modules. AnsibleModuleUtils = "ANSIBLE_MODULE_UTILS" // AnsibleNetconfPlugins (pathspec) Colon separated paths in which Ansible will search for Netconf Plugins. AnsibleNetconfPlugins = "ANSIBLE_NETCONF_PLUGINS" // AnsibleNoLog (boolean) Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures. AnsibleNoLog = "ANSIBLE_NO_LOG" // AnsibleNoTargetSyslog (boolean) Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts this will disable a newer style PowerShell modules from writing to the event log. AnsibleNoTargetSyslog = "ANSIBLE_NO_TARGET_SYSLOG" // AnsibleNullRepresentation (raw) What templating should return as a ‘null’ value. When not set it will let Jinja2 decide. AnsibleNullRepresentation = "ANSIBLE_NULL_REPRESENTATION" // 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. The default is a reasonably moderate 15 seconds which is a tradeoff between checking in frequently and providing a quick turnaround when something may have completed. AnsiblePollInterval = "ANSIBLE_POLL_INTERVAL" // 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. AnsiblePrivateKeyFile = "ANSIBLE_PRIVATE_KEY_FILE" // AnsiblePrivateRoleVars (boolean) By default, imported roles publish their variables to the play and other roles, this setting can avoid that. This was introduced as a way to reset role variables to default values if a role is used more than once in a playbook. Included roles only make their variables public at execution, unlike imported roles which happen at playbook compile time. AnsiblePrivateRoleVars = "ANSIBLE_PRIVATE_ROLE_VARS" // AnsibleRemotePort (integer) Port to use in remote connections, when blank it will use the connection plugin default. AnsibleRemotePort = "ANSIBLE_REMOTE_PORT" // AnsibleRemoteUser () Sets the login user for the target machines When blank it uses the connection plugin’s default, normally the user currently executing Ansible. AnsibleRemoteUser = "ANSIBLE_REMOTE_USER" // AnsibleRolesPath (pathspec) Colon separated paths in which Ansible will search for Roles. AnsibleRolesPath = "ANSIBLE_ROLES_PATH" // 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. Data corruption may occur and writes are not always verified when a filesystem is in the list. [:Version Added: 2.9] AnsibleSelinuxSpecialFs = "ANSIBLE_SELINUX_SPECIAL_FS" // AnsibleStdoutCallback () Set the main callback used to display Ansible output. You can only have one at a time. You can have many other callbacks, but just one can be in charge of stdout. See Callback plugins for a list of available options. AnsibleStdoutCallback = "ANSIBLE_STDOUT_CALLBACK" // AnsibleStrategy () Set the default strategy used for plays. AnsibleStrategy = "ANSIBLE_STRATEGY" // AnsibleStrategyPlugins (pathspec) Colon separated paths in which Ansible will search for Strategy Plugins. AnsibleStrategyPlugins = "ANSIBLE_STRATEGY_PLUGINS" // AnsibleSu (boolean) Toggle the use of “su” for tasks. AnsibleSu = "ANSIBLE_SU" // AnsibleSyslogFacility () Syslog facility to use when Ansible logs to the remote target AnsibleSyslogFacility = "ANSIBLE_SYSLOG_FACILITY" // AnsibleTerminalPlugins (pathspec) Colon separated paths in which Ansible will search for Terminal Plugins. AnsibleTerminalPlugins = "ANSIBLE_TERMINAL_PLUGINS" // AnsibleTestPlugins (pathspec) Colon separated paths in which Ansible will search for Jinja2 Test Plugins. AnsibleTestPlugins = "ANSIBLE_TEST_PLUGINS" // AnsibleTimeout (integer) This is the default timeout for connection plugins to use. AnsibleTimeout = "ANSIBLE_TIMEOUT" // AnsibleTransport () Can be any connection plugin available to your ansible installation. There is also a (DEPRECATED) special ‘smart’ option, that will toggle between ‘ssh’ and ‘paramiko’ depending on controller OS and ssh versions. AnsibleTransport = "ANSIBLE_TRANSPORT" // AnsibleErrorOnUndefinedVars (boolean) When True, this causes ansible templating to fail steps that reference variable names that are likely typoed. Otherwise, any ‘{{ template_expression }}’ that contains undefined variables will be rendered in a template or ansible action line exactly as written. AnsibleErrorOnUndefinedVars = "ANSIBLE_ERROR_ON_UNDEFINED_VARS" // AnsibleVarsPlugins (pathspec) Colon separated paths in which Ansible will search for Vars Plugins. AnsibleVarsPlugins = "ANSIBLE_VARS_PLUGINS" // AnsibleVaultEncryptIdentity () The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The –encrypt-vault-id cli option overrides the configured value. AnsibleVaultEncryptIdentity = "ANSIBLE_VAULT_ENCRYPT_IDENTITY" // AnsibleVaultIdMatch () If true, decrypting vaults with a vault id will only try the password from the matching vault-id AnsibleVaultIdMatch = "ANSIBLE_VAULT_ID_MATCH" // AnsibleVaultIdentity () The label to use for the default vault id label in cases where a vault id label is not provided AnsibleVaultIdentity = "ANSIBLE_VAULT_IDENTITY" // AnsibleVaultIdentityList (list) A list of vault-ids to use by default. Equivalent to multiple –vault-id args. Vault-ids are tried in order. AnsibleVaultIdentityList = "ANSIBLE_VAULT_IDENTITY_LIST" // AnsibleVaultPasswordFile (path) The vault password file to use. Equivalent to –vault-password-file or –vault-id If executable, it will be run and the resulting stdout will be used as the password. AnsibleVaultPasswordFile = "ANSIBLE_VAULT_PASSWORD_FILE" // AnsibleVerbosity (integer) Sets the default verbosity, equivalent to the number of -v passed in the command line. AnsibleVerbosity = "ANSIBLE_VERBOSITY" // AnsibleDeprecationWarnings (boolean) Toggle to control the showing of deprecation warnings AnsibleDeprecationWarnings = "ANSIBLE_DEPRECATION_WARNINGS" // AnsibleDevelWarning (boolean) Toggle to control showing warnings related to running devel AnsibleDevelWarning = "ANSIBLE_DEVEL_WARNING" // AnsibleDiffAlways (bool) Configuration toggle to tell modules to show differences when in ‘changed’ status, equivalent to --diff. AnsibleDiffAlways = "ANSIBLE_DIFF_ALWAYS" // AnsibleDiffContext (integer) How many lines of context to show when displaying the differences between files. AnsibleDiffContext = "ANSIBLE_DIFF_CONTEXT" // AnsibleDisplayArgsToStdout (boolean) Normally ansible-playbook will print a header for each task that is run. These headers will contain the name: field from the task if you specified one. If you didn’t then ansible-playbook uses the task’s action to help you tell which task is presently running. Sometimes you run many of the same action and so you want more information about the task to differentiate it from others of the same action. If you set this variable to True in the config then ansible-playbook will also include the task’s arguments in the header. This setting defaults to False because there is a chance that you have sensitive values in your parameters and you do not want those to be printed. If you set this to True you should be sure that you have secured your environment’s stdout (no one can shoulder surf your screen and you aren’t saving stdout to an insecure file) or made sure that all of your playbooks explicitly added the no_log: True parameter to tasks which have sensitive values See How do I keep secret data in my playbook? for more information. AnsibleDisplayArgsToStdout = "ANSIBLE_DISPLAY_ARGS_TO_STDOUT" // AnsibleDisplaySkippedHosts (boolean) Toggle to control displaying skipped task/host entries in a task in the default callback AnsibleDisplaySkippedHosts = "ANSIBLE_DISPLAY_SKIPPED_HOSTS" // AnsibleDocFragmentPlugins (pathspec) Colon separated paths in which Ansible will search for Documentation Fragments Plugins. AnsibleDocFragmentPlugins = "ANSIBLE_DOC_FRAGMENT_PLUGINS" // AnsibleDuplicateYamlDictKey (string) By default Ansible will issue a warning when a duplicate dict key is encountered in YAML. These warnings can be silenced by adjusting this setting to False. AnsibleDuplicateYamlDictKey = "ANSIBLE_DUPLICATE_YAML_DICT_KEY" // Editor () Editor = "EDITOR" // AnsibleEnableTaskDebugger (boolean) Whether or not to enable the task debugger, this previously was done as a strategy plugin. Now all strategy plugins can inherit this behavior. The debugger defaults to activating when a task is failed on unreachable. Use the debugger keyword for more flexibility. AnsibleEnableTaskDebugger = "ANSIBLE_ENABLE_TASK_DEBUGGER" // AnsibleErrorOnMissingHandler (boolean) Toggle to allow missing handlers to become a warning instead of an error when notifying. AnsibleErrorOnMissingHandler = "ANSIBLE_ERROR_ON_MISSING_HANDLER" // 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. If adding your own modules but you still want to use the default Ansible facts, you will want to include ‘setup’ or corresponding network module to the list (if you add ‘smart’, Ansible will also figure it out). This does not affect explicit calls to the ‘setup’ module, but does always affect the ‘gather_facts’ action (implicit or explicit). AnsibleFactsModules = "ANSIBLE_FACTS_MODULES" // AnsibleGalaxyCacheDir (path) The directory that stores cached responses from a Galaxy server. This is only used by the ansible-galaxy collection install and download commands. Cache files inside this dir will be ignored if they are world writable. AnsibleGalaxyCacheDir = "ANSIBLE_GALAXY_CACHE_DIR" // AnsibleGalaxyCollectionSkeleton (path) Collection skeleton directory to use as a template for the init action in ansible-galaxy collection, same as --collection-skeleton. AnsibleGalaxyCollectionSkeleton = "ANSIBLE_GALAXY_COLLECTION_SKELETON" // AnsibleGalaxyCollectionSkeletonIgnore (list) patterns of files to ignore inside a Galaxy collection skeleton directory AnsibleGalaxyCollectionSkeletonIgnore = "ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE" // AnsibleGalaxyCollectionsPathWarning (bool) whether ansible-galaxy collection install should warn about --collections-path missing from configured COLLECTIONS_PATHS AnsibleGalaxyCollectionsPathWarning = "ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING" // AnsibleGalaxyDisableGpgVerify (bool) Disable GPG signature verification during collection installation. AnsibleGalaxyDisableGpgVerify = "ANSIBLE_GALAXY_DISABLE_GPG_VERIFY" // 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. This config option controls whether the display wheel is shown or not. The default is to show the display wheel if stdout has a tty. AnsibleGalaxyDisplayProgress = "ANSIBLE_GALAXY_DISPLAY_PROGRESS" // AnsibleGalaxyGpgKeyring (path) Configure the keyring used for GPG signature verification during collection installation and verification. AnsibleGalaxyGpgKeyring = "ANSIBLE_GALAXY_GPG_KEYRING" // AnsibleGalaxyIgnore (boolean) If set to yes, ansible-galaxy will not validate TLS certificates. This can be useful for testing against a server with a self-signed certificate. AnsibleGalaxyIgnore = "ANSIBLE_GALAXY_IGNORE" // AnsibleGalaxyIgnoreSignatureStatusCodes (list) A list of GPG status codes to ignore during GPG signature verification. See L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes) for status code descriptions. If fewer signatures successfully verify the collection than GALAXY_REQUIRED_VALID_SIGNATURE_COUNT, signature verification will fail even if all error codes are ignored. AnsibleGalaxyIgnoreSignatureStatusCodes = "ANSIBLE_GALAXY_IGNORE_SIGNATURE_STATUS_CODES" // AnsibleGalaxyRequiredValidSignatureCount (str) The number of signatures that must be successful during GPG signature verification while installing or verifying collections. This should be a positive integer or all to indicate all signatures must successfully validate the collection. Prepend + to the value to fail if no valid signatures are found for the collection. AnsibleGalaxyRequiredValidSignatureCount = "ANSIBLE_GALAXY_REQUIRED_VALID_SIGNATURE_COUNT" // AnsibleGalaxyRoleSkeleton (path) Role skeleton directory to use as a template for the init action in ansible-galaxy/ansible-galaxy role, same as --role-skeleton. AnsibleGalaxyRoleSkeleton = "ANSIBLE_GALAXY_ROLE_SKELETON" // AnsibleGalaxyRoleSkeletonIgnore (list) patterns of files to ignore inside a Galaxy role or collection skeleton directory AnsibleGalaxyRoleSkeletonIgnore = "ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE" // AnsibleGalaxyServer () URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source. AnsibleGalaxyServer = "ANSIBLE_GALAXY_SERVER" // AnsibleGalaxyServerList (list) A list of Galaxy servers to use when installing a collection. The value corresponds to the config ini header [galaxy_server.{{item}}] which defines the server details. See Configuring the ansible-galaxy client for more details on how to define a Galaxy server. The order of servers in this list is used to as the order in which a collection is resolved. Setting this config option will ignore the GALAXY_SERVER config option. AnsibleGalaxyServerList = "ANSIBLE_GALAXY_SERVER_LIST" // AnsibleGalaxyServerTimeout (int) The default timeout for Galaxy API calls. Galaxy servers that don’t configure a specific timeout will fall back to this value. AnsibleGalaxyServerTimeout = "ANSIBLE_GALAXY_SERVER_TIMEOUT" // AnsibleGalaxyTokenPath (path) Local path to galaxy access token file AnsibleGalaxyTokenPath = "ANSIBLE_GALAXY_TOKEN_PATH" // 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 AnsibleHostKeyChecking = "ANSIBLE_HOST_KEY_CHECKING" // AnsibleHostPatternMismatch () This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it AnsibleHostPatternMismatch = "ANSIBLE_HOST_PATTERN_MISMATCH" // AnsibleInjectFactVars (boolean) Facts are available inside the ansible_facts variable, this setting also pushes them as their own vars in the main namespace. Unlike inside the ansible_facts dictionary, these will have an ansible_ prefix. AnsibleInjectFactVars = "ANSIBLE_INJECT_FACT_VARS" // AnsiblePythonInterpreter () Path to the Python interpreter to be used for module execution on remote targets, or an automatic discovery mode. Supported discovery modes are auto (the default), auto_silent, auto_legacy, and auto_legacy_silent. All discovery modes employ a lookup table to use the included system Python (on distributions known to include one), falling back to a fixed ordered list of well-known Python interpreter locations if a platform-specific default is not available. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters installed later may change which one is used). This warning behavior can be disabled by setting auto_silent or auto_legacy_silent. The value of auto_legacy provides all the same behavior, but for backwards-compatibility with older Ansible releases that always defaulted to /usr/bin/python, will use that interpreter if present. AnsiblePythonInterpreter = "ANSIBLE_PYTHON_INTERPRETER" // AnsibleInvalidTaskAttributeFailed (boolean) If ‘false’, invalid attributes for a task will result in warnings instead of errors AnsibleInvalidTaskAttributeFailed = "ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED" // 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. AnsibleInventoryAnyUnparsedIsFailed = "ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED" // AnsibleInventoryCache (bool) Toggle to turn on inventory caching. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory configuration. This message will be removed in 2.16. AnsibleInventoryCache = "ANSIBLE_INVENTORY_CACHE" // AnsibleInventoryCachePlugin () The plugin for caching inventory. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16. AnsibleInventoryCachePlugin = "ANSIBLE_INVENTORY_CACHE_PLUGIN" // AnsibleInventoryCacheConnection () The inventory cache connection. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16. AnsibleInventoryCacheConnection = "ANSIBLE_INVENTORY_CACHE_CONNECTION" // AnsibleInventoryCachePluginPrefix () The table prefix for the cache plugin. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16. AnsibleInventoryCachePluginPrefix = "ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX" // AnsibleInventoryCacheTimeout () Expiration timeout for the inventory cache plugin data. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16. AnsibleInventoryCacheTimeout = "ANSIBLE_INVENTORY_CACHE_TIMEOUT" // AnsibleInventoryEnabled (list) List of enabled inventory plugins, it also determines the order in which they are used. AnsibleInventoryEnabled = "ANSIBLE_INVENTORY_ENABLED" // AnsibleInventoryExport (bool) Controls if ansible-inventory will accurately reflect Ansible’s view into inventory or its optimized for exporting. AnsibleInventoryExport = "ANSIBLE_INVENTORY_EXPORT" // AnsibleInventoryIgnore (list) List of extensions to ignore when using a directory as an inventory source AnsibleInventoryIgnore = "ANSIBLE_INVENTORY_IGNORE" // AnsibleInventoryIgnoreRegex (list) List of patterns to ignore when using a directory as an inventory source AnsibleInventoryIgnoreRegex = "ANSIBLE_INVENTORY_IGNORE_REGEX" // 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. AnsibleInventoryUnparsedFailed = "ANSIBLE_INVENTORY_UNPARSED_FAILED" // 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. These warnings can be silenced by adjusting this setting to False. AnsibleInventoryUnparsedWarning = "ANSIBLE_INVENTORY_UNPARSED_WARNING" // 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.] AnsibleJinja2NativeWarning = "ANSIBLE_JINJA2_NATIVE_WARNING" // AnsibleLocalhostWarning (boolean) By default Ansible will issue a warning when there are no hosts in the inventory. These warnings can be silenced by adjusting this setting to False. AnsibleLocalhostWarning = "ANSIBLE_LOCALHOST_WARNING" // AnsibleMaxDiffSize (int) Maximum size of files to be considered for diff display AnsibleMaxDiffSize = "ANSIBLE_MAX_DIFF_SIZE" // AnsibleModuleIgnoreExts (list) List of extensions to ignore when looking for modules to load This is for rejecting script and binary module fallback extensions AnsibleModuleIgnoreExts = "ANSIBLE_MODULE_IGNORE_EXTS" // 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 AnsibleModuleStrictUtf8Response = "ANSIBLE_MODULE_STRICT_UTF8_RESPONSE" // AnsibleNetconfSshConfig () This variable is used to enable bastion/jump host with netconf connection. If set to True the bastion/jump host ssh settings should be present in ~/.ssh/config file, alternatively it can be set to custom ssh configuration file path to read the bastion/jump host settings. AnsibleNetconfSshConfig = "ANSIBLE_NETCONF_SSH_CONFIG" // AnsibleNetworkGroupModules (list) AnsibleNetworkGroupModules = "ANSIBLE_NETWORK_GROUP_MODULES" // 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’. This setting allows to return to that behaviour. AnsibleOldPluginCacheClear = "ANSIBLE_OLD_PLUGIN_CACHE_CLEAR" // Pager () Pager = "PAGER" // AnsibleParamikoHostKeyAutoAdd (boolean) AnsibleParamikoHostKeyAutoAdd = "ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD" // AnsibleParamikoLookForKeys (boolean) AnsibleParamikoLookForKeys = "ANSIBLE_PARAMIKO_LOOK_FOR_KEYS" // AnsiblePersistentCommandTimeout (int) This controls the amount of time to wait for response from remote device before timing out persistent connection. AnsiblePersistentCommandTimeout = "ANSIBLE_PERSISTENT_COMMAND_TIMEOUT" // AnsiblePersistentConnectRetryTimeout (integer) This controls the retry timeout for persistent connection to connect to the local domain socket. AnsiblePersistentConnectRetryTimeout = "ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT" // AnsiblePersistentConnectTimeout (integer) This controls how long the persistent connection will remain idle before it is destroyed. AnsiblePersistentConnectTimeout = "ANSIBLE_PERSISTENT_CONNECT_TIMEOUT" // AnsiblePersistentControlPathDir (path) Path to socket to be used by the connection persistence system. AnsiblePersistentControlPathDir = "ANSIBLE_PERSISTENT_CONTROL_PATH_DIR" // AnsiblePlaybookDir (path) A number of non-playbook CLIs have a --playbook-dir argument; this sets the default value for it. AnsiblePlaybookDir = "ANSIBLE_PLAYBOOK_DIR" // AnsiblePlaybookVarsRoot () This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars AnsiblePlaybookVarsRoot = "ANSIBLE_PLAYBOOK_VARS_ROOT" // 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. See https://bugs.python.org/issue11284). The value will be limited by the existing hard limit. Default value of 0 does not attempt to adjust existing system-defined limits. AnsiblePythonModuleRlimitNofile = "ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE" // AnsibleRetryFilesEnabled (bool) This controls whether a failed Ansible playbook should create a .retry file. AnsibleRetryFilesEnabled = "ANSIBLE_RETRY_FILES_ENABLED" // AnsibleRetryFilesSavePath (path) This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled. This file will be overwritten after each run with the list of failed hosts from all plays. AnsibleRetryFilesSavePath = "ANSIBLE_RETRY_FILES_SAVE_PATH" // AnsibleRunVarsPlugins (str) This setting can be used to optimize vars_plugin usage depending on user’s inventory size and play selection. AnsibleRunVarsPlugins = "ANSIBLE_RUN_VARS_PLUGINS" // AnsibleShowCustomStats (bool) This adds the custom stats set via the set_stats plugin to the default output AnsibleShowCustomStats = "ANSIBLE_SHOW_CUSTOM_STATS" // AnsibleStringConversionAction (string) Action to take when a module parameter value is converted to a string (this does not affect variables). For string parameters, values such as ‘1.00’, “[‘a’, ‘b’,]”, and ‘yes’, ‘y’, etc. will be converted by the YAML parser unless fully quoted. Valid options are ‘error’, ‘warn’, and ‘ignore’. Since 2.8, this option defaults to ‘warn’ but will change to ‘error’ in 2.12. AnsibleStringConversionAction = "ANSIBLE_STRING_CONVERSION_ACTION" // 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. AnsibleStringTypeFilters = "ANSIBLE_STRING_TYPE_FILTERS" // 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. AnsibleSystemWarnings = "ANSIBLE_SYSTEM_WARNINGS" // AnsibleRunTags (list) default list of tags to run in your plays, Skip Tags has precedence. AnsibleRunTags = "ANSIBLE_RUN_TAGS" // AnsibleSkipTags (list) default list of tags to skip in your plays, has precedence over Run Tags AnsibleSkipTags = "ANSIBLE_SKIP_TAGS" // AnsibleTaskDebuggerIgnoreErrors (boolean) This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True is specified. True specifies that the debugger will honor ignore_errors, False will not honor ignore_errors. AnsibleTaskDebuggerIgnoreErrors = "ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS" // AnsibleTaskTimeout (integer) Set the maximum time (in seconds) that a task can run for. If set to 0 (the default) there is no timeout. AnsibleTaskTimeout = "ANSIBLE_TASK_TIMEOUT" // AnsibleTransformInvalidGroupChars (string) Make ansible transform invalid characters in group names supplied by inventory sources. AnsibleTransformInvalidGroupChars = "ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS" // AnsibleUsePersistentConnections (boolean) Toggles the use of persistence for connections. AnsibleUsePersistentConnections = "ANSIBLE_USE_PERSISTENT_CONNECTIONS" // AnsibleValidateActionGroupMetadata (bool) A toggle to disable validating a collection’s ‘metadata’ entry for a module_defaults action group. Metadata containing unexpected fields or value types will produce a warning when this is True. AnsibleValidateActionGroupMetadata = "ANSIBLE_VALIDATE_ACTION_GROUP_METADATA" // AnsibleVarsEnabled (list) Accept list for variable plugins that require it. AnsibleVarsEnabled = "ANSIBLE_VARS_ENABLED" // AnsiblePrecedence (list) Allows to change the group variable precedence merge order. AnsiblePrecedence = "ANSIBLE_PRECEDENCE" // AnsibleVaultEncryptSalt () The salt to use for the vault encryption. If it is not provided, a random salt will be used. AnsibleVaultEncryptSalt = "ANSIBLE_VAULT_ENCRYPT_SALT" // AnsibleVerboseToStderr (bool) Force ‘verbose’ option to use stderr instead of stdout AnsibleVerboseToStderr = "ANSIBLE_VERBOSE_TO_STDERR" // 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. The default is 5 seconds. This can be too low on slower systems, or systems under heavy load. This is not the total time an async command can run for, but is a separate timeout to wait for an async command to start. The task will only start to be timed against its async_timeout once it has connected to the pipe, so the overall maximum duration the task can take will be extended by the amount specified here. AnsibleWinAsyncStartupTimeout = "ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT" // AnsibleWorkerShutdownPollCount (integer) The maximum number of times to check Task Queue Manager worker processes to verify they have exited cleanly. After this limit is reached any worker processes still running will be terminated. This is for internal use only. AnsibleWorkerShutdownPollCount = "ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT" // AnsibleWorkerShutdownPollDelay (float) The number of seconds to sleep between polling loops when checking Task Queue Manager worker processes to verify they have exited cleanly. This is for internal use only. AnsibleWorkerShutdownPollDelay = "ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY" // AnsibleYamlFilenameExt (list) Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these. This affects vars_files, include_vars, inventory and vars plugins among others. AnsibleYamlFilenameExt = "ANSIBLE_YAML_FILENAME_EXT" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnsibleWithConfigurationSettingsExecute ¶
type AnsibleWithConfigurationSettingsExecute struct {
// contains filtered or unexported fields
}
AnsibleWithConfigurationSettingsExecute is a builder for Ansible Cmd
func NewAnsibleWithConfigurationSettingsExecute ¶
func NewAnsibleWithConfigurationSettingsExecute(executor ExecutorEnvVarSetter, options ...ConfigurationSettingsFunc) *AnsibleWithConfigurationSettingsExecute
NewAnsibleWithConfigurationSettingsExecute return a new AnsibleWithConfigurationSettingsExecute
func (*AnsibleWithConfigurationSettingsExecute) Execute ¶
func (e *AnsibleWithConfigurationSettingsExecute) Execute(ctx context.Context) error
func (*AnsibleWithConfigurationSettingsExecute) WithExecutor ¶
func (e *AnsibleWithConfigurationSettingsExecute) WithExecutor(exec ExecutorEnvVarSetter) *AnsibleWithConfigurationSettingsExecute
type ConfigurationSettingsFunc ¶
type ConfigurationSettingsFunc func(*AnsibleWithConfigurationSettingsExecute)
ConfigurationSettingsFunc is a function to set the configuration settings
func WithAnsibleActionPlugins ¶
func WithAnsibleActionPlugins(value string) ConfigurationSettingsFunc
WithAnsibleActionPlugins sets the value for the configuraion ANSIBLE_ACTION_PLUGINS (Colon separated paths in which Ansible will search for Action Plugins.)
func WithAnsibleActionWarnings ¶
func WithAnsibleActionWarnings() ConfigurationSettingsFunc
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.)
func WithAnsibleAgnosticBecomePrompt ¶
func WithAnsibleAgnosticBecomePrompt() ConfigurationSettingsFunc
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)
func WithAnsibleAnyErrorsFatal ¶
func WithAnsibleAnyErrorsFatal() ConfigurationSettingsFunc
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.)
func WithAnsibleAskPass ¶
func WithAnsibleAskPass() ConfigurationSettingsFunc
WithAnsibleAskPass sets the option ANSIBLE_ASK_PASS to true (This controls whether an Ansible playbook should prompt for a login password. If using SSH keys for authentication, you probably do not need to change this setting.)
func WithAnsibleAskVaultPass ¶
func WithAnsibleAskVaultPass() ConfigurationSettingsFunc
WithAnsibleAskVaultPass sets the option ANSIBLE_ASK_VAULT_PASS to true (This controls whether an Ansible playbook should prompt for a vault password.)
func WithAnsibleBecome ¶
func WithAnsibleBecome() ConfigurationSettingsFunc
WithAnsibleBecome sets the option ANSIBLE_BECOME to true (Toggles the use of privilege escalation, allowing you to ‘become’ another user after login.)
func WithAnsibleBecomeAllowSameUser ¶
func WithAnsibleBecomeAllowSameUser() ConfigurationSettingsFunc
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. I.E root sudo to root. If executable, it will be run and the resulting stdout will be used as the password.)
func WithAnsibleBecomeAskPass ¶
func WithAnsibleBecomeAskPass() ConfigurationSettingsFunc
WithAnsibleBecomeAskPass sets the option ANSIBLE_BECOME_ASK_PASS to true (Toggle to prompt for privilege escalation password.)
func WithAnsibleBecomeExe ¶
func WithAnsibleBecomeExe(value string) ConfigurationSettingsFunc
WithAnsibleBecomeExe sets the value for the configuraion ANSIBLE_BECOME_EXE (executable to use for privilege escalation, otherwise Ansible will depend on PATH)
func WithAnsibleBecomeFlags ¶
func WithAnsibleBecomeFlags(value string) ConfigurationSettingsFunc
WithAnsibleBecomeFlags sets the value for the configuraion ANSIBLE_BECOME_FLAGS (Flags to pass to the privilege escalation executable.)
func WithAnsibleBecomeMethod ¶
func WithAnsibleBecomeMethod(value string) ConfigurationSettingsFunc
WithAnsibleBecomeMethod sets the value for the configuraion ANSIBLE_BECOME_METHOD (Privilege escalation method to use when become is enabled.)
func WithAnsibleBecomePasswordFile ¶
func WithAnsibleBecomePasswordFile(value string) ConfigurationSettingsFunc
WithAnsibleBecomePasswordFile sets the value for the configuraion ANSIBLE_BECOME_PASSWORD_FILE (The password file to use for the become plugin. –become-password-file. If executable, it will be run and the resulting stdout will be used as the password.)
func WithAnsibleBecomePlugins ¶
func WithAnsibleBecomePlugins(value string) ConfigurationSettingsFunc
WithAnsibleBecomePlugins sets the value for the configuraion ANSIBLE_BECOME_PLUGINS (Colon separated paths in which Ansible will search for Become Plugins.)
func WithAnsibleBecomeUser ¶
func WithAnsibleBecomeUser(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleCachePlugin ¶
func WithAnsibleCachePlugin(value string) ConfigurationSettingsFunc
WithAnsibleCachePlugin sets the value for the configuraion ANSIBLE_CACHE_PLUGIN (Chooses which cache plugin to use, the default ‘memory’ is ephemeral.)
func WithAnsibleCachePluginConnection ¶
func WithAnsibleCachePluginConnection(value string) ConfigurationSettingsFunc
WithAnsibleCachePluginConnection sets the value for the configuraion ANSIBLE_CACHE_PLUGIN_CONNECTION (Defines connection or path information for the cache plugin)
func WithAnsibleCachePluginPrefix ¶
func WithAnsibleCachePluginPrefix(value string) ConfigurationSettingsFunc
WithAnsibleCachePluginPrefix sets the value for the configuraion ANSIBLE_CACHE_PLUGIN_PREFIX (Prefix to use for cache plugin files/tables)
func WithAnsibleCachePluginTimeout ¶
func WithAnsibleCachePluginTimeout(value int) ConfigurationSettingsFunc
WithAnsibleCachePluginTimeout sets the value for the configuraion ANSIBLE_CACHE_PLUGIN_TIMEOUT (Expiration timeout for the cache plugin data)
func WithAnsibleCachePlugins ¶
func WithAnsibleCachePlugins(value string) ConfigurationSettingsFunc
WithAnsibleCachePlugins sets the value for the configuraion ANSIBLE_CACHE_PLUGINS (Colon separated paths in which Ansible will search for Cache Plugins.)
func WithAnsibleCallbackPlugins ¶
func WithAnsibleCallbackPlugins(value string) ConfigurationSettingsFunc
WithAnsibleCallbackPlugins sets the value for the configuraion ANSIBLE_CALLBACK_PLUGINS (Colon separated paths in which Ansible will search for Callback Plugins.)
func WithAnsibleCallbacksEnabled ¶
func WithAnsibleCallbacksEnabled(value string) ConfigurationSettingsFunc
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. [:Version Added: 2.11])
func WithAnsibleCliconfPlugins ¶
func WithAnsibleCliconfPlugins(value string) ConfigurationSettingsFunc
WithAnsibleCliconfPlugins sets the value for the configuraion ANSIBLE_CLICONF_PLUGINS (Colon separated paths in which Ansible will search for Cliconf Plugins.)
func WithAnsibleCollectionsOnAnsibleVersionMismatch ¶
func WithAnsibleCollectionsOnAnsibleVersionMismatch(value string) ConfigurationSettingsFunc
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).)
func WithAnsibleCollectionsPaths ¶
func WithAnsibleCollectionsPaths(value string) ConfigurationSettingsFunc
WithAnsibleCollectionsPaths sets the value for the configuraion ANSIBLE_COLLECTIONS_PATHS (Colon separated paths in which Ansible will search for collections content. Collections must be in nested subdirectories, not directly in these directories. For example, if COLLECTIONS_PATHS includes '{{ ANSIBLE_HOME ~ "/collections" }}', and you want to add my.collection to that directory, it must be saved as '{{ ANSIBLE_HOME} ~ "/collections/ansible_collections/my/collection" }}'.)
func WithAnsibleCollectionsScanSysPath ¶
func WithAnsibleCollectionsScanSysPath() ConfigurationSettingsFunc
WithAnsibleCollectionsScanSysPath sets the option ANSIBLE_COLLECTIONS_SCAN_SYS_PATH to true (A boolean to enable or disable scanning the sys.path for installed collections)
func WithAnsibleColorChanged ¶
func WithAnsibleColorChanged(value string) ConfigurationSettingsFunc
WithAnsibleColorChanged sets the value for the configuraion ANSIBLE_COLOR_CHANGED (Defines the color to use on ‘Changed’ task status)
func WithAnsibleColorConsolePrompt ¶
func WithAnsibleColorConsolePrompt(value string) ConfigurationSettingsFunc
WithAnsibleColorConsolePrompt sets the value for the configuraion ANSIBLE_COLOR_CONSOLE_PROMPT (Defines the default color to use for ansible-console)
func WithAnsibleColorDebug ¶
func WithAnsibleColorDebug(value string) ConfigurationSettingsFunc
WithAnsibleColorDebug sets the value for the configuraion ANSIBLE_COLOR_DEBUG (Defines the color to use when emitting debug messages)
func WithAnsibleColorDeprecate ¶
func WithAnsibleColorDeprecate(value string) ConfigurationSettingsFunc
WithAnsibleColorDeprecate sets the value for the configuraion ANSIBLE_COLOR_DEPRECATE (Defines the color to use when emitting deprecation messages)
func WithAnsibleColorDiffAdd ¶
func WithAnsibleColorDiffAdd(value string) ConfigurationSettingsFunc
WithAnsibleColorDiffAdd sets the value for the configuraion ANSIBLE_COLOR_DIFF_ADD (Defines the color to use when showing added lines in diffs)
func WithAnsibleColorDiffLines ¶
func WithAnsibleColorDiffLines(value string) ConfigurationSettingsFunc
WithAnsibleColorDiffLines sets the value for the configuraion ANSIBLE_COLOR_DIFF_LINES (Defines the color to use when showing diffs)
func WithAnsibleColorDiffRemove ¶
func WithAnsibleColorDiffRemove(value string) ConfigurationSettingsFunc
WithAnsibleColorDiffRemove sets the value for the configuraion ANSIBLE_COLOR_DIFF_REMOVE (Defines the color to use when showing removed lines in diffs)
func WithAnsibleColorError ¶
func WithAnsibleColorError(value string) ConfigurationSettingsFunc
WithAnsibleColorError sets the value for the configuraion ANSIBLE_COLOR_ERROR (Defines the color to use when emitting error messages)
func WithAnsibleColorHighlight ¶
func WithAnsibleColorHighlight(value string) ConfigurationSettingsFunc
WithAnsibleColorHighlight sets the value for the configuraion ANSIBLE_COLOR_HIGHLIGHT (Defines the color to use for highlighting)
func WithAnsibleColorOk ¶
func WithAnsibleColorOk(value string) ConfigurationSettingsFunc
WithAnsibleColorOk sets the value for the configuraion ANSIBLE_COLOR_OK (Defines the color to use when showing ‘OK’ task status)
func WithAnsibleColorSkip ¶
func WithAnsibleColorSkip(value string) ConfigurationSettingsFunc
WithAnsibleColorSkip sets the value for the configuraion ANSIBLE_COLOR_SKIP (Defines the color to use when showing ‘Skipped’ task status)
func WithAnsibleColorUnreachable ¶
func WithAnsibleColorUnreachable(value string) ConfigurationSettingsFunc
WithAnsibleColorUnreachable sets the value for the configuraion ANSIBLE_COLOR_UNREACHABLE (Defines the color to use on ‘Unreachable’ status)
func WithAnsibleColorVerbose ¶
func WithAnsibleColorVerbose(value string) ConfigurationSettingsFunc
WithAnsibleColorVerbose sets the value for the configuraion ANSIBLE_COLOR_VERBOSE (Defines the color to use when emitting verbose messages. i.e those that show with ‘-v’s.)
func WithAnsibleColorWarn ¶
func WithAnsibleColorWarn(value string) ConfigurationSettingsFunc
WithAnsibleColorWarn sets the value for the configuraion ANSIBLE_COLOR_WARN (Defines the color to use when emitting warning messages)
func WithAnsibleConnectionPasswordFile ¶
func WithAnsibleConnectionPasswordFile(value string) ConfigurationSettingsFunc
WithAnsibleConnectionPasswordFile sets the value for the configuraion ANSIBLE_CONNECTION_PASSWORD_FILE (The password file to use for the connection plugin. –connection-password-file.)
func WithAnsibleConnectionPath ¶
func WithAnsibleConnectionPath(value string) ConfigurationSettingsFunc
WithAnsibleConnectionPath sets the value for the configuraion ANSIBLE_CONNECTION_PATH (Specify where to look for the ansible-connection script. This location will be checked before searching $PATH. If null, ansible will start with the same directory as the ansible script.)
func WithAnsibleConnectionPlugins ¶
func WithAnsibleConnectionPlugins(value string) ConfigurationSettingsFunc
WithAnsibleConnectionPlugins sets the value for the configuraion ANSIBLE_CONNECTION_PLUGINS (Colon separated paths in which Ansible will search for Connection Plugins.)
func WithAnsibleCoverageRemoteOutput ¶
func WithAnsibleCoverageRemoteOutput(value string) ConfigurationSettingsFunc
WithAnsibleCoverageRemoteOutput sets the value for the configuraion _ANSIBLE_COVERAGE_REMOTE_OUTPUT (Sets the output directory on the remote host to generate coverage reports to. Currently only used for remote coverage on PowerShell modules. This is for internal use only.)
func WithAnsibleCoverageRemotePathFilter ¶
func WithAnsibleCoverageRemotePathFilter(value string) ConfigurationSettingsFunc
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. Only files that match the path glob will have its coverage collected. Multiple path globs can be specified and are separated by :. Currently only used for remote coverage on PowerShell modules. This is for internal use only.)
func WithAnsibleCowAcceptlist ¶
func WithAnsibleCowAcceptlist(value string) ConfigurationSettingsFunc
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. [:Version Added: 2.11])
func WithAnsibleCowPath ¶
func WithAnsibleCowPath(value string) ConfigurationSettingsFunc
WithAnsibleCowPath sets the value for the configuraion ANSIBLE_COW_PATH (Specify a custom cowsay path or swap in your cowsay implementation of choice)
func WithAnsibleCowSelection ¶
func WithAnsibleCowSelection(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleDebug ¶
func WithAnsibleDebug() ConfigurationSettingsFunc
WithAnsibleDebug sets the option ANSIBLE_DEBUG to true (Toggles debug output in Ansible. This is very verbose and can hinder multiprocessing. Debug output can also include secret information despite no_log settings being enabled, which means debug mode should not be used in production.)
func WithAnsibleDeprecationWarnings ¶
func WithAnsibleDeprecationWarnings() ConfigurationSettingsFunc
WithAnsibleDeprecationWarnings sets the option ANSIBLE_DEPRECATION_WARNINGS to true (Toggle to control the showing of deprecation warnings)
func WithAnsibleDevelWarning ¶
func WithAnsibleDevelWarning() ConfigurationSettingsFunc
WithAnsibleDevelWarning sets the option ANSIBLE_DEVEL_WARNING to true (Toggle to control showing warnings related to running devel)
func WithAnsibleDiffAlways ¶
func WithAnsibleDiffAlways(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleDiffContext ¶
func WithAnsibleDiffContext(value int) ConfigurationSettingsFunc
WithAnsibleDiffContext sets the value for the configuraion ANSIBLE_DIFF_CONTEXT (How many lines of context to show when displaying the differences between files.)
func WithAnsibleDisplayArgsToStdout ¶
func WithAnsibleDisplayArgsToStdout() ConfigurationSettingsFunc
WithAnsibleDisplayArgsToStdout sets the option ANSIBLE_DISPLAY_ARGS_TO_STDOUT to true (Normally ansible-playbook will print a header for each task that is run. These headers will contain the name: field from the task if you specified one. If you didn’t then ansible-playbook uses the task’s action to help you tell which task is presently running. Sometimes you run many of the same action and so you want more information about the task to differentiate it from others of the same action. If you set this variable to True in the config then ansible-playbook will also include the task’s arguments in the header. This setting defaults to False because there is a chance that you have sensitive values in your parameters and you do not want those to be printed. If you set this to True you should be sure that you have secured your environment’s stdout (no one can shoulder surf your screen and you aren’t saving stdout to an insecure file) or made sure that all of your playbooks explicitly added the no_log: True parameter to tasks which have sensitive values See How do I keep secret data in my playbook? for more information.)
func WithAnsibleDisplaySkippedHosts ¶
func WithAnsibleDisplaySkippedHosts() ConfigurationSettingsFunc
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)
func WithAnsibleDocFragmentPlugins ¶
func WithAnsibleDocFragmentPlugins(value string) ConfigurationSettingsFunc
WithAnsibleDocFragmentPlugins sets the value for the configuraion ANSIBLE_DOC_FRAGMENT_PLUGINS (Colon separated paths in which Ansible will search for Documentation Fragments Plugins.)
func WithAnsibleDuplicateYamlDictKey ¶
func WithAnsibleDuplicateYamlDictKey(value string) ConfigurationSettingsFunc
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. These warnings can be silenced by adjusting this setting to False.)
func WithAnsibleEnableTaskDebugger ¶
func WithAnsibleEnableTaskDebugger() ConfigurationSettingsFunc
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. Now all strategy plugins can inherit this behavior. The debugger defaults to activating when a task is failed on unreachable. Use the debugger keyword for more flexibility.)
func WithAnsibleErrorOnMissingHandler ¶
func WithAnsibleErrorOnMissingHandler() ConfigurationSettingsFunc
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.)
func WithAnsibleErrorOnUndefinedVars ¶
func WithAnsibleErrorOnUndefinedVars() ConfigurationSettingsFunc
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. Otherwise, any ‘{{ template_expression }}’ that contains undefined variables will be rendered in a template or ansible action line exactly as written.)
func WithAnsibleExecutable ¶
func WithAnsibleExecutable(value string) ConfigurationSettingsFunc
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. Users may need to change this in rare instances when shell usage is constrained, but in most cases it may be left as is.)
func WithAnsibleFactPath ¶
func WithAnsibleFactPath(value string) ConfigurationSettingsFunc
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. If not set, it will fallback to the default from the ansible.builtin.setup module: /etc/ansible/facts.d. This does not affect user defined tasks that use the ansible.builtin.setup module. The real action being created by the implicit task is currently ansible.legacy.gather_facts module, which then calls the configured fact modules, by default this will be ansible.builtin.setup for POSIX systems but other platforms might have different defaults.)
func WithAnsibleFactsModules ¶
func WithAnsibleFactsModules(value string) ConfigurationSettingsFunc
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. If adding your own modules but you still want to use the default Ansible facts, you will want to include ‘setup’ or corresponding network module to the list (if you add ‘smart’, Ansible will also figure it out). This does not affect explicit calls to the ‘setup’ module, but does always affect the ‘gather_facts’ action (implicit or explicit).)
func WithAnsibleFilterPlugins ¶
func WithAnsibleFilterPlugins(value string) ConfigurationSettingsFunc
WithAnsibleFilterPlugins sets the value for the configuraion ANSIBLE_FILTER_PLUGINS (Colon separated paths in which Ansible will search for Jinja2 Filter Plugins.)
func WithAnsibleForceColor ¶
func WithAnsibleForceColor() ConfigurationSettingsFunc
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.)
func WithAnsibleForceHandlers ¶
func WithAnsibleForceHandlers() ConfigurationSettingsFunc
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. When false, the handlers will not run if a failure has occurred on a host. This can also be set per play or on the command line. See Handlers and Failure for more details.)
func WithAnsibleForks ¶
func WithAnsibleForks(value int) ConfigurationSettingsFunc
WithAnsibleForks sets the value for the configuraion ANSIBLE_FORKS (Maximum number of forks Ansible will use to execute tasks on target hosts.)
func WithAnsibleGalaxyCacheDir ¶
func WithAnsibleGalaxyCacheDir(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyCacheDir sets the value for the configuraion ANSIBLE_GALAXY_CACHE_DIR (The directory that stores cached responses from a Galaxy server. This is only used by the ansible-galaxy collection install and download commands. Cache files inside this dir will be ignored if they are world writable.)
func WithAnsibleGalaxyCollectionSkeleton ¶
func WithAnsibleGalaxyCollectionSkeleton(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleGalaxyCollectionSkeletonIgnore ¶
func WithAnsibleGalaxyCollectionSkeletonIgnore(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyCollectionSkeletonIgnore sets the value for the configuraion ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE (patterns of files to ignore inside a Galaxy collection skeleton directory)
func WithAnsibleGalaxyCollectionsPathWarning ¶
func WithAnsibleGalaxyCollectionsPathWarning(value string) ConfigurationSettingsFunc
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)
func WithAnsibleGalaxyDisableGpgVerify ¶
func WithAnsibleGalaxyDisableGpgVerify(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyDisableGpgVerify sets the value for the configuraion ANSIBLE_GALAXY_DISABLE_GPG_VERIFY (Disable GPG signature verification during collection installation.)
func WithAnsibleGalaxyDisplayProgress ¶
func WithAnsibleGalaxyDisplayProgress(value string) ConfigurationSettingsFunc
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. This config option controls whether the display wheel is shown or not. The default is to show the display wheel if stdout has a tty.)
func WithAnsibleGalaxyGpgKeyring ¶
func WithAnsibleGalaxyGpgKeyring(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyGpgKeyring sets the value for the configuraion ANSIBLE_GALAXY_GPG_KEYRING (Configure the keyring used for GPG signature verification during collection installation and verification.)
func WithAnsibleGalaxyIgnore ¶
func WithAnsibleGalaxyIgnore() ConfigurationSettingsFunc
WithAnsibleGalaxyIgnore sets the option ANSIBLE_GALAXY_IGNORE to true (If set to yes, ansible-galaxy will not validate TLS certificates. This can be useful for testing against a server with a self-signed certificate.)
func WithAnsibleGalaxyIgnoreSignatureStatusCodes ¶
func WithAnsibleGalaxyIgnoreSignatureStatusCodes(value string) ConfigurationSettingsFunc
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. See L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes) for status code descriptions. If fewer signatures successfully verify the collection than GALAXY_REQUIRED_VALID_SIGNATURE_COUNT, signature verification will fail even if all error codes are ignored.)
func WithAnsibleGalaxyRequiredValidSignatureCount ¶
func WithAnsibleGalaxyRequiredValidSignatureCount(value string) ConfigurationSettingsFunc
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. This should be a positive integer or all to indicate all signatures must successfully validate the collection. Prepend + to the value to fail if no valid signatures are found for the collection.)
func WithAnsibleGalaxyRoleSkeleton ¶
func WithAnsibleGalaxyRoleSkeleton(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleGalaxyRoleSkeletonIgnore ¶
func WithAnsibleGalaxyRoleSkeletonIgnore(value string) ConfigurationSettingsFunc
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)
func WithAnsibleGalaxyServer ¶
func WithAnsibleGalaxyServer(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleGalaxyServerList ¶
func WithAnsibleGalaxyServerList(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyServerList sets the value for the configuraion ANSIBLE_GALAXY_SERVER_LIST (A list of Galaxy servers to use when installing a collection. The value corresponds to the config ini header [galaxy_server.{{item}}] which defines the server details. See Configuring the ansible-galaxy client for more details on how to define a Galaxy server. The order of servers in this list is used to as the order in which a collection is resolved. Setting this config option will ignore the GALAXY_SERVER config option.)
func WithAnsibleGalaxyServerTimeout ¶
func WithAnsibleGalaxyServerTimeout(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyServerTimeout sets the value for the configuraion ANSIBLE_GALAXY_SERVER_TIMEOUT (The default timeout for Galaxy API calls. Galaxy servers that don’t configure a specific timeout will fall back to this value.)
func WithAnsibleGalaxyTokenPath ¶
func WithAnsibleGalaxyTokenPath(value string) ConfigurationSettingsFunc
WithAnsibleGalaxyTokenPath sets the value for the configuraion ANSIBLE_GALAXY_TOKEN_PATH (Local path to galaxy access token file)
func WithAnsibleGatherSubset ¶
func WithAnsibleGatherSubset(value string) ConfigurationSettingsFunc
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. See the module documentation for specifics. It does not apply to user defined ansible.builtin.setup tasks.)
func WithAnsibleGatherTimeout ¶
func WithAnsibleGatherTimeout(value int) ConfigurationSettingsFunc
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. It does not apply to user defined ansible_collections.ansible.builtin.setup_module tasks.)
func WithAnsibleGathering ¶
func WithAnsibleGathering(value string) ConfigurationSettingsFunc
WithAnsibleGathering sets the value for the configuraion ANSIBLE_GATHERING (This setting controls the default policy of fact gathering (facts discovered about remote systems). This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the cache plugin.)
func WithAnsibleHashBehaviour ¶
func WithAnsibleHashBehaviour(value string) ConfigurationSettingsFunc
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. This does not affect variables whose values are scalars (integers, strings) or arrays. WARNING, changing this setting is not recommended as this is fragile and makes your content (plays, roles, collections) non portable, leading to continual confusion and misuse. Don’t change this setting unless you think you have an absolute need for it. We recommend avoiding reusing variable names and relying on the combine filter and vars and varnames lookups to create merged versions of the individual variables. In our experience this is rarely really needed and a sign that too much complexity has been introduced into the data structures and plays. For some uses you can also look into custom vars_plugins to merge on input, even substituting the default host_group_vars that is in charge of parsing the host_vars/ and group_vars/ directories. Most users of this setting are only interested in inventory scope, but the setting itself affects all sources and makes debugging even harder. All playbooks and roles in the official examples repos assume the default for this setting. Changing the setting to merge applies across variable sources, but many sources will internally still overwrite the variables. For example include_vars will dedupe variables internally before updating Ansible, with ‘last defined’ overwriting previous definitions in same file. The Ansible project recommends you avoid “merge“ for new projects. It is the intention of the Ansible developers to eventually deprecate and remove this setting, but it is being kept as some users do heavily rely on it. New projects should avoid ‘merge’.)
func WithAnsibleHome ¶
func WithAnsibleHome(value string) ConfigurationSettingsFunc
WithAnsibleHome sets the value for the configuraion ANSIBLE_HOME (The default root path for Ansible config files on the controller.)
func WithAnsibleHostKeyChecking ¶
func WithAnsibleHostKeyChecking() ConfigurationSettingsFunc
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)
func WithAnsibleHostPatternMismatch ¶
func WithAnsibleHostPatternMismatch(value string) ConfigurationSettingsFunc
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)
func WithAnsibleHttpapiPlugins ¶
func WithAnsibleHttpapiPlugins(value string) ConfigurationSettingsFunc
WithAnsibleHttpapiPlugins sets the value for the configuraion ANSIBLE_HTTPAPI_PLUGINS (Colon separated paths in which Ansible will search for HttpApi Plugins.)
func WithAnsibleInjectFactVars ¶
func WithAnsibleInjectFactVars() ConfigurationSettingsFunc
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. Unlike inside the ansible_facts dictionary, these will have an ansible_ prefix.)
func WithAnsibleInvalidTaskAttributeFailed ¶
func WithAnsibleInvalidTaskAttributeFailed() ConfigurationSettingsFunc
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)
func WithAnsibleInventory ¶
func WithAnsibleInventory(value string) ConfigurationSettingsFunc
WithAnsibleInventory sets the value for the configuraion ANSIBLE_INVENTORY (Comma separated list of Ansible inventory sources)
func WithAnsibleInventoryAnyUnparsedIsFailed ¶
func WithAnsibleInventoryAnyUnparsedIsFailed() ConfigurationSettingsFunc
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.)
func WithAnsibleInventoryCache ¶
func WithAnsibleInventoryCache(value string) ConfigurationSettingsFunc
WithAnsibleInventoryCache sets the value for the configuraion ANSIBLE_INVENTORY_CACHE (Toggle to turn on inventory caching. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory configuration. This message will be removed in 2.16.)
func WithAnsibleInventoryCacheConnection ¶
func WithAnsibleInventoryCacheConnection(value string) ConfigurationSettingsFunc
WithAnsibleInventoryCacheConnection sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_CONNECTION (The inventory cache connection. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16.)
func WithAnsibleInventoryCachePlugin ¶
func WithAnsibleInventoryCachePlugin(value string) ConfigurationSettingsFunc
WithAnsibleInventoryCachePlugin sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_PLUGIN (The plugin for caching inventory. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16.)
func WithAnsibleInventoryCachePluginPrefix ¶
func WithAnsibleInventoryCachePluginPrefix(value string) ConfigurationSettingsFunc
WithAnsibleInventoryCachePluginPrefix sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX (The table prefix for the cache plugin. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16.)
func WithAnsibleInventoryCacheTimeout ¶
func WithAnsibleInventoryCacheTimeout(value string) ConfigurationSettingsFunc
WithAnsibleInventoryCacheTimeout sets the value for the configuraion ANSIBLE_INVENTORY_CACHE_TIMEOUT (Expiration timeout for the inventory cache plugin data. This setting has been moved to the individual inventory plugins as a plugin option Inventory plugins. The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration. This message will be removed in 2.16.)
func WithAnsibleInventoryEnabled ¶
func WithAnsibleInventoryEnabled(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleInventoryExport ¶
func WithAnsibleInventoryExport(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleInventoryIgnore ¶
func WithAnsibleInventoryIgnore(value string) ConfigurationSettingsFunc
WithAnsibleInventoryIgnore sets the value for the configuraion ANSIBLE_INVENTORY_IGNORE (List of extensions to ignore when using a directory as an inventory source)
func WithAnsibleInventoryIgnoreRegex ¶
func WithAnsibleInventoryIgnoreRegex(value string) ConfigurationSettingsFunc
WithAnsibleInventoryIgnoreRegex sets the value for the configuraion ANSIBLE_INVENTORY_IGNORE_REGEX (List of patterns to ignore when using a directory as an inventory source)
func WithAnsibleInventoryPlugins ¶
func WithAnsibleInventoryPlugins(value string) ConfigurationSettingsFunc
WithAnsibleInventoryPlugins sets the value for the configuraion ANSIBLE_INVENTORY_PLUGINS (Colon separated paths in which Ansible will search for Inventory Plugins.)
func WithAnsibleInventoryUnparsedFailed ¶
func WithAnsibleInventoryUnparsedFailed(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleInventoryUnparsedWarning ¶
func WithAnsibleInventoryUnparsedWarning() ConfigurationSettingsFunc
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. These warnings can be silenced by adjusting this setting to False.)
func WithAnsibleJinja2Extensions ¶
func WithAnsibleJinja2Extensions(value string) ConfigurationSettingsFunc
WithAnsibleJinja2Extensions sets the value for the configuraion ANSIBLE_JINJA2_EXTENSIONS (This is a developer-specific feature that allows enabling additional Jinja2 extensions. See the Jinja2 documentation for details. If you do not know what these do, you probably don’t need to change this setting :))
func WithAnsibleJinja2Native ¶
func WithAnsibleJinja2Native() ConfigurationSettingsFunc
WithAnsibleJinja2Native sets the option ANSIBLE_JINJA2_NATIVE to true (This option preserves variable types during template operations.)
func WithAnsibleJinja2NativeWarning ¶
func WithAnsibleJinja2NativeWarning() ConfigurationSettingsFunc
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.])
func WithAnsibleKeepRemoteFiles ¶
func WithAnsibleKeepRemoteFiles() ConfigurationSettingsFunc
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. If this option is enabled it will disable ANSIBLE_PIPELINING.)
func WithAnsibleLibrary ¶
func WithAnsibleLibrary(value string) ConfigurationSettingsFunc
WithAnsibleLibrary sets the value for the configuraion ANSIBLE_LIBRARY (Colon separated paths in which Ansible will search for Modules.)
func WithAnsibleLibvirtLxcNoseclabel ¶
func WithAnsibleLibvirtLxcNoseclabel() ConfigurationSettingsFunc
WithAnsibleLibvirtLxcNoseclabel sets the option ANSIBLE_LIBVIRT_LXC_NOSECLABEL to true (This setting causes libvirt to connect to lxc containers by passing –noseclabel to virsh. This is necessary when running on systems which do not have SELinux.)
func WithAnsibleLoadCallbackPlugins ¶
func WithAnsibleLoadCallbackPlugins() ConfigurationSettingsFunc
WithAnsibleLoadCallbackPlugins sets the option ANSIBLE_LOAD_CALLBACK_PLUGINS to true (Controls whether callback plugins are loaded when running /usr/bin/ansible. This may be used to log activity from the command line, send notifications, and so on. Callback plugins are always loaded for ansible-playbook.)
func WithAnsibleLocalTemp ¶
func WithAnsibleLocalTemp(value string) ConfigurationSettingsFunc
WithAnsibleLocalTemp sets the value for the configuraion ANSIBLE_LOCAL_TEMP (Temporary directory for Ansible to use on the controller.)
func WithAnsibleLocalhostWarning ¶
func WithAnsibleLocalhostWarning() ConfigurationSettingsFunc
WithAnsibleLocalhostWarning sets the option ANSIBLE_LOCALHOST_WARNING to true (By default Ansible will issue a warning when there are no hosts in the inventory. These warnings can be silenced by adjusting this setting to False.)
func WithAnsibleLogFilter ¶
func WithAnsibleLogFilter(value string) ConfigurationSettingsFunc
WithAnsibleLogFilter sets the value for the configuraion ANSIBLE_LOG_FILTER (List of logger names to filter out of the log file)
func WithAnsibleLogPath ¶
func WithAnsibleLogPath(value string) ConfigurationSettingsFunc
WithAnsibleLogPath sets the value for the configuraion ANSIBLE_LOG_PATH (File to which Ansible will log on the controller. When empty logging is disabled.)
func WithAnsibleLookupPlugins ¶
func WithAnsibleLookupPlugins(value string) ConfigurationSettingsFunc
WithAnsibleLookupPlugins sets the value for the configuraion ANSIBLE_LOOKUP_PLUGINS (Colon separated paths in which Ansible will search for Lookup Plugins.)
func WithAnsibleMaxDiffSize ¶
func WithAnsibleMaxDiffSize(value string) ConfigurationSettingsFunc
WithAnsibleMaxDiffSize sets the value for the configuraion ANSIBLE_MAX_DIFF_SIZE (Maximum size of files to be considered for diff display)
func WithAnsibleModuleArgs ¶
func WithAnsibleModuleArgs(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleModuleIgnoreExts ¶
func WithAnsibleModuleIgnoreExts(value string) ConfigurationSettingsFunc
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)
func WithAnsibleModuleStrictUtf8Response ¶
func WithAnsibleModuleStrictUtf8Response(value string) ConfigurationSettingsFunc
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)
func WithAnsibleModuleUtils ¶
func WithAnsibleModuleUtils(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleNetconfPlugins ¶
func WithAnsibleNetconfPlugins(value string) ConfigurationSettingsFunc
WithAnsibleNetconfPlugins sets the value for the configuraion ANSIBLE_NETCONF_PLUGINS (Colon separated paths in which Ansible will search for Netconf Plugins.)
func WithAnsibleNetconfSshConfig ¶
func WithAnsibleNetconfSshConfig(value string) ConfigurationSettingsFunc
WithAnsibleNetconfSshConfig sets the value for the configuraion ANSIBLE_NETCONF_SSH_CONFIG (This variable is used to enable bastion/jump host with netconf connection. If set to True the bastion/jump host ssh settings should be present in ~/.ssh/config file, alternatively it can be set to custom ssh configuration file path to read the bastion/jump host settings.)
func WithAnsibleNetworkGroupModules ¶
func WithAnsibleNetworkGroupModules(value string) ConfigurationSettingsFunc
WithAnsibleNetworkGroupModules sets the value for the configuraion ANSIBLE_NETWORK_GROUP_MODULES ()
func WithAnsibleNoLog ¶
func WithAnsibleNoLog() ConfigurationSettingsFunc
WithAnsibleNoLog sets the option ANSIBLE_NO_LOG to true (Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures.)
func WithAnsibleNoTargetSyslog ¶
func WithAnsibleNoTargetSyslog() ConfigurationSettingsFunc
WithAnsibleNoTargetSyslog sets the option ANSIBLE_NO_TARGET_SYSLOG to true (Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts this will disable a newer style PowerShell modules from writing to the event log.)
func WithAnsibleNocows ¶
func WithAnsibleNocows() ConfigurationSettingsFunc
WithAnsibleNocows sets the option ANSIBLE_NOCOWS to true (If you have cowsay installed but want to avoid the ‘cows’ (why????), use this.)
func WithAnsibleNullRepresentation ¶
func WithAnsibleNullRepresentation(value string) ConfigurationSettingsFunc
WithAnsibleNullRepresentation sets the value for the configuraion ANSIBLE_NULL_REPRESENTATION (What templating should return as a ‘null’ value. When not set it will let Jinja2 decide.)
func WithAnsibleOldPluginCacheClear ¶
func WithAnsibleOldPluginCacheClear() ConfigurationSettingsFunc
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’. This setting allows to return to that behaviour.)
func WithAnsibleParamikoHostKeyAutoAdd ¶
func WithAnsibleParamikoHostKeyAutoAdd() ConfigurationSettingsFunc
WithAnsibleParamikoHostKeyAutoAdd sets the option ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD to true ()
func WithAnsibleParamikoLookForKeys ¶
func WithAnsibleParamikoLookForKeys() ConfigurationSettingsFunc
WithAnsibleParamikoLookForKeys sets the option ANSIBLE_PARAMIKO_LOOK_FOR_KEYS to true ()
func WithAnsiblePersistentCommandTimeout ¶
func WithAnsiblePersistentCommandTimeout(value string) ConfigurationSettingsFunc
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.)
func WithAnsiblePersistentConnectRetryTimeout ¶
func WithAnsiblePersistentConnectRetryTimeout(value int) ConfigurationSettingsFunc
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.)
func WithAnsiblePersistentConnectTimeout ¶
func WithAnsiblePersistentConnectTimeout(value int) ConfigurationSettingsFunc
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.)
func WithAnsiblePersistentControlPathDir ¶
func WithAnsiblePersistentControlPathDir(value string) ConfigurationSettingsFunc
WithAnsiblePersistentControlPathDir sets the value for the configuraion ANSIBLE_PERSISTENT_CONTROL_PATH_DIR (Path to socket to be used by the connection persistence system.)
func WithAnsiblePipelining ¶
func WithAnsiblePipelining() ConfigurationSettingsFunc
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. Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfer. It can result in a very significant performance improvement when enabled. However this conflicts with privilege escalation (become). For example, when using ‘sudo:’ operations you must first disable ‘requiretty’ in /etc/sudoers on all managed hosts, which is why it is disabled by default. This setting will be disabled if ANSIBLE_KEEP_REMOTE_FILES is enabled.)
func WithAnsiblePlaybookDir ¶
func WithAnsiblePlaybookDir(value string) ConfigurationSettingsFunc
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.)
func WithAnsiblePlaybookVarsRoot ¶
func WithAnsiblePlaybookVarsRoot(value string) ConfigurationSettingsFunc
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)
func WithAnsiblePollInterval ¶
func WithAnsiblePollInterval(value int) ConfigurationSettingsFunc
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. The default is a reasonably moderate 15 seconds which is a tradeoff between checking in frequently and providing a quick turnaround when something may have completed.)
func WithAnsiblePrecedence ¶
func WithAnsiblePrecedence(value string) ConfigurationSettingsFunc
WithAnsiblePrecedence sets the value for the configuraion ANSIBLE_PRECEDENCE (Allows to change the group variable precedence merge order.)
func WithAnsiblePrivateKeyFile ¶
func WithAnsiblePrivateKeyFile(value string) ConfigurationSettingsFunc
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.)
func WithAnsiblePrivateRoleVars ¶
func WithAnsiblePrivateRoleVars() ConfigurationSettingsFunc
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. This was introduced as a way to reset role variables to default values if a role is used more than once in a playbook. Included roles only make their variables public at execution, unlike imported roles which happen at playbook compile time.)
func WithAnsiblePythonInterpreter ¶
func WithAnsiblePythonInterpreter(value string) ConfigurationSettingsFunc
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. Supported discovery modes are auto (the default), auto_silent, auto_legacy, and auto_legacy_silent. All discovery modes employ a lookup table to use the included system Python (on distributions known to include one), falling back to a fixed ordered list of well-known Python interpreter locations if a platform-specific default is not available. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters installed later may change which one is used). This warning behavior can be disabled by setting auto_silent or auto_legacy_silent. The value of auto_legacy provides all the same behavior, but for backwards-compatibility with older Ansible releases that always defaulted to /usr/bin/python, will use that interpreter if present.)
func WithAnsiblePythonModuleRlimitNofile ¶
func WithAnsiblePythonModuleRlimitNofile(value string) ConfigurationSettingsFunc
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. See https://bugs.python.org/issue11284). The value will be limited by the existing hard limit. Default value of 0 does not attempt to adjust existing system-defined limits.)
func WithAnsibleRemotePort ¶
func WithAnsibleRemotePort(value int) ConfigurationSettingsFunc
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.)
func WithAnsibleRemoteUser ¶
func WithAnsibleRemoteUser(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleRetryFilesEnabled ¶
func WithAnsibleRetryFilesEnabled(value string) ConfigurationSettingsFunc
WithAnsibleRetryFilesEnabled sets the value for the configuraion ANSIBLE_RETRY_FILES_ENABLED (This controls whether a failed Ansible playbook should create a .retry file.)
func WithAnsibleRetryFilesSavePath ¶
func WithAnsibleRetryFilesSavePath(value string) ConfigurationSettingsFunc
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. This file will be overwritten after each run with the list of failed hosts from all plays.)
func WithAnsibleRolesPath ¶
func WithAnsibleRolesPath(value string) ConfigurationSettingsFunc
WithAnsibleRolesPath sets the value for the configuraion ANSIBLE_ROLES_PATH (Colon separated paths in which Ansible will search for Roles.)
func WithAnsibleRunTags ¶
func WithAnsibleRunTags(value string) ConfigurationSettingsFunc
WithAnsibleRunTags sets the value for the configuraion ANSIBLE_RUN_TAGS (default list of tags to run in your plays, Skip Tags has precedence.)
func WithAnsibleRunVarsPlugins ¶
func WithAnsibleRunVarsPlugins(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleSelinuxSpecialFs ¶
func WithAnsibleSelinuxSpecialFs(value string) ConfigurationSettingsFunc
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. Data corruption may occur and writes are not always verified when a filesystem is in the list. [:Version Added: 2.9])
func WithAnsibleShowCustomStats ¶
func WithAnsibleShowCustomStats(value string) ConfigurationSettingsFunc
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)
func WithAnsibleSkipTags ¶
func WithAnsibleSkipTags(value string) ConfigurationSettingsFunc
WithAnsibleSkipTags sets the value for the configuraion ANSIBLE_SKIP_TAGS (default list of tags to skip in your plays, has precedence over Run Tags)
func WithAnsibleStdoutCallback ¶
func WithAnsibleStdoutCallback(value string) ConfigurationSettingsFunc
WithAnsibleStdoutCallback sets the value for the configuraion ANSIBLE_STDOUT_CALLBACK (Set the main callback used to display Ansible output. You can only have one at a time. You can have many other callbacks, but just one can be in charge of stdout. See Callback plugins for a list of available options.)
func WithAnsibleStrategy ¶
func WithAnsibleStrategy(value string) ConfigurationSettingsFunc
WithAnsibleStrategy sets the value for the configuraion ANSIBLE_STRATEGY (Set the default strategy used for plays.)
func WithAnsibleStrategyPlugins ¶
func WithAnsibleStrategyPlugins(value string) ConfigurationSettingsFunc
WithAnsibleStrategyPlugins sets the value for the configuraion ANSIBLE_STRATEGY_PLUGINS (Colon separated paths in which Ansible will search for Strategy Plugins.)
func WithAnsibleStringConversionAction ¶
func WithAnsibleStringConversionAction(value string) ConfigurationSettingsFunc
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). For string parameters, values such as ‘1.00’, “[‘a’, ‘b’,]”, and ‘yes’, ‘y’, etc. will be converted by the YAML parser unless fully quoted. Valid options are ‘error’, ‘warn’, and ‘ignore’. Since 2.8, this option defaults to ‘warn’ but will change to ‘error’ in 2.12.)
func WithAnsibleStringTypeFilters ¶
func WithAnsibleStringTypeFilters(value string) ConfigurationSettingsFunc
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.)
func WithAnsibleSu ¶
func WithAnsibleSu() ConfigurationSettingsFunc
WithAnsibleSu sets the option ANSIBLE_SU to true (Toggle the use of “su” for tasks.)
func WithAnsibleSyslogFacility ¶
func WithAnsibleSyslogFacility(value string) ConfigurationSettingsFunc
WithAnsibleSyslogFacility sets the value for the configuraion ANSIBLE_SYSLOG_FACILITY (Syslog facility to use when Ansible logs to the remote target)
func WithAnsibleSystemWarnings ¶
func WithAnsibleSystemWarnings() ConfigurationSettingsFunc
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.)
func WithAnsibleTaskDebuggerIgnoreErrors ¶
func WithAnsibleTaskDebuggerIgnoreErrors() ConfigurationSettingsFunc
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. True specifies that the debugger will honor ignore_errors, False will not honor ignore_errors.)
func WithAnsibleTaskTimeout ¶
func WithAnsibleTaskTimeout(value int) ConfigurationSettingsFunc
WithAnsibleTaskTimeout sets the value for the configuraion ANSIBLE_TASK_TIMEOUT (Set the maximum time (in seconds) that a task can run for. If set to 0 (the default) there is no timeout.)
func WithAnsibleTerminalPlugins ¶
func WithAnsibleTerminalPlugins(value string) ConfigurationSettingsFunc
WithAnsibleTerminalPlugins sets the value for the configuraion ANSIBLE_TERMINAL_PLUGINS (Colon separated paths in which Ansible will search for Terminal Plugins.)
func WithAnsibleTestPlugins ¶
func WithAnsibleTestPlugins(value string) ConfigurationSettingsFunc
WithAnsibleTestPlugins sets the value for the configuraion ANSIBLE_TEST_PLUGINS (Colon separated paths in which Ansible will search for Jinja2 Test Plugins.)
func WithAnsibleTimeout ¶
func WithAnsibleTimeout(value int) ConfigurationSettingsFunc
WithAnsibleTimeout sets the value for the configuraion ANSIBLE_TIMEOUT (This is the default timeout for connection plugins to use.)
func WithAnsibleTransformInvalidGroupChars ¶
func WithAnsibleTransformInvalidGroupChars(value string) ConfigurationSettingsFunc
WithAnsibleTransformInvalidGroupChars sets the value for the configuraion ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS (Make ansible transform invalid characters in group names supplied by inventory sources.)
func WithAnsibleTransport ¶
func WithAnsibleTransport(value string) ConfigurationSettingsFunc
WithAnsibleTransport sets the value for the configuraion ANSIBLE_TRANSPORT (Can be any connection plugin available to your ansible installation. There is also a (DEPRECATED) special ‘smart’ option, that will toggle between ‘ssh’ and ‘paramiko’ depending on controller OS and ssh versions.)
func WithAnsibleUsePersistentConnections ¶
func WithAnsibleUsePersistentConnections() ConfigurationSettingsFunc
WithAnsibleUsePersistentConnections sets the option ANSIBLE_USE_PERSISTENT_CONNECTIONS to true (Toggles the use of persistence for connections.)
func WithAnsibleValidateActionGroupMetadata ¶
func WithAnsibleValidateActionGroupMetadata(value string) ConfigurationSettingsFunc
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. Metadata containing unexpected fields or value types will produce a warning when this is True.)
func WithAnsibleVarsEnabled ¶
func WithAnsibleVarsEnabled(value string) ConfigurationSettingsFunc
WithAnsibleVarsEnabled sets the value for the configuraion ANSIBLE_VARS_ENABLED (Accept list for variable plugins that require it.)
func WithAnsibleVarsPlugins ¶
func WithAnsibleVarsPlugins(value string) ConfigurationSettingsFunc
WithAnsibleVarsPlugins sets the value for the configuraion ANSIBLE_VARS_PLUGINS (Colon separated paths in which Ansible will search for Vars Plugins.)
func WithAnsibleVaultEncryptIdentity ¶
func WithAnsibleVaultEncryptIdentity(value string) ConfigurationSettingsFunc
WithAnsibleVaultEncryptIdentity sets the value for the configuraion ANSIBLE_VAULT_ENCRYPT_IDENTITY (The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The –encrypt-vault-id cli option overrides the configured value.)
func WithAnsibleVaultEncryptSalt ¶
func WithAnsibleVaultEncryptSalt(value string) ConfigurationSettingsFunc
WithAnsibleVaultEncryptSalt sets the value for the configuraion ANSIBLE_VAULT_ENCRYPT_SALT (The salt to use for the vault encryption. If it is not provided, a random salt will be used.)
func WithAnsibleVaultIdMatch ¶
func WithAnsibleVaultIdMatch(value string) ConfigurationSettingsFunc
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)
func WithAnsibleVaultIdentity ¶
func WithAnsibleVaultIdentity(value string) ConfigurationSettingsFunc
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)
func WithAnsibleVaultIdentityList ¶
func WithAnsibleVaultIdentityList(value string) ConfigurationSettingsFunc
WithAnsibleVaultIdentityList sets the value for the configuraion ANSIBLE_VAULT_IDENTITY_LIST (A list of vault-ids to use by default. Equivalent to multiple –vault-id args. Vault-ids are tried in order.)
func WithAnsibleVaultPasswordFile ¶
func WithAnsibleVaultPasswordFile(value string) ConfigurationSettingsFunc
WithAnsibleVaultPasswordFile sets the value for the configuraion ANSIBLE_VAULT_PASSWORD_FILE (The vault password file to use. Equivalent to –vault-password-file or –vault-id If executable, it will be run and the resulting stdout will be used as the password.)
func WithAnsibleVerboseToStderr ¶
func WithAnsibleVerboseToStderr(value string) ConfigurationSettingsFunc
WithAnsibleVerboseToStderr sets the value for the configuraion ANSIBLE_VERBOSE_TO_STDERR (Force ‘verbose’ option to use stderr instead of stdout)
func WithAnsibleVerbosity ¶
func WithAnsibleVerbosity(value int) ConfigurationSettingsFunc
WithAnsibleVerbosity sets the value for the configuraion ANSIBLE_VERBOSITY (Sets the default verbosity, equivalent to the number of -v passed in the command line.)
func WithAnsibleWinAsyncStartupTimeout ¶
func WithAnsibleWinAsyncStartupTimeout(value int) ConfigurationSettingsFunc
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. The default is 5 seconds. This can be too low on slower systems, or systems under heavy load. This is not the total time an async command can run for, but is a separate timeout to wait for an async command to start. The task will only start to be timed against its async_timeout once it has connected to the pipe, so the overall maximum duration the task can take will be extended by the amount specified here.)
func WithAnsibleWorkerShutdownPollCount ¶
func WithAnsibleWorkerShutdownPollCount(value int) ConfigurationSettingsFunc
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. After this limit is reached any worker processes still running will be terminated. This is for internal use only.)
func WithAnsibleWorkerShutdownPollDelay ¶
func WithAnsibleWorkerShutdownPollDelay(value string) ConfigurationSettingsFunc
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. This is for internal use only.)
func WithAnsibleYamlFilenameExt ¶
func WithAnsibleYamlFilenameExt(value string) ConfigurationSettingsFunc
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. This affects vars_files, include_vars, inventory and vars plugins among others.)
func WithEditor ¶
func WithEditor(value string) ConfigurationSettingsFunc
WithEditor sets the value for the configuraion EDITOR ()
func WithNoColor ¶
func WithNoColor() ConfigurationSettingsFunc
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.)
func WithPager ¶
func WithPager(value string) ConfigurationSettingsFunc
WithPager sets the value for the configuraion PAGER ()
func WithoutAnsibleActionWarnings ¶
func WithoutAnsibleActionWarnings() ConfigurationSettingsFunc
WithoutAnsibleActionWarnings sets the option ANSIBLE_ACTION_WARNINGS to false
func WithoutAnsibleAgnosticBecomePrompt ¶
func WithoutAnsibleAgnosticBecomePrompt() ConfigurationSettingsFunc
WithoutAnsibleAgnosticBecomePrompt sets the option ANSIBLE_AGNOSTIC_BECOME_PROMPT to false
func WithoutAnsibleAnyErrorsFatal ¶
func WithoutAnsibleAnyErrorsFatal() ConfigurationSettingsFunc
WithoutAnsibleAnyErrorsFatal sets the option ANSIBLE_ANY_ERRORS_FATAL to false
func WithoutAnsibleAskPass ¶
func WithoutAnsibleAskPass() ConfigurationSettingsFunc
WithoutAnsibleAskPass sets the option ANSIBLE_ASK_PASS to false
func WithoutAnsibleAskVaultPass ¶
func WithoutAnsibleAskVaultPass() ConfigurationSettingsFunc
WithoutAnsibleAskVaultPass sets the option ANSIBLE_ASK_VAULT_PASS to false
func WithoutAnsibleBecome ¶
func WithoutAnsibleBecome() ConfigurationSettingsFunc
WithoutAnsibleBecome sets the option ANSIBLE_BECOME to false
func WithoutAnsibleBecomeAllowSameUser ¶
func WithoutAnsibleBecomeAllowSameUser() ConfigurationSettingsFunc
WithoutAnsibleBecomeAllowSameUser sets the option ANSIBLE_BECOME_ALLOW_SAME_USER to false
func WithoutAnsibleBecomeAskPass ¶
func WithoutAnsibleBecomeAskPass() ConfigurationSettingsFunc
WithoutAnsibleBecomeAskPass sets the option ANSIBLE_BECOME_ASK_PASS to false
func WithoutAnsibleCollectionsScanSysPath ¶
func WithoutAnsibleCollectionsScanSysPath() ConfigurationSettingsFunc
WithoutAnsibleCollectionsScanSysPath sets the option ANSIBLE_COLLECTIONS_SCAN_SYS_PATH to false
func WithoutAnsibleDebug ¶
func WithoutAnsibleDebug() ConfigurationSettingsFunc
WithoutAnsibleDebug sets the option ANSIBLE_DEBUG to false
func WithoutAnsibleDeprecationWarnings ¶
func WithoutAnsibleDeprecationWarnings() ConfigurationSettingsFunc
WithoutAnsibleDeprecationWarnings sets the option ANSIBLE_DEPRECATION_WARNINGS to false
func WithoutAnsibleDevelWarning ¶
func WithoutAnsibleDevelWarning() ConfigurationSettingsFunc
WithoutAnsibleDevelWarning sets the option ANSIBLE_DEVEL_WARNING to false
func WithoutAnsibleDisplayArgsToStdout ¶
func WithoutAnsibleDisplayArgsToStdout() ConfigurationSettingsFunc
WithoutAnsibleDisplayArgsToStdout sets the option ANSIBLE_DISPLAY_ARGS_TO_STDOUT to false
func WithoutAnsibleDisplaySkippedHosts ¶
func WithoutAnsibleDisplaySkippedHosts() ConfigurationSettingsFunc
WithoutAnsibleDisplaySkippedHosts sets the option ANSIBLE_DISPLAY_SKIPPED_HOSTS to false
func WithoutAnsibleEnableTaskDebugger ¶
func WithoutAnsibleEnableTaskDebugger() ConfigurationSettingsFunc
WithoutAnsibleEnableTaskDebugger sets the option ANSIBLE_ENABLE_TASK_DEBUGGER to false
func WithoutAnsibleErrorOnMissingHandler ¶
func WithoutAnsibleErrorOnMissingHandler() ConfigurationSettingsFunc
WithoutAnsibleErrorOnMissingHandler sets the option ANSIBLE_ERROR_ON_MISSING_HANDLER to false
func WithoutAnsibleErrorOnUndefinedVars ¶
func WithoutAnsibleErrorOnUndefinedVars() ConfigurationSettingsFunc
WithoutAnsibleErrorOnUndefinedVars sets the option ANSIBLE_ERROR_ON_UNDEFINED_VARS to false
func WithoutAnsibleForceColor ¶
func WithoutAnsibleForceColor() ConfigurationSettingsFunc
WithoutAnsibleForceColor sets the option ANSIBLE_FORCE_COLOR to false
func WithoutAnsibleForceHandlers ¶
func WithoutAnsibleForceHandlers() ConfigurationSettingsFunc
WithoutAnsibleForceHandlers sets the option ANSIBLE_FORCE_HANDLERS to false
func WithoutAnsibleGalaxyIgnore ¶
func WithoutAnsibleGalaxyIgnore() ConfigurationSettingsFunc
WithoutAnsibleGalaxyIgnore sets the option ANSIBLE_GALAXY_IGNORE to false
func WithoutAnsibleHostKeyChecking ¶
func WithoutAnsibleHostKeyChecking() ConfigurationSettingsFunc
WithoutAnsibleHostKeyChecking sets the option ANSIBLE_HOST_KEY_CHECKING to false
func WithoutAnsibleInjectFactVars ¶
func WithoutAnsibleInjectFactVars() ConfigurationSettingsFunc
WithoutAnsibleInjectFactVars sets the option ANSIBLE_INJECT_FACT_VARS to false
func WithoutAnsibleInvalidTaskAttributeFailed ¶
func WithoutAnsibleInvalidTaskAttributeFailed() ConfigurationSettingsFunc
WithoutAnsibleInvalidTaskAttributeFailed sets the option ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED to false
func WithoutAnsibleInventoryAnyUnparsedIsFailed ¶
func WithoutAnsibleInventoryAnyUnparsedIsFailed() ConfigurationSettingsFunc
WithoutAnsibleInventoryAnyUnparsedIsFailed sets the option ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED to false
func WithoutAnsibleInventoryUnparsedWarning ¶
func WithoutAnsibleInventoryUnparsedWarning() ConfigurationSettingsFunc
WithoutAnsibleInventoryUnparsedWarning sets the option ANSIBLE_INVENTORY_UNPARSED_WARNING to false
func WithoutAnsibleJinja2Native ¶
func WithoutAnsibleJinja2Native() ConfigurationSettingsFunc
WithoutAnsibleJinja2Native sets the option ANSIBLE_JINJA2_NATIVE to false
func WithoutAnsibleJinja2NativeWarning ¶
func WithoutAnsibleJinja2NativeWarning() ConfigurationSettingsFunc
WithoutAnsibleJinja2NativeWarning sets the option ANSIBLE_JINJA2_NATIVE_WARNING to false
func WithoutAnsibleKeepRemoteFiles ¶
func WithoutAnsibleKeepRemoteFiles() ConfigurationSettingsFunc
WithoutAnsibleKeepRemoteFiles sets the option ANSIBLE_KEEP_REMOTE_FILES to false
func WithoutAnsibleLibvirtLxcNoseclabel ¶
func WithoutAnsibleLibvirtLxcNoseclabel() ConfigurationSettingsFunc
WithoutAnsibleLibvirtLxcNoseclabel sets the option ANSIBLE_LIBVIRT_LXC_NOSECLABEL to false
func WithoutAnsibleLoadCallbackPlugins ¶
func WithoutAnsibleLoadCallbackPlugins() ConfigurationSettingsFunc
WithoutAnsibleLoadCallbackPlugins sets the option ANSIBLE_LOAD_CALLBACK_PLUGINS to false
func WithoutAnsibleLocalhostWarning ¶
func WithoutAnsibleLocalhostWarning() ConfigurationSettingsFunc
WithoutAnsibleLocalhostWarning sets the option ANSIBLE_LOCALHOST_WARNING to false
func WithoutAnsibleNoLog ¶
func WithoutAnsibleNoLog() ConfigurationSettingsFunc
WithoutAnsibleNoLog sets the option ANSIBLE_NO_LOG to false
func WithoutAnsibleNoTargetSyslog ¶
func WithoutAnsibleNoTargetSyslog() ConfigurationSettingsFunc
WithoutAnsibleNoTargetSyslog sets the option ANSIBLE_NO_TARGET_SYSLOG to false
func WithoutAnsibleNocows ¶
func WithoutAnsibleNocows() ConfigurationSettingsFunc
WithoutAnsibleNocows sets the option ANSIBLE_NOCOWS to false
func WithoutAnsibleOldPluginCacheClear ¶
func WithoutAnsibleOldPluginCacheClear() ConfigurationSettingsFunc
WithoutAnsibleOldPluginCacheClear sets the option ANSIBLE_OLD_PLUGIN_CACHE_CLEAR to false
func WithoutAnsibleParamikoHostKeyAutoAdd ¶
func WithoutAnsibleParamikoHostKeyAutoAdd() ConfigurationSettingsFunc
WithoutAnsibleParamikoHostKeyAutoAdd sets the option ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD to false
func WithoutAnsibleParamikoLookForKeys ¶
func WithoutAnsibleParamikoLookForKeys() ConfigurationSettingsFunc
WithoutAnsibleParamikoLookForKeys sets the option ANSIBLE_PARAMIKO_LOOK_FOR_KEYS to false
func WithoutAnsiblePipelining ¶
func WithoutAnsiblePipelining() ConfigurationSettingsFunc
WithoutAnsiblePipelining sets the option ANSIBLE_PIPELINING to false
func WithoutAnsiblePrivateRoleVars ¶
func WithoutAnsiblePrivateRoleVars() ConfigurationSettingsFunc
WithoutAnsiblePrivateRoleVars sets the option ANSIBLE_PRIVATE_ROLE_VARS to false
func WithoutAnsibleSu ¶
func WithoutAnsibleSu() ConfigurationSettingsFunc
WithoutAnsibleSu sets the option ANSIBLE_SU to false
func WithoutAnsibleSystemWarnings ¶
func WithoutAnsibleSystemWarnings() ConfigurationSettingsFunc
WithoutAnsibleSystemWarnings sets the option ANSIBLE_SYSTEM_WARNINGS to false
func WithoutAnsibleTaskDebuggerIgnoreErrors ¶
func WithoutAnsibleTaskDebuggerIgnoreErrors() ConfigurationSettingsFunc
WithoutAnsibleTaskDebuggerIgnoreErrors sets the option ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS to false
func WithoutAnsibleUsePersistentConnections ¶
func WithoutAnsibleUsePersistentConnections() ConfigurationSettingsFunc
WithoutAnsibleUsePersistentConnections sets the option ANSIBLE_USE_PERSISTENT_CONNECTIONS to false
func WithoutNoColor ¶
func WithoutNoColor() ConfigurationSettingsFunc
WithoutNoColor sets the option NO_COLOR to false