.. _cli-confluent-list:

==============
confluent list
==============

Description
-----------
List all available services or plugins.


Usage
-----

.. sourcecode:: bash

   confluent list [ plugins | connectors ]

.. tip:: For usage information, enter ``confluent help list``.

Options
-------


===================================  =======  ==============================================
Name, shorthand                      Default  Description
===================================  =======  ==============================================
``plugins``                                   Print all discoverable connector-plugins that
                                              are in the current |CP| deployment.
``connectors``                                Print connector names that map to predefined
                                              connectors. The configuration files are located
                                              in the ``<path-to-confluent>/etc/``
                                              directory in |CP|.
===================================  =======  ==============================================


Positional arguments
--------------------

None.

Examples
--------

- Print the available services.

  .. sourcecode:: bash

    confluent list

  Your output should resemble:

  .. sourcecode:: bash

    Available services:
      zookeeper
      kafka
      schema-registry
      kafka-rest
      connect

- Print the available connector plugins (connector classes) that are discoverable at Connect runtime.

  .. sourcecode:: bash

    confluent list plugins

  Your output should resemble:

  .. codewithvars:: bash

    Available Connector Plugins:
    [
      {
        "class": "io.confluent.connect.elasticsearch.ElasticsearchSinkConnector",
        "type": "sink",
        "version": "|release|"
      },
      {
        "class": "io.confluent.connect.hdfs.HdfsSinkConnector",
        "type": "sink",
        "version": "|release|"
      },
    ...

- Print a list of predefined connectors.

  .. sourcecode:: bash

    confluent list connectors

  Your output should resemble:

  .. sourcecode:: bash

    Bundled Predefined Connectors (edit configuration under etc/):
      elasticsearch-sink
      file-source
      file-sink
      jdbc-source
      jdbc-sink
      hdfs-sink
      s3-sink