The available command arguments include:

• -upload is the key argument to upload a generated report to a server.

The following code is the uploaded command syntax of the upload value.

-upload
"{scheme}://[{userInfo}@]{host}[:{port}][/{path}][?{query}][#{fragment}]"

where square brackets [...] are delineated as optional.

• {scheme}
  The {scheme} defines the namespace, purpose, and the syntax of the remaining part of a URL. This field is mandatory. A scheme must be followed by “://”. The supported schemes are:
• ftp
• ftps
• sftp
• http

• https
  
  
  

• {userInfo}
  The {userInfo} defines the username and password for authentication. The syntax is displayed as follows.
  
  

  Code Block
  {username}[:{password}]

  
  

  This optional password must be predicated by “:”, and it can be an empty string. If the password is omitted, the command line will prompt for the password. 
  UserInfo must be followed by “@”, and this field is optional.

  
  

  Warning
  title Warning
  {username} and {password} should not contain special characters such as “:”, “/”, and “@” for they may cause an invalid result or error when the uploaded command is parsed.

• {host}
  The {host} defines a host name or an IP address that gives the destination location of a URL. This field is mandatory.

• {port}
  The {port} defines a port number where the server is listed. The port value has to be a value from 1 to 65535. It is necessary when the port number is different from the default port for well-known services. If the port is omitted, the default port will be used to connect to the server. The table below shows a port number for each scheme.

  The table below lists the Default Port Numbers for Schemes

 The port must be preceded by ":". This field is optional.

• {path}
  The {path} defines a remote location where the report will be saved. Paths are Unix-style paths; therefore use “/” (forward-slash) as delimiters. This field is optional.

• {query}
  The {query} defines a query string that contains data to be passed to software running on the server. It may contain name or value pairs separated by ampersands.

• {fragment}
  The {fragment} defines a fragment identifier that, if present, specifies a part or a position within the overall resource or document.

The following are some examples of valid server addresses.

• • ftp://magicreport:1234@10.1.2.4:25/report

    Scheme	ftp
    User name	magicreport
    Password	1234
    Host	10.1.2.4
    Port	25
    Path	report

  • ftp://10.1.2.4:25/report

    Scheme	ftp
    Host	10.1.2.4
    Port	25
    Path	report

  • ftp://10.1.2.4

    Scheme	ftp
    Host	10.1.2.4
    Port	21 (Default port for ftp)

  • ftp://magicreport@10.1.2.4:25/report

    Scheme	ftp
    User name	magicreport
    Host	10.1.2.4
    Port	25
    Path	report

    Tip
    title Tip
    The command line prompts for password.

  • ftp://magicreport:@10.1.2.4:25/report
    
    

    Scheme	ftp
    User name	magicreport
    Password
    Host	10.1.2.4
    Port	25
    Path	report

    Tip
    title Tip
    The command line uses an empty password.

    The following are some examples of invalid server addresses.

    Invalid Server Address	Cause
    10.1.2.4:25	The scheme is required.
    Xx://10.1.2.4:25	The scheme is invalid.
    ftp://magicreport@	The host is required.
    ftp://@10.1.2.4:25	The username is required.

Related pages

• Uploading generated reports to servers
• Generating a Report from Teamwork Server
• Generating a report from Teamwork Cloud Server
• Properties filename
• Syntax rules
• Using the Generate command to generate reports