Lines Matching refs:msgid

6 msgid ""
20 msgid "Action Plugins"
24 msgid "Action plugins act in conjunction with :ref:`modules <working_with_modules>` to execute the …
28 msgid "The 'normal' action plugin is used for modules that do not already have an action plugin."
32 msgid "Enabling action plugins"
36 msgid "You can enable a custom action plugin by either dropping it into the ``action_plugins`` dire…
40 msgid "Using action plugins"
44 msgid "Action plugin are executed by default when an associated module is used; no action is requir…
49 msgid "Plugin list"
53 msgid "You cannot list action plugins directly, they show up as their counterpart modules:"
57 msgid "Use ``ansible-doc -l`` to see the list of available modules. Use ``ansible-doc <name>`` to s…
62 msgid ":ref:`cache_plugins`"
66 msgid "Ansible Cache plugins"
74 msgid ":ref:`callback_plugins`"
82 msgid "Ansible callback plugins"
88 msgid ":ref:`connection_plugins`"
94 msgid "Ansible connection plugins"
101 msgid ":ref:`inventory_plugins`"
108 msgid "Ansible inventory plugins"
113 msgid ":ref:`shell_plugins`"
118 msgid "Ansible Shell plugins"
123 msgid ":ref:`strategy_plugins`"
128 msgid "Ansible Strategy plugins"
134 msgid ":ref:`vars_plugins`"
139 msgid "Ansible Vars plugins"
148 msgid "`User Mailing List <https://groups.google.com/group/ansible-devel>`_"
158 msgid "Have a question? Stop by the google group!"
168 msgid "`irc.libera.chat <https://libera.chat/>`_"
177 msgid "#ansible IRC chat channel"
181 msgid "Become Plugins"
185 msgid "Become plugins work to ensure that Ansible can use certain privilege escalation systems when…
189 msgid "These utilities (``sudo``, ``su``, ``doas``, and so on) generally let you 'become' another u…
193 msgid "Enabling Become Plugins"
197 msgid "The become plugins shipped with Ansible are already enabled. Custom plugins can be added by …
201 msgid "Using Become Plugins"
205 msgid "In addition to the default configuration settings in :ref:`ansible_configuration_settings` o…
209 msgid "You can further control the settings for each plugin via other configuration options detaile…
214 msgid "Plugin List"
218 msgid "You can use ``ansible-doc -t become -l`` to see the list of available plugins. Use ``ansible…
224 msgid ":ref:`about_playbooks`"
231 msgid "An introduction to playbooks"
237 msgid ":ref:`playbooks_filters`"
243 msgid "Jinja2 filter plugins"
249 msgid ":ref:`playbooks_tests`"
255 msgid "Jinja2 test plugins"
261 msgid ":ref:`playbooks_lookups`"
267 msgid "Jinja2 lookup plugins"
271 msgid "Cache Plugins"
275 msgid "Cache plugins allow Ansible to store gathered facts or inventory source data without the per…
279 msgid "The default cache plugin is the :ref:`memory <memory_cache>` plugin, which only caches the d…
283 msgid "You can use different cache plugins for inventory and facts. If you enable inventory caching…
287 msgid "Enabling Fact Cache Plugins"
291 msgid "Fact caching is always enabled. However, only one fact cache plugin can be active at a time.…
295 msgid "or in the ``ansible.cfg`` file:"
299 msgid "If the cache plugin is in a collection use the fully qualified name:"
303 msgid "To enable a custom cache plugin, save it in a ``cache_plugins`` directory adjacent to your p…
307 msgid "You also need to configure other settings specific to each plugin. Consult the individual pl…
311 msgid "Enabling Inventory Cache Plugins"
315 msgid "Inventory caching is disabled by default. To cache inventory data, you must enable inventory…
319 msgid "or if the inventory plugin accepts a YAML configuration source, in the configuration file:"
323 msgid "Only one inventory cache plugin can be active at a time. You can set it with an environment …
327 msgid "or in the ansible.cfg file:"
331 msgid "To cache inventory with a custom plugin in your plugin path, follow the :ref:`developer guid…
335 msgid "To cache inventory with a cache plugin in a collection, use the FQCN:"
339 msgid "If you enable caching for inventory plugins without selecting an inventory-specific cache pl…
343 msgid "Using Cache Plugins"
347 msgid "Cache plugins are used automatically once they are enabled."
351 msgid "You can use ``ansible-doc -t cache -l`` to see the list of available plugins. Use ``ansible-…
356 msgid ":ref:`action_plugins`"
361 msgid "Ansible Action plugins"
365 msgid "`User Mailing List <https://groups.google.com/forum/#!forum/ansible-devel>`_"
369 msgid "Callback Plugins"
373 msgid "Callback plugins enable adding new behaviors to Ansible when responding to events. By defaul…
377 msgid "Example callback plugins"
381 msgid "The :ref:`log_plays <log_plays_callback>` callback is an example of how to record playbook e…
385 msgid "The :ref:`say <say_callback>` callback responds with computer synthesized speech in relation…
389 msgid "Enabling callback plugins"
393 msgid "You can activate a custom callback by either dropping it into a ``callback_plugins`` directo…
397 msgid "Plugins are loaded in alphanumeric order. For example, a plugin implemented in a file named …
401 msgid "Most callbacks shipped with Ansible are disabled by default and need to be enabled in your :…
405 msgid "Setting a callback plugin for ``ansible-playbook``"
409 msgid "You can only have one plugin be the main manager of your console output. If you want to repl…
413 msgid "or for my custom callback:"
417 msgid "This only affects :ref:`ansible-playbook` by default."
421 msgid "Setting a callback plugin for ad hoc commands"
425 msgid "The :ref:`ansible` ad hoc command specifically uses a different callback plugin for stdout, …
429 msgid "You can also set this as an environment variable:"
433 msgid "You can use ``ansible-doc -t callback -l`` to see the list of available plugins. Use ``ansib…
437 msgid "Ansible cache plugins"
441 msgid "Cliconf Plugins"
445 msgid "Cliconf plugins are abstractions over the CLI interface to network devices. They provide a s…
449 msgid "These plugins generally correspond one-to-one to network device platforms. Ansible loads the…
453 msgid "Adding cliconf plugins"
457 msgid "You can extend Ansible to support other network devices by dropping a custom plugin into the…
461 msgid "Using cliconf plugins"
465 msgid "The cliconf plugin to use is determined automatically from the ``ansible_network_os`` variab…
469 msgid "Most cliconf plugins can operate without configuration. A few have additional options that c…
474 msgid "Plugins are self-documenting. Each plugin should document its configuration options."
478 msgid "Viewing cliconf plugins"
482 msgid "These plugins have migrated to collections on `Ansible Galaxy <https://galaxy.ansible.com>`_…
487 msgid ":ref:`Ansible for Network Automation<network_guide>`"
492 msgid "An overview of using Ansible to automate networking devices."
497 msgid "#ansible-network IRC chat channel"
501 msgid "Connection Plugins"
505 msgid "Connection plugins allow Ansible to connect to the target hosts so it can execute tasks on t…
509 msgid "By default, Ansible ships with several plugins. The most commonly used are the :ref:`paramik…
513 msgid "The basics of these connection types are covered in the :ref:`getting started<intro_getting_…
517 msgid "``ssh`` plugins"
521 msgid "Because ssh is the default protocol used in system administration and the protocol most used…
525 msgid "Adding connection plugins"
529 msgid "You can extend Ansible to support other transports (such as SNMP or message bus) by dropping…
533 msgid "Using connection plugins"
537 msgid "You can set the connection plugin globally via :ref:`configuration<ansible_configuration_set…
541 msgid "Most connection plugins can operate with minimal configuration. By default they use the :ref…
545 msgid "Plugins are self-documenting. Each plugin should document its configuration options. The fol…
549 msgid ":ref:`ansible_host<magic_variables_and_hostvars>`"
553 msgid "The name of the host to connect to, if different from the :ref:`inventory <intro_inventory>`…
557 msgid ":ref:`ansible_port<faq_setting_users_and_ports>`"
561 msgid "The ssh port number, for :ref:`ssh <ssh_connection>` and :ref:`paramiko_ssh <paramiko_ssh_co…
565 msgid ":ref:`ansible_user<faq_setting_users_and_ports>`"
569 msgid "The default user name to use for log in. Most plugins default to the 'current user running A…
573 msgid "Each plugin might also have a specific version of a variable that overrides the general vers…
577 msgid "You can use ``ansible-doc -t connection -l`` to see the list of available plugins. Use ``ans…
581 msgid ":ref:`Working with Playbooks<working_with_playbooks>`"
585 msgid ":ref:`Filters<playbooks_filters>`"
589 msgid ":ref:`Tests<playbooks_tests>`"
593 msgid ":ref:`Lookups<playbooks_lookups>`"
597 msgid "Ansible vars plugins"
601 msgid "Httpapi Plugins"
605 msgid "Httpapi plugins tell Ansible how to interact with a remote device's HTTP-based API and execu…
609 msgid "Each plugin represents a particular dialect of API. Some are platform-specific (Arista eAPI,…
613 msgid "Adding httpapi plugins"
617 msgid "You can extend Ansible to support other APIs by dropping a custom plugin into the ``httpapi_…
621 msgid "Using httpapi plugins"
625 msgid "The httpapi plugin to use is determined automatically from the ``ansible_network_os`` variab…
629 msgid "Most httpapi plugins can operate without configuration. Additional options may be defined by…
633 msgid "The following sample playbook shows the httpapi plugin for an Arista network device, assumin…
637 msgid "See the full working example `on GitHub <https://github.com/network-automation/httpapi>`_."
641 msgid "Viewing httpapi plugins"
645 msgid "These plugins have migrated to collections on `Ansible Galaxy <https://galaxy.ansible.com>`_…
649 msgid ":ref:`Developing network modules<developing_modules_network>`"
653 msgid "How to develop network modules."
657 msgid "Inventory Plugins"
661 msgid "Inventory plugins allow users to point at data sources to compile the inventory of hosts tha…
665 msgid "Enabling inventory plugins"
669 msgid "Most inventory plugins shipped with Ansible are enabled by default or can be used by with th…
673 msgid "In some circumstances, for example, if the inventory plugin does not use a YAML configuratio…
677 msgid "If the plugin is in a collection, use the fully qualified name:"
681 msgid "Using inventory plugins"
685 msgid "To use an inventory plugin, you must provide an inventory source. Most of the time this is a…
689 msgid "To start using an inventory plugin with a YAML configuration source, create a file with the …
693 msgid "Each plugin should document any naming restrictions. In addition, the YAML config file must …
697 msgid "After providing any required options, you can view the populated inventory with ``ansible-in…
701 msgid "If you are using an inventory plugin in a playbook-adjacent collection and want to test your…
705 msgid "Your inventory source might be a directory of inventory configuration files. The constructed…
709 msgid "You can create dynamic groups using host variables with the constructed ``keyed_groups`` opt…
713 msgid "Now the output of ``ansible-inventory -i demo.aws_ec2.yml --graph``:"
717 msgid "If a host does not have the variables in the configuration above (in other words, ``tags.Nam…
721 msgid "Inventory plugins that support caching can use the general settings for the fact cache defin…
725 msgid "Here is an example of setting inventory caching with some fact caching defaults for the cach…
729 msgid "You can use ``ansible-doc -t inventory -l`` to see the list of available plugins. Use ``ansi…
733 msgid "Lookup Plugins"
737 msgid "Lookup plugins are an Ansible-specific extension to the Jinja2 templating language. You can …
741 msgid "Lookups are executed with a working directory relative to the role or play, as opposed to lo…
745 msgid "Pass ``wantlist=True`` to lookups to use in Jinja2 template \"for\" loops."
749 msgid "By default, lookup return values are marked as unsafe for security reasons. If you trust the…
753 msgid "Some lookups pass arguments to a shell. When using variables from a remote/untrusted source,…
757 msgid "Enabling lookup plugins"
761 msgid "Ansible enables all lookup plugins it can find. You can activate a custom lookup by either d…
765 msgid "Using lookup plugins"
769 msgid "You can use lookup plugins anywhere you can use templating in Ansible: in a play, in variabl…
773 msgid "Lookups are an integral part of loops. Wherever you see ``with_``, the part after the unders…
777 msgid "You can combine lookups with :ref:`filters <playbooks_filters>`, :ref:`tests <playbooks_test…
781 msgid "You can control how errors behave in all lookup plugins by setting ``errors`` to ``ignore``,…
785 msgid "To ignore lookup errors::"
789 msgid "To get a warning instead of a failure::"
793 msgid "To get a fatal error (the default)::"
797 msgid "Forcing lookups to return lists: ``query`` and ``wantlist=True``"
801 msgid "In Ansible 2.5, a new Jinja2 function called ``query`` was added for invoking lookup plugins…
805 msgid "This feature provides an easier and more consistent interface for interacting with the new `…
809 msgid "The following examples are equivalent:"
813 msgid "As demonstrated above, the behavior of ``wantlist=True`` is implicit when using ``query``."
817 msgid "Additionally, ``q`` was introduced as a shortform of ``query``:"
821 msgid "You can use ``ansible-doc -t lookup -l`` to see the list of available plugins. Use ``ansible…
825 msgid "Netconf Plugins"
829 msgid "Netconf plugins are abstractions over the Netconf interface to network devices. They provide…
833 msgid "These plugins generally correspond one-to-one to network device platforms. Ansible loads the…
837 msgid "Adding netconf plugins"
841 msgid "You can extend Ansible to support other network devices by dropping a custom plugin into the…
845 msgid "Using netconf plugins"
849 msgid "The netconf plugin to use is determined automatically from the ``ansible_network_os`` variab…
853 msgid "Most netconf plugins can operate without configuration. A few have additional options that c…
857 msgid "Listing netconf plugins"
861 msgid "These plugins have migrated to collections on `Ansible Galaxy <https://galaxy.ansible.com>`_…
865 msgid "Working With Plugins"
869 msgid "Plugins are pieces of code that augment Ansible's core functionality. Ansible uses a plugin …
873 msgid "Ansible ships with a number of handy plugins, and you can easily write your own."
877 msgid "This section covers the various types of plugins that are included with Ansible:"
881 msgid ":ref:`ansible_configuration_settings`"
885 msgid "Ansible configuration documentation and settings"
889 msgid ":ref:`command_line_tools`"
893 msgid "Ansible tools, description and options"
897 msgid "Shell Plugins"
901 msgid "Shell plugins work to ensure that the basic commands Ansible runs are properly formatted to …
905 msgid "Enabling shell plugins"
909 msgid "You can add a custom shell plugin by dropping it into a ``shell_plugins`` directory adjacent…
913 msgid "You should not alter which plugin is used unless you have a setup in which the default ``/bi…
917 msgid "Using shell plugins"
921 msgid "In addition to the default configuration settings in :ref:`ansible_configuration_settings`, …
925 msgid "Strategy Plugins"
929 msgid "Strategy plugins control the flow of play execution by handling task and host scheduling."
933 msgid "Enabling strategy plugins"
937 msgid "All strategy plugins shipped with Ansible are enabled by default. You can enable a custom st…
941 msgid "Using strategy plugins"
945 msgid "Only one strategy plugin can be used in a play, but you can use different ones for each play…
949 msgid "or in the `ansible.cfg` file:"
953 msgid "You can also specify the strategy plugin in the play via the :ref:`strategy keyword <playboo…
957 msgid "You can use ``ansible-doc -t strategy -l`` to see the list of available plugins. Use ``ansib…
961 msgid "Vars Plugins"
965 msgid "Vars plugins inject additional variable data into Ansible runs that did not come from an inv…
969 msgid "Vars plugins were partially implemented in Ansible 2.0 and rewritten to be fully implemented…
973 msgid "The :ref:`host_group_vars <host_group_vars_vars>` plugin shipped with Ansible enables readin…
977 msgid "Enabling vars plugins"
981 msgid "You can activate a custom vars plugin by either dropping it into a ``vars_plugins`` director…
985 msgid "Most vars plugins are disabled by default. To enable a vars plugin, set ``vars_plugins_enabl…
989 msgid "Starting in Ansible 2.10, you can use vars plugins in collections. All vars plugins in colle…
993 msgid "Using vars plugins"
997 msgid "By default, vars plugins are used on demand automatically after they are enabled."
1001 msgid "Starting in Ansible 2.10, vars plugins can be made to run at specific times. `ansible-invent…
1005 msgid "The global setting ``RUN_VARS_PLUGINS`` can be set in ``ansible.cfg`` using ``run_vars_plugi…
1009 msgid "You can also control vars plugin execution on a per-plugin basis for vars plugins that suppo…
1013 msgid "Plugin Lists"
1017 msgid "You can use ``ansible-doc -t vars -l`` to see the list of available plugins. Use ``ansible-d…
1020 #~ msgid "`irc.freenode.net <http://irc.freenode.net>`_"
1023 #~ msgid "`webchat.freenode.net <https://webchat.freenode.net>`_"