Spectra Logic

1-800-833-1132 : 1-303-449-6400

Modify Data Path Backend

Description

Activate the data path or configure automatic data path activation. Setting the auto activation timeout to null disables auto activation. If a tape partition is connected to more than one BlackPearl system, for example, for failover purposes, it is critical that at most one system attached to the same tape partition, is active at a time. Otherwise, multiple BlackPearl systems may issue conflicting requests to robots and tape drives. This can cause data corruption or data loss. If your configuration has only one BlackPearl system, it is safe to increase the auto activate timeout. If your configuration has multiple BlackPearl systems attached to the same tape partition, consider modifying the auto activate timeout to null in order to guarantee that both systems cannot be auto-activated at the same time.

Having two BlackPearl systems connected to the same tape partition, active at the same time can cause database corruption or data loss.

Note:

If an optional request parameter is not included, the previous setting is retained.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/data_path_backend​[?activated=TRUE|FALSE]{&allow_new_job_requests=TRUE|FALSE} [&auto_activate_timeout_in_mins={32‑bit integer}]​[&auto_inspect=NEVER|MINIMAL|DEFAULT][&cache_available_retry_after_in_seconds={32-bit integer}]​[&default_import_conflict_resolution_mode=ACCEPT_EXISTING|​ACCEPT_MOST_RECENT|CANCEL][&default_verify_data_after_import=CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND][&default_verify_data_prior_to_import=TRUE|FALSE][&partially_verify_last_percent_of_tapes={32-bit integer}]​[&unavailable_media_policy=ALLOW|DISCOURAGED|DISALLOW]​[&unavailable_pool_max_job_retry_in_mins={32‑bit integer}]​[&unavailable_tape_partition_max_job_retry_in_mins=​{32‑bit integer}]

Request Parameters

Parameter	Description	Required
activated	Whether the BlackPearl system is allowed to send data to the data path backend (pool or tape partitions). Values: TRUE, FALSE	no
allow_new_job_ requests	Whether the BlackPearl system allows new jobs to be initiated. Values: TRUE, FALSE	no
auto_activate_ timeout_in_mins	The number of minutes allowed for the data planner to take between when it is shut down and when it comes back up, and have the data path back end automatically activate. If the data planner remains shutdown for longer than this number of minutes, the data path backend will not automatically activate. If this parameter is null, the data path backend will never automatically activate. Default: 30 minutes	no
auto_inspect	Whether tape inspections are automatically scheduled whenever the data planner starts. Values: § DEFAULT — Tapes have inspections scheduled for them if an inspection is necessary given the tape's current state, as well as every time the data path starts up. § MINIMAL — Tapes have inspections scheduled for them if an inspection is necessary given the tape's current state. § NEVER — Tapes are not automatically scheduled for inspection.	no
cache_available_ retry_after_in_ seconds	Set the recommended number of seconds for clients to wait between sending Get Job Chunks Ready for Processing (see page 204) requests.	no
default_import_ conflict_resolution_mode	How the data path backend handles object name conflicts. Values: § ACCEPT_EXISTING — Keep the file currently in the BlackPearl database. § ACCEPT_MOST_RECENT — Keep the file with the most recent creation date. § CANCEL (default) — Cancel the import process.	no
default_verify_ data_after_import	The priority for verifying the data after import. This determines the resources assigned and the processing order. Tasks with priority URGENT can use up all of the resources and prevent other jobs from making progress. Use this priority sparingly. Values: URGENT, HIGH, NORMAL, LOW	no
default_verify_ data_ prior_to_ import	Whether the data must be verified before the media is imported. Values: TRUE, FALSE Note: It is recommended to verify data prior to import whenever it is possible that the media being imported contain objects with the same name as objects already in the bucket. Without verifying data prior to import, it is possible for the existing object to be replaced with the one being imported, even if the one being imported is partially corrupt and cannot be read.	no
partially_verify_ last_percent_of_ tapes	The percentage of the overall tape capacity before the EOD marker that the BlackPearl system verifies during data integrity verification. Verifying a percentage of the tape, rather than the entire tape is useful when you only want to verify the most recent data written to the tape. Values: 1-99 Note: To verify the entire tape, see Verify Tape.	no
unavailable_media_policy	Whether new job requests are allowed to use media that are currently unavailable. Values: § ALLOW —New job requests for unavailable media are allowed and will retry for the duration of the unavailable_pool_max_job_retry_in_mins or unavailable_tape_partition_max_job_retry_in_mins. § DISCOURAGE (default) — Unavailable partitions can be used, but only if no other media is available. § DISALLOW — New job requests for unavailable media will fail.	no
unavailable_pool_max_job_retry_in_mins	How long job requests using unavailable pools will retry before being re-chunked or failing if re-chunking cannot solve the problem. Default: 20 minutes	no
unavailable_tape_partition_max_job_retry_in_mins	How long job requests using unavailable tape partitions will retry before being re-chunked or failing if re-chunking cannot solve the problem. Default: 20 minutes	no

Responses

Response Elements

