Export (0) Print
Expand All

Bitsadmin Syntax

Updated: March 28, 2003

Applies To: Windows Server 2003, Windows Server 2003 R2, Windows Server 2003 with SP1, Windows Server 2003 with SP2

BitsAdmin Syntax

BitsAdmin uses the following syntax:

Art Image bitsadmin [/rawreturn] [/wrap] [/nowrap Job] [/help|/?] [/list [/allusers] [/verbose]] [/monitor [/allusers] [/refresh Seconds]] [/reset] [/create DisplayName] [/info Job [/verbose] [/addfile Job RemoteURL LocalName] [/listfiles Job] [/suspend Job] [/resume Job] [/cancel Job] [/complete Job] [/gettype Job] [/getbytestotal Job] [/getbytestransferred Job] [/getfilestotal Job] [/getfilestransferred Job] [/getcreationtime Job] [/getmodificationtime Job] [/getcompletiontime Job] [/getstate Job] [/geterror Job] [/getowner Job] [/getdisplayname Job] [/setdisplayname Job DisplayName] [/getdescription Job] [/setdescription Job Description] [/getpriority Job] [/setpriority Job Priority] [/getnotifyflags Job] [/setnotifyflags Job NotifyFlags] [/getnotifyinterface Job] [/getminretrydelay Job] [/setminretrydelay Job RetryDelay] [/getnoprogresstimeout Job] [/setnoprogresstimeout Job Timeout] [/geterrorcount Job] [/getproxyusage Job] [/getproxylist Job] [/getproxybypasslist Job] [/setproxysettings Job use, List, Bypass] [/takeownership Job] [/SetNotifycmdline Job command-line] [/GetNotifycmdline Job] [/SetCredentials Job Target Scheme Username Password] [/RemoveCredentials Job Target Scheme] [Getreplyfilename Job] [Setreplyfilename Job Path] [/GetReplyProgress Job] [/GetReplyData Job] [/GetReplyData Job]

Parameters

/help| /?
Displays command line usage.

/list[ /allusers] [ /verbose]
Lists transfer jobs. The /allusers parameter lists jobs for all users on the system. The /verbose parameter provides detailed information about jobs.

/monitor[ /allusers] [ /refreshSeconds]
Monitors the copy manager. The /allusers parameter monitors the copy manager for all users on the system. The /refresh parameter reacquires copy manager data in the specified time interval in seconds.

/reset
Deletes all jobs in the manager. If executed by an administrator, all jobs are deleted. If executed by a normal user, only the jobs owned by the user are deleted.

/create [type] DisplayName
Creates a job and assigns DisplayName to it. The type can be /Download, /Upload, or /Upload-Reply.

/info Job[ /verbose]
Displays information about the specified job. The /verbose parameter provides detailed information about the job.

/addfile Job RemoteURL LocalName
Adds a file to the specified job. RemoteURL specifies the file's source location. LocalName specifies the file's name on the local target computer.

/listfiles Job
Lists the files in the specified job.

/suspend Job
Suspends the specified job. The job will not be scheduled to run again until the /resume parameter is executed.

/resume Job
Queues the job to the list of jobs enabled for transfer.

/cancel Job
Deletes the specified job.

/complete Job
Completes the job and makes the files available for the destination directory. This is normally executed after the job moves to the transferred state.

/gettype Job
Retrieves the job type of the specified job.

/getbytestotal Job
Retrieves the size of the specified job.

/getbytestransferred Job
Retrieves the number of bytes transferred for the specified job.

/getfilestotal Job
Retrieves the number of files in the specified job.

/getfilestransferred Job
Retrieves the number of files transferred for the specified job.

/getcreationtime Job
Retrieves the job creation time for the specified job.

/getmodificationtime Job
Retrieves the job modification time.

/getcompletiontime Job
Retrieves the job completion time for the specified job.

/getstate Job
Retrieves the job state for the specified job.

/geterror Job
Retrieves detailed error information for the specified job

/getowner Job
Retrieves the job owner for the specified job.

/getdisplayname Job
Retrieves the display name for the specified job.

/setdisplayname Job DisplayName
Sets the DisplayName for the specified job.

/getdescription Job
Retrieves the job description of the specified job.

/setdescription Job Description
Sets the description for the specified job.

/getpriority Job
Retrieves the priority of the specified job.

/setpriority Job Priority
Sets the priority for the specified job.

/getnotifyflags Job
Retrieves the notify flags for the specified job.

/setnotifyflags Job NotifyFlags
Sets the notify flags for the specified job.

/getnotifyinterface Job
Determines if notify interface is registered for the specified job.

/getminretrydelay Job
Retrieves the retry delay, in seconds, for the specified job.

/setminretrydelay Job RetryDelay
Sets the RetryDelay, in seconds, for the specified job.

/getnoprogresstimeout Job
Retrieves the no progress timeout, in seconds.

/setnoprogresstimeout Job Timeout
Sets the no progress Timeout, in seconds, for the specified job.

/geterrorcount Job
Retrieves an error count for the specified job.

/getproxyusage Job
Retrieves the proxy usage setting for the specified job.

/getproxylist Job
Retrieves the proxy list for the specified job.

/getproxybypasslist Job
Retrieves the proxy bypass list for the specified job.

/setproxysettings Job use, List, Bypass
Sets the proxy Settings for the specified job.

/takeownership Job
Takes ownership of the specified job.

/SetNotifycmdline Job command-line
Sets a command line for job notification.

/GetNotifycmdline Job
Returns the job's notification command line.

/SetCredentials Job Target Scheme Username Password
Adds credentials to a job. The Target can be either SERVER or PROXY. The scheme can be BASIC, DIGEST, NTLM, NEGOTIATE, or PASSPORT.

/RemoveCredentials Job Target Scheme
Removes credentials from a job. The Target can be either SERVER or PROXY. The scheme can be BASIC, DIGEST, NTLM, NEGOTIATE, or PASSPORT.

The following options are valid for Upload-reply jobs only:

  • Getreplyfilename Job

    Gets the path of the file containing the server reply.

  • Setreplyfilename Job

    Path Sets the path of the file containing the server reply.

  • /GetReplyProgress Job

    Returns the size and progress of the server reply.

  • /GetReplyData Job

    Retrieves the server's reply data in hexadecimal format.

The following options can be placed before the command:

  • /rawreturn

    Returns data suitable for parsing. Strips new line characters and formatting from the output. This parameter can be used in conjunction with the /create and /get* parameters.

  • /wrap

    Wraps output to fit in a command window.

  • /nowrap Job

    Does not wrap output to fit in a command window.

Note

  • Commands that take a job parameter will accept either a job name or a job-ID GUID inside braces. BitsAdmin reports an error if the name is ambiguous.

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft