Intial commit for policy update and viewbox support

1) Added option to support policy updation. 2) Storage domain creation, updation and deletion support added.
cohesity · Feb 14, 2024 · 0d02b50 · 0d02b50
1 parent 6bf1318
commit 0d02b50
Show file tree

Hide file tree

Showing 52 changed files with 961 additions and 215 deletions.
diff --git a/docs/modules/cohesity_agent.rst b/docs/modules/cohesity_agent.rst
@@ -26,8 +26,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -53,7 +53,7 @@ Parameters
 
 
   create_user (False, bool, True)
-    When enabled, will create a new user and group based on the values of *service_user* and *service_group*
+    When enabled, will create a new user and group based on the values of \ :emphasis:`service\_user`\  and \ :emphasis:`service\_group`\ 
 
     This parameter does not apply for native installations.
 
@@ -83,27 +83,27 @@ Parameters
 
 
   operating_system (optional, str, None)
-    ansible_distribution from facts, this value is automatically populated. Not given by module user
+    ansible\_distribution from facts, this value is automatically populated. Not given by module user
 
 
   service_group (optional, str, cohesityagent)
     Group underwhich permissions will be configured for the Cohesity Agent configuration.
 
-    This group must exist unless *create_user=True* is also configured.
+    This group must exist unless \ :emphasis:`create\_user=True`\  is also configured.
 
     This parameter doesn't apply for native installation.
 
 
   service_user (optional, str, cohesityagent)
     Username underwhich the Cohesity Agent will be installed and run.
 
-    This user must exist unless *create_user=True* is also configured.
+    This user must exist unless \ :emphasis:`create\_user=True`\  is also configured.
 
     This user must be an existing user for native installation.
 
 
   state (optional, str, present)
-    Determines if the agent should be ``present`` or ``absent`` from the host
+    Determines if the agent should be \ :literal:`present`\  or \ :literal:`absent`\  from the host
 
 
   upgrade (False, bool, False)

diff --git a/docs/modules/cohesity_cancel_migration.rst b/docs/modules/cohesity_cancel_migration.rst
@@ -22,8 +22,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 

diff --git a/docs/modules/cohesity_clone_vm.rst b/docs/modules/cohesity_clone_vm.rst
@@ -20,8 +20,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -69,7 +69,7 @@ Parameters
 
 
   name (True, str, None)
-    Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of the job_name:name format.
+    Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of the job\_name:name format.
 
 
   network_connected (optional, bool, True)
@@ -93,7 +93,7 @@ Parameters
 
 
   state (optional, str, present)
-    Determines if the clone vm should be ``present`` or ``absent`` from the cluster
+    Determines if the clone vm should be \ :literal:`present`\  or \ :literal:`absent`\  from the cluster
 
 
   suffix (optional, str, None)

diff --git a/docs/modules/cohesity_facts.rst b/docs/modules/cohesity_facts.rst
@@ -51,31 +51,31 @@ Parameters
   include_sources (optional, bool, False)
     When True, will return the details about all registered Protection Sources.  This value
 
-    is skipped when the ``state=complete``
+    is skipped when the \ :literal:`state=complete`\ 
 
 
   include_jobs (optional, bool, False)
     When True, will return the details about all registered Protection Jobs.  This value
 
-    is skipped when the ``state=complete``
+    is skipped when the \ :literal:`state=complete`\ 
 
 
   include_runs (optional, bool, False)
     When True, will return the details about all registered Protection Job executions.  This value
 
-    is skipped when the ``state=complete``
+    is skipped when the \ :literal:`state=complete`\ 
 
 
   active_only (optional, bool, False)
     When True, will return only the actively running Protection Job executions.  This value
 
-    will filter the Protection Job executions data if *active_only=yes*
+    will filter the Protection Job executions data if \ :emphasis:`active\_only=yes`\ 
 
 
   include_deleted (optional, bool, False)
     When True, will return all details about all registered Protection data included items marked deleted.  This value
 
-    will filter the Protection Sources, Jobs, and Executions data and return only current information if *include_deleted=no*
+    will filter the Protection Sources, Jobs, and Executions data and return only current information if \ :emphasis:`include\_deleted=no`\ 
 
 
   validate_certs (optional, bool, False)

diff --git a/docs/modules/cohesity_finalize_migration.rst b/docs/modules/cohesity_finalize_migration.rst
@@ -22,8 +22,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 

diff --git a/docs/modules/cohesity_job.rst b/docs/modules/cohesity_job.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -37,7 +37,7 @@ Parameters
 
     If not specified new list of vms will replace the existing vms available in the Protection job.
 
-    In case of tag based jobs, if append_to_existing is set to true new list of tags will be added to already available tags.
+    In case of tag based jobs, if append\_to\_existing is set to true new list of tags will be added to already available tags.
 
     Optional and only valid when (environment=VMware)
 
@@ -47,7 +47,7 @@ Parameters
 
     and a failure will be raised.
 
-    Optional and only valid when *state=stopped*
+    Optional and only valid when \ :emphasis:`state=stopped`\ 
 
 
   cluster (optional, str, None)
@@ -71,7 +71,7 @@ Parameters
   delete_backups (optional, bool, False)
     Specifies if Snapshots generated by the Protection Job should also be deleted when the Job is deleted.
 
-    Optional and only valid when *state=absent*
+    Optional and only valid when \ :emphasis:`state=absent`\ 
 
 
   delete_sources (optional, bool, False)
