:orphan:

.. index:: pair: group; Virtual machines configuration
.. _doxid-group__tapi__conf__vm:

Virtual machines configuration
==============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Definition of TAPI to configure virtual machines. :ref:`More...<details-group__tapi__conf__vm>`


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

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_vm_add<doxid-group__tapi__conf__vm_1gafe3bf14e0782a1437f7fb8ab2a3db38a>`(const char* ta, const char* vm_name, const char* tmpl, bool start);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_vm_del<doxid-group__tapi__conf__vm_1gaa36f4cb4274e53b59fd4c3c05a6c4f4e>`(const char* ta, const char* vm_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_vm_start<doxid-group__tapi__conf__vm_1gada05f7004f0c2c9a4e8172d12f59dfe4>`(const char* ta, const char* vm_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_vm_stop<doxid-group__tapi__conf__vm_1ga232e2b670b55abeff2b2d321ff539fee>`(const char* ta, const char* vm_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_vm_add_drive<doxid-group__tapi__conf__vm_1ga66942ea363ccdf34d64e2ca7cee403fa>`(const char* ta, const char* vm_name, const char* drive_name, const char* file, bool snapshot);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_vm_pass_pci<doxid-group__tapi__conf__vm_1ga758a2fa59fbce2c0ff31b5bf7284ca4a>`(const char* ta, const char* vm_name, const char* pci_pt_name, unsigned long vendor, unsigned long device, unsigned long instance);

.. _details-group__tapi__conf__vm:

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

Definition of TAPI to configure virtual machines.

Copyright (C) 2019-2022 OKTET Labs Ltd. All rights reserved.

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

.. index:: pair: function; tapi_cfg_vm_add
.. _doxid-group__tapi__conf__vm_1gafe3bf14e0782a1437f7fb8ab2a3db38a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_vm_add(const char* ta, const char* vm_name, const char* tmpl, bool start)

Add virtual machine.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- vm_name

		- Virtual machine name.

	*
		- tmpl

		- ``NULL`` or virtual machine configuration template.

	*
		- start

		- Start it just after addition and template apply



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_vm_del
.. _doxid-group__tapi__conf__vm_1gaa36f4cb4274e53b59fd4c3c05a6c4f4e:

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

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

Delete virtual machine.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- vm_name

		- Virtual machine name.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_vm_start
.. _doxid-group__tapi__conf__vm_1gada05f7004f0c2c9a4e8172d12f59dfe4:

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

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

Start virtual machine.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- vm_name

		- Virtual machine name.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_vm_stop
.. _doxid-group__tapi__conf__vm_1ga232e2b670b55abeff2b2d321ff539fee:

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

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

Stop virtual machine.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- vm_name

		- Virtual machine name.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_vm_add_drive
.. _doxid-group__tapi__conf__vm_1ga66942ea363ccdf34d64e2ca7cee403fa:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_vm_add_drive(const char* ta, const char* vm_name, const char* drive_name, const char* file, bool snapshot)

Add drive subtree.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- vm_name

		- Virtual machine name.

	*
		- drive_name

		- Drive name.

	*
		- file

		- File option.

	*
		- snapshot

		- Snapshot option.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_vm_pass_pci
.. _doxid-group__tapi__conf__vm_1ga758a2fa59fbce2c0ff31b5bf7284ca4a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_vm_pass_pci(const char* ta, const char* vm_name, const char* pci_pt_name, unsigned long vendor, unsigned long device, unsigned long instance)

Pass PCI function to virtual machine.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- vm_name

		- Virtual machine name.

	*
		- pci_pt_name

		- PCI function name.

	*
		- vendor

		- Vendor component of PCI address.

	*
		- device

		- Device component of PCI address.

	*
		- instance

		- Instance component of PCI address.



.. rubric:: Returns:

Status code