cohesity.dataprotect.cohesity_oracle_job (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 register, remove, start, and stop the Cohesity Protection Job on a Cohesity Cluster.

When executed in a playbook, the Cohesity Protection Job 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 new Oracle Server Protection Job
- cohesity_oracle_job:
    cluster: cohesity.lab
    username: admin
    password: password
    state: present
    name: myhost
    endpoint: cohesity-source-ip
    protection_policy: Bronze
    storage_domain: Default

Inputs

    
name:
    aliases:
    - job_name
    description:
    - Name to assign to the Protection Job
    required: true
    type: str

state:
    choices:
    - present
    - absent
    - started
    - stopped
    default: present
    description:
    - Determines the state of the Protection Job
    type: str

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

endpoint:
    description: Ip address of the Oracle source.
    type: str

databases:
    description:
    - list of databases to be selected for backup job creation.
    elements: str
    type: list

time_zone:
    default: America/Los_Angeles
    description:
    - Specifies the timezone to use when calculating time for this Protection Job such
      as the Job start time.
    type: str

start_time:
    description:
    - Specifies the registered start time for the Protection Job.  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

description:
    description:
    - Optional Description to assign to the Protection Job
    type: str

environment:
    default: kOracle
    description:
    - Specifies the environment type of the job.
    required: false
    type: str

cancel_active:
    default: false
    description:
    - Specifies if Current Running Backup Job should be canceled.  If False, active jobs
      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
    - AD.domain.com/username
    - AD.domain.com/username@tenant
    - LOCAL/username@tenant
    type: str

delete_backups:
    default: false
    description:
    - Specifies if Snapshots generated by the Protection Job should also be deleted when
      the Job is deleted.
    - Optional and only valid when I(state=absent)
    type: bool

storage_domain:
    default: DefaultStorageDomain
    description:
    - Existing Storage Domain to which the Protection Job 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.
    type: bool

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
      job.
    - Required when I(state=present).
    type: str