<plugin_type>: -> name: (#1541)

2025-10-01 22:13:21 -07:00 · 2021-01-12 07:12:03 +01:00 · 2021-01-12 07:12:03 +01:00 · 99cfb993d5
commit 99cfb993d5
parent 6c7f8f97ad
78 changed files with 69 additions and 78 deletions
--- a/plugins/lookup/cartesian.py
+++ b/plugins/lookup/cartesian.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author: Unknown (!UNKNOWN)
-    lookup: cartesian
+    name: cartesian
    short_description: returns the cartesian product of lists
    description:
        - Takes the input lists and returns a list that represents the product of the input lists.
--- a/plugins/lookup/chef_databag.py
+++ b/plugins/lookup/chef_databag.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author: Unknown (!UNKNOWN)
-    lookup: chef_databag
+    name: chef_databag
    short_description: fetches data from a Chef Databag
    description:
       - "This is a lookup plugin to provide access to chef data bags using the pychef package.
--- a/plugins/lookup/consul_kv.py
+++ b/plugins/lookup/consul_kv.py
@ -7,7 +7,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author: Unknown (!UNKNOWN)
-    lookup: consul_kv
+    name: consul_kv
    short_description: Fetch metadata from a Consul key value store.
    description:
      - Lookup metadata for a playbook from the key value store in a Consul cluster.
--- a/plugins/lookup/credstash.py
+++ b/plugins/lookup/credstash.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author: Unknown (!UNKNOWN)
-    lookup: credstash
+    name: credstash
    short_description: retrieve secrets from Credstash on AWS
    requirements:
      - credstash (python library)
--- a/plugins/lookup/cyberarkpassword.py
+++ b/plugins/lookup/cyberarkpassword.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author: Unknown (!UNKNOWN)
-    lookup: cyberarkpassword
+    name: cyberarkpassword
    short_description: get secrets from CyberArk AIM
    requirements:
      - CyberArk AIM tool installed
--- a/plugins/lookup/dig.py
+++ b/plugins/lookup/dig.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: dig
+    name: dig
    author: Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
    short_description: query DNS using the dnspython library
    requirements:
--- a/plugins/lookup/dnstxt.py
+++ b/plugins/lookup/dnstxt.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: dnstxt
+    name: dnstxt
    author: Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
    short_description: query a domain(s)'s DNS txt fields
    requirements:
--- a/plugins/lookup/dsv.py
+++ b/plugins/lookup/dsv.py
@ -6,7 +6,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type

 DOCUMENTATION = r"""
-lookup: dsv
+name: dsv
 author: Adam Migus (@amigus) <adam@migus.org>
 short_description: Get secrets from Thycotic DevOps Secrets Vault
 version_added: 1.0.0
--- a/plugins/lookup/etcd.py
+++ b/plugins/lookup/etcd.py
@ -22,7 +22,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    author:
        - Jan-Piet Mens (@jpmens)
-    lookup: etcd
+    name: etcd
    short_description: get info from an etcd server
    description:
        - Retrieves data from an etcd server
--- a/plugins/lookup/etcd3.py
+++ b/plugins/lookup/etcd3.py
@ -10,7 +10,7 @@ DOCUMENTATION = '''
    author:
    - Eric Belhomme (@eric-belhomme) <ebelhomme@fr.scc.com>
    version_added: '0.2.0'
-    lookup: etcd3
+    name: etcd3
    short_description: Get key values from etcd3 server
    description:
    - Retrieves key values and/or key prefixes from etcd3 server using its native gRPC API.
--- a/plugins/lookup/filetree.py
+++ b/plugins/lookup/filetree.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = r'''
-lookup: filetree
+name: filetree
 author: Dag Wieers (@dagwieers) <dag@wieers.com>
 short_description: recursively match all files in a directory tree
 description:
--- a/plugins/lookup/flattened.py
+++ b/plugins/lookup/flattened.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: flattened
+    name: flattened
    author: Serge van Ginderachter (!UNKNOWN) <serge@vanginderachter.be>
    short_description: return single list completely flattened
    description:
--- a/plugins/lookup/hiera.py
+++ b/plugins/lookup/hiera.py
@ -7,7 +7,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    author:
      - Juan Manuel Parrilla (@jparrill)
-    lookup: hiera
+    name: hiera
    short_description: get info from hiera data
    requirements:
      - hiera (command line utility)
--- a/plugins/lookup/keyring.py
+++ b/plugins/lookup/keyring.py
@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: keyring
+    name: keyring
    author:
      - Samuel Boucher (!UNKNOWN) <boucher.samuel.c@gmail.com>
    requirements:
--- a/plugins/lookup/lastpass.py
+++ b/plugins/lookup/lastpass.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: lastpass
+    name: lastpass
    author:
      - Andrew Zenk (!UNKNOWN) <azenk@umn.edu>
    requirements:
--- a/plugins/lookup/lmdb_kv.py
+++ b/plugins/lookup/lmdb_kv.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: lmdb_kv
+    name: lmdb_kv
    author:
      - Jan-Piet Mens (@jpmens)
    version_added: '0.2.0'
--- a/plugins/lookup/manifold.py
+++ b/plugins/lookup/manifold.py
@ -7,7 +7,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    author:
        - Kyrylo Galanov (!UNKNOWN) <galanoff@gmail.com>
-    lookup: manifold
+    name: manifold
    short_description: get credentials from Manifold.co
    description:
        - Retrieves resources' credentials from Manifold.co
--- a/plugins/lookup/nios.py
+++ b/plugins/lookup/nios.py
@ -23,7 +23,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
 ---
 author: Unknown (!UNKNOWN)
-lookup: nios
+name: nios
 short_description: Query Infoblox NIOS objects
 description:
  - Uses the Infoblox WAPI API to fetch NIOS specified objects.  This lookup
--- a/plugins/lookup/nios_next_ip.py
+++ b/plugins/lookup/nios_next_ip.py
@ -23,7 +23,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
 ---
 author: Unknown (!UNKNOWN)
-lookup: nios_next_ip
+name: nios_next_ip
 short_description: Return the next available IP address for a network
 description:
  - Uses the Infoblox WAPI API to return the next available IP addresses
--- a/plugins/lookup/nios_next_network.py
+++ b/plugins/lookup/nios_next_network.py
@ -23,7 +23,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
 ---
 author: Unknown (!UNKNOWN)
-lookup: nios_next_network
+name: nios_next_network
 short_description: Return the next available network range for a network-container
 description:
  - Uses the Infoblox WAPI API to return the next available network addresses for
--- a/plugins/lookup/onepassword.py
+++ b/plugins/lookup/onepassword.py
@ -8,7 +8,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: onepassword
+    name: onepassword
    author:
      - Scott Buchanan (@scottsb)
      - Andrew Zenk (@azenk)
--- a/plugins/lookup/onepassword_raw.py
+++ b/plugins/lookup/onepassword_raw.py
@ -8,7 +8,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: onepassword_raw
+    name: onepassword_raw
    author:
      - Scott Buchanan (@scottsb)
      - Andrew Zenk (@azenk)
--- a/plugins/lookup/passwordstore.py
+++ b/plugins/lookup/passwordstore.py
@ -6,7 +6,7 @@ __metaclass__ = type


 DOCUMENTATION = '''
-    lookup: passwordstore
+    name: passwordstore
    author:
      - Patrick Deelman (!UNKNOWN) <patrick@patrickdeelman.nl>
    short_description: manage passwords with passwordstore.org's pass utility
--- a/plugins/lookup/redis.py
+++ b/plugins/lookup/redis.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: redis
+    name: redis
    author:
      - Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
      - Ansible Core Team
--- a/plugins/lookup/shelvefile.py
+++ b/plugins/lookup/shelvefile.py
@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    lookup: shelvefile
+    name: shelvefile
    author: Alejandro Guirao (!UNKNOWN) <lekumberri@gmail.com>
    short_description: read keys from Python shelve file
    description:
--- a/plugins/lookup/tss.py
+++ b/plugins/lookup/tss.py
@ -6,7 +6,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type

 DOCUMENTATION = r"""
-lookup: tss
+name: tss
 author: Adam Migus (@amigus) <adam@migus.org>
 short_description: Get secrets from Thycotic Secret Server
 version_added: 1.0.0