Windows Server Administration Windows Commands

https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/
Admin
Comprehensive documentation for Windows Server administration command-line tools and utilities for...
Tokens:623,801
Snippets:9,122
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Start Install Image Multicast Transmission with Details

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-start-multicasttransmission

Example of starting a multicast transmission for an install image, specifying server, image group, and filename.

```cmd
wdsutil /start-MulticastTransmission /Server:MyWDSServemedia:Vista with Officemediatype:InstalmediaGroup:ImageGroup1 /Filename:install.wim
```

--------------------------------

### Example: Start Install Image Multicast Transmission

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-start-multicasttransmission

Example of starting a multicast transmission for an install image named 'Vista with Office'.

```cmd
wdsutil /start-MulticastTransmissiomedia:Vista with Office
/Imagetype:Install
```

--------------------------------

### Example: Start Boot Image Multicast Transmission (x64)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-start-multicasttransmission

Example of starting a multicast transmission for a 64-bit boot image, specifying server, architecture, and filename.

```cmd
wdsutil /start-MulticastTransmission /Server:MyWDSServemedia:X64 Boot Imagemediatype:Boot /Architecture:x64
/Filename:boot.wim

```

--------------------------------

### Example: Export Install Image (Basic)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-export-image

Example command to export an install image named 'Windows Vista with Office' to 'C:\Temp\Install.wim'.

```bash
wdsutil /Export-Image image:Windows Vista with Office imagetype:Install /DestinationImage /Filepath:C:\Temp\Install.wim

```

--------------------------------

### Retrieve Install Image Information

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-get-image

Examples for retrieving install image details. The first example retrieves by name. The second includes verbose output, server, image group, and filename.

```bash
wdsutil /Get-Image:Windows Vista with Office imagetype:Install
```

```bash
wdsutil /verbose /Get-Image:Windows Vista with Office /Server:MyWDSServer imagetype:Install imagegroup:ImageGroup1 /Filename:install.wim
```

--------------------------------

### Example: Export Install Image (Append)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-export-image

Example command to export an install image, specifying server, image group, filename, destination, and using the 'append' option for overwrite.

```bash
wdsutil /verbose /Progress /Export-Image image:Windows Vista with Office /Server:MyWDSServer imagetype:Instal imageGroup:ImageGroup1 /Filename:install.wim /DestinationImage /Filepath:\\server\share\export.wim /Name:Exported Windows image /Description:Windows Vista image from WDS server /Overwrite:append

```

--------------------------------

### TFTP Get Example

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/tftp

Copies the 'boot.img' file from the remote computer 'Host1' to the local computer. Use binary image transfer mode.

```bash
tftp  -i Host1 get boot.img
```

--------------------------------

### Add Device using GUID String with Options

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-add-device

This example demonstrates adding a computer using its GUID string and specifies several optional parameters including referral server, boot program, unattend file, user rights, boot image path, and organizational unit.

```bash
wdsutil /add-Device /Device:computer1 /ID:{E8A3EFAC-201F-4E69-953F-B2DAA1E8B1B6} /ReferralServer:WDSServer1 /BootProgram:boot\x86\pxeboot.com/WDSClientUnattend:WDSClientUnattend\unattend.xml /User:Domain\MyUser/JoinRights:Full /BootImagepath:boot\x86\images\boot.wim /OU:OU=MyOU,CN=Test,DC=Domain,DC=com
```

--------------------------------

### Example: Remove an Install Image with Server, Image Group, and Filename

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-remove-image

This example demonstrates removing a specific install image from 'ImageGroup1' on 'MyWDSServe', including the filename.

```bash
wdsutil /verbose /remove-Image:Windows Vista with Office /Server:MyWDSServemediatype:Install ImageGroup:ImageGroup1 /Filename:install.wim

```

--------------------------------

### Add a basic install image to WDS

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-add-image

Example of adding a basic install image. The /ImageFile and /ImageType:Install parameters are mandatory.

```bash
wdsutil /Add-Image /ImageFile:"C:\MyFolder\Install.wim" /ImageType:Install
```

--------------------------------

### Example: Remove an Install Image by Name

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-remove-image

This example shows how to remove an install image named 'Windows Vista with Office'.

```bash
wdsutil /remove-Image:Windows Vista with Officemediatype:Install

```

--------------------------------

### wdsutil start-MulticastTransmission Syntax (Windows Server 2008 R2 - Install Images)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-start-multicasttransmission

