tftp (nrcmd)							tftp (nrcmd)


NAME
    tftp - Configures and controls the TFTP server

SYNOPSIS
    tftp disable <attribute>
    tftp enable <attribute>
    
    tftp get <attribute>
    tftp set <attribute>=<value> [=<value> ...]
    tftp unset <attribute>
    tftp show

    tftp serverLogs show
    tftp serverLogs nlogs=<nlogs> logsize=<logsize>
    
DESCRIPTION
    The tftp command lets you configure the TFTP server in the cluster. 

    The serverLogs show command displays the number of log files and the 
    maximum size for each file.
    
    The serverLogs command allows you to set the two server logging
    parameters,nlogs and logsize.  You can set one parameter or both.
    Changes occur only to the one or ones specified.  When setting 
    logsize, you can add the suffix K or M signify units of thousands or
    millions.  Note that in order for these changes to take effect you must
    save the changes and restart the server Agent. 
    
        tftp serverLogs nlogs=6 logsize=500K
        tftp serverLogs logsize=5M

EXAMPLES
    nrcmd> tftp enable docsis-access
    nrcmd> tftp set file-cache-directory="CacheDir"
    nrcmd> tftp reload 

STATUS

SEE ALSO
    server(nrcmd)

PROPERTIES
  Attributes:

    active-directory-domain[2] (AT_STRING, Required, default: <none>)
        Specifies the name of an Active Directory Domain the TFTP server
        will use to provide dynamic configuration file support.

    csrc-configuration-file[36] (AT_STRING, Required, default: <none>)
        Specifies the path to a configuration file the TFTP server will use
        when loading the CSRC library.  The CSRC library enables the TFTP
        server to generate DOCSIS modem configuration files.  The location
        of the CSRC configuration file is typically
        /CSRC_INSTALL_DIR/conf/csrc.cfg.

    default-device[3] (AT_STRING, Required, default: <none>)
        Specifies the name of the default disk device the TFTP server will
        use when none is specified in the pathname contained in the TFTP
        request.  This property is specifically to be used on NT to
        specify a default drive letter.

    file-cache[39] (AT_BOOL, Optional, default: disabled)
        Specifies whether the TFTP server should perform file caching on
        files located in the file-cache-directory.

    file-cache-directory[40] (AT_STRING, Optional, default: <none>)
        Specifies a path to a cache directory the TFTP server will use to
        find the files to put into cache.  Upon start up the TFTP server
        will load all the files located in this directory into cache.

    file-cache-max-memory-size[43] (AT_RANGEINT(0-2147483647), Optional, default: 32000)
        Specifies the maximum number of bytes available to the server
        for file-caching.
        Valid range: 0-2147483647

    home-directory[30] (AT_STRING, Required, default: <none>)
        Specifies a path to a home directory the TFTP server will use to
        resolve TFTP requests.  If use-home-directory-as-root is disabled,
        the home directory is used in conjunction with the paths specified
        in the search-list to resolve TFTP requests.

    initial-packet-timeout[8] (AT_RANGEINT(1-2147483647), Required, default: 5)
        Specifies the initial length of time the TFTP server will wait
        after sending a response to a client before declaring that response
        timed-out and sending a retransmission to the client.

    ldap-host-name[9] (AT_STRING, Required, default: localhost)
        Specifies the hostname or IP address of an LDAP server the TFTP
        server will use to provide dynamic configuration file support.

    ldap-initial-timeout[10] (AT_RANGEINT(1-2147483647), Required, default: 10)
        Specifies the initial length of time the TFTP server will wait
        after sending a request to an LDAP server before declaring that
        request timed-out and sending a retransmission to the server.

    ldap-maximum-timeout[11] (AT_RANGEINT(1-2147483647), Required, default: 60)
        Specifies the maximum length of time the TFTP server will wait
        after transmitting the initial LDAP request before giving up
        retrying on that request.

    ldap-password[12] (AT_STRING, Required, default: <none>)
        Specifies the password the TFTP server will use when connecting to
        an LDAP server.

    ldap-port-number[13] (AT_RANGEINT(1-65535), Required, default: 389)
        Specifies the port number the TFTP server will use when
        communicating with an LDAP server.

    ldap-root-dn[14] (AT_STRING, Required, default: <none>)
        Specifies the root distinguished name the TFTP server will use to
        locate the root of the directory tree for dynamic configuration
        file support.

    ldap-use-ssl[15] (AT_BOOL, Required, default: disabled)
        Specifies whether or not the TFTP server will use SSL when
        communicating with an LDAP server.  If this feature is disabled, the
        TFTP server will not use SSL when communicating with LDAP.

    ldap-user-name[16] (AT_STRING, Required, default: <none>)
        Specifies the user name the TFTP server will use when connecting
        to an LDAP server.

    log-level[19] (AT_RANGEINT(0-4), Required, default: 3)
        Specifies the level of verbosity the TFTP server will employ when
        writing log messages to the TFTP server log file.  Each integer
        value from 0 through 4 enables the following log levels: None,
        Error, Warning, Information and Activity.

    log-settings[38] (AT_FLAGSINT(), Optional, default: verbose)
        Enables the TFTP server to allow control over additional details
        about the events listed in the log-settings. These details can 
        help analyze a problem, but can also cause the log files
        to fill up quickly if left enabled for a long period of time.
        When log files fill up quickly, they also turn over frequently.
        So you might lose important information.
        By default, the TFTP server's logging is verbose.
        The possible flags are:
           1  verbose
              Causes all the logging in the server to be active.
              A success message is printed to the log for
              each successful transfer.
           2  no-success-messages
              Causes the single line message that is normally logged
              for every successful read from or write to the TFTP server
              to not appear.  It affects logging only for successful 
              file reads from the TFTP server.

    max-inbound-file-size[21] (AT_STRING, Required, default: 1024k)
        Specifies the maximum file size limit that the TFTP server will
        enforce for a file written to the TFTP server.  Default units is in
        kilobytes.  Use k, m or g to indicate kilobytes, megabytes or
        gigabytes.

    min-socket-buffer-size[24] (AT_RANGEINT(1-2147483647), Required, default: 65536)
        Specifies the minimum socket buffer size the TFTP server will use
        for the well known port on which it is listening for TFTP requests.

    packet-trace-level[20] (AT_RANGEINT(0-4), Required, default: 0)
        Specifies the level of verbosity the TFTP server will employ when
        writing messages to the server trace file.  Each integer value
        from 1 through 4 enables increasing levels of tracing.  Setting
        packet trace level to 0 disables tracing.

    port-number[26] (AT_RANGEINT(1-65535), Required, default: 69)
        Specifies the UDP port number the TFTP server will use to listen
        for TFTP requests.

    read-access[5] (AT_BOOL, Required, default: enabled)
        Specifies how the TFTP server should respond to file read requests
        from TFTP clients.  If this feature is disabled, the TFTP server
        will refuse file read requests.

    search-list[31] (AT_STRING, Required, default: <none>)
        Specifies a comma separated list of paths the TFTP server will use
        to resolve TFTP requests.  If use-home-directory-as-root is
        enabled, the paths in the search list are ignored and the home
        directory is used to resolve all TFTP requests.

    session-timeout[27] (AT_RANGEINT(1-2147483647), Required, default: 20)
        Specifies the maximum length of time the TFTP server will wait
        after transmitting the initial response before giving up retrying
        on that response.  If no response is received from the client
        within this timeout period, the TFTP session is terminated.

    use-home-directory-as-root[29] (AT_BOOL, Required, default: disabled)
        Specifies whether or not the TFTP server will treat pathnames
        contained within TFTP requests as if the paths were rooted at the
        specified home directory.  If this feature is enabled, the TFTP
        server will attempt to resolve both absolute and relative
        pathnames to paths located beneath the specified home directory.

    write-access[6] (AT_BOOL, Required, default: disabled)
        Specifies how the TFTP server should respond to file write requests
        from TFTP clients.  If this feature is disabled, the TFTP server
        will refuse file write requests.

    write-allow-file-create[44] (AT_BOOL, Optional, default: disabled)
        Specifies whether to allow file creates on a PUT.  If false and
        write-access equals true, the file must exist on the server for the
        PUT to succeed.  If true and write-access is true, then the file
        does not need to exist on the server first and will be created on
        a PUT.  max-inbound-file-size will apply a limit to the size of
        the file.

