cohesity / cohesity.dataprotect / 1.0.10 / module / cohesity_agent Management of Cohesity Physical Agent | "added in version" 1.0.8 of cohesity.dataprotect" Authors: Naveena (@naveena-maplelabs)cohesity.dataprotect.cohesity_agent (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 deploy or remove the Cohesity Physical Agent from supported Linux 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.
# Install the current version of the agent on Linux - cohesity_agent: server: cohesity.lab cohesity_admin: admin cohesity_password: password state: present
# Install the current version of the agent with custom User and Group - cohesity_agent: server: cohesity.lab cohesity_admin: admin cohesity_password: password state: present service_user: cagent service_group: cagent create_user: True
# Removes the current installed agent from the host - cohesity_agent: server: cohesity.lab cohesity_admin: admin cohesity_password: password state: absent
# Download the agent installer to a custom location. - cohesity_agent: server: cohesity.lab cohesity_admin: admin cohesity_password: password download_location: /software/installers state: present
# Install the current version of the agent on Linux using native installers, the service user here should be an # existing user - cohesity_agent: server: cohesity.lab cohesity_admin: admin cohesity_password: password state: present service_user: cagent native_package: True
# Install the cohesity agent using native package downloaded from given URI. Here, the Cohesity cluster credentials are not required - cohesity_agent: state: present service_user: cagent native_package: True download_uri: 'http://10.2.145.47/files/bin/installers/el-cohesity-agent-6.3-1.x86_64.rpm'
host: default: '' description: - Host name of the source. type: str state: choices: - present - absent default: present description: - Determines if the agent should be C(present) or C(absent) from the host type: str cluster: aliases: - cohesity_server description: - IP or FQDN for the Cohesity Cluster type: str upgrade: default: false description: - If set to true and agent is already installed in the source, agent will be upgraded. required: false type: bool file_based: default: false description: - When enabled, will install the agent in non-LVM mode and support only file based backups. required: false type: bool create_user: default: true description: - When enabled, will create a new user and group based on the values of I(service_user) and I(service_group) - This parameter does not apply for native installations. required: false type: bool download_uri: default: '' description: - The download uri from where the installer can be downloaded type: str service_user: default: cohesityagent description: - Username underwhich the Cohesity Agent will be installed and run. - This user must exist unless I(create_user=True) is also configured. - This user must be an existing user for native installation. type: str wait_minutes: default: 30 description: - Wait time for agent installation. required: false type: int service_group: default: cohesityagent description: - Group underwhich permissions will be configured for the Cohesity Agent configuration. - This group must exist unless I(create_user=True) is also configured. - This parameter doesn't apply for native installation. type: str 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 native_package: default: false description: - When enabled, native installer packages are used based on the operating system type: bool validate_certs: aliases: - cohesity_validate_certs default: true description: - Switch determines if SSL Validation should be enabled. type: bool operating_system: description: - ansible_distribution from facts, this value is automatically populated. Not given by module user type: str cohesity_password: aliases: - password - admin_pass description: - Password belonging to the selected Username. This parameter will not be logged. type: str download_location: description: - Optional directory path to which the installer will be downloaded. If not selected, then a temporary - directory will be created in the default System Temp Directory. When choosing an alternate directory, - the directory and installer will not be deleted at the end of the execution. type: str