Try SpotterManagement of Cohesity Protection Sources
| "added in version" 1.1.9 of cohesity.dataprotect"
Authors: Naveena (@naveena-maplelabs)
Install with ansible-galaxy collection install cohesity.dataprotect:==1.1.9
collections:
- name: cohesity.dataprotect
version: 1.1.9Ansible 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.
# Register a Physical Cohesity Protection Source on a selected Linux endpoint using Defaults
- cohesity_source:
server: cohesity.lab
username: admin
password: password
endpoint: mylinux.host.lab
state: present
# Register a Physical Cohesity Protection Source on a selected Windows endpoint
- cohesity_source:
server: cohesity.lab
username: admin
password: password
endpoint: mywindows.host.lab
environment: Physical
host_type: Windows
state: present
# Register a VMware Cohesity Protection Source on a selected endpoint
- cohesity_source:
server: cohesity.lab
username: admin
password: password
endpoint: myvcenter.host.lab
environment: VMware
source_username: admin@vcenter.local
source_password: vmware
vmware_type: Vcenter
state: present
# Register a NAS Cohesity Protection Source on a selected NFS mountpoint
- cohesity_source:
server: cohesity.lab
username: admin
password: password
endpoint: mynfs.host.lab:/exports
environment: GenericNas
state: present
# Register a NAS Cohesity Protection Source on a selected SMB share
- cohesity_source:
server: cohesity.lab
username: admin
password: password
endpoint: \\myfileserver.host.lab\data
environment: GenericNas
nas_protocol: SMB
nas_username: DOMAIN/administrator or administrator@DOMAIN
nas_password: password
state: present
# Unegister an existing Cohesity Protection Source on a selected endpoint
- cohesity_source:
server: cohesity.lab
username: admin
password: password
endpoint: myvcenter.host.lab
environment: VMware
state: absent
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
refresh:
default: false
description:
- Switch determines whether to refresh the existing source.
- Applicable only when source is already registered.
type: bool
timeout:
default: 120
description:
- Wait time in seconds while registering/updating source.
type: int
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 or a NAS Share/Export
Path.
required: true
type: str
nas_type:
default: Host
description:
- Specifies the type of connection for the NAS Mountpoint.
type: str
host_type:
choices:
- Linux
- Windows
- Aix
default: Linux
description:
- Specifies the optional OS type of the Protection Source (such as C(Windows) or C(Linux)).
- C(Linux) indicates the Linux operating system.
- C(Windows) indicates the Microsoft Windows operating system.
- C(Aix) indicates the IBM AIX operating system.
- Optional when I(state=present) and I(environment=Physical).
type: str
environment:
choices:
- VMware
- Physical
- GenericNas
- SQL
default: Physical
description:
- Specifies the environment type (such as VMware or SQL) of the Protection Source
this Job
- is protecting. Supported environment types include 'Physical', 'VMware', 'GenericNas'
required: false
type: str
vmware_type:
choices:
- VCenter
- Folder
- Datacenter
- ComputeResource
- ClusterComputeResource
- ResourcePool
- Datastore
- HostSystem
- VirtualMachine
- VirtualApp
- StandaloneHost
- StoragePod
- Network
- DistributedVirtualPortgroup
- TagCategory
- Tag
default: VCenter
description:
- Specifies the entity type such as C(VCenter) if the environment is C(VMware).
type: str
nas_password:
description:
- Specifies the password to accessthe target NAS Environment.
- This parameter will not be logged.
- Required when I(state=present) and I(environment=GenericNas) and I(nas_protocol=SMB)
type: str
nas_protocol:
choices:
- NFS
- SMB
default: NFS
description:
- Specifies the protocol type of connection for the NAS Mountpoint.
- SMB Share paths must be in \\server\share format.
- Required when I(state=present) and I(environment=GenericNas)
type: str
nas_username:
description:
- Specifies username to access the target NAS Environment.
- Supported Format is Username or username@domain or Domain/username (will be deprecated
in future).
- Required when I(state=present) and I(environment=GenericNas) and I(nas_protocol=SMB)
type: str
physical_type:
choices:
- Host
- WindowsCluster
default: Host
description:
- Specifies the entity type such as C(Host) if the I(environment=Physical).
- C(Host) indicates a single physical server.
- C(WindowsCluster) indicates a Microsoft Windows cluster.
- Optional when I(state=present) and I(environment=Physical).
type: str
update_source:
default: false
description:
- Switch determines whether to update the existing source.
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
force_register:
default: false
description:
- Enabling this option will force the registration of the Cohesity Protection Source.
type: bool
validate_certs:
aliases:
- cohesity_validate_certs
default: true
description:
- Switch determines if SSL Validation should be enabled.
type: bool
skip_validation:
default: false
description: Switch for source validation during registeration.
type: bool
source_password:
description:
- Specifies the password to access the target source.
- This parameter will not be logged.
- Required when I(state=present) and I(environment=VMware)
type: str
source_username:
description:
- Specifies username to access the target source.
- Required when I(state=present) and I(environment=VMware)
type: str
cohesity_password:
aliases:
- password
- admin_pass
description:
- Password belonging to the selected Username. This parameter will not be logged.
type: str