Try SpotterManage SyncIQ jobs on PowerScale
| "added in version" 1.3.0 of dellemc.powerscale"
Authors: Jennifer John (@johnj9) <ansible.team@dell.com>
Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0
collections:
- name: dellemc.powerscale
version: 3.0.0Managing SyncIQ jobs on PowerScale storage system includes retrieving and modifying details of a SyncIQ job.
- name: Get SyncIQ job details
dellemc.powerscale.synciqjob:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
job_id: "Test_SSL"
state: "present"
- name: Pause a SyncIQ job when in running state
dellemc.powerscale.synciqjob:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
job_id: "Test_SSL"
job_state: "pause"
state: "present"
- name: Resume a SyncIQ job when in paused state
dellemc.powerscale.synciqjob:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
job_id: "Test_SSL"
job_state: "run"
state: "present"
- name: Cancel a SyncIQ job
dellemc.powerscale.synciqjob:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
job_id: "Test_SSL"
job_state: "cancel"
state: "absent"
state:
choices:
- absent
- present
description:
- The state of the SyncIQ job after the task is performed.
- C(present) - indicates that the SyncIQ job should exist on the system.
- C(absent) - indicates that the SyncIQ job should not exist on the system.
required: true
type: str
job_id:
description:
- Specifies the id or name of the policy job.
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
job_state:
choices:
- run
- pause
- cancel
description:
- Specifies the state of the job.
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
changed:
description: Whether or not the resource has changed.
returned: always
type: bool
job_details:
contains:
action:
description: The action to be taken by this job.
type: str
id:
description: A unique identifier for this object.
type: str
policy_id:
description: The id of the policy from which the job is triggered.
type: str
policy_name:
description: The name of the policy from which this job is triggered.
type: str
state:
description: The state of the job.
type: str
sync_type:
description: The type of sync being performed by this job.
type: str
description: The SyncIQ job details.
returned: When SyncIQ job exists
type: complex
modified_job:
contains:
id:
description: A unique identifier for this object.
type: str
state:
description: The state of the job.
type: str
description: The modified SyncIQ job details.
returned: When SyncIQ job is modified
sample:
job_details:
- action: run
ads_streams_replicated: 0
block_specs_replicated: 0
bytes_recoverable: 0
bytes_transferred: 0
char_specs_replicated: 0
committed_files: 0
corrected_lins: 0
dead_node: false
directories_replicated: 0
dirs_changed: 0
dirs_deleted: 0
dirs_moved: 0
dirs_new: 0
duration: 1
encrypted: true
end_time: 1687488893
error: ''
error_checksum_files_skipped: 0
error_io_files_skipped: 0
error_net_files_skipped: 0
errors: []
failed_chunks: 0
fifos_replicated: 0
file_data_bytes: 0
files_changed: 0
files_linked: 0
files_new: 0
files_selected: 0
files_transferred: 0
files_unlinked: 0
files_with_ads_replicated: 0
flipped_lins: 0
hard_links_replicated: 0
hash_exceptions_fixed: 0
hash_exceptions_found: 0
id: test
job_id: 1
lins_total: 0
network_bytes_to_source: 0
network_bytes_to_target: 0
new_files_replicated: 0
num_retransmitted_files: 0
phases: []
policy:
action: sync
file_matching_pattern:
or_criteria: null
name: test
source_exclude_directories: []
source_include_directories: []
source_root_path: /ifs/ATest
target_host: 10.**.**.**
target_path: /ifs/ATest
policy_action: sync
policy_id: 2ed973731814666a9d258db3a8875b5d
policy_name: test
quotas_deleted: 0
regular_files_replicated: 0
resynced_lins: 0
retransmitted_files: []
retry: 1
running_chunks: 0
service_report: null
sockets_replicated: 0
source_bytes_recovered: 0
source_directories_created: 0
source_directories_deleted: 0
source_directories_linked: 0
source_directories_unlinked: 0
source_directories_visited: 0
source_files_deleted: 0
source_files_linked: 0
source_files_unlinked: 0
sparse_data_bytes: 0
start_time: 1687488892
state: running
succeeded_chunks: 0
symlinks_replicated: 0
sync_type: invalid
target_bytes_recovered: 0
target_directories_created: 0
target_directories_deleted: 0
target_directories_linked: 0
target_directories_unlinked: 0
target_files_deleted: 0
target_files_linked: 0
target_files_unlinked: 0
target_snapshots: []
throughput: 0 b/s
total_chunks: 0
total_data_bytes: 0
total_exported_services: null
total_files: 0
total_network_bytes: 0
total_phases: 0
unchanged_data_bytes: 0
up_to_date_files_skipped: 0
updated_files_replicated: 0
user_conflict_files_skipped: 0
warnings: []
workers: []
worm_committed_file_conflicts: 0
type: complex