4.6. TM Reports¶
The reports
module contains interfaces for all of the various Report
collection calls offered by the dyn.tm REST API
4.6.1. List Functions¶
-
dyn.tm.reports.
get_check_permission
(permission, zone_name=None)[source]¶ Returns a list of allowed and forbidden permissions for the currently logged in user based on the provided permissions array.
Parameters: - permission – A list of permissions to check for the current user.
- zone_name – The zone to check for specific permissions.
Returns: A dict containing permission information.
-
dyn.tm.reports.
get_dnssec_timeline
(zone_name, start_ts=None, end_ts=None)[source]¶ Generates a report of events for the
DNSSEC
service attached to the specified zone has performed and has scheduled to perform.Parameters: - zone_name – The name of the zone with DNSSEC service
- start_ts – datetime.datetime instance identifying point in time for the start of the timeline report
- end_ts – datetime.datetime instance identifying point in time for the end of the timeline report. Defaults to datetime.datetime.now()
Returns: A dict containing log report data
-
dyn.tm.reports.
get_rttm_log
(zone_name, fqdn, start_ts, end_ts=None)[source]¶ Generates a report with information about changes to an existing RTTM service.
Parameters: - zone_name – The name of the zone
- fqdn – The FQDN where RTTM is attached
- start_ts – datetime.datetime instance identifying point in time for the log report to start
- end_ts – datetime.datetime instance indicating the end of the data range for the report. Defaults to datetime.datetime.now()
Returns: A dict containing log report data
-
dyn.tm.reports.
get_rttm_rrset
(zone_name, fqdn, ts)[source]¶ Generates a report of regional response sets for this RTTM service at a given point in time.
Parameters: - zone_name – The name of the zone
- fqdn – The FQDN where RTTM is attached
- ts – datetime.datetime instance identifying point in time for the report
Returns: A dict containing rrset report data
-
dyn.tm.reports.
get_qps
(start_ts, end_ts=None, breakdown=None, hosts=None, rrecs=None, zones=None)[source]¶ Generates a report with information about Queries Per Second (QPS).
Parameters: - start_ts – datetime.datetime instance identifying point in time for the QPS report
- end_ts – datetime.datetime instance indicating the end of the data range for the report. Defaults to datetime.datetime.now()
- breakdown – By default, most data is aggregated together. Valid values (‘hosts’, ‘rrecs’, ‘zones’).
- hosts – List of hosts to include in the report.
- rrecs – List of record types to include in report.
- zones – List of zones to include in report.
Returns: A str with CSV data
-
dyn.tm.reports.
get_zone_notes
(zone_name, offset=None, limit=None)[source]¶ Generates a report containing the Zone Notes for given zone.
Parameters: - zone_name – The name of the zone
- offset – UNIX timestamp of the starting point at which to retrieve the notes
- limit – The maximum number of notes to be retrieved
Returns: A list of dict containing Zone Notes