Try SpotterManage SyncIQ performance rules on PowerScale Storage System
| "added in version" 1.3.0 of dellemc.powerscale"
Authors: Spandita Panigrahi (@panigs7) <ansible.team@dell.com>
Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0
collections:
- name: dellemc.powerscale
version: 3.0.0Managing SyncIQ performance rules on PowerScale includes create a SyncIQ performance rule, modify a SyncIQ performance rule, get details of a SyncIQ performance rule, delete a SyncIQ performance rule.
- name: Create SyncIQ performance rule
dellemc.powerscale.synciqrules:
onefs_host: "{{onefs_host}}"
verify_ssl: "{{verify_ssl}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
description: "Create a rule"
enabled: true
schedule:
begin: "00:00"
end: "13:30"
days_of_week:
- "monday"
- "tuesday"
- "sunday"
rule_type: "cpu"
limit: "80"
state: "present"
- name: Modify SyncIQ performance rule
dellemc.powerscale.synciqrules:
onefs_host: "{{onefs_host}}"
verify_ssl: "{{verify_ssl}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
sync_rule_id: "cpu-0"
limit: "85"
description: "Modify the performance rule"
state: "present"
- name: Get SyncIQ performance rule details
dellemc.powerscale.synciqrules:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
sync_rule_id: "cpu-0"
state: "present"
- name: Delete SyncIQ performance rule
dellemc.powerscale.synciqrules:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
sync_rule_id: "cpu-0"
enabled: true
schedule:
begin: "00:00"
end: "13:30"
days_of_week:
- "monday"
- "tuesday"
- "sunday"
rule_type: "bandwidth"
limit: "85"
state: "absent"
limit:
description:
- It tells the amount the specified system resource type is limited by this rule.
- Units are kb/s for bandwidth, files/s for file-count, processing percentage used
for cpu, or percentage of maximum available workers.
- This is a mandatory parameter while creating/deleting a performance rule.
type: int
state:
choices:
- absent
- present
description:
- The state option is used to determine whether the performance rule exists or not.
required: true
type: str
enabled:
description:
- Indicates whether the performance rule is currently in effect during its specified
interval.
- This mandatory while creating/deleting a performance rule.
type: bool
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
schedule:
description:
- A schedule defining when during a week this performance rule is in effect.
- It is mandatory to enter schedule while creating/deleting a performance rule.
suboptions:
begin:
description:
- Start time for this schedule, during its specified days.
- It is of the format hh:mm (24 hour format).
type: str
days_of_week:
choices:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
description:
- The days in a week when the performance rule is effective.
elements: str
type: list
end:
description:
- End time for this schedule, during its specified days.
- It is of the format hh:mm (24 hour format).
type: str
type: dict
rule_type:
choices:
- bandwidth
- file_count
- cpu
- worker
description:
- The type of system resource this rule limits.
- This is mandatory parameter while creating/deleting a performance rule.
- This cannot be modified.
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
description:
description:
- User entered description of the performance rule.
type: str
api_password:
description:
- the password of the PowerScale cluster.
required: true
type: str
sync_rule_id:
description:
- This is an auto generated ID at the time of creation of SyncIQ performance rule.
- For get/modify/delete operations I(sync_rule_id) is required.
- The ID of a performance rule is not absolute to a particular existing rule configuration.
The IDs are auto-sequenced during creation/deletion of a performance rule.
type: str
changed:
description: Whether or not the resource has changed.
returned: always
type: bool
sync_rule_details:
contains:
description:
description: Description of the performance rule.
type: str
enabled:
description: Indicates whether performance rule is enabled
type: bool
id:
description: ID of the performance rule.
type: str
limit:
description: Amount the specified system resource type is limited by this rule
type: int
schedule:
description: Duration when performance rule is effective
type: str
type:
description: Type of performance rule
type: str
description: Details of the SyncIQ performance rule.
returned: When SyncIQ performance rule exists
type: complex