models.remote_script_path_and_params module

class models.remote_script_path_and_params.RemoteScriptPathAndParams(continue_on_error=None, is_active=None, script_params=None, script_path=None, timeout_secs=None)

Bases: object

Implementation of the ‘RemoteScriptPathAndParams’ model.

Specifies the path to the remote script and any parameters expected by the remote script.

Attributes:

continue_on_error (bool): Specifies if the script needs to continue

even if there is an occurence of an error. If this flag is set to true, then backup job will start even if the pre backup script fails. Applicable only for pre backup scripts.

is_active (bool): Specifies if the script is active. If set to false,

this script will not be executed even if it is part of the backup job.

script_params (string): Specifies the parameters and values to pass

into the remote script. For example if the script expects values for the ‘database’ and ‘user’ parameters, specify the parameters and values using the following string: “database=myDatabase user=me”.

script_path (string): Specifies the path to the script on the remote

host.

timeout_secs (int): Specifies the timeout of the script in seconds.

The script will be killed if it exceeds this value. If the value of the field is ‘-1’ then timeout is not set for the script.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.