cohesity.dataprotect.cohesity_uda_source (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 or remove the Cohesity Protection Sources to/from a Cohesity Cluster.

When executed in a playbook, the Cohesity Protection Source 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.

# Unegister an existing Cohesity Protection Source on a selected endpoint
- cohesity_uda_source:
    server: cohesity.lab
    username: admin
    password: password
    endpoint: myvcenter.host.lab
    state: absent

Inputs

    
hosts:
    description:
    - Specifies the list of Ips/hostnames for the nodes forming UDA Source Cluster.
    elements: str
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines the state of the Protection Source
    type: str

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

os_type:
    description:
    - Type of the UDA source to be registered.
    - Field is applicable for few cluster versions.
    type: str

refresh:
    default: false
    description:
    - Switch determines whether to refresh the existing source.
    - Applicable only when source is already registered.
    type: bool

endpoint:
    description:
    - Specifies the network endpoint of the Protection Source where it is reachable. It
      could
    - be an URL or hostname or an IP address of the Protection Source
    required: true
    type: str

mount_view:
    default: false
    description: Specifies if SMB/NFS view mounting should be enabled or not.
    type: bool

db_password:
    description:
    - Password of the database.
    type: str

db_username:
    description:
    - Username of the database.
    type: str

scripts_dir:
    default: /opt/cohesity/postgres/scripts/
    description:
    - Absolute path of the scripts used to interact with the UDA source.
    type: str

source_name:
    description:
    - Specifies the name of the protection source while registering.
    required: true
    type: str

source_type:
    choices:
    - Aix
    - CockroachDB
    - DB2
    - Linux
    - MySQL
    - Other
    - PostgreSQL
    - SapASE
    - SapHana
    - SapMaxDB
    - SapOracle
    - SapSybase
    - SapSybaseIQ
    - Solaris
    - VMWareCDPFilter
    - Windows
    default: Linux
    description:
    - Type of the UDA source to be registered.
    type: str

update_source:
    default: false
    description:
    - Specifies whether to update the source, if the source is already registered.
    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

validate_certs:
    aliases:
    - cohesity_validate_certs
    default: true
    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

source_registration_args:
    description:
    - Specifies the custom arguments to be supplied to the source registration scripts.
    type: str