dellemc.powerstore.replicationrule (3.2.0) — module

Replication rule operations on a PowerStore storage system

| "added in version" 1.2.0 of dellemc.powerstore"

Authors: P Srinivas Rao (@srinivas-rao5) <ansible.team@dell.com>

Install collection

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


Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.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 supported parameters, modify replication rule and delete a specific replication rule.


Requirements

Usage examples

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

- name: Create new replication rule
  dellemc.powerstore.replicationrule:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    replication_rule_name: "sample_replication_rule"
    rpo: "Five_Minutes"
    alert_threshold: "15"
    remote_system: "WN-D8877"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify existing replication rule
  dellemc.powerstore.replicationrule:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get details of replication rule
  dellemc.powerstore.replicationrule:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    replication_rule_id: "{{id}}"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete an existing replication rule
  dellemc.powerstore.replicationrule:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    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

port:
    description:
    - Port number for the PowerStore array.
    - If not passed, it will take 443 as default.
    type: int

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 C(absent).
    - For all Create, Modify or Get details operations it should be set to C(present).
    required: true
    type: str

timeout:
    default: 120
    description:
    - Time after which the connection will get terminated.
    - It is to be mentioned in seconds.
    type: int

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.
    type: str

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

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

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - C(false) - indicates that the SSL certificate should not be verified.
    type: bool

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.
    - Parameter I(replication_rule_name) and I(replication_rule_id) are mutually exclusive.
    type: str

remote_system_address:
    description:
    - The management IPv4 address of the remote system.
    - It is required in case the remote system name passed in I(remote_system) parameter
      is not unique on the PowerStore Array.
    - If ID of the remote system is passed then no need to pass I(remote_system_address).
    required: false
    type: str

replication_rule_name:
    description:
    - Name of the replication rule.
    - Required during creation of a replication rule.
    - Parameter I(replication_rule_name) and I(replication_rule_id) are mutually exclusive.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  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
  sample:
    alert_threshold: 15
    id: 0a9dc368-3085-4f4b-b7a4-23ec0166542f
    is_replica: false
    name: sample_replication_rule
    policies: []
    remote_system_id: 677f64ff-955a-49ce-9a06-7d5af0ec4929
    remote_system_name: RT-D0101
    rpo: Thirty_Minutes
  type: complex