Skip to content

Commit 1e4a4db

Browse files
authored
pve*, qm*: add missing option placeholders (#17558)
1 parent 205090d commit 1e4a4db

File tree

11 files changed

+30
-30
lines changed

11 files changed

+30
-30
lines changed

pages/linux/pct-clone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Clone a container with a custom name:
1111

12-
`pct clone {{template_id}} {{copy_id}} --hostname {{host_name}}`
12+
`pct {{[cl|clone]}} {{template_id}} {{copy_id}} --hostname {{host_name}}`

pages/linux/pct-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
66
- Convert a container into a template:
77

8-
`pct template {{100}}`
8+
`pct {{[t|template]}} {{100}}`

pages/linux/pve-firewall.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
66
- Compile and print all firewall rules:
77

8-
`pve-firewall compile`
8+
`pve-firewall {{[c|compile]}}`
99

1010
- Show information about the local network:
1111

12-
`pve-firewall localnet`
12+
`pve-firewall {{[l|localnet]}}`
1313

1414
- Restart the Proxmox VE Firewall service:
1515

16-
`pve-firewall restart`
16+
`pve-firewall {{[r|restart]}}`
1717

1818
- Start the Proxmox VE Firewall service:
1919

@@ -25,7 +25,7 @@
2525

2626
- Simulate all firewall rules:
2727

28-
`pve-firewall simulate`
28+
`pve-firewall {{[si|simulate]}}`
2929

3030
- Show the status of Proxmox VE Firewall:
3131

pages/linux/pveam.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
66
- Update container template database:
77

8-
`pveam update`
8+
`pveam {{[u|update]}}`
99

1010
- List available templates:
1111

12-
`pveam available`
12+
`pveam {{[a|available]}}`
1313

1414
- Download a template:
1515

16-
`pveam download {{local}} {{template_name}}`
16+
`pveam {{[d|download]}} {{local}} {{template_name}}`
1717

1818
- List downloaded templates:
1919

20-
`pveam list {{local}}`
20+
`pveam {{[l|list]}} {{local}}`

pages/linux/pvecm.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@
99

1010
- Add a node to the cluster configuration (internal use):
1111

12-
`pvecm addnode {{node}}`
12+
`pvecm {{[addn|addnode]}} {{node}}`
1313

1414
- Display the version of the cluster join API available on this node:
1515

16-
`pvecm apiver`
16+
`pvecm {{[ap|apiver]}}`
1717

1818
- Generate new cluster configuration:
1919

20-
`pvecm create {{clustername}}`
20+
`pvecm {{[c|create]}} {{clustername}}`
2121

2222
- Remove a node from the cluster configuration:
2323

24-
`pvecm delnode {{node}}`
24+
`pvecm {{[d|delnode]}} {{node}}`
2525

2626
- Display the local view of the cluster nodes:
2727

28-
`pvecm nodes`
28+
`pvecm {{[n|nodes]}}`
2929

3030
- Display the local view of the cluster status:
3131

32-
`pvecm status`
32+
`pvecm {{[s|status]}}`

pages/linux/pvesh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
66
- List available nodes:
77

8-
`pvesh get /nodes`
8+
`pvesh {{[g|get]}} /nodes`
99

1010
- Discover API paths:
1111

12-
`pvesh ls {{/}}`
12+
`pvesh {{[l|ls]}} {{/}}`

pages/linux/pvesm.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
66
- Get status for all datastores:
77

8-
`pvesm status`
8+
`pvesm {{[st|status]}}`
99

1010
- List storage contents:
1111

12-
`pvesm list {{storage_name}}`
12+
`pvesm {{[l|list]}} {{storage_name}}`
1313

1414
- Add a directory storage:
1515

16-
`pvesm add dir {{storage_name}} --path {{path/to/directory}}`
16+
`pvesm add {{[d|dir]}} {{storage_name}} --path {{path/to/directory}}`
1717

1818
- Remove a storage:
1919

20-
`pvesm remove {{storage_name}}`
20+
`pvesm {{[r|remove]}} {{storage_name}}`

pages/linux/pveum.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
66
- List users:
77

8-
`pveum user list`
8+
`pveum {{[u|user]}} {{[l|list]}}`
99

1010
- Add a user:
1111

12-
`pveum user add {{username}}@pve`
12+
`pveum {{[u|user]}} {{[a|add]}} {{username}}@pve`
1313

1414
- Delete a user:
1515

16-
`pveum user delete {{username}}@pve`
16+
`pveum {{[u|user]}} {{[d|delete]}} {{username}}@pve`

pages/linux/qm-disk-rescan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
66
- Rescan all storages and update disk sizes and unused disk images of a specific virtual machine:
77

8-
`qm disk rescan {{vm_id}}`
8+
`qm {{[di|disk]}} {{[resc|rescan]}} {{vm_id}}`
99

1010
- Perform a dry-run of rescan on a specific virtual machine and do not write any changes to configurations:
1111

12-
`qm disk rescan --dryrun {{true}} {{vm_id}}`
12+
`qm {{[di|disk]}} {{[resc|rescan]}} --dryrun {{true}} {{vm_id}}`

pages/linux/qm-list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
66
- List all virtual machines:
77

8-
`qm list`
8+
`qm {{[l|list]}}`
99

1010
- List all virtual machines with a full status about the ones which are currently running:
1111

12-
`qm list --full 1`
12+
`qm {{[l|list]}} --full 1`

0 commit comments

Comments
 (0)