cohesity.dataprotect.cohesity_storage_domain (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 create or delete a storage domain from a Cohesity Cluster.

When executed in a playbook 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.

# Create a Storage Domain in the cohesity cluster.
- cohesity_storage_domain:
    server: cohesity.lab
    username: admin
    password: password
    name: StorageDomain
    cluster_partition_name: DefaultPartition
    state: present

Scanned by Steampunk Spotter

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

# Delete a storage domain from the cohesity cluster.
- cohesity_storage_domain:
    server: cohesity.lab
    username: admin
    password: password
    name: StorageDomain
    state: absent

Inputs

    
id:
    description:
    - Specifies the Id of the Storage Domain.
    - Applicable only when the domain is already created
    type: int

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

kms_server_id:
    default: None
    description: Specifies the associated KMS Server ID.
    type: int

ad_domain_name:
    description:
    - Specifies an active directory domain that this storage domain box is mapped to.
    required: false
    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

physical_quota:
    description:
    - Specifies an optional quota limit (in bytes) for the physical usage of this Storage
      Domain.
    - Supports two fields hard_limit_bytes and alert_limit_bytes
    type: dict

storage_policy:
    description:
    - Specifies the storage options applied to the Storage Domain.
    type: dict

validate_certs:
    aliases:
    - cohesity_validate_certs
    default: true
    description:
    - Switch determines if SSL Validation should be enabled.
    type: bool

ldap_provider_id:
    description: Specifies the following provides the LDAP provider the storage domain
      is mapped to.
    type: int

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

default_view_quota:
    description:
    - Specifies an optional default logical quota limit (in bytes) for the Views in this
      Storage Domain.
    - Supports two fields hard_limit_bytes and alert_limit_bytes
    type: dict

cluster_partition_id:
    default: 3
    description:
    - Specifies the Cluster Partition id where the Storage Domain is located.
    type: int

cluster_partition_name:
    description:
    - Specifies the Cluster Partition Name where the Storage Domain is located.
    type: str