Skip to content

Commit

Permalink
chore(docs): Sync wiki to wiki/ [skip-cd]
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 12, 2024
1 parent cb0629d commit b155eec
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions wiki/πŸ“—-[User-Guide]-CLI-‐-Language.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
+ [Interact with Rack](#interact-with-rack)
* [Device](#device)
+ [Interact with Device](#interact-with-device)
+ [Add Virtual Config](#add-virtual-config)
* [Group](#group)
+ [Interact with Group](#interact-with-group)
* [Corridor](#corridor)
Expand Down Expand Up @@ -924,6 +925,26 @@ All other devices (blades / components like processor, memory, adapters, disks..
[name]:localCS=[true|false]
```

### Add Virtual Config

A `virtual_config` can be added to a device to add information related to its virtual setup. It can be used to link a device to a virtual object using the `clusterId`. A simple use case is to add a `virtual_config` to a server to state that this server device is a "node" (`type`) of my cluster represented by a virtual object with id "my-proxmox-cluster" (`clusterId`).

```
[name]:virtual_config=[type]
[name]:virtual_config=[type]@[clusterId]
[name]:virtual_config=[type]@[clusterId]@[role]
```

*`[type]` is a string to describe the type of this device in its virtual setup
`[clusterId]` is the ID of an existing virtual object to which this device will be linked
`[role]` is a string to describe the role of this device in its virtual setup*

```
/P/siteA/BldgA/R1/A01/server:virtual_config=node
/P/siteA/BldgA/R1/A01/server:virtual_config=node@my-proxmox-cluster
/P/siteA/BldgA/R1/A01/server:virtual_config=node@my-proxmox-cluster@proxmox
```

## Group

```
Expand Down

0 comments on commit b155eec

Please sign in to comment.