Edit-Nano Server Image

Module:: nanoserverimagegenerator

Modifies a Nano Server installation image.

Syntax

Edit-NanoServerImage
    [[-BasePath] <String>]
    [-TargetPath] <String>
    [[-SetupUI] <String[]>]
    [[-Package] <String[]>]
    [[-ServicingPackagePath] <String[]>]
    [[-ComputerName] <String>]
    [[-AdministratorPassword] <SecureString>]
    [[-UnattendPath] <String>]
    [[-DomainName] <String>]
    [[-DomainBlobPath] <String>]
    [[-DriverPath] <String[]>]
    [[-InterfaceNameOrIndex] <String>]
    [[-Ipv6Address] <String>]
    [[-Ipv6Dns] <String[]>]
    [[-Ipv4Address] <String>]
    [[-Ipv4SubnetMask] <String>]
    [[-Ipv4Gateway] <String>]
    [[-Ipv4Dns] <String[]>]
    [[-DebugMethod] <String> {Serial | Net | 1394 | USB}
    [[-DebugBaudRate] <UInt32>]
    [[-DebugBusParams <String>]
    [[-DebugChannel] <UInt16>]
    [[-DebugCOMPort] <Byte>]
    [[-DebugKey] <String>]
    [[-DebugPort] <UInt16>]
    [[-DebugRemoteIP] <String>]
    [[-DebugTargetName] <String>]]
    [-EnableEMS]
    [[-EMSPort] <Byte>]
    [[-EMSBaudRate] <UInt32>]
    [[-CopyPath] <Object>]
    [[-SetupCompleteCommand] <String[]>]
    [[-LogPath] <String>]
    [[-OfflineScriptPath] <String[]>]
    [[-OfflineScriptArgument] <Hashtable>]
    [[-Internal] <String>]
    [-Storage]
    [-Compute]
    [-Defender]
    [-Clustering]
    [-OEMDrivers]
    [-Containers]
    [-ReuseDomainNode]
    [-EnableRemoteManagementPort]
    [-Development]
    [<CommonParameters>]

Description

The Edit-NanoServerImage cmdlet adds packages, drivers, and configures operating system options for a base Nano Server installation. The cmdlet operates on an image produced by the New-NanoServerImage cmdlet.

You can use the Edit-NanoServerImage cmdlet to do the following operations:

Add packages.
Add drivers.
Add servicing packages (updates).
Add an unattended setup file (unattend.xml).
Add files.
Add setup scripts.
Set the computer name.
Set the administrator password.
Configure network settings.
Join a domain.
Enable debugging.
Enable Emergency Management Services (EMS).
Enable remote management.
Enable development options.

Examples

Example 1: Modify a Nano Server installation image

PS C:\> Edit-NanoServerImage -MediaPath D:\ -BasePath .\Base -TargetPath .\NanoServer.vhdx -Compute -ComputerName Nano -DomainName ContosoDomain -AdministratorPassword (ConvertTo-SecureString -String "Passw0rd" -AsPlainText -Force)

This example assumes that you've run the New-NanoServerImage cmdlet and specified .\Base as the base path.

This command edits the existing Nano Server image (NanoServer.vhdx) specified by the TargetPath parameter and the existing Nano Server files in the .\Base folder as specified by the BasePath parameter are reused. The command adds the Compute (Hyper-V) package, sets the computer name to Nano, sets the administrator password to Passw0rd, and performs an offline domain join of the machine to ContosoDomain.

Required Parameters

-DebugChannel

Specifies the channel that the computer running the debugger can use to connect to the host. This parameter is only applicable when DebugMethod is 1394.

Type:	UInt16
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugPort

Specifies the port that the computer running the debugger can use to connect to the host. This parameter is only applicable when DebugMethod is Net.

Type:	UInt16
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugRemoteIP

Specifies the IP address of the computer running the debugger. This parameter is only applicable when DebugMethod is Net.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugTargetName

Specifies the target name that the computer running the debugger can use to connect to the host. This parameter is only applicable when DebugMethod is USB.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-TargetPath

Specifies the path of the final, modified image. The image format is determined based on the file extension. Possible extension values are .vhd, .vhdx, and .wim.

Type:	String
Position:	1
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Optional Parameters

-AdministratorPassword

Specifies the password for the built-in Administrator account for the image. If you do not specify this value on the command line, this cmdlet prompts you for the password.

Type:	SecureString
Position:	6
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-BasePath

Specifies the path where Nano Server files are copied from the source media. These files are not automatically deleted after running Edit-NanoServerImage or New-NanoServerImage. This enables you to copy the Nano Server files from the source media once with the MediaPath parameter and reuse the same files with the BasePath parameter when running Edit-NanoServerImage or New-NanoServerImage again.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Clustering

Indicates that this operation adds the Clustering package. This package includes Failover Clustering, VM Failover Clustering, Volume Replication Clustering, Storage Spaces Direct (S2D), Storage Quality of Service (QoS), and SMB Witness Service.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Compute

Indicates that this operation adds the Compute package. This package includes Hyper-V and NetQoS.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputerName

Specifies the computer name of the image.

Type:	String
Position:	5
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Containers

Indicates that this operation adds the Containers package. This package includes host support for Windows Containers.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-CopyPath

Specifies one or more files to copy into the target image. This parameter accepts a path to a single file, an array of paths to multiple files, or a hashtable of file paths and target directories where the keys are the file path names and the values are the target directories. For example, @{"C:\mytool.exe"="windows"} will copy mytool.exe from C:\ on the source machine to the windows directory in the target image.

Type:	Object
Position:	21
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugBaudRate

Specifies the baud rate to use for kernel debugging. This parameter is only applicable when DebugMethod is Serial. The default rate is 115200 bps.

Type:	UInt32
Position:	Named
Default value:	115200
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugBusParams

Specifies additional bus parameters to use for network kernel debugging (KDNet). This parameter is only applicable when DebugMethod is Net.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugCOMPort

Specifies the serial port that kernel debugging is enabled on. This parameter is only applicable when DebugMethod is Serial. The default port is 2.

Type:	Byte
Position:	Named
Default value:	2
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugKey

Specifies the shared key secret for establishing the debugger connection. This parameter is only applicable when DebugMethod is Net.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DebugMethod

Specifies the method of kernel debugging for the target image. The acceptable values for this parameter are:

Serial
Net (KDNET)
1394 (FireWire)
USB

Depending on the value of this parameter, other parameters become available.

Type:	String
Parameter Sets:	Serial, Net, 1394, USB
Position:	18
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Defender

Indicates that this operation adds the Windows Defender package. This package also includes a default malware definition file for Windows Defender.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Development

Indicates that this operation enables settings for development and testing scenarios on Nano Server. This includes enabling PowerShell as the default local shell, allowing installation of unsigned drivers, copying debugger binaries into the image, opening a port for debugging, enabling test signing, and enabling installation of AppX packages without a developer license.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainBlobPath

Specifies the path to a domain blob. This cmdlet joins the image to the domain that this parameter specifies. You can harvest a domain blob from a computer that is joined to the domain using the djoin.exe tool with the Provision parameter. Save the blob to a file and specify the path to the blob file using this parameter.

Type:	String
Position:	9
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainName

Specifies a domain name. This cmdlet performs an offline join to the domain specified by this parameter. A domain blob is retrieved from the local computer. If the local computer is not a member of the specified domain, the command fails. In this case, harvest a domain blob from a computer that is joined to the domain and use the DomainBlobPath parameter instead.

Type:	String
Position:	8
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DriverPath

Specifies one or more paths to driver .inf files and binary files to add to the image. Paths can be directories containing drivers or paths to individual driver files. For each driver, both the .inf and .sys files must be present. Only 64-bit drivers are supported on Nano Server. If the drivers are not signed, the command fails.

Type:	String[]
Position:	10
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EMSBaudRate

Specifies the baud rate for Emergency Management Services (EMS). The default is 115200 bps.

Type:	UInt32
Position:	20
Default value:	115200
Accept pipeline input:	False
Accept wildcard characters:	False

-EMSPort

Specifies the port on which to enable Emergency Management Services (EMS). The default is 1.

Type:	Byte
Position:	19
Default value:	1
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableEMS

Indicates that this operation enables Emergency Management Services (EMS) and BootEMS on the image.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableRemoteManagementPort

Indicates that this operation opens port 5985 for inbound TCP connections for Windows Remote Management (WinRM) and enable the Remote Event Log Management firewall group.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InterfaceNameOrIndex

Specifies the network adapter interface name or index to modify. You can get the interface name or index using Get-NetAdapter , netsh, or Recovery Console.

Type:	String
Position:	11
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Internal

This parameter is reserved for internal use.

Type:	String
Position:	26
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Ipv4Address

Specifies the given IPv4 static address on the interface specified by the InterfaceNameOrIndex parameter.

Type:	String
Position:	14
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Ipv4Dns

Specifies an array of static IPv4 DNS server addresses.

Type:	String[]
Position:	17
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Ipv4Gateway

Specifies the given IPv4 gateway on the interface specified by the InterfaceNameOrIndex parameter.

Type:	String
Position:	16
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Ipv4SubnetMask

Specifies the IPv4 subnet mask on the interface specified by the InterfaceNameOrIndex parameter.

Type:	String
Position:	15
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Ipv6Address

Specifies the IPv6 static address on the interface specified by the InterfaceNameOrIndex parameter.

Type:	String
Position:	12
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Ipv6Dns

Specifies an array of static IPv6 DNS server addresses.

Type:	String[]
Position:	13
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-LogPath

Specifies the path where log files from the operation will be collected. If LogPath is not specified, all logs are collected into a Logs folder in BasePath.

Type:	String
Position:	23
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-OEMDrivers

Indicates that this operation adds the OEM Drivers package. This package includes drivers for a variety of network adapters, storage controllers, and other peripherals. This is the same set of drivers included in a Server Core installation of Windows Server.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-OfflineScriptArgument

Use the OfflineScriptPath parameter to specify an array of paths to PowerShell (.ps1) scripts. If those scripts take arguments, use the OfflineScriptArgument parameter to pass a hashtable of additional arguments to the scripts.

Type:	Hashtable
Position:	25
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-OfflineScriptPath

Type:	String[]
Position:	24
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Package

Specifies an array of Nano Server packages to add. Packages are stored in the NanoServer\Packages folder on the installation media. You can get a list of Nano Server packages by running the Get-NanoServerPackage cmdlet.

Type:	String[]
Position:	3
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ReuseDomainNode

Indicates that this operation reuses a node with the same name if it exists when joining a domain.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicingPackagePath

Specifies an array of servicing packages (updates) to add.

Type:	String[]
Position:	4
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SetupCompleteCommand

Specifies an array of commands to run after setup completes.

Type:	String[]
Position:	22
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SetupUI

This parameter is reserved for internal use.

Type:	String[]
Position:	2
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Storage

Indicates that this operation adds the Storage package. This package includes the File Server role, Data Deduplication, Multipath I/O, including a driver for Microsoft Device-Specific Module (MSDSM), ReFS (v1 and v2), iSCSI Initiator (but not iSCSI Target), Storage Replica, Storage Management Service with SMI-S support, SMB Witness Service, Volume Shadow Copy Service (VSS), Dynamic Volumes, and basic Windows storage providers (for Windows Storage Management). Note that when using the Storage parameter to install the File Server role, the role is installed but not enabled. You can enable the File Server role from a remote computer using Server Manager.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-UnattendPath

Specifies the path to an unattended setup file (unattend.xml).

Type:	String
Position:	7
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None.

Outputs

None.

Edit-Nano Server Image

Syntax

Description

Examples

Required Parameters

Optional Parameters

Inputs

Outputs

Feedback

Liquid error: Can't find the localized string giveDocumentationFeedback for template Conceptual.

Edit-Nano Server Image

Syntax

Description

Examples

Required Parameters

Optional Parameters

Inputs

Outputs

Related Links

Feedback

Liquid error: Can't find the localized string giveDocumentationFeedback for template Conceptual.