/ home / cohesity / cohesity.dataprotect / 1.1.9 / module / cohesity_win_agent

cohesity.dataprotect.cohesity_win_agent (1.1.9) — module

Management of Cohesity Physical Windows Agent

| "added in version" 1.1.9 of cohesity.dataprotect"

Authors: Naveena (@naveena-maplelabs)

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 deploy or remove the Cohesity Physical Agent from supported Windows Machines.

When executed in a playbook, the Cohesity Agent installation will be validated and the appropriate

state action will be applied. The most recent version of the Cohesity Agent will be automatically

downloaded to the host.

Requirements

python >= 3.6
cohesity_management_sdk >= 1.6.0

Usage examples

Scanned by Steampunk Spotter

# Install the current version of the agent on Windows
- cohesity_win_agent:
    server: cohesity.lab
    username: admin
    password: password
    state: present

Scanned by Steampunk Spotter

# Install the current version of the agent with custom Service Username/Password
- cohesity_win_agent:
    server: cohesity.lab
    username: admin
    password: password
    state: present
    service_user: cagent
    service_password: cagent

Scanned by Steampunk Spotter

# Install the current version of the agent using FileSystem ChangeBlockTracker
- cohesity_win_agent:
    server: cohesity.lab
    username: admin
    password: password
    state: present
    install_type: fscbt

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines if the agent should be C(present) or C(absent) from the host

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

install_type:
    choices:
    - volcbt
    - fscbt
    - allcbt
    - onlyagent
    default: volcbt
    description:
    - Installation type for the Cohesity Agent on Windows

service_user:
    description:
    - Username with which Cohesity Agent will be installed

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

preservesettings:
    default: 'no'
    description:
    - Should the settings be retained when uninstalling the Cohesity Agent
    type: bool

service_password:
    description:
    - Password belonging to the selected Username.  This parameter will not be logged.

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