@@ -133,11 +133,11 @@ Parameters
   indexing (optional, dict, None)
     Specifies the list of allowed and denied indexing prefixes
 
-    Applicable only when disable_indexing is set to false.
+    Applicable only when disable\_indexing is set to false.
 
-    allowed_prefix contains list of prefixes to be allowed while indexing.
+    allowed\_prefix contains list of prefixes to be allowed while indexing.
 
-    denied_prefix contains list of prefixes to be denied while indexing.
+    denied\_prefix contains list of prefixes to be denied while indexing.
 
 
   name (True, str, None)
@@ -151,15 +151,15 @@ Parameters
   protection_policy (optional, str, Bronze)
     Valid policy name or ID for andexisting Protection Policy to be assigned to the job.
 
-    Required when *state=present*.
+    Required when \ :emphasis:`state=present`\ .
 
 
   protection_sources (optional, list, None)
-    A list of dictionaries with endpoints and paths to backup. Required when *state=present*.
+    A list of dictionaries with endpoints and paths to backup. Required when \ :emphasis:`state=present`\ .
 
     (valid only for physical sources and file based protection jobs)
 
-    protection_sources contains list of dicts(endpoint(str), paths(dict))
+    protection\_sources contains list of dicts(endpoint(str), paths(dict))
 
     excludeFilePaths - (List, defaults to empty list [], optional field) - String
 
@@ -179,7 +179,7 @@ Parameters
 
 
   storage_domain (optional, str, DefaultStorageDomain)
-    Existing Storage Domain to which the Protection Job will be associated. Required when *state=present*.
+    Existing Storage Domain to which the Protection Job will be associated. Required when \ :emphasis:`state=present`\ .
 
 
   time_zone (optional, str, America/Los_Angeles)

diff --git a/docs/modules/cohesity_migrate_vm.rst b/docs/modules/cohesity_migrate_vm.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -91,7 +91,7 @@ Parameters
 
 
   name (False, str, None)
-    Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of the name_date_time format.
+    Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of the name\_date\_time format.
 
 
   network_name (optional, str, None)
@@ -118,6 +118,14 @@ Parameters
     Specifies the resource pool name where the migrated objects are attached.
 
 
+  start_time (optional, str, None)
+    Restore tasks will be filtered by a start time specified. If not provided the start time is set to the last week.
+
+
+  end_time (optional, str, None)
+    Restore tasks will be filtered by a start time specified. If not provided the end time is the current time.
+
+
   state (optional, str, present)
     Determines the state of the Recovery Job.
 

diff --git a/docs/modules/cohesity_migration_status.rst b/docs/modules/cohesity_migration_status.rst
@@ -22,8 +22,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 

diff --git a/docs/modules/cohesity_oracle_job.rst b/docs/modules/cohesity_oracle_job.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -37,7 +37,7 @@ Parameters
 
     and a failure will be raised.
 
-    Optional and only valid when *state=stopped*
+    Optional and only valid when \ :emphasis:`state=stopped`\ 
 
 
   cluster (optional, str, None)
@@ -65,7 +65,7 @@ Parameters
   delete_backups (optional, bool, False)
     Specifies if Snapshots generated by the Protection Job should also be deleted when the Job is deleted.
 
-    Optional and only valid when *state=absent*
+    Optional and only valid when \ :emphasis:`state=absent`\ 
 
 
   description (optional, str, None)
@@ -91,7 +91,7 @@ Parameters
   protection_policy (optional, str, Bronze)
     Valid policy name or ID for andexisting Protection Policy to be assigned to the job.
 
-    Required when *state=present*.
+    Required when \ :emphasis:`state=present`\ .
 
 
   start_time (optional, str, None)
@@ -105,7 +105,7 @@ Parameters
 
 
   storage_domain (optional, str, DefaultStorageDomain)
-    Existing Storage Domain to which the Protection Job will be associated. Required when *state=present*.
+    Existing Storage Domain to which the Protection Job will be associated. Required when \ :emphasis:`state=present`\ .
 
 
   time_zone (optional, str, America/Los_Angeles)

diff --git a/docs/modules/cohesity_oracle_restore.rst b/docs/modules/cohesity_oracle_restore.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -51,7 +51,7 @@ Parameters
 
 
   state (optional, str, present)
-    Determines if the oracle recovery should be ``present`` or ``absent``.
+    Determines if the oracle recovery should be \ :literal:`present`\  or \ :literal:`absent`\ .
 
     absent is currently not implemented.
 

diff --git a/docs/modules/cohesity_oracle_source.rst b/docs/modules/cohesity_oracle_source.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 

diff --git a/docs/modules/cohesity_plugin.rst b/docs/modules/cohesity_plugin.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 

diff --git a/docs/modules/cohesity_policy.rst b/docs/modules/cohesity_policy.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 

diff --git a/docs/modules/cohesity_restore_file.rst b/docs/modules/cohesity_restore_file.rst
@@ -24,8 +24,8 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 3.6
-- cohesity_management_sdk >= 1.6.0
+- python \>= 3.6
+- cohesity\_management\_sdk \>= 1.6.0
 
 
 
@@ -59,7 +59,7 @@ Parameters
 
 
   name (True, str, None)
-    Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of the job_name:name format.
+    Descriptor to assign to the Recovery Job.  The Recovery Job name will consist of the job\_name:name format.
 
 
   environment (False, str, PhysicalFiles)