dellemc.powerstore.dellemc_powerstore_replicationrule (1.3.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==1.3.0

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 1.3.0

Description

Performs all replication rule operations on a PowerStore Storage System. This module supports get details of an existing replication rule. Create new replication rule for all supported parameters. Modify replication rule with supported parameters. Delete a specific replication rule.

Requirements

• A Dell EMC PowerStore Storage System.
• Ansible 2.9 or 2.10

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create new replication rule
  dellemc_powerstore_replicationrule:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    replication_rule_name: "sample_replication_rule"
    rpo: "Five_Minutes"
    alert_threshold: "15"
    remote_system: "WN-D8877"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify existing replication rule
  dellemc_powerstore_replicationrule:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    replication_rule_name: "sample_replication_rule"
    new_name: "new_sample_replication_rule"
    rpo: "One_Hour"
    alert_threshold: "60"
    remote_system: "WN-D0517"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get details of replication rule
  dellemc_powerstore_replicationrule:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    replication_rule_id: "{{id}}"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete an existing replication rule
  dellemc_powerstore_replicationrule:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    replication_rule_name: "new_sample_replication_rule"
    state: "absent"

Inputs

    
rpo:
    choices:
    - Five_Minutes
    - Fifteen_Minutes
    - Thirty_Minutes
    - One_Hour
    - Six_Hours
    - Twelve_Hours
    - One_Day
    description:
    - Recovery point objective (RPO), which is the acceptable amount of data, measured
      in units of time, that may be lost in case of a failure.
    required: false
    type: str

user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description:
    - The state of the replication rule after the task is performed.
    - For Delete operation only, it should be set to "absent".
    - For all Create, Modify or Get details operations it should be set to "present".
    required: true
    type: str

array_ip:
    description:
    - IP or FQDN of the PowerStore management system.
    required: true
    type: str

new_name:
    description:
    - New name of the replication rule.
    - Used for renaming a replication rule.
    required: false
    type: str

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

verifycert:
    choices:
    - true
    - false
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

remote_system:
    description:
    - ID or name of the remote system to which this rule will replicate the associated
      resources.
    required: false
    type: str

alert_threshold:
    description:
    - Acceptable delay between the expected and actual replication sync intervals. The
      system generates an alert if the delay between the expected and actual sync exceeds
      this threshold.
    - During creation, if not passed, then by default one RPO in minutes will be passed.
    - The range of integers supported are in between 0 and 1440 (inclusive of both).
    required: false
    type: int

replication_rule_id:
    description:
    - ID of the replication rule.
    - ID for the rule is autogenerated, cannot be passed during creation of a replication
      rule.
    - replication_rule_name and replication_rule_id are mutually exclusive.
    required: false
    type: str

replication_rule_name:
    description:
    - Name of the replication rule.
    - Required during creation of a replication rule.
    - replication_rule_name and replication_rule_id are mutually exclusive.
    required: false
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool
replication_rule_details:
  contains:
    alert_threshold:
      description: Acceptable delay in minutes between the expected and actual replication
        sync intervals.
      type: int
    id:
      description: The system generated ID of the replication rule.
      type: str
    name:
      description: Name of the replication rule.
      type: str
    remote_system_id:
      description: Unique identifier of the remote system to which this rule will
        replicate the associated resources.
      type: str
    remote_system_name:
      description: Name of the remote system to which this rule will replicate the
        associated resources.
      type: str
    rpo:
      description: Recovery point objective (RPO), which is the acceptable amount
        of data, measured in units of time, that may be lost in case of a failure.
      type: str
  description: Details of the replication rule.
  returned: When replication rule exists
  type: complex