:py:mod:`k8s_client.views.pods`
===============================

.. py:module:: k8s_client.views.pods


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   k8s_client.views.pods.get_pods



.. py:function:: get_pods(context_name=None, node_name=None)

   Get pods list

   Parameters
   ----------
   ``"context_name"``: `string` (optional)
       The name of the context of which showing the pods. 
       if ``value`` is `None` the default context name will be used.

   ``"node_name"``: `string` (optional)
       The name of the node inside the context of which showing the pods. 

   Returns
   -------
   - JSON containing the full list of pods of the default context if ``context_name`` is `None` and ``node_name`` is `None` 
   - JSON containing the full list of pods of the specified context if ``context_name`` is a `<valid value>` and ``node_name`` is `None` 
   - JSON containing the full list of pods of the node of the specified context if ``context_name`` is a `<valid value>` and ``node_name`` is a `<valid value>` 
   - Error message with return code `500` if ``context_name`` is **NOT** a `<valid value>` 
   - JSON containing empty pods list if ``node_name`` is **NOT** a `<valid value>`