Skip to content

Latest commit

 

History

History
281 lines (233 loc) · 16.3 KB

synciq_replication_report.md

File metadata and controls

281 lines (233 loc) · 16.3 KB
title linkTitle page_title subcategory description
powerscale_synciq_replication_report data source
powerscale_synciq_replication_report
powerscale_synciq_replication_report Data Source - terraform-provider-powerscale

powerscale_synciq_replication_report (Data Source)

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing Replication Report from PowerScale array.

# Returns the entire list of PowerScale replication report.
data "powerscale_synciq_replication_report" "all" {
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_synciq_replication_report.all
output "powerscale_synciq_replication_report" {
  value = data.powerscale_synciq_replication_report.all
}

# Returns a list of PowerScale Replication Report based on the filters specified in the filter block.
data "powerscale_synciq_replication_report" "filtering" {
  filter {
    policy_name        = "Policy"
    reports_per_policy = 2
    sort               = "policy_name"
    dir                = "ASC"
  }
}

# Output value of above block by executing 'terraform output' command
# You can use the the fetched information by the variable data.powerscale_synciq_replication_report.filtering
output "powerscale_replication_report_filter" {
  value = data.powerscale_synciq_replication_report.filtering
}

Schema

Optional

Read-Only

  • id (String) Unique identifier of the network pool instance.
  • replication_reports (Attributes List) (see below for nested schema)

Nested Schema for filter

Optional:

  • dir (String) The direction of the sort.
  • limit (Number) Return no more than this many results at once (see resume).
  • newer_than (Number) Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.
  • policy_name (String) Filter the returned reports to include only those with this policy name.
  • reports_per_policy (Number) If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1.
  • sort (String) The field that will be used for sorting.
  • state (String) Filter the returned reports to include only those whose jobs are in this state.
  • summary (Boolean) Return a summary rather than entire objects

Nested Schema for replication_reports

Read-Only:

  • action (String) The action to be taken by this job.
  • ads_streams_replicated (Number) The number of ads streams replicated by this job.
  • block_specs_replicated (Number) The number of block specs replicated by this job.
  • bytes_recoverable (Number) The number of bytes recoverable by this job.
  • bytes_transferred (Number) The number of bytes that have been transferred by this job.
  • char_specs_replicated (Number) The number of char specs replicated by this job.
  • committed_files (Number) The number of WORM committed files.
  • corrected_lins (Number) The number of LINs corrected by this job.
  • dead_node (Boolean) This field is true if the node running this job is dead.
  • directories_replicated (Number) The number of directories replicated.
  • dirs_changed (Number) The number of directories changed by this job.
  • dirs_deleted (Number) The number of directories deleted by this job.
  • dirs_moved (Number) The number of directories moved by this job.
  • dirs_new (Number) The number of directories created by this job.
  • duration (Number) The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.
  • encrypted (Boolean) If true, syncs will be encrypted.
  • end_time (Number) The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.
  • error (String) The primary error message for this job.
  • error_checksum_files_skipped (Number) The number of files with checksum errors skipped by this job.
  • error_io_files_skipped (Number) The number of files with io errors skipped by this job.
  • error_net_files_skipped (Number) The number of files with network errors skipped by this job.
  • errors (List of String) A list of error messages for this job.
  • failed_chunks (Number) Tyhe number of data chunks that failed transmission.
  • fifos_replicated (Number) The number of fifos replicated by this job.
  • file_data_bytes (Number) The number of bytes transferred that belong to files.
  • files_changed (Number) The number of files changed by this job.
  • files_linked (Number) The number of files linked by this job.
  • files_new (Number) The number of files created by this job.
  • files_selected (Number) The number of files selected by this job.
  • files_transferred (Number) The number of files transferred by this job.
  • files_unlinked (Number) The number of files unlinked by this job.
  • files_with_ads_replicated (Number) The number of files with ads replicated by this job.
  • flipped_lins (Number) The number of LINs flipped by this job.
  • hard_links_replicated (Number) The number of hard links replicated by this job.
  • hash_exceptions_fixed (Number) The number of hash exceptions fixed by this job.
  • hash_exceptions_found (Number) The number of hash exceptions found by this job.
  • id (String) A unique identifier for this object.
  • job_id (Number) The ID of the job.
  • lins_total (Number) The number of LINs transferred by this job.
  • network_bytes_to_source (Number) The total number of bytes sent to the source by this job.
  • network_bytes_to_target (Number) The total number of bytes sent to the target by this job.
  • new_files_replicated (Number) The number of new files replicated by this job.
  • num_retransmitted_files (Number) The number of files that have been retransmitted by this job.
  • phases (Attributes List) Data for each phase of this job. (see below for nested schema)
  • policy (Attributes) The policy associated with this job, or null if there is currently no policy associated with this job (this can happen if the job is newly created and not yet fully populated in the underlying database). (see below for nested schema)
  • policy_action (String) This is the action the policy is configured to perform.
  • policy_id (String) The ID of the policy.
  • policy_name (String) The name of the policy.
  • quotas_deleted (Number) The number of quotas removed from the target.
  • regular_files_replicated (Number) The number of regular files replicated by this job.
  • resynced_lins (Number) The number of LINs resynched by this job.
  • retransmitted_files (List of String) The files that have been retransmitted by this job.
  • retry (Number) The number of times the job has been retried.
  • running_chunks (Number) The number of data chunks currently being transmitted.
  • sockets_replicated (Number) The number of sockets replicated by this job.
  • source_bytes_recovered (Number) The number of bytes recovered on the source.
  • source_directories_created (Number) The number of directories created on the source.
  • source_directories_deleted (Number) The number of directories deleted on the source.
  • source_directories_linked (Number) The number of directories linked on the source.
  • source_directories_unlinked (Number) The number of directories unlinked on the source.
  • source_directories_visited (Number) The number of directories visited on the source.
  • source_files_deleted (Number) The number of files deleted on the source.
  • source_files_linked (Number) The number of files linked on the source.
  • source_files_unlinked (Number) The number of files unlinked on the source.
  • sparse_data_bytes (Number) The number of sparse data bytes transferred by this job.
  • start_time (Number) The time the job started in unix epoch seconds. The field is null if the job hasn't started.
  • state (String) The state of the job.
  • subreport_count (Number) The number of subreports that are available for this job report.
  • succeeded_chunks (Number) The number of data chunks that have been transmitted successfully.
  • symlinks_replicated (Number) The number of symlinks replicated by this job.
  • sync_type (String) The type of sync being performed by this job.
  • target_bytes_recovered (Number) The number of bytes recovered on the target.
  • target_directories_created (Number) The number of directories created on the target.
  • target_directories_deleted (Number) The number of directories deleted on the target.
  • target_directories_linked (Number) The number of directories linked on the target.
  • target_directories_unlinked (Number) The number of directories unlinked on the target.
  • target_files_deleted (Number) The number of files deleted on the target.
  • target_files_linked (Number) The number of files linked on the target.
  • target_files_unlinked (Number) The number of files unlinked on the target.
  • target_snapshots (List of String) The target snapshots created by this job.
  • throughput (String) Throughput of a job
  • total_chunks (Number) The total number of data chunks transmitted by this job.
  • total_data_bytes (Number) The total number of bytes transferred by this job.
  • total_files (Number) The number of files affected by this job.
  • total_network_bytes (Number) The total number of bytes sent over the network by this job.
  • total_phases (Number) The total number of phases for this job.
  • unchanged_data_bytes (Number) The number of bytes unchanged by this job.
  • up_to_date_files_skipped (Number) The number of up-to-date files skipped by this job.
  • updated_files_replicated (Number) The number of updated files replicated by this job.
  • user_conflict_files_skipped (Number) The number of files with user conflicts skipped by this job.
  • warnings (List of String) A list of warning messages for this job.
  • worm_committed_file_conflicts (Number) The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.

Nested Schema for replication_reports.phases

Read-Only:

  • end_time (Number) The time the job ended this phase.
  • phase (String) The phase that the job was in.
  • start_time (Number) The time the job began this phase.
  • statistics (Attributes) Statistics for each phase of this job. (see below for nested schema)

Nested Schema for replication_reports.phases.statistics

Read-Only:

  • compliance_dir_links (String) Compliance Dir Links
  • corrected_lins (String) Corrected LINs
  • deleted_dirs (String) Deleted Dirs
  • dirs (String) Dirs
  • files (String) Files
  • flipped_lins (String) Flipped LINs
  • hash_exceptions (String) Hash Exceptions
  • linked_dirs (String) Linked Dirs
  • linked_files (String) Linked Files
  • marked_directories (String) Marked Directories
  • marked_files (String) Marked Files
  • modified_dirs (String) Modified Dirs
  • modified_files (String) Modified Files
  • modified_lins (String) Modified LINs
  • new_compliance_dirs (String) New Compliance Dirs
  • new_dirs (String) New Dirs
  • new_files (String) New Files
  • new_resynced_files (String) New Resynced Files
  • resynced_file_links (String) Resynced File Links
  • resynced_lins (String) Resynced LINs
  • unlinked_files (String) Unlinked Files

Nested Schema for replication_reports.policy

Read-Only:

  • action (String) The action to be taken by the job.
  • file_matching_pattern (Attributes) A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria. (see below for nested schema)
  • name (String) User-assigned name of this sync policy.
  • source_exclude_directories (List of String) Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.
  • source_include_directories (List of String) Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.
  • source_root_path (String) The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.
  • target_host (String) Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.
  • target_path (String) Absolute filesystem path on the target cluster for the sync destination.

Nested Schema for replication_reports.policy.file_matching_pattern

Read-Only:

  • or_criteria (Attributes List) An array containing objects with "and_criteria" properties, each set of and_criteria will be logically OR'ed together to create the full file matching pattern. (see below for nested schema)

Nested Schema for replication_reports.policy.file_matching_pattern.or_criteria

Read-Only:

  • and_criteria (Attributes List) An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria. (see below for nested schema)

Nested Schema for replication_reports.policy.file_matching_pattern.or_criteria.and_criteria

Read-Only:

  • attribute_exists (Boolean) For "custom_attribute" type criteria. The file will match as long as the attribute named by "field" exists. Default is true.
  • case_sensitive (Boolean) If true, the value comparison will be case sensitive. Default is true.
  • field (String) The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string "".
  • operator (String) How to compare the specified attribute of each file to the specified value.
  • type (String) The type of this criterion, that is, which file attribute to match on.
  • value (String) The value to compare the specified attribute of each file to.
  • whole_word (Boolean) If true, the attribute must match the entire word. Default is true.