..
    Warning: Do not edit this file. It is automatically generated from the
    software project's code and your changes will be overwritten.

    The tool to generate this file lives in openstack-doc-tools repository.

    Please make any changes needed in the code, then run the
    autogenerate-config-doc tool from the openstack-doc-tools repository, or
    ask for help on the documentation mailing list, IRC channel or meeting.

.. _cinder-smbfs:

.. list-table:: Description of Samba volume driver configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description
   * - **[DEFAULT]**
     -
   * - ``smbfs_allocation_info_file_path`` = ``$state_path/allocation_data``
     - (String) The path of the automatically generated file containing information about volume disk space allocation.
   * - ``smbfs_default_volume_format`` = ``qcow2``
     - (String) Default format that will be used when creating volumes if no volume format is specified.
   * - ``smbfs_mount_options`` = ``noperm,file_mode=0775,dir_mode=0775``
     - (String) Mount options passed to the smbfs client. See mount.cifs man page for details.
   * - ``smbfs_mount_point_base`` = ``$state_path/mnt``
     - (String) Base dir containing mount points for smbfs shares.
   * - ``smbfs_oversub_ratio`` = ``1.0``
     - (Floating point) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.
   * - ``smbfs_shares_config`` = ``/etc/cinder/smbfs_shares``
     - (String) File with the list of available smbfs shares.
   * - ``smbfs_sparsed_volumes`` = ``True``
     - (Boolean) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time.
   * - ``smbfs_used_ratio`` = ``0.95``
     - (Floating point) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.