Syntax for starting a multicast transmission of an install image on Windows Server 2008 R2. Requires image name, media type, and optionally server, image group, and filename.

```cmd
wdsutil [Options] /start-MulticastTransmissiomedia:<Image name>
        [/Server:<Server name>]
      mediatype:Install
       mediaGroup:<Image Group>]
        [/Filename:<File name>]
```

--------------------------------

### Get all install images

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-get-allimages

Use this command to retrieve information about all install images and their associated image groups. No server name is specified, so it defaults to the local server.

```bash
wdsutil /get-allimages /show:install
```

--------------------------------

### Provide Script Explanation with Comments

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/rem

Use multiple 'rem' commands to provide a detailed explanation of what a script does, including partition creation and drive assignment. This example explains the setup of three drives.

```batch
rem The commands in this script set up 3 drives.
rem The first drive is a primary partition and is
rem assigned the letter D. The second and third drives
rem are logical partitions, and are assigned letters
rem E and F.
create partition primary size=2048
assign d:
create partition extended
create partition logical size=2048
assign e:
create partition logical
assign f:
```

--------------------------------

### View all transmissions (Windows Server 2008 R2)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-get-allmulticasttransmissions

This example retrieves all types of multicast transmissions (boot and install) on Windows Server 2008 R2.

```bash
wdsutil /Get-AllMulticastTransmissions /Show:All
```

--------------------------------

### Prepare Installation Share for Dynamic Update

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/winnt32

Use /duprepare to prepare an installation share for Dynamic Update files downloaded from Windows Update. This allows for multi-client installations using updated files.

```bash
winnt32 /duprepare: <pathName>

```

--------------------------------

### Set Network Boot Program and Referral Server

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-set-device

Use this example to configure the network boot program and the server from which the client should download it.

```bash
wdsutil /Set-Device /Device:computer1 /ReferralServer:MyWDSServer
/BootProgram:boot\x86\pxeboot.n12

```

--------------------------------

### Example: Get Temporary Filename for a Specific File

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-gettemporaryname

Use this command to report the temporary filename of file index 1 for a job named 'myDownloadJob'. The file_index starts from 0.

```bash
bitsadmin /gettemporaryname myDownloadJob 1
```

--------------------------------

### Get Custom Headers for a Specific Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getcustomheaders

Example of how to retrieve custom HTTP headers for a BITS job named 'myDownloadJob'. Replace 'myDownloadJob' with the actual job name or GUID.

```bash
bitsadmin /getcustomheaders myDownloadJob
```

--------------------------------

### Get Validation State of a Specific File

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getvalidationstate

Example of how to retrieve the content validation state for file index 1 in a BITS job named 'myDownloadJob'. File indices start from 0.

```bash
bitsadmin /getvalidationstate myDownloadJob 1
```

--------------------------------

### Certutil Examples for Viewing Stores

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/certutil

Examples demonstrating how to use the -viewstore command with different options and store names, including enterprise, user, and root stores.

```Windows Command Prompt
-enterprise NTAuth
-enterprise Root 37
-user My 26e0aaaf000000000004
CA .11
```

--------------------------------

### ksetup setrealm Example

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ksetup

Use this command to make the current computer a member of a specified Kerberos realm. Ensure the DNS domain name is correctly provided.

```bash
ksetup /setrealm contoso.com
```

--------------------------------

### Create a Discover Image with Specific Settings

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-new-discoverimage

This example demonstrates creating a discover image with verbose and progress options, specifying the server, architecture, filename, destination path, name, description, and overwrite behavior.

```bash
wdsutil /Verbose /Progress /New-DiscoverImage /Server:MyWDSServer
/Image:WinPE boot image /Architecture:x64 /Filename:boot.wim /DestinationImage /FilePath:\\Server\Share\WinPEDiscover.wim
/Name:New WinPE image /Description:WinPE image for WDS Client discovery /Overwrite:No
```

--------------------------------

### Set Various Computer Settings

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-set-device

This example demonstrates setting multiple attributes for a computer, including its ID, unattend file, user permissions, join rights, boot image path, domain, and account reset.

```bash
wdsutil /verbose /Set-Device /Device:computer2 /ID:00-B0-56-88-2F-DC /WdsClientUnattend:WDSClientUnattend\unattend.xml
/User:Domain\user /JoinRights:JoinOnly /JoinDomain:No /BootImagepath:boot\x86\images\boot.wim /Domain:NorthAmerica /resetAccount

```

--------------------------------

### Example: Export Boot Image (Basic)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-export-image

