ctera.ctera.ctera_filer_share (2.2.17) — module

Install collection

Install with ansible-galaxy collection install ctera.ctera:==2.2.17

Add to requirements.yml

  collections:
    - name: ctera.ctera
      version: 2.2.17

Description

Create, modify and delete shares.

This module does not handle the creation of the directory and share creation will fail if the directory does not exist

Requirements

• A physical or virtual CTERA-Networks Gateway
• Ansible 2.8
• Python3 cterasdk. Install using 'pip install cterasdk'

Usage examples

Scanned by Steampunk Spotter

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

- name: create local share
  ctera_filer_share:
    name: demo
    directory: /main/public/demo
    acl:
      - { name: 'Everyone', type: 'LocalGroup', perm: 'ReadWrite' }
      - { name: 'CTERA\Support', type: 'DomainGroup', perm: 'ReadWrite' }
      - { name: 'admin', type: 'LocalUser', perm: 'ReadWrite' }
      - { name: 'jsmith@ctera.com', type: 'DomainUser', perm: 'ReadOnly' }
    access: authenticated
    ctera_host: "{{ ctera_filer_hostname }}"
    ctera_user: "{{ ctera_filer_user }}"
    ctera_password: "{{ ctera_filer_password }}"

Inputs

    
acl:
    description: List of Access Control Entries
    elements: dict
    suboptions:
      name:
        description: The name of the user or group
        required: true
        type: str
      perm:
        choices:
        - ReadWrite
        - ReadOnly
        - None
        description: The file access permission
        required: true
        type: str
      principal_type:
        choices:
        - LocalUser
        - LocalGroup
        - DomainUser
        - DomainGroup
        description: The principal type
        required: true
        type: str
    type: list

csc:
    choices:
    - manual
    - documents
    - disable
    default: manual
    description: The client side caching (offline files) configuration
    type: str

name:
    description: The name of the share
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified share should exist or not.
    type: str

access:
    choices:
    - winAclMode
    - authenticated
    default: winAclMode
    description: The Windows File Sharing authentication mode
    type: str

comment:
    description: Comment
    type: str

indexed:
    default: false
    description: Enabled indexing
    type: bool

directory:
    description:
    - The directory to share
    - Required when C(state=present) and the share does not exist
    type: str

ctera_host:
    description: IP Address or FQDN of the CTERA Networks Host
    required: true
    type: str

ctera_port:
    description: Connection port to the Host
    type: int

ctera_user:
    description: User Name for communicating with the CTERA Networks Host
    required: true
    type: str

ctera_https:
    default: true
    description: Connect to the Host using HTTPS
    type: bool

export_to_afp:
    default: false
    description: Export the share to AFP
    type: bool

export_to_ftp:
    default: false
    description: Export the share to FTP
    type: bool

export_to_nfs:
    default: false
    description: Export the share to NFS
    type: bool

ctera_password:
    description: Password of the user
    required: true
    type: str

dir_permissions:
    default: 777
    description: Directory Permission
    type: int

export_to_rsync:
    default: false
    description: Export the share to RSync
    type: bool

export_to_pc_agent:
    default: false
    description: Export the share to PC Agent
    type: bool

trusted_nfs_clients:
    description: Trusted NFS v3 clients
    elements: dict
    suboptions:
      address:
        description: IP address, hostname or fully qualified domain name of client machine
        required: true
        type: str
      netmask:
        description: Subnet mask
        required: true
        type: str
      perm:
        choices:
        - ReadWrite
        - ReadOnly
        - None
        description: File access permission
        required: true
        type: str
    type: list

ctera_trust_certificate:
    default: false
    description: Trust unverified certificates
    type: bool

Outputs

name:
  description: The name of the managed share
  returned: Always
  sample: demo
  type: str