Skip to content

Commit

Permalink
Update documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
MouriNaruto committed Jun 12, 2024
1 parent 5e0cfb2 commit 256cb3f
Show file tree
Hide file tree
Showing 2 changed files with 124 additions and 122 deletions.
244 changes: 122 additions & 122 deletions Documents/ConfigurationReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,6 @@
- Version (Number)
- GuestType (String)
- Name (String)
- ChipsetInformation (Object)
- BaseBoardSerialNumber (String)
- ChassisSerialNumber (String)
- ChassisAssetTag (String)
- Manufacturer (String)
- ProductName (String)
- Version (String)
- SerialNumber (String)
- Family (String)
- UUID (String)
- SKUNumber (String)
- ProcessorCount (Number)
- MemorySize (Number)
- ComPorts (Object)
Expand Down Expand Up @@ -119,6 +108,17 @@
- RedirectDynamicDevices (Boolean)
- Drives (String Array)
- Devices (String Array)
- ChipsetInformation (Object)
- BaseBoardSerialNumber (String)
- ChassisSerialNumber (String)
- ChassisAssetTag (String)
- Manufacturer (String)
- ProductName (String)
- Version (String)
- SerialNumber (String)
- Family (String)
- UUID (String)
- SKUNumber (String)

### NanaBox

Expand Down Expand Up @@ -148,116 +148,6 @@ The unique name of virtual machine.

Example value: "TestVM"

### ChipsetInformation

The chipset information object of virtual machine.

Note: Available starting with NanaBox 1.2 Update 4.

#### BaseBoardSerialNumber

The serial number of the baseboard of virtual machine.

Example value: "QTFCOU0000001"

Note: Available starting with NanaBox 1.2 Update 4.

#### ChassisSerialNumber

The serial number of the chassis of virtual machine.

Example value: "QTFCOU0000001"

Note: Available starting with NanaBox 1.2 Update 4.

#### ChassisAssetTag

The asset tag of the chassis of virtual machine.

Example value: "TestVM"

Note: Available starting with NanaBox 1.2 Update 4.

#### Manufacturer

The manufacturer of virtual machine.

Leave blank to use default vaule: "Microsoft Corporation"

Example value: "NVIDIA"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### ProductName

The product name of virtual machine.

Leave blank to use default vaule: "Virtual Machine"

Example value: "DGX-1"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### Version

The version of virtual machine.

Leave blank to use default vaule: "Hyper-V UEFI Release v4.1"

Example value: "DGX-1 with V100-32 1.0"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### SerialNumber

The serial number of virtual machine.

Leave blank to use default vaule

Example value: "QTFCOU0000001"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### Family

The family of virtual machine.

Leave blank to use default vaule: "Virtual Machine"

Example value: "Enterprise Server"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### UUID

The universally unique identifier of virtual machine.

Example value: "12345678-abcd-efgh-ijkl-0123456789ab"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### SKUNumber

The sku number of virtual machine.

Example value: "TestVM"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

### ProcessorCount

The processor count of virtual machine, in cores.
Expand Down Expand Up @@ -709,6 +599,116 @@ Example value: "USB\\VID_5986&PID_211C&MI_00\\6&218C4A3&0&0000"
Note: Available starting with NanaBox 1.1 and you can modify these settings at
runtime.

### ChipsetInformation

The chipset information object of virtual machine.

Note: Available starting with NanaBox 1.2 Update 4.

#### BaseBoardSerialNumber

The serial number of the baseboard of virtual machine.

Example value: "QTFCOU0000001"

Note: Available starting with NanaBox 1.2 Update 4.

#### ChassisSerialNumber

The serial number of the chassis of virtual machine.

Example value: "QTFCOU0000001"

Note: Available starting with NanaBox 1.2 Update 4.

#### ChassisAssetTag

The asset tag of the chassis of virtual machine.

Example value: "TestVM"

Note: Available starting with NanaBox 1.2 Update 4.

#### Manufacturer

The manufacturer of virtual machine.

Leave blank to use default vaule: "Microsoft Corporation"

Example value: "NVIDIA"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### ProductName

The product name of virtual machine.

Leave blank to use default vaule: "Virtual Machine"

Example value: "DGX-1"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### Version

The version of virtual machine.

Leave blank to use default vaule: "Hyper-V UEFI Release v4.1"

Example value: "DGX-1 with V100-32 1.0"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### SerialNumber

The serial number of virtual machine.

Leave blank to use default vaule

Example value: "QTFCOU0000001"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### Family

The family of virtual machine.

Leave blank to use default vaule: "Virtual Machine"

Example value: "Enterprise Server"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### UUID

The universally unique identifier of virtual machine.

Example value: "12345678-abcd-efgh-ijkl-0123456789ab"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

#### SKUNumber

The sku number of virtual machine.

Example value: "TestVM"

Note: You need Windows Server 2022 or later Host OS.

Note: Available starting with NanaBox 1.2 Update 4.

## Samples

### Typical Windows Virtual Machine
Expand Down Expand Up @@ -875,4 +875,4 @@ runtime.
"Version": 1
}
}
```
```
2 changes: 2 additions & 0 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ If you'd like me to add features or improvements ahead of time, please use
11 Version 24H2 or later Host OS. (Although Windows Server 2022 had introduced
the related Host Compute System API interfaces, but it seems doesn't be
implemented.)
- Support customize partial System Management BIOS (SMBIOS) information for
virtual machines.

## System Requirements

Expand Down

0 comments on commit 256cb3f

Please sign in to comment.