:orphan:

.. index:: pair: group; Configuration backup manipulation
.. _doxid-group__confapi__base__backup:

Configuration backup manipulation
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_create_backup<doxid-group__confapi__base__backup_1gaf57c751493648f16a39569e2de1c03e2>`(char** name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_verify_backup<doxid-group__confapi__base__backup_1ga4641dfd818a37a5b915a3cb9cfcdbb95>`(const char* name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_restore_backup<doxid-group__confapi__base__backup_1ga2c726a09e673da1857814137d1d5c4d2>`(const char* name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_restore_backup_ta<doxid-group__confapi__base__backup_1gab6d03ce9141106f1493817b8e29ac99a>`(const char* ta, const char* name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_restore_backup_nohistory<doxid-group__confapi__base__backup_1ga0a9e9cc75aeb4e54061b8c72d22642ea>`(const char* name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_release_backup<doxid-group__confapi__base__backup_1ga195f5f8583faf1b2bdbfd9f8d2a42bf7>`(char** name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_create_config<doxid-group__confapi__base__backup_1gaea8a8a1512c208c0a7130268990a310b>`(const char* name, bool history);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`cfg_process_history<doxid-group__confapi__base__backup_1gad48071ac515a4ec65dc6969032e754e2>`(const char* filename, const te_kvpair_h* expand_vars);

.. _details-group__confapi__base__backup:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Global Functions
----------------

.. index:: pair: function; cfg_create_backup
.. _doxid-group__confapi__base__backup_1gaf57c751493648f16a39569e2de1c03e2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_create_backup(char** name)

Create a backup.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- name

		- OUT: location for backup file name



.. rubric:: Returns:

Status code (see ``te_errno.h``)

.. index:: pair: function; cfg_verify_backup
.. _doxid-group__confapi__base__backup_1ga4641dfd818a37a5b915a3cb9cfcdbb95:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_verify_backup(const char* name)

Verify the backup.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- name

		- name returned by cfg_create_backup

	*
		- 0

		- current configuration is equal to backup

	*
		- TE_EBACKUP

		- current configuration differs from backup



.. rubric:: Returns:

Status code (see ``te_errno.h``)

.. index:: pair: function; cfg_restore_backup
.. _doxid-group__confapi__base__backup_1ga2c726a09e673da1857814137d1d5c4d2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_restore_backup(const char* name)

Restore the backup.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- name

		- name returned by cfg_create_backup



.. rubric:: Returns:

Status code (see ``te_errno.h``)

.. index:: pair: function; cfg_restore_backup_ta
.. _doxid-group__confapi__base__backup_1gab6d03ce9141106f1493817b8e29ac99a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_restore_backup_ta(const char* ta, const char* name)

Restore the TA backup.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Test Agent name

	*
		- name

		- name returned by :ref:`cfg_create_backup() <doxid-group__confapi__base__backup_1gaf57c751493648f16a39569e2de1c03e2>`



.. rubric:: Returns:

Status code (see ``te_errno.h``)

.. index:: pair: function; cfg_restore_backup_nohistory
.. _doxid-group__confapi__base__backup_1ga0a9e9cc75aeb4e54061b8c72d22642ea:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_restore_backup_nohistory(const char* name)

Restore the backup w/o processing history.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- name

		- name returned by cfg_create_backup



.. rubric:: Returns:

Status code (see ``te_errno.h``)

.. index:: pair: function; cfg_release_backup
.. _doxid-group__confapi__base__backup_1ga195f5f8583faf1b2bdbfd9f8d2a42bf7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_release_backup(char** name)

Ask Configurator to forget about the backup, if known.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- name

		- Location of name returned by cfg_create_backup (set to NULL on success)



.. rubric:: Returns:

Status code

.. index:: pair: function; cfg_create_config
.. _doxid-group__confapi__base__backup_1gaea8a8a1512c208c0a7130268990a310b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_create_config(const char* name, bool history)

Create a configuration file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- name

		- configuration file name

	*
		- history

		- if ``true`` "history" configuration file is created; otherwise "backup" configuration file is created



.. rubric:: Returns:

Status code (see ``te_errno.h``)

.. index:: pair: function; cfg_process_history
.. _doxid-group__confapi__base__backup_1gad48071ac515a4ec65dc6969032e754e2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` cfg_process_history(const char* filename, const te_kvpair_h* expand_vars)

Process a history configuration file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filename

		- history configuration file name

	*
		- expand_vars

		- List of key-value pairs for expansion in file, ``NULL`` if environment variables are used for substitutions



.. rubric:: Returns:

Status code (see ``te_errno.h``)