dellemc / dellemc.powerscale / 3.0.0 / module / synciqtargetreports Provides the SyncIQ target reports for PowerScale Storage System | "added in version" 1.3.0 of dellemc.powerscale" Authors: Meenakshi Dembi (@dembim) <ansible.team@dell.com>dellemc.powerscale.synciqtargetreports (3.0.0) — module
Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0
collections: - name: dellemc.powerscale version: 3.0.0
This module provides the SyncIQ target reports for PowerScale Storage System.
- name: Get a single SyncIQ target report with id dellemc.powerscale.synciqtargetreports: onefs_host: "{{onefs_host}}" api_user: "{{api_user}}" api_password: "{{api_password}}" verify_ssl: "{{verify_ssl}}" id: "2-sample_policy" state: "present"
- name: Get a single SyncIQ target report with name dellemc.powerscale.synciqtargetreports: onefs_host: "{{onefs_host}}" api_user: "{{api_user}}" api_password: "{{api_password}}" verify_ssl: "{{verify_ssl}}" name: "sample_policy" state: "present"
- name: Get all SyncIQ target sub-reports with report id dellemc.powerscale.synciqtargetreports: onefs_host: "{{onefs_host}}" api_user: "{{api_user}}" api_password: "{{api_password}}" verify_ssl: "{{verify_ssl}}" id: "2-sample_policy" include_sub_reports: true state: "present"
- name: Get all SyncIQ target sub-reports with report name dellemc.powerscale.synciqtargetreports: onefs_host: "{{onefs_host}}" api_user: "{{api_user}}" api_password: "{{api_password}}" verify_ssl: "{{verify_ssl}}" name: "sample_policy" include_sub_reports: true state: "present"
- name: Get a single SyncIQ target sub-report with sub-report id dellemc.powerscale.synciqtargetreports: onefs_host: "{{onefs_host}}" api_user: "{{api_user}}" api_password: "{{api_password}}" verify_ssl: "{{verify_ssl}}" id: "2-sample_policy" sub_report_id: "1" state: "present"
id: description: - The id of the SyncIQ target report. type: str name: description: - The name of the SyncIQ target report. type: str state: choices: - absent - present description: - The state option is used to mention the existence of target reports. required: true type: str port_no: default: '8080' description: - Port number of the PowerScale cluster.It defaults to 8080 if not specified. required: false type: str api_user: description: - username of the PowerScale cluster. required: true type: str onefs_host: description: - IP address or FQDN of the PowerScale cluster. required: true type: str verify_ssl: choices: - true - false description: - boolean variable to specify whether to validate SSL certificate or not. - C(true) - indicates that the SSL certificate should be verified. - C(false) - indicates that the SSL certificate should not be verified. required: true type: bool api_password: description: - the password of the PowerScale cluster. required: true type: str sub_report_id: description: - The id of the SyncIQ target sub report. type: str include_sub_reports: default: false description: - This flag is used to fetch the list of target sub reports. type: bool
changed: description: Whether or not the resource has changed. returned: always type: bool synciq_target_report: contains: action: description: The action to be taken by this job. type: str ads_streams_replicated: description: The number of ads streams replicated by this job. type: int block_specs_replicated: description: The number of block specs replicated by this job. type: int bytes_recoverable: description: The number of bytes recoverable by this job. type: int bytes_transferred: description: The number of bytes that have been transferred by this job. type: int char_specs_replicated: description: The number of char specs replicated by this job. type: int committed_files: description: The number of WORM committed files. type: int corrected_lins: description: The number of LINs corrected by this job. type: int dead_node: description: This field is true if the node running this job is dead. type: bool directories_replicated: description: The number of directories replicated. type: int dirs_changed: description: The number of directories changed by this job. type: int dirs_deleted: description: The number of directories deleted by this job. type: int dirs_moved: description: The number of directories moved by this job. type: int dirs_new: description: The number of directories created by this job. type: int duration: description: 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. type: int encrypted: description: If true, syncs will be encrypted. type: bool end_time: description: The time the job ended in unix epoch seconds. The field is null if the job hasn't ended. type: int error: description: The primary error message for this job. type: str error_checksum_files_skipped: description: The number of files with checksum errors skipped by this job. type: int error_io_files_skipped: description: The number of files with io errors skipped by this job. type: int error_net_files_skipped: description: The number of files with network errors skipped by this job. type: int errors: description: A list of error messages for this job. elements: str type: list failed_chunks: description: The number of data chunks that failed transmission. type: int fifos_replicated: description: The number of fifos replicated by this job. type: int file_data_bytes: description: The number of bytes transferred that belong to files. type: int files_changed: description: The number of files changed by this job. type: int files_linked: description: The number of files linked by this job. type: int files_new: description: The number of files created by this job. type: int files_selected: description: The number of files selected by this job. type: int files_transferred: description: The number of files transferred by this job. type: int files_unlinked: description: The number of files unlinked by this job. type: int files_with_ads_replicated: description: The number of files with ads replicated by this job. type: int flipped_lins: description: The number of LINs flipped by this job. type: int hard_links_replicated: description: The number of hard links replicated by this job. type: int hash_exceptions_fixed: description: The number of hash exceptions fixed by this job. type: int hash_exceptions_found: description: The number of hash exceptions found by this job. type: int id: description: A unique identifier for this object. type: str job_id: description: The ID of the job. type: int lins_total: description: The number of LINs transferred by this job. type: int network_bytes_to_source: description: The total number of bytes sent to the source by this job. type: int network_bytes_to_target: description: The total number of bytes sent to the target by this job. type: int new_files_replicated: description: The number of new files replicated by this job. type: int num_retransmitted_files: description: The number of files that have been retransmitted by this job. type: int phases: contains: end_time: description: The time the job ended this phase. type: int phase: description: The phase that the job was in. type: str start_time: description: The time the job began this phase. type: int description: Data for each phase of this job. type: complex policy: contains: name: description: User-assigned name of this sync policy. type: str source_root_path: description: The root directory on the source cluster the files will be synced from. type: str target_host: description: Hostname or IP address of sync target cluster. type: str description: Policy details type: complex policy_action: description: This is the action the policy is configured to perform. type: str policy_id: description: The ID of the policy. type: str policy_name: description: The name of the policy. type: str quotas_deleted: description: The number of quotas removed from the target. type: int regular_files_replicated: description: The number of regular files replicated by this job. type: int resynced_lins: description: The number of LINs resynched by this job. type: int retransmitted_files: description: The files that have been retransmitted by this job. elements: str type: list retry: description: The number of times the job has been retried. type: int running_chunks: description: The number of data chunks currently being transmitted. type: int service_report: contains: end_time: description: The time the job end this component. type: int start_time: description: The time the job began this component. type: int status: description: The current status of export for this component. type: str description: Data for each component exported as part of service replication. type: complex sockets_replicated: description: The number of sockets replicated by this job. type: int source_bytes_recovered: description: The number of bytes recovered on the source. type: int source_directories_created: description: The number of directories created on the source. type: int source_directories_deleted: description: The number of directories deleted on the source. type: int source_directories_linked: description: The number of directories linked on the source. type: int source_directories_unlinked: description: The number of directories unlinked on the source. type: int source_directories_visited: description: The number of directories visited on the source. type: int source_files_deleted: description: The number of files deleted on the source. type: int source_files_linked: description: The number of files linked on the source. type: int source_files_unlinked: description: The number of sparse data bytes transferred by this job. type: int start_time: description: The time the job started in unix epoch seconds. The field is null if the job hasn't started. type: int state: description: The state of the job. type: str subreport_count: description: The number of subreports that are available for this job report. type: int succeeded_chunks: description: The number of data chunks that have been transmitted successfully. type: int symlinks_replicated: description: The number of symlinks replicated by this job. type: int sync_type: description: The type of sync being performed by this job. type: str target_bytes_recovered: description: The number of bytes recovered on the target. type: int target_directories_created: description: The number of directories created on the target. type: int target_directories_deleted: description: The number of directories deleted on the target. type: int target_directories_linked: description: The number of directories linked on the target. type: int target_directories_unlinked: description: The number of directories unlinked on the target. type: int target_files_deleted: description: The number of files deleted on the target. type: int target_files_linked: description: The number of files linked on the target. type: int target_files_unlinked: description: The number of files unlinked on the target. type: int target_snapshots: description: The target snapshots created by this job. elements: str type: list total_chunks: description: The total number of data chunks transmitted by this job. type: int total_data_bytes: description: The total number of bytes transferred by this job. type: int total_exported_services: description: The total number of components exported as part of service replication. type: int total_files: description: The number of files affected by this job. type: int total_network_bytes: description: The total number of bytes sent over the network by this job. type: int total_phases: description: The total number of phases for this job. type: int unchanged_data_bytes: description: The number of bytes unchanged by this job. type: int up_to_date_files_skipped: description: The number of up-to-date files skipped by this job. type: int updated_files_replicated: description: The number of updated files replicated by this job. type: int user_conflict_files_skipped: description: The number of files with user conflicts skipped by this job. type: int warnings: description: A list of warning messages for this job. elements: str type: list worm_committed_file_conflicts: description: 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. type: int description: Details of the SyncIQ target report. returned: When SyncIQ target report exists type: complex