arvpyf.mgmt.ArchiverConfig

class arvpyf.mgmt.ArchiverConfig(url)[source]

Interface to REST API commands supported by the Archiver Appliance MGMT service

__init__(self, url)[source]

Constructor

Parameters
urlstr

url of the Archiver Appliance MGMT service

e.g., http://xf04id-ca1.cs.nsls2.local:17665

Methods

__init__(self, url)

Constructor

abort_archiving_pv(self, pv)

Abort any pending requests for archiving the specified PV

archive_pvs(self, pvnames[, period, method, …])

Archive one or more PVs

change_archival_parameters(self, pv, period)

Change the archival parameters for the specified PV

delete_pv(self, pv[, deleteData])

Stop archiving the specified PV (Note: the PV needs to be paused first)

get_all_pvs(self[, regex, limit])

Return all the PVs (Note: this call can return millions of PVs)

get_archiving_status(self, pvs)

Return the PV archiving status

get_never_connected_pvs(self)

Return a list of PVs that never connected

get_paused_pvs_report(self)

Return a list of PVs that are currently paused

get_pv_details(self, pv)

Return the detailed statistics for the specified PV

get_pv_status(self, pvs)

Return the PV status

get_pv_type_info(self, pv)

Return the type info for the specified PV

get_recently_added_pvs(self)

Return a list of PVs sorted by descending PVTypeInfo creation timestamp

pause_archiving_pvs(self, pvs)

Pause archiving the specified PVs

resume_archiving_pvs(self, pvs)

Resume archiving the specified PVs