Inicio de escenarios: run()

API de SOAP › API de gestión de escenarios › Inicio de escenarios: run()

Inicio de escenarios: run()

La función de API de ejecución permite ejecutar escenarios. Como práctica recomendable, llame a la API add_credentials_ex para autenticar el host máster antes de llamar a la API de ejecución.

Argumentos

La función de API de ejecución incluye los argumentos descritos en la tabla siguiente:

Name	Tipo	Descripción
session_id	uint	El ID de sesión que se ha devuelto llamando a la API de función create_session.
scenario_id	uint	El ID de escenario que debe iniciarse.
sync_method	uint	El método de sincronización, que consiste en una de las opciones siguientes: 0: Sincronización de archivos 1: Sincronización de bloques 2: Sincronización de volúmenes (solo para el escenario Todo el sistema).
ignore_same_files	bool	Ignore los mismos archivos de tamaño/hora.
arc_upt	bool	Este parámetro se aplica solamente a los escenarios integrados de Arcserve Backup. Cuando el escenario no sea un parámetro integrado de Arcserve Backup, se debería establecer este parámetro como falso. Cuando el escenario se integra con Arcserve Backup, llame a la API add_bab_credentials antes de llamar a la API de ejecución.
verification_and_run	uint	Reservado. Debe definirse siempre como 1.
mensaje	out string	Contiene una descripción detallada del error cuando se produce un error en esta API.

Valores de retorno

Esta función devuelve un valor verdadero cuando el escenario se inicia correctamente. De lo contrario, esta función devuelve un valor falso y proporciona una descripción detallada del error en el argumento del mensaje.

Ejemplo

public bool run_example()
        {
            try
            {
                uint scenario_id = _scenario_id;
                //0:File Sync;1:Block Sync;2:Volume Sync
                uint sync_method = 0;
                bool ignore_same_files = true;
                bool arc_integrated = false;
                string message = "";
                return get_mng().run(_session_id, scenario_id, sync_method, ignore_same_files, arc_integrated, 1, out message);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }