Smarter by Design.Simpler for Business
v-device
The v-device command manages the vDevice records on the device. Every vDevice carries its own network interfaces, processor cores, memory and disk space; the traffic objects run on a vDevice.
Command Summary
# Tab after the command
admin@TR7LBWAF01> v-device
add delete list show update
admin@TR7LBWAF01> v-device list
admin@TR7LBWAF01> v-device add name <name> memory 8 --interfaces.0 <interface> --cores.0 2
admin@TR7LBWAF01> v-device update id <id> …
admin@TR7LBWAF01> v-device delete <id>
admin@TR7LBWAF01>
Required Fields
In the add command the CLI asks for two fields in the order below; both are written with the field name and the value together. The interface and core lists are required in the schema, but because they are list fields the CLI does not ask for them: they have to be written with --.
| Order | Field | Status | Value |
|---|---|---|---|
| 1 | name | Required | A name specific to the record; the same name cannot be used on two vDevices |
| 2 | memory | Required | An integer between 1 and 64; the unit is GB |
| — | --interfaces.N | Required in the schema | It appears as optional in the completion list; at least one interface must be given |
| — | --cores.N | Required in the schema | It appears as optional in the completion list; at least one core must be given |
The List Fields
| Field | What it does | What is written after it |
|---|---|---|
--interfaces.N | Determines which network interfaces will be given to the vDevice | Ethernet interfaces, for example ETH-1, 10G-3; each interface with its own index |
--cores.N | Determines which processor cores will be given to the vDevice | An integer between 0 and 63; each core with its own index, the same core cannot be written twice |
In the update command the record to be edited is selected with id <id>; in the show and delete commands the id is written without a field name (v-device delete <id>).
Optional Fields
| Field | What it does | What is written after it |
|---|---|---|
--desc | Adds a description to the record | Free text, for example "vDevice for the vServices"; if it carries a space, inside double quotation marks |
--vmDataDiskSize | Determines the size of the application area | A number between 0.5 and 1024 (the default is 4); the unit is GB |
--rawDataDiskSize | Determines the size of the log and report area | A number between 0.5 and 1024 (the default is 16); the unit is GB |
Examples
# two interfaces, three cores, 16 GB of memory
admin@TR7LBWAF01> v-device add name vdev-web memory 16 \
--interfaces.0 10G-4 --interfaces.1 10G-5 \
--cores.0 4 --cores.1 5 --cores.2 6 \
--desc "Web vServices" --vmDataDiskSize 8 --rawDataDiskSize 64
# growing an existing record
admin@TR7LBWAF01> v-device list
admin@TR7LBWAF01> v-device update id <id> --memory 32 --rawDataDiskSize 128
# removing an entry from the core list
admin@TR7LBWAF01> v-device update id <id> --cores.2.delete
admin@TR7LBWAF01>
Things to Know
- The required fields do not take
--.nameandmemoryare written with the field name and the value side by side; the other fields are in the--field valueform. The detail is on the API Commands page. - The list fields are not asked for by the CLI.
--interfaces.Nand--cores.Nare required in the schema, but the command line does not ask for list fields as required fields; in theaddcommand both must be added with--. - Only ethernet interfaces can be selected. The
--interfaces.Nlist is limited to the interfaces of the device that are of the ethernet type. - The cores are not shared. The same core number cannot be written twice in one record; the core numbers are in the
0–63range. - The two disk areas are given separately.
--vmDataDiskSizeis the area of the application and--rawDataDiskSizethe area of the logs and the reports; both are in GB. - The vDevice is where the objects run. The listener addresses, the interfaces and the traffic objects are bound to a vDevice; the addresses are managed with the
network ipand the interfaces with thenetwork interfacecommands. - The list fields can be deleted one by one or all at once.
--<field>.N.deleteremoves a single entry, and--<field>.deleteempties the list.
