:mod:`cloudmesh-cloud.cloudmesh.group.Group`
============================================

.. py:module:: cloudmesh-cloud.cloudmesh.group.Group


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

Classes
~~~~~~~

.. autoapisummary::

   cloudmesh-cloud.cloudmesh.group.Group.Group



.. class:: Group


   Bases: :class:`object`

   Groups are used to store the names of services that are part of the
   group. Members are identified by their name and the kind (such as vm).

   The data of a group is managed via a dict. Here is a simple example

   cm:
     name: test
     cloud: local
     kind: group
   members:
   - name: vm-1
     kind: vm
   - name: vm-2
     kind: vm
   - name: vm-3
     kind: vm

   .. method:: update_list(self, d)


   .. method:: delete_group(self, name=None)
      :abstractmethod:


   .. method:: delete_member(self, name=None, member=None)
      :abstractmethod:

      delete the member from the group

      :param name: name of the group
      :param member: name of the member
      :return:


   .. method:: copy_group(self, source, destination)
      :abstractmethod:

      copies the group source to destination

      :param source: name of the source
      :param destination: name of the destination
      :return:


   .. method:: merge(self, destination, *groups)
      :abstractmethod:

      merge the members of the groups into the destination group

      :param destination:
      :param groups:
      :return:


   .. method:: members(self, name=None)


   .. method:: list(self, name=None)


   .. method:: add(self, name=None, services=None, category=None)