Module for Storage domain and Policy update

Author: naveena-maplelabs

docs/modules/cohesity_storage_domain.rst

@@ -0,0 +1,132 @@
+.. _cohesity_storage_domain_module:
+
+
+cohesity_storage_domain -- Management of Cohesity Storage Domains.
+==================================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Ansible Module used to create or remove a storage domain from a Cohesity Cluster.
+
+When executed in a playbook the appropriate state action will be applied.
+
+
+
+
+
+
+Parameters
+----------
+
+  cluster (optional, str, None)
+    IP or FQDN for the Cohesity Cluster
+
+
+  cohesity_admin (optional, str, None)
+    Username with which Ansible will connect to the Cohesity Cluster. Domain Specific credentails can be configured in following formats
+
+    AD.domain.com/username
+
+    AD.domain.com/username@tenant
+
+    LOCAL/username@tenant
+
+
+  cohesity_password (optional, str, None)
+    Password belonging to the selected Username. This parameter will not be logged.
+
+
+  ad_domain_name (False, str, None)
+    Specifies the active directory name that the view box is mapped to.
+
+
+  cluster_partition_id (optional, int, 3)
+    The Cluster Partition id where the Storage Domain (View Box) will be created.
+
+
+  state (optional, str, present)
+    Determines the state of the storage domain.
+
+
+  cluster_partition_name (optional, str, DefaultPartition)
+    Name of the cluster partition where the Storage Domain (View Box) will be created.
+
+
+  default_view_quota (optional, str, False)
+    Specifies an optional default logical quota limit (in bytes) for the Views in this Storage Domain (View Box).
+
+
+  kms_Server_id (optional, str, None)
+    Specifies the associated KMS Server ID.
+
+
+  validate_certs (optional, bool, True)
+    Switch determines if SSL Validation should be enabled.
+
+
+  ldap_provider_id (optional, str, None)
+    When set, the following provides the LDAP provider the view box is mapped to.
+
+
+  storage_policy (optional, dict, None)
+    Specifies the storage options applied to the Storage Domain (View Box).
+
+    Supports keys duplicate and compression\_policy.
+
+
+  erasure_coding_params (optional, dict, None)
+    Specifies information for erasure coding.
+
+
+
+
+
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+    
+    # Create a view box in the cohesity cluster.
+    - cohesity_storage_domain:
+        server: cohesity.lab
+        username: admin
+        password: password
+        name: Custom
+        partition_name: DefaultPartition
+        state: present
+
+    # Remove a viewbox from the cohesity cluster.
+    - cohesity_storage_domain:
+        server: cohesity.lab
+        username: admin
+        password: password
+        name: Custom
+        state: absent
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Naveena (@naveena-maplelabs)
+

playbooks/storage_domain_workflow/create_storage_domain.yaml

@@ -0,0 +1,16 @@
+# Playbook to create storage domain (view-box).
+---
+- hosts: localhost
+  become: false
+  collections:
+    - cohesity.dataprotect
+  tasks:
+    - name: Create view box in the cohesity server.
+      cohesity_storage_domain:
+        cluster: "{{ cohesity_server }}"
+        username: "{{ cohesity_username }}"
+        password: "{{ cohesity_password }}"
+        validate_certs: "{{ cohesity_validate_certs }}"
+        name: 'Ansible'
+        state: 'present'
+        cluster_partition_id: 3

playbooks/storage_domain_workflow/delete_storage_domain.yaml

@@ -0,0 +1,16 @@
+# Playbook to delete a storage domain (view-box).
+---
+- hosts: localhost
+  become: false
+  collections:
+    - cohesity.dataprotect
+  tasks:
+    - name: Create view box in the cohesity server.
+      cohesity_storage_domain:
+        cluster: "{{ cohesity_server }}"
+        username: "{{ cohesity_username }}"
+        password: "{{ cohesity_password }}"
+        validate_certs: "{{ cohesity_validate_certs }}"
+        name: 'Ansible'
+        state: 'absent'
+  

plugins/modules/cohesity_policy.py

@@ -457,6 +457,81 @@ def create_policy(module):
         raise__cohesity_exception__handler(error, module)
 
 
+
+def update_policy(module, policy):
+    """
+    Function to update a protection policy.
+    :param module: object that holds parameters passed to the module
+    :param policy: existing policy object.
+    :return:
+    """
+    try:
+        policy = ProtectionPolicyRequest()
+        policy.name = module.params.get("name")
+        policy.description = module.params.get("description")
+        policy.days_to_keep = module.params.get("days_to_retain")
+        policy.retries = module.params.get("retries")
+        policy.retry_interval_mins = module.params.get("retry_interval")
+        if module.params.get("blackout_window"):
+            policy.blackout_periods = blackout_window(module)
+
+        if module.params.get("incremental_backup_schedule"):
+            policy.incremental_scheduling_policy = policy_schedule(
+                module, module.params.get("incremental_backup_schedule")
+            )
+
+        if module.params.get("full_backup_schedule"):
+            policy.full_scheduling_policy = policy_schedule(
+                module, module.params.get("full_backup_schedule")
+            )
+
+        if module.params.get("log_backup_schedule"):
+            policy.log_scheduling_policy = policy_schedule(
+                module, module.params.get("log_backup_schedule")
+            )
+            policy.days_to_keep_log = module.params.get(
+                "log_backup_schedule"
+            ).get("days_to_retain", module.params.get("days_to_retain"))
+
+        if module.params.get("bmr_backup_schedule"):
+            policy.system_scheduling_policy = policy_schedule(
+                module, module.params.get("bmr_backup_schedule")
+            )
+            policy.days_to_keep_system = module.params.get(
+                "bmr_backup_schedule"
+            ).get("days_to_retain", module.params.get("days_to_retain"))
+
+        if module.params.get("extended_retention"):
+            policy.extended_retention_policies = extended_retention(module)
+
+        if module.params.get("replication_copy"):
+            policy.snapshot_replication_copy_policies = (
+                replication_copy_policies(module)
+            )
+        if module.params.get("archival_copy"):
+            policy.snapshot_archival_copy_policies = archival_copy_policies(
+                module
+            )
+
+        policy_response = cohesity_client.protection_policies.update_protection_policy(
+            policy, policy.id
+        )
+
+        result = dict(
+            changed=True,
+            msg="Cohesity protection policy is updated successfully",
+            id=policy_response.id,
+            task_name=module.params.get("name"),
+        )
+        module.exit_json(**result)
+    except APIException as ex:
+        raise__cohesity_exception__handler(
+            str(json.loads(ex.context.response.raw_body)), module
+        )
+    except Exception as error:
+        raise__cohesity_exception__handler(error, module)
+
+
 def delete_policy(module, policy_id):
     """
     function to delete the protection policy
@@ -569,6 +644,7 @@ def main():
         module.exit_json(**check_mode_results)
 
     elif module.params.get("state") == "present":
+        update_policy = update_policy(module, policy_details)
         if policy_exists:
             results = dict(
                 changed=False,