# Module `netapp_ontap.models.consistency_group_cifs_share`

Copyright © 2023 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Classes

`class ConsistencyGroupCifsShareSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the ConsistencyGroupCifsShare object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `access_based_enumeration: bool GET POST PATCH`

    Specifies whether all folders inside this share are visible to a user based on that individual user's access right; prevents the display of folders or other shared resources that the user does not have access to.

  `acls: List[CifsShareAcls] GET POST`

    The acls field of the consistency_group_cifs_share.

  `allow_unencrypted_access: bool GET POST PATCH`

    Specifies whether or not the SMB2 clients are allowed to access the encrypted share.

  `change_notify: bool GET POST PATCH`

    Specifies whether CIFS clients can request for change notifications for directories on this share.

  `comment: str GET POST PATCH`

    Specify the CIFS share descriptions.

    Example: HR Department Share

  `continuously_available: bool GET POST PATCH`

    Specifies whether or not the clients connecting to this share can open files in a persistent manner. Files opened in this way are protected from disruptive events, such as, failover and giveback.

  `dir_umask: Size GET POST PATCH`

    Directory mode creation mask to be viewed as an octal number.

    Example: 22

  `encryption: bool GET POST PATCH`

    Specifies whether SMB encryption must be used when accessing this share. Clients that do not support encryption are not able to access this share.

  `file_umask: Size GET POST PATCH`

    File mode creation mask to be viewed as an octal number.

    Example: 22

  `home_directory: bool GET POST`

    Specifies whether or not the share is a home directory share, where the share and path names are dynamic. ONTAP home directory functionality automatically offer each user a dynamic share to their home directory without creating an individual SMB share for each user. The ONTAP CIFS home directory feature enable us to configure a share that maps to different directories based on the user that connects to it. Instead of creating a separate shares for each user, a single share with a home directory parameters can be created. In a home directory share, ONTAP dynamically generates the share-name and share-path by substituting %w, %u, and %d variables with the corresponding Windows user name, UNIX user name, and domain name, respectively.

  `links: SelfLink GET`

    The links field of the consistency_group_cifs_share.

  `name: str GET POST`

    Specifies the name of the CIFS share that you want to create. If this is a home directory share then the share name includes the pattern as %w (Windows user name), %u (UNIX user name) and %d (Windows domain name) variables in any combination with this parameter to generate shares dynamically.

    Example: HR_SHARE

  `namespace_caching: bool GET POST PATCH`

    Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration results returned by the CIFS servers.

  `no_strict_security: bool GET POST PATCH`

    Specifies whether or not CIFS clients can follow Unix symlinks outside the share boundaries.

  `offline_files: str GET POST PATCH`

    Offline Files The supported values are:

    - none - Clients are not permitted to cache files for offline access.
    - manual - Clients may cache files that are explicitly selected by the user for offline access.
    - documents - Clients may automatically cache files that are used by the user for offline access.
    - programs - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.

    Valid choices:

    - none
    - manual
    - documents
    - programs
  `oplocks: bool GET POST PATCH`

    Specifies whether opportunistic locks are enabled on this share. "Oplocks" allow clients to lock files and cache content locally, which can increase performance for file operations.

  `show_snapshot: bool GET POST PATCH`

    Specifies whether or not the Snapshot copies can be viewed and traversed by clients.

  `unix_symlink: str GET POST PATCH`

    Controls the access of UNIX symbolic links to CIFS clients. The supported values are:

        * local - Enables only local symbolic links which is within the same CIFS share.
        * widelink - Enables both local symlinks and widelinks.
        * disable - Disables local symlinks and widelinks.

    Valid choices:

    - local
    - widelink
    - disable
  `vscan_profile: str GET POST PATCH`

    Vscan File-Operations Profile The supported values are:

    - no_scan - Virus scans are never triggered for accesses to this share.
    - standard - Virus scans can be triggered by open, close, and rename operations.
    - strict - Virus scans can be triggered by open, read, close, and rename operations.
    - writes_only - Virus scans can be triggered only when a file that has been modified is closed.

    Valid choices:

    - no_scan
    - standard
    - strict
    - writes_only