# Smb

{% code fullWidth="true" %}

```
NAME:
   singularity storage update smb - SMB / CIFS

USAGE:
   singularity storage update smb [command options] <name|id>

DESCRIPTION:
   --host
      SMB server hostname to connect to.
      
      E.g. "example.com".

   --user
      SMB username.

   --port
      SMB port number.

   --pass
      SMB password.

   --domain
      Domain name for NTLM authentication.

   --spn
      Service principal name.
      
      Rclone presents this name to the server. Some servers use this as further
      authentication, and it often needs to be set for clusters. For example:
      
          cifs/remotehost:1020
      
      Leave blank if not sure.
      

   --use-kerberos
      Use Kerberos authentication.
      
      If set, rclone will use Kerberos authentication instead of NTLM. This
      requires a valid Kerberos configuration and credentials cache to be
      available, either in the default locations or as specified by the
      KRB5_CONFIG and KRB5CCNAME environment variables.
      

   --idle-timeout
      Max time before closing idle connections.
      
      If no connections have been returned to the connection pool in the time
      given, rclone will empty the connection pool.
      
      Set to 0 to keep connections indefinitely.
      

   --hide-special-share
      Hide special shares (e.g. print$) which users aren't supposed to access.

   --case-insensitive
      Whether the server is configured to be case-insensitive.
      
      Always true on Windows shares.

   --kerberos-ccache
      Path to the Kerberos credential cache (krb5cc).
      
      Overrides the default KRB5CCNAME environment variable and allows this
      instance of the SMB backend to use a different Kerberos cache file.
      This is useful when mounting multiple SMB with different credentials
      or running in multi-user environments.
      
      Supported formats:
        - FILE:/path/to/ccache   – Use the specified file.
        - DIR:/path/to/ccachedir – Use the primary file inside the specified directory.
        - /path/to/ccache        – Interpreted as a file path.

   --encoding
      The encoding for the backend.
      
      See the [encoding section in the overview](/overview/#encoding) for more info.

   --description
      Description of the remote.


OPTIONS:
   --domain value  Domain name for NTLM authentication. (default: "WORKGROUP") [$DOMAIN]
   --help, -h      show help
   --host value    SMB server hostname to connect to. [$HOST]
   --pass value    SMB password. [$PASS]
   --port value    SMB port number. (default: 445) [$PORT]
   --spn value     Service principal name. [$SPN]
   --use-kerberos  Use Kerberos authentication. (default: false) [$USE_KERBEROS]
   --user value    SMB username. (default: "$USER") [$USER]

   Advanced

   --case-insensitive       Whether the server is configured to be case-insensitive. (default: true) [$CASE_INSENSITIVE]
   --description value      Description of the remote. [$DESCRIPTION]
   --encoding value         The encoding for the backend. (default: "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot") [$ENCODING]
   --hide-special-share     Hide special shares (e.g. print$) which users aren't supposed to access. (default: true) [$HIDE_SPECIAL_SHARE]
   --idle-timeout value     Max time before closing idle connections. (default: "1m0s") [$IDLE_TIMEOUT]
   --kerberos-ccache value  Path to the Kerberos credential cache (krb5cc). [$KERBEROS_CCACHE]

   Client Config

   --client-ca-cert value                           Path to CA certificate used to verify servers. To remove, use empty string.
   --client-cert value                              Path to Client SSL certificate (PEM) for mutual TLS auth. To remove, use empty string.
   --client-connect-timeout value                   HTTP Client Connect timeout (default: 1m0s)
   --client-expect-continue-timeout value           Timeout when using expect / 100-continue in HTTP (default: 1s)
   --client-header value [ --client-header value ]  Set HTTP header for all transactions (i.e. key=value). This will replace the existing header values. To remove a header, use --http-header "key="". To remove all headers, use --http-header ""
   --client-insecure-skip-verify                    Do not verify the server SSL certificate (insecure) (default: false)
   --client-key value                               Path to Client SSL private key (PEM) for mutual TLS auth. To remove, use empty string.
   --client-no-gzip                                 Don't set Accept-Encoding: gzip (default: false)
   --client-scan-concurrency value                  Max number of concurrent listing requests when scanning data source (default: 1)
   --client-timeout value                           IO idle timeout (default: 5m0s)
   --client-use-server-mod-time                     Use server modified time if possible (default: false)
   --client-user-agent value                        Set the user-agent to a specified string. To remove, use empty string. (default: rclone default)

   Retry Strategy

   --client-low-level-retries value  Maximum number of retries for low-level client errors (default: 10)
   --client-retry-backoff value      The constant delay backoff for retrying IO read errors (default: 1s)
   --client-retry-backoff-exp value  The exponential delay backoff for retrying IO read errors (default: 1.0)
   --client-retry-delay value        The initial delay before retrying IO read errors (default: 1s)
   --client-retry-max value          Max number of retries for IO read errors (default: 10)
   --client-skip-inaccessible        Skip inaccessible files when opening (default: false)

```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://data-programs.gitbook.io/singularity/cli-reference/storage/update/smb.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