Example command to export a boot image named 'WinPE boot image' to 'C:\temp\boot.wim' with x86 architecture.

```bash
wdsutil /Export-Image image:WinPE boot image imagetype:Boot /Architecture:x86 /DestinationImage /Filepath:C:\temp\boot.wim

```

--------------------------------

### Disable Dynamic Update

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/winnt32

Prevent Dynamic Update from running during setup by using the /dudisable parameter. This ensures setup uses only the original installation files.

```bash
winnt32 /dudisable

```

--------------------------------

### Establish Domain Connection with User Mapping

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ksetup-domain

This example demonstrates establishing a connection to a domain using `ksetup /mapuser` and specifying the domain name. This is useful for scenarios where you need to map a user principal to a domain user for Kerberos authentication.

```bash
ksetup /mapuser principal@realm domain-user /domain domain-name
```

--------------------------------

### Start NFS Services

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/nfsadmin

Use these commands to start the Server for NFS or Client for NFS services. These are typically started automatically on boot, but can be manually started if needed.

```bash
nfsadmin server start
nfsadmin client start
```

--------------------------------

### Example: Stop Multicast Transmission (Install Image)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-remove-multicasttransmission

This command stops a multicast transmission for an install image. Existing clients will complete the transfer, but new clients cannot join.

```bash
wdsutil /remove-MulticastTransmission:Vista with Office
/Imagetype:Install
```

--------------------------------

### Create Temporary Folders During Setup

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/winnt32

The /copysource parameter creates temporary folders during setup that are deleted upon completion. This is useful for staging files needed during the installation process.

```bash
winnt32 /copysource: <FolderName>

```

--------------------------------

### Example: Mirror Volume to Disk 2

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/add_2

This example demonstrates how to mirror the currently selected volume to disk 2 using the 'add disk' command.

```bash
add disk=2
```

--------------------------------

### Install Web Server Role and Save Results

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/servermanagercmd

This command installs the Web Server (IIS) role and saves the installation results to an XML file named 'installResult.xml'.

```bash
servermanagercmd -install Web-Server -resultpath installResult.xml
```

--------------------------------

### Example: Export Boot Image (Verbose)

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-export-image

Example command to export a boot image with verbose output, progress, server specification, filename, and overwrite option set to 'Yes'.

```bash
wdsutil /verbose /Progress /Export-Image image:WinPE boot image /Server:MyWDSServer imagetype:Boot /Architecture:x64 /Filename:boot.wim /DestinationImage /Filepath:\\Server\Share\ExportImage.wim /Name:Exported WinPE image /Description:WinPE Image from WDS server /Overwrite:Yes

```

--------------------------------

### Example: Retrieve Client Certificate for a Specific Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getclientcertificate

This example shows how to retrieve the client certificate for a BITS job named 'myDownloadJob'. Ensure you replace 'myDownloadJob' with the actual name or GUID of your job.

```bash
bitsadmin /getclientcertificate myDownloadJob
```

--------------------------------

### Get Device Information by GUID

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-get-device

Use this command to retrieve information about a prestaged computer using its GUID. The /forest:Yes flag searches the entire forest. The /verbose flag provides more detailed output.

```bash
wdsutil /verbose /Get-Device /ID:E8A3EFAC-201F-4E69-953-B2DAA1E8B1B6 /forest:Yes
```

--------------------------------

### ksetup Help

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ksetup

Displays the help information for the ksetup command, providing a quick reference for all available options and parameters.

```bash
ksetup /?
```

--------------------------------

### Get Error Count for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-geterrorcount

Use this command to retrieve the number of transient errors for a BITS job identified by its display name or GUID. Replace 'myDownloadJob' with the actual job name or GUID.

```bash
bitsadmin /geterrorcount myDownloadJob
```

--------------------------------

### Get Job State

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getstate

Retrieves the current state of a BITS job using its display name or GUID.

```APIDOC
## bitsadmin /getstate

### Description
Retrieves the state of a specified BITS job.

### Method
Command-line utility

### Syntax
```
bitsadmin /getstate <job>
```

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Output
The returned output values can be:
- `Queued`: The job is waiting to run.
- `Connecting`: BITS is contacting the server.
- `Transferring`: BITS is transferring data.
- `Transferred`: BITS has successfully transferred all files in the job.
- `Suspended`: The job is paused.
- `Error`: A nonrecoverable error occurred; the transfer isn't retried.
- `Transient_Error`: A recoverable error occurred; the transfer retries when the minimum retry delay expires.
- `Acknowledged`: The job completed.
- `Canceled`: The job was canceled.

### Example
To retrieve the state for the job named _myDownloadJob_:
```
bitsadmin /getstate myDownloadJob
```
```

