cohesity.dataprotect.cohesity_policy (1.1.9) — module

Install collection

Install with ansible-galaxy collection install cohesity.dataprotect:==1.1.9

Add to requirements.yml

  collections:
    - name: cohesity.dataprotect
      version: 1.1.9

Description

Ansible Module used to create/update/remove protection policy on a Cohesity Cluster.

When executed in a playbook, the Cohesity Policy will be validated and the appropriate state action

will be applied.

Requirements

• python >= 3.6
• cohesity_management_sdk >= 1.6.0

Usage examples

Scanned by Steampunk Spotter

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

# Create a protection policy.
- cohesity_policy:
    cluster: cohesity.lab
    username: admin
    password: password
    state: present
    name: 'Ansible'
    incremental_backup_schedule:
        periodicity: Daily

Scanned by Steampunk Spotter

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

# Delete a protection policy.

- cohesity_policy:
    cluster: cohesity.lab
    username: admin
    password: password
    state: present
    name: 'Ansible'

Inputs

    
name:
    description: Specifies the name of the protection policy.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines the state of the Policy.
    - (C)present a policy will be created.
    - (C)absent will remove the policy.
    type: str

cluster:
    aliases:
    - cohesity_server
    description:
    - IP or FQDN for the Cohesity Cluster
    type: str

retries:
    default: 3
    description: Specifies the retry count while policy creation.
    type: int

description:
    default: ''
    description: Specifies the description for the policy created
    type: str

archival_copy:
    description: Specifies the list of external targets to be added while creating policy.
    elements: dict
    type: list

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
    - AD.domain.com/username
    - AD.domain.com/username@tenant
    - LOCAL/username@tenant
    type: str

days_to_retain:
    default: 90
    description: Specifies the number of retention days.
    type: int

retry_interval:
    default: 30
    description: Specifies the retry interval.
    type: int

validate_certs:
    aliases:
    - cohesity_validate_certs
    default: true
    description:
    - Switch determines if SSL Validation should be enabled.
    type: bool

blackout_window:
    description: Specifies the list of blackout windows.
    elements: dict
    type: list

replication_copy:
    description: Specifies the list of replication cluster to be added while creating
      policy.
    elements: dict
    type: list

cohesity_password:
    aliases:
    - password
    - admin_pass
    description:
    - Password belonging to the selected Username.  This parameter will not be logged.
    type: str

extended_retention:
    description: Specifies the extended retention
    elements: dict
    type: list

bmr_backup_schedule:
    description: ' BMR backup schedule.'
    type: dict

log_backup_schedule:
    description: Specifies the log backup schedule for policy creation
    type: dict

full_backup_schedule:
    description: Specifies the full backup schedule for policy creation
    type: dict

incremental_backup_schedule:
    description: Specifies the incremental backup schedule for policy creation
    required: true
    type: dict