Skip to content

Commit a0f7363

Browse files
authored
Improve the public docs for VM Repair (#8581)
1 parent 34562a1 commit a0f7363

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

src/vm-repair/HISTORY.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Release History
33
===============
44

5+
2.1.1
6+
++++++
7+
Updated README file for `vm repair` extension.
8+
59
2.1.0
610
++++++
711
Added new parameter `--os-disk-type` to `vm repair create` to let users specify the repair vm's os disk storage account type.

src/vm-repair/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Azure CLI VM Repair Extension #
2-
This is a extension for repairing VMs.
2+
This is an extension for repairing VMs. Usually this is used to repair VMs that cannot boot by copying the
3+
OS Disk to a separate repair VM copy and run [repair scripts](https://github.com/Azure/repair-script-library) against it.
4+
VM Repair can also run repair scripts against the source VM itself.
5+
You can also create then run your own custom repair scripts, seen in the `--custom-script-file` parameter in the `az vm repair run` command.
36

47
### How to use ###
58
Install this extension using the below CLI command
@@ -8,11 +11,15 @@ az extension add --name vm-repair
811
```
912

1013
### Sample Commands ###
11-
Repair create command
14+
Create repair VM command
1215
```
1316
az vm repair create -g MyResourceGroup -n myVM --verbose
1417
```
15-
Restore command
18+
Run a repair script on the new repair VM
19+
```
20+
az vm repair run -g MyResourceGroup -n MySourceWinVM --run-id win-hello-world --run-on-repair --verbose
21+
```
22+
Restore the now fixed copied OS disk from the repair VM to the original VM
1623
```
1724
az vm repair restore -g MyResourceGroup -n myVM --verbose
18-
```
25+
```

src/vm-repair/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from codecs import open
99
from setuptools import setup, find_packages
1010

11-
VERSION = "2.1.0"
11+
VERSION = "2.1.1"
1212

1313
CLASSIFIERS = [
1414
'Development Status :: 4 - Beta',

0 commit comments

Comments
 (0)