:orphan: .. index:: pair: group; DNS zone file generation tool TAPI .. _doxid-group__tapi__dns__zone__file: DNS zone file generation tool TAPI ================================== .. toctree:: :hidden: enum_tapi_dns_zone_file_rr_class.rst enum_tapi_dns_zone_file_rr_type.rst struct_tapi_dns_zone_file_rr.rst struct_tapi_dns_zone_file_rr_a.rst struct_tapi_dns_zone_file_rr_data.rst struct_tapi_dns_zone_file_rr_ns.rst struct_tapi_dns_zone_file_rr_soa.rst Overview ~~~~~~~~ (tapi_dns_zone_file). :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`tapi_dns_zone_file_rr_type` :ref:`tapi_dns_zone_file_rr_type`; typedef enum :ref:`tapi_dns_zone_file_rr_class` :ref:`tapi_dns_zone_file_rr_class`; typedef struct :ref:`tapi_dns_zone_file_rr_a` :ref:`tapi_dns_zone_file_rr_a`; typedef struct :ref:`tapi_dns_zone_file_rr_soa` :ref:`tapi_dns_zone_file_rr_soa`; typedef struct :ref:`tapi_dns_zone_file_rr_ns` :ref:`tapi_dns_zone_file_rr_ns`; typedef struct :ref:`tapi_dns_zone_file_rr_data` :ref:`tapi_dns_zone_file_rr_data`; typedef struct :ref:`tapi_dns_zone_file_rr` :ref:`tapi_dns_zone_file_rr`; // enums enum :ref:`tapi_dns_zone_file_rr_class`; enum :ref:`tapi_dns_zone_file_rr_type`; // structs struct :ref:`tapi_dns_zone_file_rr`; struct :ref:`tapi_dns_zone_file_rr_a`; struct :ref:`tapi_dns_zone_file_rr_data`; struct :ref:`tapi_dns_zone_file_rr_ns`; struct :ref:`tapi_dns_zone_file_rr_soa`; // global functions :ref:`te_errno` :ref:`tapi_dns_zone_file_create`(const char* ta, :ref:`tapi_dns_zone_file_rr`* resource_records, size_t resource_records_n, const char* base_dir, const char* pathname, char** result_pathname); :ref:`te_errno` :ref:`tapi_dns_zone_file_destroy`(const char* ta, const char* pathname); .. _details-group__tapi__dns__zone__file: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ (tapi_dns_zone_file). TAPI to handle DNS zone file generation tool. Typedefs -------- .. index:: pair: typedef; tapi_dns_zone_file_rr_type .. _doxid-group__tapi__dns__zone__file_1ga075858d0f6f8c779ea2b9f13f200b443: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_dns_zone_file_rr_type` tapi_dns_zone_file_rr_type Possible types of resource record in zone file. .. index:: pair: typedef; tapi_dns_zone_file_rr_class .. _doxid-group__tapi__dns__zone__file_1gaa4f192e2a817c55fa5c238cfd6c86619: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_dns_zone_file_rr_class` tapi_dns_zone_file_rr_class Possible classes of resource record in zone file. .. index:: pair: typedef; tapi_dns_zone_file_rr_a .. _doxid-group__tapi__dns__zone__file_1gade0713757ee7c762f81887e1e53e62b9: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_dns_zone_file_rr_a` tapi_dns_zone_file_rr_a Describe ``RDATA`` field of resource record of ``A`` type. At the moment, only the ``IN`` class is supported. .. index:: pair: typedef; tapi_dns_zone_file_rr_soa .. _doxid-group__tapi__dns__zone__file_1ga3bf8fbbd1960aa368d0d063a52c3a3bb: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_dns_zone_file_rr_soa` tapi_dns_zone_file_rr_soa Describe ``RDATA`` field of resource record of ``SOA`` type. .. index:: pair: typedef; tapi_dns_zone_file_rr_ns .. _doxid-group__tapi__dns__zone__file_1ga71b0337b95968114925c5939b14afac6: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_dns_zone_file_rr_ns` tapi_dns_zone_file_rr_ns Describe ``RDATA`` field of resource record of ``NS`` type. .. index:: pair: typedef; tapi_dns_zone_file_rr_data .. _doxid-group__tapi__dns__zone__file_1ga5578860fb399752dde09c5463f82a85e: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_dns_zone_file_rr_data` tapi_dns_zone_file_rr_data Describe pair of ``TYPE`` and corresponding ``RDATA`` fields of resource record. .. index:: pair: typedef; tapi_dns_zone_file_rr .. _doxid-group__tapi__dns__zone__file_1gab4c304587c0b156586a70489d4377f2c: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_dns_zone_file_rr` tapi_dns_zone_file_rr Analog of resource record in zone file. Global Functions ---------------- .. index:: pair: function; tapi_dns_zone_file_create .. _doxid-group__tapi__dns__zone__file_1gab800b3ad6aebc1d170a45a4a29ea8052: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dns_zone_file_create(const char* ta, :ref:`tapi_dns_zone_file_rr`* resource_records, size_t resource_records_n, const char* base_dir, const char* pathname, char** result_pathname) Generate zone file for DNS server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name. * - resource_records - Array of resource records. * - resource_records_n - Number of resource records. * - base_dir - Path to directory where the file will be generated. If ``NULL``, the default base directory will be used. * - pathname - Path to the config file. If ``NULL``, the file name will be randomly generated. If not an absolute path, ``base_dir`` will be used. * - result_pathname - Resulting path to the file. Maybe ``NULL``. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_dns_zone_file_destroy .. _doxid-group__tapi__dns__zone__file_1gab98c2ec3f2e5b8a397a186b483fcf6c3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_dns_zone_file_destroy(const char* ta, const char* pathname) Destroy zone file for DNS server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name. * - pathname - Path to zone file. .. rubric:: Returns: Status code.