--------------------------------

### Example: Associate and Add Ports to a LUN in Diskraid

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/diskraid

Demonstrates selecting a LUN and then associating and adding controller ports using Diskraid commands. Shows the output after each association.

```bash
DISKRAID> SEL LUN 5
LUN 5 is now the selected LUN.

DISKRAID> ASSOCIATE PORTS 0-0,0-1
Controller port associations changed.
(Controller ports active after this command: Ctlr 0 Port 0, Ctlr 0 Port 1)

DISKRAID> ASSOCIATE PORTS ADD 1-1
Controller port associations changed.
(Controller ports active after this command: Ctlr 0 Port 0, Ctlr 0 Port 1, Ctlr 1 Port 1)
```

--------------------------------

### Copy Additional Folders During Setup

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/winnt32

Use /copydir to create additional folders within the operating system installation directory. These folders can contain custom files like drivers and will be copied to the newly installed computer.

```bash
winnt32 /copydir:i386\_Private_drivers_

```

--------------------------------

### bootcfg addsw Command Examples

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bootcfg-addsw

Illustrative examples demonstrating various ways to use the bootcfg /addsw command with different parameters.

```APIDOC
## Examples

To use the **bootcfg /addsw** command:

```
bootcfg /addsw /mm 64 /id 2
bootcfg /addsw /so /id 3
bootcfg /addsw /so /ng /s srvmain /u hiropln /id 2
bootcfg /addsw /ng /id 2
bootcfg /addsw /mm 96 /ng /s srvmain /u maindom\hiropln /p p@ssW23 /id 2
```
```

--------------------------------

### Get Job Description

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getdescription

This command retrieves the description of a specified job. The job can be identified by its display name or GUID.

```APIDOC
## bitsadmin /getdescription <job>

### Description
Retrieves the description of the specified job.

### Syntax
```
bitsadmin /getdescription <job>
```

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Examples
To retrieve the description for the job named _myDownloadJob_:
```
bitsadmin /getdescription myDownloadJob
```
```

--------------------------------

### Example: Test DFS configuration

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/dfsdiag-testdfsconfig

This example demonstrates how to verify the configuration of a specific DFS namespace, \\contoso.com\MyNamespace.

```bash
dfsdiag /testdfsconfig /DFSroot:\\contoso.com\MyNamespace
```

--------------------------------

### Get Notify Flags for a Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getnotifyflags

Retrieves the notification flags for a specified job. The job can be identified by its display name or GUID.

```APIDOC
## bitsadmin /getnotifyflags <job>

### Description
Retrieves the notification flags for the specified job.

### Method
Command-line tool invocation

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Remarks
The job can contain one or more of the following notification flags:
- **0x001**: Generate an event when all files in the job have been transferred.
- **0x002**: Generate an event when an error occurs.
- **0x004**: Disable notifications.
- **0x008**: Generate an event when the job is modified or transfer progress is made.

### Request Example
```
bitsadmin /getnotifyflags myDownloadJob
```
```

--------------------------------

### Add a boot image with details

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-add-image

Adds a boot image with verbose output, progress indication, server specification, name, description, and a new filename.

```bash
wdsutil /Verbose /Progress /Add-Image /ImageFile:\\MyServer\Share\Boot.wim /Server:MyWDSServer /ImageType:Boot /Name:"My WinPE Image" /Description:"WinPE Image containing the WDS Client" /Filename:WDSBoot.wim
```

--------------------------------

### Retrieve Boot Image Information

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-get-image

Examples for retrieving boot image details. The first example retrieves by name and architecture. The second includes verbose output, server, and filename.

```bash
wdsutil /Get-Image image:WinPE boot imagetype:Boot /Architecture:x86
```

```bash
wdsutil /verbose /Get-Image image:WinPE boot /Server:MyWDSServer imagetype:Boot /Architecture:x86 /Filename:boot.wim
```

--------------------------------

### Get Maximum Download Time

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getmaxdownloadtime

Retrieves the download timeout in seconds for a BITS job using its display name or GUID.

```APIDOC
## bitsadmin /getmaxdownloadtime <job>

### Description
Retrieves the download timeout in seconds for a specified BITS job.

### Method
Command-line utility

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Request Example
```
bitsadmin /getmaxdownloadtime myDownloadJob
```

### Response
#### Success Response (200)
- **timeout** (integer) - The download timeout in seconds.
```

