cohesity.dataprotect.cohesity_facts (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

Gather facts about Cohesity Clusters.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather facts about all nodes and supported resources in a cluster
- cohesity_facts:
    cluster: cohesity.lab
    username: admin
    password: password

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather facts about all nodes and protection sources in a cluster
- cohesity_facts:
    cluster: cohesity.lab
    username: admin
    password: password
    state: minimal
    include_sources: True

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather facts about all nodes and return active job executions in a cluster
- cohesity_facts:
    cluster: cohesity.lab
    username: admin
    password: password
    state: minimal
    include_runs: True
    active_only: True

Inputs

    
state:
    choices:
    - complete
    - minimal
    default: complete
    description:
    - Determines the level of data collection to perform. Complete will gather all details
    - currently supported by the module.  Minimal will gather basic cluster information
      but
    - not gather details about source, jobs, or executions.
    type: str

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

active_only:
    default: false
    description:
    - When True, will return only the actively running Protection Job executions.  This
      value
    - will filter the Protection Job executions data if I(active_only=yes)
    type: bool

include_jobs:
    default: false
    description:
    - When True, will return the details about all registered Protection Jobs.  This value
    - is skipped when the C(state=complete)
    type: bool

include_runs:
    default: false
    description:
    - When True, will return the details about all registered Protection Job executions.  This
      value
    - is skipped when the C(state=complete)
    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:
    default: false
    description:
    - Switch determines if SSL Validation should be enabled.
    type: bool

include_deleted:
    default: false
    description:
    - When True, will return all details about all registered Protection data included
      items marked deleted.  This value
    - will filter the Protection Sources, Jobs, and Executions data and return only current
      information if I(include_deleted=no)
    type: bool

include_sources:
    default: false
    description:
    - When True, will return the details about all registered Protection Sources.  This
      value
    - is skipped when the C(state=complete)
    type: bool

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