You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Index of all Lookup Plugins

amazon.aws

• amazon.aws.aws_account_attribute – Look up AWS account attributes

• amazon.aws.aws_secret – Look up secrets stored in AWS Secrets Manager

• amazon.aws.aws_service_ip_ranges – Look up the IP ranges for services provided in AWS such as EC2 and S3.

• amazon.aws.aws_ssm – Get the value for a SSM parameter or all parameters under a path

ansible.builtin

• ansible.builtin.config – Lookup current Ansible configuration values

• ansible.builtin.csvfile – read data from a TSV or CSV file

• ansible.builtin.dict – returns key/value pair items from dictionaries

• ansible.builtin.env – Read the value of environment variables

• ansible.builtin.file – read file contents

• ansible.builtin.fileglob – list files matching a pattern

• ansible.builtin.first_found – return first file found from list

• ansible.builtin.indexed_items – rewrites lists to return ‘indexed items’

• ansible.builtin.ini – read data from an ini file

• ansible.builtin.inventory_hostnames – list of inventory hosts matching a host pattern

• ansible.builtin.items – list of items

• ansible.builtin.lines – read lines from command

• ansible.builtin.list – simply returns what it is given.

• ansible.builtin.nested – composes a list with nested elements of other lists

• ansible.builtin.password – retrieve or generate a random password, stored in a file

• ansible.builtin.pipe – read output from a command

• ansible.builtin.random_choice – return random element from list

• ansible.builtin.sequence – generate a list based on a number sequence

• ansible.builtin.subelements – traverse nested key from a list of dictionaries

• ansible.builtin.template – retrieve contents of file after templating with Jinja2

• ansible.builtin.together – merges lists into synchronized list

• ansible.builtin.unvault – read vaulted file(s) contents

• ansible.builtin.url – return contents from URL

• ansible.builtin.varnames – Lookup matching variable names

• ansible.builtin.vars – Lookup templated value of variables

ansible.utils

• ansible.utils.get_path – Retrieve the value in a variable using a path

• ansible.utils.index_of – Find the indices of items in a list matching some criteria

• ansible.utils.to_paths – Flatten a complex object into a dictionary of paths and values

• ansible.utils.validate – Validate data with provided criteria

awx.awx

• awx.awx.controller_api – Search the API for objects

• awx.awx.schedule_rrule – Generate an rrule string which can be used for Schedules

• awx.awx.schedule_rruleset – Generate an rruleset string

azure.azcollection

• azure.azcollection.azure_keyvault_secret – Read secret from Azure Key Vault.

cisco.aci

• cisco.aci.interface_range – query interfaces from a range or comma separated list of ranges

cloud.common

• cloud.common.turbo_demo – A demo for lookup plugins on cloud.common

community.general

• community.general.bitwarden – Retrieve secrets from Bitwarden

• community.general.cartesian – returns the cartesian product of lists

• community.general.chef_databag – fetches data from a Chef Databag

• community.general.collection_version – Retrieves the version of an installed collection

• community.general.consul_kv – Fetch metadata from a Consul key value store.

• community.general.credstash – retrieve secrets from Credstash on AWS

• community.general.cyberarkpassword – get secrets from CyberArk AIM

• community.general.dependent – Composes a list with nested elements of other lists or dicts which can depend on previous loop variables

• community.general.dig – query DNS using the dnspython library

• community.general.dnstxt – query a domain(s)’s DNS txt fields

• community.general.dsv – Get secrets from Thycotic DevOps Secrets Vault

• community.general.etcd – get info from an etcd server

• community.general.etcd3 – Get key values from etcd3 server

• community.general.filetree – recursively match all files in a directory tree

• community.general.flattened – return single list completely flattened

• community.general.hiera – get info from hiera data

• community.general.keyring – grab secrets from the OS keyring

• community.general.lastpass – fetch data from LastPass

• community.general.lmdb_kv – fetch data from LMDB

• community.general.manifold – get credentials from Manifold.co

• community.general.merge_variables – merge variables with a certain suffix

• community.general.onepassword – fetch field values from 1Password

• community.general.onepassword_raw – fetch an entire item from 1Password

• community.general.passwordstore – manage passwords with passwordstore.org’s pass utility

• community.general.random_pet – Generates random pet names

• community.general.random_string – Generates random string

• community.general.random_words – Return a number of random words

• community.general.redis – fetch data from Redis

• community.general.revbitspss – Get secrets from RevBits PAM server

• community.general.shelvefile – read keys from Python shelve file

• community.general.tss – Get secrets from Thycotic Secret Server

community.google

• community.google.gcp_storage_file – Return GC Storage content

community.grafana

• community.grafana.grafana_dashboard – list or search grafana dashboards

community.hashi_vault

• community.hashi_vault.hashi_vault – Retrieve secrets from HashiCorp’s Vault

• community.hashi_vault.vault_ansible_settings – Returns plugin settings (options)

• community.hashi_vault.vault_kv1_get – Get a secret from HashiCorp Vault’s KV version 1 secret store

• community.hashi_vault.vault_kv2_get – Get a secret from HashiCorp Vault’s KV version 2 secret store

• community.hashi_vault.vault_list – Perform a list operation against HashiCorp Vault

• community.hashi_vault.vault_login – Perform a login operation against HashiCorp Vault

• community.hashi_vault.vault_read – Perform a read operation against HashiCorp Vault

• community.hashi_vault.vault_token_create – Create a HashiCorp Vault token

• community.hashi_vault.vault_write – Perform a write operation against HashiCorp Vault

community.mongodb

• community.mongodb.mongodb – lookup info from MongoDB

community.network

• community.network.avi – Look up ``Avi`` objects.

community.rabbitmq

