epicsarchiver_mgmt.commands.archive

Provides the archive command to archive PVs.

Attributes

LOG
ARCHIVE_OPERATION_RESULT_STATUS_OK
ARCHIVE_OPERATION_EXPECTED_STATUS

Exceptions

ArchivePolicyNotFoundError

Exception for when the policy is not found.

Functions

validate_policy_names(→ None)	Validate the policy names.
archive(→ None)	Provide the archive command to archive PVs.

Module Contents

epicsarchiver_mgmt.commands.archive.LOG: logging.Logger

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

Bases: epicsarchiver_mgmt.exceptions.BaseMgmtError

Exception for when the policy is not found.

pv_request

policy_names

epicsarchiver_mgmt.commands.archive.validate_policy_names(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv_requests: list[epicsarchiver_mgmt.archiver.mgmt.ArchivePVRequest]) → None

Validate the policy names.

Parameters:

• archiver (ArchiverMgmt) – The archiver information.

• pv_requests (list[ArchivePVRequest]) – The PVs to archive.

Raises:

ArchivePolicyNotFoundError – If the policy is not found.

epicsarchiver_mgmt.commands.archive.ARCHIVE_OPERATION_RESULT_STATUS_OK = 'Archive request submitted'

epicsarchiver_mgmt.commands.archive.ARCHIVE_OPERATION_EXPECTED_STATUS

epicsarchiver_mgmt.commands.archive.archive(archiver_fqdn: str, pv_requests: list[epicsarchiver_mgmt.archiver.mgmt.ArchivePVRequest], *, dry_run: bool = False) → None

Provide the archive command to archive PVs.

Parameters:

• archiver_fqdn (str) – The fully qualified domain name of the archiver.

• pv_requests (list[ArchivePVRequest]) – The PVs to archive.

• dry_run (bool) – Whether to do a dry run or not.

Raises:

RequestHTTPError – If there is an error archiving the PVs.