<Data>
   <Activated>TRUE|FALSE</Activated>
   <AllowNewJobRequests>TRUE|FALSE</AllowNewJobRequests>
   <AutoActivateTimeoutInMins>
      {32‑bit integer}
   </AutoActivateTimeoutInMins>

   <AutoInspect>DEFAULT|MINIMAL|NEVER</AutoInspect>
   <CacheAvailableRetryAfterInSeconds>
      {32‑bit integer}
   </CacheAvailableRetryAfterInSeconds>
   <DefaultImportConflictResolutionMode>
      ACCEPT_EXISTING|ACCEPT_MOST_RECENT|CANCEL
   </DefaultImportConflictResolutionMode>
   <DefaultVerifyDataAfterImport>
      URGENT|HIGH|NORMAL|LOW
   </DefaultVerifyDataAfterImport>
   <DefaultVerifyDataPriorToImport>
      TRUE|FALSE

   <PartiallyVerifyLastPercentOfTape>
      {32‑bit integer}
   </PartiallyVerifyLastPercentOfTape>
   </DefaultVerifyDataPriorToImport>
   <Id>{string}</Id>
   <LastHeartbeat>YYYY-MM-DDThh:mm:ss.xxxZ</LastHeartbeat>
   <UnavailableMediaPolicy>
       ALLOW|DISCOURAGED|DISALLOW
   </UnavailableMediaPolicy>
   <UnavailablePoolMaxJobRetryInMins>
      {32‑bit integer}
   </UnavailablePoolMaxJobRetryInMins>
   <UnavailableTapePartitionMaxJobRetryInMins>
      {32‑bit integer}
   </UnavailableTapePartitionMaxJobRetryInMins>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Activated	Whether the BlackPearl system is allowed to send to the data path backend (pool or tape partitions). Values: TRUE, FALSE
AllowNewJob Requests	Whether the BlackPearl system allows new jobs to be initiated. Values: TRUE, FALSE
AutoActivate TimeoutInMins	The number of minutes allowed for the data planner to take between when it is shut down and when it comes back up, and have the data path back end automatically activate. If the data planner remains shutdown for longer than this number of minutes, the data path backend will not automatically activate. If this parameter is null, the data path backend will never automatically activate.
AutoInspect	Whether tape inspections are automatically scheduled whenever the data planner starts. Values: DEFAULT, MINIMAL, NEVER See auto_inspect.
CacheAvailable RetryAfterIn Seconds	The recommended number of seconds for clients to wait between sending Get Job Chunks Ready for Processing (see page 204) requests.
DefaultImport ConflictResolution	How the data path backend handles object name conflicts. See default_import_ conflict_resolution_mode. Values: ACCEPT_EXISTING, ACCEPT_MOST_RECENT, CANCEL
DefaultVerifyDataAfterImport	The priority for verifying the data after import. This determines the resources assigned and the processing order. Values: URGENT, HIGH, NORMAL, LOW
DefaultVerifyData PriorToImport	Whether the data must be verified before the tape is imported. Values: TRUE, FALSE Note: It is recommended to verify data prior to import whenever it is possible that the tapes being imported contain objects with the same name as objects already in the bucket. Without verifying data prior to import, it is possible for the existing object to be replaced with the one being imported, even if the one being imported is partially corrupt and cannot be read.
PartiallyVerifyLastPercentOfTapes	The percentage of the overall tape capacity before the EOD marker that the BlackPearl system verifies during data integrity verification. Verifying a percentage of the tape, rather than the entire tape is useful when you only want to verify the most recent data written to the tape. Values: 1-99 Note: To verify the entire tape, see Verify Tape.
Id	The UUID for the record. This is only useful to the BlackPearl system.
LastHeartbeat	The date and time that the system last sent a heartbeat in the format YYYY-MM-DDThh:mm:ss.xxxZ.
UnavailableMedia Policy	Whether new job requests are allowed to use partitions that are currently unavailable. Values: ALLOW, DISCOURAGE, DISALLOW See unavailable_media_policy.
UnavailablePool MaxJobRetryIn Mins	How long job requests using unavailable pools will retry before being re-chunked or failing if re-chunking cannot solve the problem.
UnavailableTape PartitionMaxJob RetryInMins	How long job requests using unavailable tape partitions will retry before being re-chunked or failing if re-chunking cannot solve the problem.

Example

Sample Request

This request activates the data path backend.

PUT http://blackpearl-hostname/_rest_/data_path_backend​?activated=TRUE HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Activated>TRUE</Activated>
   <AllowNewJobRequests>TRUE</AllowNewJobRequests>
   <AutoActivateTimeoutInMins>44</AutoActivateTimeoutInMins>
   <AutoInspect>DEFAULT</AutoInspect>
   <CacheAvailableRetryAfterInSeconds>
      300
   </CacheAvailableRetryAfterInSeconds
   <DefaultImportConflictResolutionMode>
      CANCEL
   </DefaultImportConflictResolutionMode>
   <DefaultVerifyDataAfterImport/>
   <DefaultVerifyDataPriorToImport>
      TRUE
   </DefaultVerifyDataPriorToImport>

   <PartiallyVerifyLastPercentOfTape>
      15
   </PartiallyVerifyLastPercentOfTape>
   <Id>c9cebae2-a312-489e-b92c-84030957983a</Id>
   <LastHeartbeat>2016-01-21T18:53:55.000Z</LastHeartbeat>
   <UnavailableMediaPolicy>DISCOURAGED</UnavailableMediaPolicy>
   <UnavailablePoolMaxJobRetryInMins>
      20
   </UnavailablePoolMaxJobRetryInMins>

   <UnavailableTapePartitionMaxJobRetryInMins>
      20
   </UnavailableTapePartitionMaxJobRetryInMins>
</Data>