• community.rabbitmq.rabbitmq – Retrieve messages from an AMQP/AMQPS RabbitMQ queue.

community.skydive

• community.skydive.skydive – Query Skydive objects

community.sops

• community.sops.sops – Read sops encrypted file contents

community.windows

• community.windows.laps_password – Retrieves the LAPS password for a server.

cyberark.conjur

• cyberark.conjur.conjur_variable – Fetch credentials from CyberArk Conjur.

f5networks.f5_modules

• f5networks.f5_modules.bigiq_license – Select a random license key from a pool of biqiq available licenses

• f5networks.f5_modules.license_hopper – Return random license from list

infoblox.nios_modules

• infoblox.nios_modules.nios_lookup – Query Infoblox NIOS objects

• infoblox.nios_modules.nios_next_ip – Return the next available IP address for a network

• infoblox.nios_modules.nios_next_network – Return the next available network range for a network-container

kubernetes.core

• kubernetes.core.k8s – Query the K8s API

• kubernetes.core.kustomize – Build a set of kubernetes resources using a ‘kustomization.yaml’ file.

netapp_eseries.santricity

• netapp_eseries.santricity.santricity_host –

• netapp_eseries.santricity.santricity_host_detail – Expands the host information from santricity_host lookup

• netapp_eseries.santricity.santricity_lun_mapping –

• netapp_eseries.santricity.santricity_storage_pool – Storage pool information

• netapp_eseries.santricity.santricity_volume –

netbox.netbox

• netbox.netbox.nb_lookup – Queries and returns elements from NetBox

vmware.vmware_rest

• vmware.vmware_rest.cluster_moid – Look up MoID for vSphere cluster objects using vCenter REST API

• vmware.vmware_rest.datacenter_moid – Look up MoID for vSphere datacenter objects using vCenter REST API

• vmware.vmware_rest.datastore_moid – Look up MoID for vSphere datastore objects using vCenter REST API

• vmware.vmware_rest.folder_moid – Look up MoID for vSphere folder objects using vCenter REST API

• vmware.vmware_rest.host_moid – Look up MoID for vSphere host objects using vCenter REST API

• vmware.vmware_rest.network_moid – Look up MoID for vSphere network objects using vCenter REST API

• vmware.vmware_rest.resource_pool_moid – Look up MoID for vSphere resource pool objects using vCenter REST API

• vmware.vmware_rest.vm_moid – Look up MoID for vSphere vm objects using vCenter REST API

wti.remote

• wti.remote.cpm_alarm_info – Get alarm information from WTI OOB and PDU devices

• wti.remote.cpm_config_backup – Get parameters from WTI OOB and PDU devices

• wti.remote.cpm_config_restore – Send operational parameters to WTI OOB and PDU devices

• wti.remote.cpm_current_info – Get the Current Information of a WTI device

• wti.remote.cpm_firmware_info – Get firmware information from WTI OOB and PDU devices

• wti.remote.cpm_firmware_update – Set Serial port parameters in WTI OOB and PDU devices

• wti.remote.cpm_hostname_config – Set Hostname (Site ID), Location, Asset Tag parameters in WTI OOB and PDU devices.

• wti.remote.cpm_hostname_info – Get Hostname (Site ID), Location, Asset Tag parameters in WTI OOB and PDU devices

• wti.remote.cpm_interface_config – Set network interface parameters in WTI OOB and PDU devices

• wti.remote.cpm_interface_info – Get network interface parameters from WTI OOB and PDU devices

• wti.remote.cpm_iptables_config – Set network IPTables parameters in WTI OOB and PDU devices

• wti.remote.cpm_iptables_info – Get network IPTABLES parameters from WTI OOB and PDU devices

• wti.remote.cpm_metering – Get Power and Current data from WTI OOB/Combo and PDU devices

• wti.remote.cpm_plugconfig – Get and Set Plug Parameters on WTI OOB and PDU power devices

• wti.remote.cpm_plugcontrol – Get and Set Plug actions on WTI OOB and PDU power devices

• wti.remote.cpm_power_info – Get the Power Information of a WTI device

• wti.remote.cpm_serial_port_action_info – Get Serial port connection status in WTI OOB and PDU devices

• wti.remote.cpm_serial_port_action_set – Set Serial port connection/disconnection commands in WTI OOB and PDU devices

• wti.remote.cpm_serial_port_config – Set Serial port parameters in WTI OOB and PDU devices

• wti.remote.cpm_serial_port_info – Get Serial port parameters in WTI OOB and PDU devices

• wti.remote.cpm_snmp_config – Set network IPTables parameters in WTI OOB and PDU devices

• wti.remote.cpm_snmp_info – Get network SNMP parameters from WTI OOB and PDU devices

• wti.remote.cpm_status – Get status and parameters from WTI OOB and PDU devices.

• wti.remote.cpm_status_info – Get general status information from WTI OOB and PDU devices

• wti.remote.cpm_syslog_client_config – Set network SYSLOG Client parameters in WTI OOB and PDU devices

• wti.remote.cpm_syslog_client_info – Get network SYSLOG Client parameters from WTI OOB and PDU devices

• wti.remote.cpm_syslog_server_config – Set network SYSLOG Server parameters in WTI OOB and PDU devices

• wti.remote.cpm_syslog_server_info – Get network SYSLOG Server parameters from WTI OOB and PDU devices

• wti.remote.cpm_temp_info – Get temperature information from WTI OOB and PDU devices

• wti.remote.cpm_time_config – Set Time/Date parameters in WTI OOB and PDU devices.

• wti.remote.cpm_time_info – Get Time/Date parameters in WTI OOB and PDU devices

• wti.remote.cpm_user – Get various status and parameters from WTI OOB and PDU devices