cohesity / cohesity.dataprotect / 1.0.10 / module / cohesity_uda_protection_group Management of Cohesity UDA Protection Groups | "added in version" 1.0.10 of cohesity.dataprotect" Authors: Naveena (@naveena-maplelabs)cohesity.dataprotect.cohesity_uda_protection_group (1.0.10) — module
Install with ansible-galaxy collection install cohesity.dataprotect:==1.0.10
collections: - name: cohesity.dataprotect version: 1.0.10
Ansible Module used to register, remove, start, and stop the Cohesity Protection Group on a Cohesity Cluster.
When executed in a playbook, the Cohesity Protection Group will be validated and the appropriate state action
will be applied.
# Create a new UDA Protection Group - cohesity_uda_group: cluster: cohesity.lab username: admin password: password state: present name: myhost endpoint: cohesity-source-ip protection_policy: Bronze storage_domain: Default
name: aliases: - protection_group_name description: - Name to assign to the Protection Group required: true type: str state: choices: - present - absent - started - stopped default: present description: - Determines the state of the Protection Group type: str mounts: default: 1 description: - Specifies the maximum number of view mounts per host. type: int cluster: aliases: - cohesity_server description: - IP or FQDN for the Cohesity Cluster type: str objects: description: Defines the list of objects to be protected. elements: str type: list endpoint: description: Ip address of the Uda host. type: str is_paused: default: true description: - Switch determines whether the newly created job run should be enabled or not. type: bool time_zone: default: America/Los_Angeles description: - Specifies the timezone to use when calculating time for this Protection Group such as the Group start time. type: str start_time: default: 00:00 description: - Specifies the registered start time for the Protection Group. Format must be 24hr time in either HHMM or HH:MM style. - If not configured then the Cluster will automatically select a time. type: str concurrency: default: 1 description: - Specifies the maximum number of concurrent IO Streams that will be created to exchange data with the cluster. type: int description: description: - Optional Description to assign to the Protection Group type: str environment: default: UDA description: - Specifies the environment type of the group. required: false type: str cancel_active: default: false description: - Specifies if Current Running Backup Group should be canceled. If False, active groups will not be stopped - and a failure will be raised. - Optional and only valid when I(state=stopped) type: bool cohesity_admin: aliases: - admin_name - cohesity_user - username description: - Username with which Ansible will connect to the Cohesity Cluster. Domain Specific credentails can be configured in following formats - username@AD.domain.com - AD.domain.com/username@tenant - LOCAL/username@tenant - Domain/username (Will be deprecated in future) type: str delete_backups: default: false description: - Specifies if Snapshots generated by the Protection Group should also be deleted when the Group is deleted. - Optional and only valid when I(state=absent) type: bool storage_domain: default: DefaultStorageDomain description: - Existing Storage Domain to which the Protection Group will be associated. Required when I(state=present). type: str validate_certs: aliases: - cohesity_validate_certs default: false description: - Switch determines if SSL Validation should be enabled or not. type: bool log_backup_args: default: '' description: - Specifies the custom arguments to be supplied to the log backup script when a log backup is enabled in the policy. type: str full_backup_args: default: '' description: - Specifies the custom arguments to be supplied to the full backup script when a full backup is enabled in the policy. type: str incr_backup_args: default: '' description: - Specifies the custom arguments to be supplied to the incremental backup script when an incremental backup is enabled in the policy. type: str cohesity_password: aliases: - password - admin_pass description: - Password belonging to the selected Username. This parameter will not be logged. type: str ondemand_run_type: choices: - Regular - Full - Log - System default: Regular description: - Specifies the type of OnDemand Backup. type: str protection_policy: aliases: - policy default: Bronze description: - Valid policy name or ID for andexisting Protection Policy to be assigned to the group. - Required when I(state=present). type: str