epicsarchiver_mgmt.commands.archive
===================================

.. py:module:: epicsarchiver_mgmt.commands.archive

.. autoapi-nested-parse::

   Provides the archive command to archive PVs.



Attributes
----------

.. autoapisummary::

   epicsarchiver_mgmt.commands.archive.LOG
   epicsarchiver_mgmt.commands.archive.ARCHIVE_OPERATION_RESULT_STATUS_OK
   epicsarchiver_mgmt.commands.archive.ARCHIVE_OPERATION_EXPECTED_STATUS


Exceptions
----------

.. autoapisummary::

   epicsarchiver_mgmt.commands.archive.ArchivePolicyNotFoundError


Functions
---------

.. autoapisummary::

   epicsarchiver_mgmt.commands.archive.validate_policy_names
   epicsarchiver_mgmt.commands.archive.archive


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

.. py:data:: LOG
   :type:  logging.Logger

.. py:exception:: ArchivePolicyNotFoundError(pv_request: epicsarchiver_mgmt.archiver.mgmt.ArchivePVRequest, policy_names: set[str])

   Bases: :py:obj:`epicsarchiver_mgmt.exceptions.BaseMgmtError`


   Exception for when the policy is not found.


   .. py:attribute:: pv_request


   .. py:attribute:: policy_names


.. py:function:: validate_policy_names(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv_requests: list[epicsarchiver_mgmt.archiver.mgmt.ArchivePVRequest]) -> None

   Validate the policy names.

   :param archiver: The archiver information.
   :type archiver: ArchiverMgmt
   :param pv_requests: The PVs to archive.
   :type pv_requests: list[ArchivePVRequest]

   :raises ArchivePolicyNotFoundError: If the policy is not found.


.. py:data:: ARCHIVE_OPERATION_RESULT_STATUS_OK
   :value: 'Archive request submitted'


.. py:data:: ARCHIVE_OPERATION_EXPECTED_STATUS

.. py:function:: archive(archiver_fqdn: str, pv_requests: list[epicsarchiver_mgmt.archiver.mgmt.ArchivePVRequest], *, dry_run: bool = False) -> None

   Provide the archive command to archive PVs.

   :param archiver_fqdn: The fully qualified domain name of the archiver.
   :type archiver_fqdn: str
   :param pv_requests: The PVs to archive.
   :type pv_requests: list[ArchivePVRequest]
   :param dry_run: Whether to do a dry run or not.
   :type dry_run: bool

   :raises RequestHTTPError: If there is an error archiving the PVs.