Sha256: acf64645d55316a7deaf77ede1ea667759c61cb710595c7f9bc6f6b1c8099ebf

Contents?: true

Size: 1.78 KB

Versions: 46

Compression:

Stored size: 1.78 KB

Contents

# `free_veids`

The `free_veids` executable will output all free VEIDs (smaller than 10000).
Useful to assign unused VEIDs to new VMs to be created.

***This executable is still in alpha version: not properly tested, no clear process, no stable interface. Pending [this ticket](https://github.com/sweet-delights/hybrid-platforms-conductor/issues/45).***

## Process

<!-- Mermaid generator - Section start -->
![Mermaid diagram](/docs/gen/mermaid/docs/executables/free_veids.md-0.png)
<details>
<summary><sub><sup>Diagram code</sup></sub></summary>

```mermaid
sequenceDiagram
participant Main as ./bin/free_veids
participant CMDB as CMDB

Main->>+CMDB: Get VEID metadata for nodes
CMDB-->>-Main: VEIDs
Main->>Main: Display free VEIDs
```
</details>
<!-- Mermaid generator - Section end -->

## Usage

```
Usage: ./bin/free_veids [options]

Main options:
    -d, --debug                      Activate debug mode
    -h, --help                       Display help and exit

Nodes handler options:
    -o, --show-nodes                 Display the list of possible nodes and exit

Command runner options:
    -s, --show-commands              Display the commands that would be run instead of running them
```

## Examples

```bash
./bin/free_veids
```

Example of output:
```
=> ./bin/free_veids
Free VEIDs: [420, 426, 428, 430, 434, 437..438, 445..446, 449..450, 453, 456..457, 459, 464, 466..467, 471, 475..476, 484, 488, 490, 493, 500..502, 504..513, 523, 525, 536, 544, 546, 554..555, 560..566, 578, 589, 594, 642..659, 668..9999]
```

## Used credentials

| Credential | Usage
| --- | --- |

## Used Metadata

| Metadata | Type | Usage
| --- | --- | --- |
| `veid` | `String` or `Integer` | VEID associated to the node |

## Used environment variables

| Variable | Usage
| --- | --- |

## External tools dependencies

None

Version data entries

46 entries across 46 versions & 1 rubygems

Version Path
hybrid_platforms_conductor-33.9.5 docs/executables/free_veids.md
hybrid_platforms_conductor-33.9.4 docs/executables/free_veids.md
hybrid_platforms_conductor-33.9.2 docs/executables/free_veids.md
hybrid_platforms_conductor-33.9.1 docs/executables/free_veids.md
hybrid_platforms_conductor-33.9.0 docs/executables/free_veids.md
hybrid_platforms_conductor-33.8.4 docs/executables/free_veids.md
hybrid_platforms_conductor-33.8.3 docs/executables/free_veids.md
hybrid_platforms_conductor-33.8.2 docs/executables/free_veids.md
hybrid_platforms_conductor-33.8.1 docs/executables/free_veids.md
hybrid_platforms_conductor-33.8.0 docs/executables/free_veids.md
hybrid_platforms_conductor-33.7.4 docs/executables/free_veids.md
hybrid_platforms_conductor-33.7.3 docs/executables/free_veids.md
hybrid_platforms_conductor-33.7.2 docs/executables/free_veids.md
hybrid_platforms_conductor-33.7.1 docs/executables/free_veids.md
hybrid_platforms_conductor-33.7.0 docs/executables/free_veids.md
hybrid_platforms_conductor-33.6.0 docs/executables/free_veids.md
hybrid_platforms_conductor-33.5.1 docs/executables/free_veids.md
hybrid_platforms_conductor-33.5.0 docs/executables/free_veids.md
hybrid_platforms_conductor-33.4.0 docs/executables/free_veids.md
hybrid_platforms_conductor-33.3.0 docs/executables/free_veids.md