models.script_path_and_params module

class models.script_path_and_params.ScriptPathAndParams(continue_on_error=None, is_active=None, script_params=None, script_path=None, timeout_secs=None)

Bases: object

Implementation of the ‘ScriptPathAndParams’ model.

A message to encapsulate pre or post script associated with a backup job policy.

Attributes:

continue_on_error (bool): Applicable only for pre backup scripts. If

this flag is set to true, then backup job will start even if the pre backup script fails.

is_active (bool): Indicates if the script is active. If ‘is_active’ is

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

script_params (string): Custom parameters that users want to pass to

the script. For example, if user wants to pass following params: 1. foo=bar 2. v=10. User can construct the param string as “far=bar v=10”.

script_path (string): For backup jobs of type ‘kPuppeteer’,

‘script_path’ is full path of location of the script within the host. For Pre/Post scripts of agent-based backup jobs, ‘script_path’ is just name of the script, not full path.

timeout_secs (int): Timeout of the script. The script will be killed

if it exceeds this value. ‘-1’ indicates that the 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.