gselib.cloud.nextcloud.occ
==========================

.. py:module:: gselib.cloud.nextcloud.occ


Classes
-------

.. autoapisummary::

   gselib.cloud.nextcloud.occ.NextcloudOCC


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

.. py:class:: NextcloudOCC(host: str = None, user: str = None, key_path: str = None, password: str = None, port: int = 22, occ_cmd: str = None)

   .. py:method:: create_local_storage(mount_point: str, server_path: str, applicable_users: list[str] = None, applicable_groups: list[str] = None) -> dict

      Creates a local-path external storage mount.



   .. py:method:: create_user(uid: str, display_name: str, email: str, groups: list[str] = None) -> None

      Creates a new local Nextcloud user with a generated password emailed to the user.



   .. py:method:: list_users(search: str = None) -> dict

      Returns Nextcloud users as {uid: display_name}. Parses plain text output.



   .. py:method:: list_storages() -> list

      Returns all configured external storage mounts.



   .. py:method:: delete_storage(mount_id: int) -> None

      Deletes an external storage mount by its ID.



   .. py:method:: close() -> None

      Closes the SSH connection if open.