--------------------------------

### Retrieve Policy for Multiple Categories Using GUIDs

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/auditpol-get

This command retrieves audit policy settings for multiple categories specified by their GUIDs, including all subcategories within those categories. It's useful for getting a consolidated view of policies across several categories.

```bash
auditpol /get /category:{69979849-797a-11d9-bed3-505054503030},{69997984a-797a-11d9-bed3-505054503030} subcategory:{0ccee921a-69ae-11d9-bed3-505054503030}
```

--------------------------------

### Example: Set ksetup Target to a Specific Server

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ksetup-server

This example demonstrates how to make ksetup configurations apply to the server named 'IPops897.corp.contoso.com'. Ensure the specified name is a fully-qualified domain name.

```bash
ksetup /server IPops897.corp.contoso.com
```

--------------------------------

### Install Sysmon with a Configuration File

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/sysmon

Installs the Sysmon service and driver using a specified configuration file. The EULA is automatically accepted.

```bash
sysmon -accepteula -i c:\windows\config.xml
```

--------------------------------

### ksetup server Example

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ksetup

Specifies the name of a Windows computer on which to apply the ksetup changes. This is useful for remote administration.

```bash
ksetup /server SERVER01
```

--------------------------------

### Get Proxy Usage for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getproxyusage

This command retrieves the proxy usage setting for a BITS job identified by its display name or GUID.

```APIDOC
## bitsadmin /getproxyusage <job>

### Description
Retrieves the proxy usage setting for the specified job.

### Method
Command-line utility

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

#### Output
The returned proxy usage values can be:
  * **Preconfig** - Use the owner's Internet Explorer defaults.
  * **No_Proxy** - Don't use a proxy server.
  * **Override** - Use an explicit proxy list.
  * **Autodetect** - Automatically detect the proxy settings.

### Request Example
```
bitsadmin /getproxyusage myDownloadJob
```
```

--------------------------------

### Start Diskpart Interpreter

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/diskpart

To begin using diskpart, type 'diskpart' at the command prompt. You must have administrator privileges to run this utility.

```bash
diskpart <parameter>

```

--------------------------------

### Get Notify Interface Syntax

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getnotifyinterface

This is the basic syntax for the bitsadmin /getnotifyinterface command. Replace `<job>` with the job's display name or GUID.

```bash
bitsadmin /getnotifyinterface <job>
```

--------------------------------

### Create Key Package Example

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/manage-bde-keypackage

Use this command to create a key package for drive C:, using a specific key protector ID, and save it to the 'f:\Folder' directory. Ensure the specified ID corresponds to a valid key protector for the drive.

```bash
manage-bde -keypackage C: -id {84E151C1...7A62067A512} -path f:\Folder
```

--------------------------------

### Start a Namespace

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-start-namespace

Starts a namespace on the local server. Ensure the namespace name is accurate.

```bash
wdsutil /start-Namespace /Namespace:Custom Auto 1
```

--------------------------------

### Connect to Local Server

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/winrs

Example of connecting to a local server endpoint.

```bash
winrs /r:myserver command
```

--------------------------------

### Get Validation State of a File in a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getvalidationstate

Reports the content validation state of the given file within the job. The file_index starts from 0.

```APIDOC
## bitsadmin /getvalidationstate <job> <file_index>

### Description
Reports the content validation state of the given file within the job.

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.
- **file_index** (integer) - Required - Starts from 0.

### Request Example
To retrieve the content validation state of file 2 within the job named _myDownloadJob_ :
```
bitsadmin /getvalidationstate myDownloadJob 1
```
```

--------------------------------

### Bring Disk Online Example

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/online-disk

Use this command to bring the currently selected disk online. Ensure the disk is selected using the 'select disk' command before running this.

```bash
online disk
```

--------------------------------

### Get BITS Job Priority

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getpriority

Use this command to retrieve the priority of a BITS job. Replace 'myDownloadJob' with the actual display name or GUID of your job.

```bash
bitsadmin /getpriority myDownloadJob
```

--------------------------------

### Get Upload-Reply Progress

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getreplyprogress

Use this command to retrieve the upload-reply progress for a specific job. Replace 'myDownloadJob' with the actual display name or GUID of your job.

```bash
bitsadmin /getreplyprogress myDownloadJob
```

--------------------------------

