Language Server Settings

The following are the default values of the settings provided by the Ansible Language Server:

ansible.ansible.path { #ansible.path data-toc-label=ansible.path }

Path to the ansible executable . Default value: ansible

ansible.ansible.useFullyQualifiedCollectionNames { #ansible.useFullyQualifiedCollectionNames data-toc-label=ansible.useFullyQualifiedCollectionNames }

Toggle usage of fully qualified collection names (FQCN) when inserting module names . Default value: true

ansible.python.interpreterPath { #python.interpreterPath data-toc-label=python.interpreterPath }

Path to the python/python3 executable. This settings may be used to make the extension work with ansible and ansible-lint installations in a python virtual environment . Default value: ""

ansible.python.activationScript { #python.activationScript data-toc-label=python.activationScript }

Path to a custom activation script, which is to be used instead of the settings above to run in a python virtual environment . Default value: ""

ansible.executionEnvironment.containerEngine { #executionEnvironment.containerEngine data-toc-label=executionEnvironment.containerEngine }

Container engine to be used while running with execution environment. valid values are 'auto', 'podman' and 'docker'. For 'auto', it will look for 'podman' and then for 'docker' . Default value: auto

ansible.executionEnvironment.enabled { #executionEnvironment.enabled data-toc-label=executionEnvironment.enabled }

Toggle usage of an execution environment . Default value: false

ansible.executionEnvironment.image { #executionEnvironment.image data-toc-label=executionEnvironment.image }

Name of the execution environment to be used . Default value: ghcr.io/ansible/community-ansible-dev-tools:latest

ansible.executionEnvironment.pull.policy { #executionEnvironment.pull.policy data-toc-label=executionEnvironment.pull.policy }

Image pull policy to be used. Valid values are 'always', 'missing', 'never' and 'tag'. always will always pull the image when extension is activated or reloaded. 'missing' will pull if not locally available. 'never' will never pull the image and 'tag' will always pull if the image tag is 'latest', otherwise pull if not locally available. . Default value: missing

ansible.executionEnvironment.pull.arguments { #executionEnvironment.pull.arguments data-toc-label=executionEnvironment.pull.arguments }

Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. '-–tls-verify=false' . Default value: ""

ansible.executionEnvironment.volumeMounts { #executionEnvironment.volumeMounts data-toc-label=executionEnvironment.volumeMounts }

Add a dictionary entry to the array with the volume mount source path (key: 'src'), destination (key: 'dest'), and options (key: 'options') . Default value: []

ansible.executionEnvironment.containerOptions { #executionEnvironment.containerOptions data-toc-label=executionEnvironment.containerOptions }

Extra parameters passed to the container engine command example: '--net=host' . Default value: ""

ansible.completion.provideRedirectModules { #completion.provideRedirectModules data-toc-label=completion.provideRedirectModules }

Toggle redirected module provider when completing modules . Default value: true

ansible.completion.provideModuleOptionAliases { #completion.provideModuleOptionAliases data-toc-label=completion.provideModuleOptionAliases }

Toggle alias provider when completing module options . Default value: true

ansible.validation.enabled { #validation.enabled data-toc-label=validation.enabled }

Toggle validation provider. If enabled and ansible-lint is disabled, validation falls back to ansible-playbook --syntax-check . Default value: true

ansible.validation.lint.enabled { #validation.lint.enabled data-toc-label=validation.lint.enabled }

Toggle usage of ansible-lint . Default value: true

ansible.validation.lint.path { #validation.lint.path data-toc-label=validation.lint.path }

Path to the ansible-lint executable . Default value: ansible-lint

ansible.validation.lint.arguments { #validation.lint.arguments data-toc-label=validation.lint.arguments }

Optional command line arguments to be appended to ansible-lint invocation . Default value: ""

ansible.validation.lint.autoFixOnSave { #validation.lint.autoFixOnSave data-toc-label=validation.lint.autoFixOnSave }

Specifies whether `ansible-lint --fix` should run automatically when you save a file. . Default value: false