****************************
Get the State of the Cluster
****************************

Problem
=======

You want to get the list of agents connected to the cluster.



Solution
========

Call the
:py:meth:`get_coordinator_snapshot() <agiparallel.client.ClusterJobScheduler.get_coordinator_snapshot>` method on the ClusterJobScheduler to retrieve the list of agents currently connected to the coordinator.



.. literalinclude:: ..\..\..\code\HowTos\AgentInfo.py
	:language: python
	:linenos:



Discussion
==========

Getting the list of agents is useful when checking to make sure the coordinator is in a certain state before submitting tasks.
Another use for getting the list of agents is to display the information for monitoring purposes.


See Also
========

Reference
"""""""""
* :py:meth:`get_coordinator_snapshot() <agiparallel.client.ClusterJobScheduler.get_coordinator_snapshot>`

Other Resources
"""""""""""""""
* :ref:`Control Agent That is Selected to Run Task`