### Create a New Service with Binary Path

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/sc-create

Use this command to create a new service and specify its binary path. This is a basic example for creating a service.

```bash
sc.exe \\myserver create NewService binpath= c:\\windows\\system32\\NewServ.exe

```

--------------------------------

### Get Modification Time Syntax

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getmodificationtime

This is the basic syntax for using the bitsadmin /getmodificationtime command. Replace <job> with the job's display name or GUID.

```bash
bitsadmin /getmodificationtime <job>
```

--------------------------------

### Get BITS Job Description

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getdescription

Use this command to retrieve the description of a BITS job. Replace 'myDownloadJob' with the actual display name or GUID of the job.

```bash
bitsadmin /getdescription myDownloadJob
```

--------------------------------

### Get Bytes Transferred for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getbytestransferred

This command retrieves the number of bytes transferred for a specified BITS job using its display name or GUID.

```APIDOC
## bitsadmin /getbytestransferred

### Description
Retrieves the number of bytes transferred for the specified job.

### Syntax
```
bitsadmin /getbytestransferred <job>
```

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Request Example
```
bitsadmin /getbytestransferred myDownloadJob
```

### Response
(Output is typically the number of bytes transferred, displayed directly in the console.)
```

--------------------------------

### Install a new forest using an answer file

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/dcpromo

Use this command to automate the installation of a new Active Directory forest by providing an answer file. Ensure the answer file is correctly configured.

```cli
dcpromo /answer:NewForestInstallation
```

--------------------------------

### bitsadmin /util Help and Syntax

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-util

Displays the command-line usage for the /Util switches. You can also specify /?. Use this to understand the available /util options.

```bash
bitsadmin /util /help
```

```bash
bitsadmin /util /getieproxy
```

```bash
bitsadmin /util /repairservice
```

```bash
bitsadmin /util /setieproxy
```

```bash
bitsadmin /util /version
```

--------------------------------

### Perform What-If Installation Analysis

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/servermanagercmd

This command displays detailed information about roles, role services, and features that would be installed or removed based on instructions in an XML answer file ('install.xml'). It performs a simulation without making actual changes.

```bash
servermanagercmd -inputpath install.xml -whatif
```

--------------------------------

### Get BITS Job State

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getstate

Use this command to retrieve the current state of a BITS job. Replace 'myDownloadJob' with the actual display name or GUID of your job.

```bash
bitsadmin /getstate myDownloadJob
```

--------------------------------

### Get Owner of a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getowner

This command retrieves and displays the owner of a BITS job. You need to provide the job's identifier, which can be its display name or GUID.

```APIDOC
## bitsadmin /getowner <job>

### Description
Displays the display name or GUID of the owner of the specified job.

### Method
Command Line

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Request Example
```
bitsadmin /getowner myDownloadJob
```

### Response
#### Success Response (Output)
The command outputs the display name or GUID of the owner of the specified job.

#### Response Example
```
Owner: [Owner's Display Name or GUID]
```
```

--------------------------------

### Execute a Doskey Macro to Format a Disk

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/doskey

This demonstrates using the 'qf' macro to quickly and unconditionally format the disk in drive A.

```batch
qf a:
```

--------------------------------

### View 'start' Command Help

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/start

This command opens a separate maximized Command Prompt window to display help information for the 'start' command.

```cmd
start /max start /?
```

--------------------------------

### Get Client Certificate Syntax

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getclientcertificate

This is the general syntax for retrieving a client certificate from a BITS job. Replace `<job>` with the job's display name or GUID.

```bash
bitsadmin /getclientcertificate <job>
```

--------------------------------

### Initialize Server

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-initialize-server

Initializes the Windows Deployment Services server and sets the remote installation folder. This command is essential for the initial setup of the WDS server role.

```APIDOC
## wdsutil initialize-server

### Description
Configures a Windows Deployment Services server for initial use after the server role has been installed. After you run this command, you should use the `wdsutil add-Image` command command to add images to the server.

### Syntax
```
wdsutil /Initialize-Server [/Server:<Server name>] /remInst:<Full path> [/Authorize]
```

### Parameters
#### Path Parameters
- **[/Server]** (string) - Optional - Specifies the name of the server. This can be either the NetBIOS name or the fully qualified domain name (FQDN). If no server name is specified, the local server will be used.
- **[/remInst]** (string) - Required - Specifies the full path and name of the remoteInstall folder. If the specified folder does not already exist, this option will create it when the command is run. You should always enter a local path, even in the case of a remote computer. For example: **D:\remoteInstall**.
- **[/Authorize]** (boolean) - Optional - Authorizes the server in Dynamic Host Control Protocol (DHCP). This option is necessary only if DHCP rogue detection is enabled, meaning that the Windows Deployment Services PXE server must be authorized in DHCP before client computers can be serviced. Note that DHCP rogue detection is disabled by default.

### Examples
To initialize the server and set the remoteInstall shared folder to the F: drive, type.
```
wdsutil /Initialize-Server /remInst:F:\remoteInstall
```

To initialize the server and set the remoteInstall shared folder to the C: drive, type.
```
wdsutil /verbose /Progress /Initialize-Server /Server:MyWDSServer /remInst:C:\remoteInstall
```
```

--------------------------------

### View file content with more

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/more

Use these commands to view the first screen of information from a file named 'clients.new'. Press the SPACEBAR to see the next screen.

```bash
more < clients.new
```

```bash
type clients.new | more
```

--------------------------------

### Initialize WDS Server with Remote Install Folder

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-initialize-server

Initializes the WDS server and sets the remoteInstall shared folder to a specified drive. This is a basic setup command.

```bash
wdsutil /Initialize-Server /remInst:F:\\remoteInstall
```

--------------------------------

### Add an install image with advanced options

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-add-image

Adds an install image with verbose output, progress, server, image group, single image name, display name, description, new filename, and an unattended file.

```bash
wdsutil /Verbose /Progress /Add-Image /ImageFile:\\MyServer\Share\Install.wim /Server:MyWDSServer /ImageType:Install /ImageGroup:ImageGroup1
/SingleImage:"Windows Pro" /Name:"My WDS Image" /Description:"Windows Pro image with Microsoft Office" /Filename:"Win Pro.wim" /UnattendFile:"\\server\share\unattend.xml"
```

--------------------------------

### Install Default Certificate Templates - certutil -InstallDefaultTemplates

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/certutil

Installs the default certificate templates. Specify a domain controller name using the -dc option.

```bash
certutil [options] -InstallDefaultTemplates
```

```bash
[-dc DCName]
```

--------------------------------

### Find Files Recursively

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/where

Use the /r parameter to perform a recursive search starting from a specified directory. This example searches for 'Test' files in drive C and its subdirectories.

```bash
where /r c:\ test

```

--------------------------------

### Display basic info for a BITS job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-info

Use this command to get summary information for a BITS job. Replace 'myDownloadJob' with the actual display name or GUID of your job.

```bash
bitsadmin /info myDownloadJob
```

--------------------------------

### Diskraid Example: Associating and Dissociating Controller Ports

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/diskraid

This example demonstrates selecting a LUN, associating controller ports, adding more associations, and then dissociating specific ports. It shows the state of active controller ports after each operation.

```bash
DISKRAID> SEL LUN 5
LUN 5 is now the selected LUN.

DISKRAID> ASSOCIATE PORTS 0-0,0-1
Controller port associations changed.
(Controller ports active after this command: Ctlr 0 Port 0, Ctlr 0 Port 1)

DISKRAID> ASSOCIATE PORTS ADD 1-1
Controller port associations changed.
(Controller ports active after this command: Ctlr 0 Port 0, Ctlr 0 Port 1, Ctlr 1 Port 1)

DISKRAID> DISSOCIATE PORTS 0-0,1-1
Controller port associations changed.
(Controller ports active after this command: Ctlr 0 Port 1)
```

--------------------------------

### Example: Map IPops897 to CONTOSO Realm

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ksetup-addhosttorealmmap

This example demonstrates how to map the host computer 'IPops897' to the 'CONTOSO' realm using the ksetup addhosttorealmmap command. After execution, verify the mapping in the registry.

```bash
ksetup /addhosttorealmmap IPops897 CONTOSO
```

--------------------------------

### Get Upload-Reply Filename for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getreplyfilename

Use this command to retrieve the upload-reply filename for a job. Replace 'myDownloadJob' with the actual display name or GUID of your BITS job.

```bitsadmin
bitsadmin /getreplyfilename myDownloadJob
```

--------------------------------

### Get Proxy List for a Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getproxylist

This command retrieves the proxy servers configured for a specified BITS job. You need to provide the job's display name or GUID.

```APIDOC
## bitsadmin /getproxylist <job>

### Description
Retrieves the comma-delimited list of proxy servers to use for the specified job.

### Method
Command-line utility

### Parameters
#### Path Parameters
- **job** (string) - Required - The job's display name or GUID.

### Request Example
```
bitsadmin /getproxylist myDownloadJob
```

### Response
#### Success Response
Returns a comma-delimited string of proxy servers.

#### Response Example
```
proxy1.example.com:8080,proxy2.example.com:80
```
```

--------------------------------

### Example DiskShadow Output: List Providers

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/add-volume

Shows an example output of the 'list providers' command, detailing a registered provider. This output is typically seen after running 'list providers' at the DiskShadow prompt.

```text
* ProviderID: {b5946137-7b9f-4925-af80-51abd60b20d5}
        Type: [1] VSS_PROV_SYSTEM
        Name: Microsoft Software Shadow Copy provider 1.0
        Version: 1.0.0.7
        CLSID: {65ee1dba-8ff4-4a58-ac1c-3470ee2f376a}
1 provider registered.
```

--------------------------------

### Enable Windows To Go Startup Options

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/pwlauncher

Use this command to enable the Windows To Go startup options, allowing the computer to automatically boot from a USB device when one is present.

```bash
pwlauncher /enable
```

--------------------------------

### Get Number of Files Transferred for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getfilestransferred

Use this command to retrieve the count of files transferred for a BITS job. Specify the job by its display name or GUID.

```bash
bitsadmin /getfilestransferred <job>
```

```bash
bitsadmin /getfilestransferred myDownloadJob
```

--------------------------------

### Creating Symbolic and Hard Links with mklink

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/mklink

Examples demonstrating how to create a directory symbolic link and a file hard link, along with commands to remove them.

```bash
mklink /d \MyFolder \Users\User1\Documents
mklink /h \MyFile.file \User1\Documents\example.file
rd \MyFolder
del \MyFile.file
```

--------------------------------

### Get HTTP Method for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-gethttpmethod

Use this command to retrieve the HTTP verb for a BITS job. Replace 'myDownloadJob' with the actual display name or GUID of your job.

```bitsadmin
bitsadmin /gethttpmethod myDownloadJob
```

--------------------------------

### Retrieve Error Information for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-geterror

Use this command to get detailed error information for a BITS job. Specify the job's display name or GUID.

```bash
bitsadmin /geterror myDownloadJob
```

--------------------------------

### Turn on BitLocker

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/manage-bde

Use the 'on' subcommand to encrypt a drive and enable BitLocker protection.

```bash
manage-bde on
```

--------------------------------

### Display Help for bitsadmin /util Switches

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-util-and-help

Run this command to display the command-line help for the /util switches. This is useful for understanding all available options within the /util command.

```CLI
bitsadmin /util /help
```

--------------------------------

### Get Total Bytes for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getbytestotal

Use this command to retrieve the total size of a BITS job. Replace 'myDownloadJob' with the actual display name or GUID of your job.

```bash
bitsadmin /getbytestotal <job>
```

```bash
bitsadmin /getbytestotal myDownloadJob
```

--------------------------------

### Enable Windows Deployment Services

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/wdsutil-enable-server

Enables all services for Windows Deployment Services on the local server. No specific setup is required beyond having Windows Deployment Services installed.

```bash
wdsutil /Enable-Server
```

--------------------------------

### Schedule Task on System Startup

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/schtasks-create

Use the /sc onstart parameter to schedule a task that runs every time the system starts. The /sd parameter is optional.

```bash
schtasks /create /tn MyApp /tr c:\apps\myapp.exe /sc onstart

```

--------------------------------

### Display Operating Parameters

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/telnet-display

Use this command to view the current operating parameters of the telnet client. No specific setup or imports are required beyond having the telnet client installed.

```bash
d
```

--------------------------------

### Install MSI Package

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec

Use this command to perform a normal installation of an MSI package. Ensure the correct path to the .msi file is provided.

```bash
msiexec.exe /i "C:\example.msi"
```

--------------------------------

### Get Reply Data for a BITS Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getreplydata

Use this command to retrieve the hexadecimal reply data from the server for a BITS job. Specify the job's display name or GUID.

```bash
bitsadmin /getreplydata <job>
```

```bash
bitsadmin /getreplydata myDownloadJob
```

--------------------------------

### Get Modification Time for a Specific Job

Source: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/bitsadmin-getmodificationtime

Use this command to retrieve the last modified time for a BITS job named 'myDownloadJob'. Ensure the job name or GUID is accurate.

```bash
bitsadmin /getmodificationtime myDownloadJob
```
Tokens:
Raw