Skip to content

CSV Specifications

This section will provide details of different CSV formats, the definition of columns, possible values, and validation details:

  • Gold Master CSV

  • Courses CSV

  • HyLabs Users CSV

  • Reservation CSV

  • Classification Rules CSV

Gold Master CSV

All specifications of the Gold Master CSV are provided in tabular format:

Column Description Mandatory Type Max Length I18N Allowed

Characters
Default Value if missing Example data and output with different inputs
UseVDI If enabled (UseVDI=1), then it will import. If already imported and set to do not use(UseVDI=0), then delete the record from the HyLabs configuration/RMS. For New record if we set UseVDI=0 then the record will not be imported. No Int 1 1 byte 1,0, blank 0 If UseVDI = 1: import.

If already imported and UseVDI = 0: Delete from HyLabs.

New entry and UseVDI = 0: Do not import.

New entry and UseVDI = other than 0/1 e.g., 2 or ‘abc’: Do not import
Provider hostname (or IP address) of the provider server. It can be the hostname or IP address of provider server from which gold master will be imported. This provider must be already registered within HyLabs No String 64 1 byte Allowed hostname and IP address characters Read from HyLabs settings E,g., 172.17.23.256 OR vcenter.accops.com

If blank and only single provider in HyLabs: read from HyLabs.

If blank and multiple providers in HyLabs: Error to specify provider.

If incorrect provider: error and do not import .
Gold Master Name Name of gold master as on VMWare Yes String 64 2 bytes [A-Za-z0-9-_SPACE] Check VMWare Specs error E.g., Maths_gm_001

Blank or incorrect GM name: Do not import and error in resultant CSV .
Max Total VM Maximum number of virtual machines created from this VM which are in running state at a specific time. This means total VM of all running reservations for this gold master 0 means no limit max is 99999 No Number 5 1 byte 0-99999 Unlimited E.g., 500

Blank: Unlimited.

Non-numerical value: Do not import and error in resultant CSV.

Greater than 99999: Error
Max Active VM Maximum number of virtual machines created from this VM which are in running state as well as standby state. This means total of all VMs from this gold master across all reservations for any time 0 means no limit max is 99999 No Number 5 1 byte 0-99999 Unlimited E.g., 5000

Blank: Unlimited

Non-numerical value: Do not import and error in resultant CSV.

Greater than total: Error. Greater than 99999: Error
Max Concurrent Connections Maximum number of virtual machines concurrently created from this VM which are in running state as well as standby state. This means total concurrent of all VMs from this gold master across all reservations for any time 0 means no limit max is 99999 No Number 5 1 byte 0-99999 Unlimited E.g., 50

Blank: Unlimited Non-numerical value: Do not import and error in resultant CSV.

Greater than total: Error Greater than 99999: Error
Assignment Type Assigned for course, faculty, or self-study only, or default gold master C: course S: self-study only F: faculty D: default GM for all users No Character 1 1 byte [CSFD] D E.g., C

Blank: Course default

Invalid character other than C,S,F,D or blank: Error.
Gold Master Type GM with Windows OS, Ubuntu OS, CentOS WXXX: Windows, WS16-Win2016 LUXX: Ubuntu LCXX: CentOS Yes String 4 1 byte [] Error E.g., LUXX

Blank: Error

Invalid (other than specified): Error
RDP Port Remote connection port. Connections from HyLite to reserved VMs (from this GM) will use this port e.g., 3389. No Integer 5 1 byte 0-99999 3389 E.g., 3389.

Blank: 3389

Invalid values (other than specified): Error.

Pl. note, by default valid port range is 0-65535.
Realmname Organization name in HyLabs. It is useful when there will be multiple colleges using same HyLabs, but each college has different authentication settings and different resources No String 64 2 bytes [A-Za-z0-9-_] default E.g., College of Economics

Blank: Default Organization or Realm

Invalid Organization: Error

Courses CSV

Column Description Mandatory Type Max Length I18N Allowed Characters Default Value if missing Example data and output with different inputs
UseVDI If enabled(UseVDI=1), then it will import. If already imported and set to do not use(UseVDI=0), then delete the record from the HyLabs configuration/RMS. For New record if we set UseVDI=0 then the record will not be imported. No Int 1 1 byte 1,0, blank 0 If UseVDI = 1: import.

If already imported and UseVDI = 0: Delete from HyLabs.

New entry and UseVDI = 0: Do not import.

New entry and UseVDI = other than 0/1 e.g., 2 or ‘abc’: Do not import
Class Code Unique code for each course Yes String 16 1 byte [A-Za-z0-9-_] error E.g., MATH-001

Class code = blank: Error

Not supported chars: Error
Class Display Name Display name of the class Yes String 64 2 bytes [A-Za-z0-9-_SPACE, Unicode] error E.g., Mathematics

Class Display Name = blank: error

Not supported chars: Error
Classroom Classroom No String 16 2 bytes [A-Za-z0-9-_SPACE, Unicode] E.g., LAB 1

No errors if left blank.
Department Department No String 64 2 bytes [A-Za-z0-9-_SPACE, Unicode] E.g., Science

No errors if left blank.
Group Course group name No String 64 2 bytes [A-Za-z0-9-_SPACE] E.g., ExampleGroup

No errors if left blank.
Max Participant Number of participants Yes Number 5 1 byte 0-99999 0 E.g., 50

Blank: Error

Non-numeric: Error
Realmname Organization name in HyLabs. It is useful when there will be multiple colleges using same HyLabs, but each college has different authentication settings and different resources No String 64 2 bytes [A-Za-z0-9-_] default E.g., Economics

Blank: Default Organization or Realm

Invalid Organization: Error

HyLabs users CSV

Note

  • Class Code field does not support multiple values using semicolon as separator. The field for multi-value separation will also be removed from HyLabs portal > CSV Import Profile wizard.
Column Description Mandatory Type Max Length I18N Allowed Characters Default Value if missing Example data and output with different inputs
UseVDI If enabled, import. If already imported and set to do not use, then delete from database No Int 1 1 byte 1,0, blank 0 If UseVDI = 1: import.

If already imported and UseVDI = 0: Delete from HyLabs.

New entry and UseVDI = 0: Do not import.

New entry and UseVDI = other than 0/1 e.g., 2 or ‘abc’: Do not import
Role Role of this participant Participant: Participant/Student Incharge: Faculty Assistant: Assistant XXXXXX: Any custom role on HyLabs Yes String 64 1 byte [A-Za-z0-9-_SPACE] Participant E.g., Faculty

Error if left blank

Error if role not found
Display Name User display name Yes String 64 2 bytes [A-Za-z0-9-_SPACE] Check AD Specs error E.g., Shubhash Yadav

Error if left blank
Username AD UserId Yes String 64 2 bytes [A-Za-z0-9-_SPACE] Check AD Specs error Shubhashyadav

Error if left blank
Class Code (M) Code of the course
Does not support multiple values using custom separator
No If custom role String 64 2 bytes [A-Za-z0-9-_;] error if HyLabs Role MATH-001

Error if left blank

Error if class code not found
Email User’s email address No String 254 2 bytes username@domain Saved as blank Shubhash.Yadav@accops.com

- Error if invalid email format is specified.
Realmname Organization name in HyLabs. It is useful when there will be multiple colleges using same HyLabs, but each college has different authentication settings and different resources No String 64 2 bytes [A-Za-z0-9-_] default Economics

Blank: Default Organization or Realm

Invalid Organization: Error

Reservations CSV

CSV Specification Before 3.4-SP1-HF1 or Older

In HyWorks v3.4-SP1-HF2 some new fields are added and thus, the specifications are different for these versions. If deployment is having Controller version v3.4-SP1-HF1 or older, please use below specifications. For later versions, CSV specifications are given later in this document.

Column Description Mandatory Type Max Length I18N Allowed Characters Default Value if missing Example data and output with different inputs
UseVDI If enabled, import. If already imported and set to do not use, then disable or delete from database No Int 1 1 byte 1,0, blank 0 0 or 1

If UseVDI = 1: import. If already imported and UseVDI = 0 > Do not process. Like other CSVs, it does not delete existing reservations. New entry and UseVDI = 0 : Do not import. New entry and UseVDI = other than 0/1 e.g., 2 or ‘abc’: Do not import
Reservation

Type
Whether course reservation or Self-study reservation C: for course (possible for self-study) S: Only self-study No Character 1 1 byte [CS] Course Reservation E.g., C

If left blank then Course reservation If invalid: Error
Class Code Unique code for each course Yes String 64 2 bytes [A-Za-z0-9-_] error E.g., MATH-001

Blank or invalid data: Error
Gold Master

Name
Name of gold master as on VMWare This gold master must be already imported into HyLabs using CSV or from UI and this gold master assignment type must be [Course or Default] Yes String 64 2 bytes [A-Za-z0-9-_SPACE]

Check VMWare Specs
error E.g., Maths_gm_001

Blank or invalid data: Error
Max

Participant
Number of VM to create This number must be less than or equal to = students + [faculty + assistant] Yes Number 5 1 byte 1-99999 error E.g., 50

Blank or invalid data or greater than 99999: Error
Start Date Date from when to create this reservation format: DD/MM/YYYY Yes Date 10 1 byte [0-9/] error E.g., 19/12/2017

Blank or invalid data: Error
End Date Date on which reservation will expire Format: DD/MM/YYYY Yes No Date 10 1 byte [0-9/] No End Date E.g., 19/12/2018

Blank or invalid data: Error
Schedule

Code
This is a unique code for each schedule as per timetable. For e.g., M1, T3, F4, etc Yes String 3 1 byte [A-Za-z0-9] error E.g., M12

Blank or invalid data: Error
Recurrence

Pattern
If the recurrence happens every day or every week D: Daily, W: Weekly, 0: not recurring No Character 1 1 byte [0DW] 0 (not recurring) E.g., W

Blank: Not recurring

Invalid Char: Error
Recurring

Frequency
Decide if the recurrence happen every day/week or x day/week 0: not recurring 1: every 1 day/week 2: every 2 day/week 3: every 3 day/week 4: every 4 day/week No Int 1 1 byte [0-5] 0 (not recurring) E.g., 1

Blank: Not recurring

Invalid Char: Error
Daysof

Schedule
In case of reservation for multiple days (but same time), use this flag. This is bitwise operator Bit wise operation None = 0x0, Monday = 0x1(1) Tuesday = 0x2(2), Wednesday = 0x4(4), Thursday = 0x8(8), Friday = 0x10(16), Saturday = 0x20(32), Sunday = 0x40(64), No Int 2 1 byte [0/1/2/4/8/

16/32/64]
0 E.g., 1

Blank: 0 = None Invalid Char: Error
Start Time start time of the reservation Yes Time 4 1 byte [XXXX] [0-9] error E.g., 0900

Blank: Error

Invalid Char: Error
End Time end time of the reservation Yes Time 4 1 byte [XXXX] [0-9] error E.g., 1030

Blank: Error

Invalid Char: Error
Enable course

extension
If faculty can extend the reservation beyond end time No Int 1 1 byte [0-1] 0 (disable extension) E.g., 0 or 1

Blank: 0

Invalid Char: Error.

It accepts only 0 or 1 as input.
course reservation

Extension step

count
If extension allowed how many times reservation can be extended. For e.g., faculty can extend the session only maximum 5 times In case of self-study reservation, this field is for student No Int 2 1 byte [0-9] 5 (5 times

extensions

allowed if

extension

permission)
E.g., 5

If Course Extensions Enabled but this field is blank: 5 times

Invalid Char: Error
course res Extension step interval in minutes Interval in minutes for which the reservation can be extended in each extension. For e.g., each time faculty can extend the reservation only for 15 minutes In case of self-study reservation, this field is for student No Int 2 1 byte [0-9] 15 (maximum

extension

per try)
E.g., 30

If Course Extensions Enabled but this field is blank: 15 minutes

Invalid Char: Error
Enable Course Self-study Allow students to reserve VM from this reservation for self-study 0: disable self-study 1: allow self-study No Int 1 1 byte [0-1] 0 ( not enabled) E.g., 1

Blank: 0

Invalid char: Error
Self-study max count Maximum self-study VM usage from this reservation No Int 5 1 byte 1-99999 same as max

participant
E.g., 13

Blank: Same as max participant (if Self-study is enabled)

Invalid char: Error
Self-study max duration Maximum duration of self-study reservation in minutes 0: no limit X: minutes No Int 4 1 byte [0/30/60/120/

180/240/300]
0 (no limit) E.g., 120

Blank: Unlimited

Invalid char: Error
Self-study Allow time extension Allow student to extent their reservation No Int 1 1 byte [0-1] 0 (disable

extension)
E.g., 1

Blank: 0 (Not enabled)

Invalid char: Error
Self-study Window start time Self-study reservation can be used only after this time (say after university work hours) No Time 4 1 byte [XXXX] [0-9] no

limitation
E.g., 1730

Blank: No restrictions

Invalid char: Error
Self-study Window end time Self-study reservations must finish before this time (say before university work hour start) No Time 4 1 byte [XXXX] [0-9] no

limitation
E.g., 0630

Blank: No restrictions

Invalid char: Error
delete VM

after reservation

finish
Delete the linked clones after reservation end. When the reservation starts again, recreate the linked clones 0: keep the linked clones 1: delete linked clones after reservation time over (not expire) No Int 1 1 byte [0-1] 0 (keep VM) E.g., 0

Blank: 0 (Keep VMs)

Invalid char: Error
Realmname Organization name in HyLabs. It is useful when there will be multiple colleges using same HyLabs, but each college has different authentication settings and different resources No String 64 2 bytes [A-Za-z0-9-_] default E.g., Economics

Blank: Default Organization or Realm

Invalid Organization: Error

CSV Specification for v3.4-SP1-HF2 or Later

In HyWorks v3.4-SP1-HF2 some new fields are added and thus, the specifications are different for these versions. If deployment is having Controller version v3.4-SP1-HF2 or newer, please use below specifications. For older versions, CSV specifications are given above in this document.

Column Description Mandatory Type Max Length I18N Allowed Characters Default Value if missing Example data and output with different inputs
UseVDI If enabled, import. If already imported and set to do not use, then disable or delete from database No Int 1 1 byte 1,0, blank 0 0 or 1

If UseVDI = 1: import. If already imported and UseVDI = 0 > Do not process. Like other CSVs, it does not delete existing reservations. New entry and UseVDI = 0 : Do not import. New entry and UseVDI = other than 0/1 e.g., 2 or ‘abc’: Do not import
Reservation

Type
Whether course reservation or Self-study reservation C: for course (possible for self-study) S: Only self-study No Character 1 1 byte [CS] Course Reservation E.g., C

If left blank then Course reservation If invalid: Error
Class Code Unique code for each course Yes String 64 2 bytes [A-Za-z0-9-_] error E.g., MATH-001

Blank or invalid data: Error
Gold Master

Name
Name of gold master as on VMWare This gold master must be already imported into HyLabs using CSV or from UI and this gold master assignment type must be [Course or Default] Yes String 64 2 bytes [A-Za-z0-9-_SPACE]

Check VMWare Specs
error E.g., Maths_gm_001

Blank or invalid data: Error
Max

Participant
Number of VM to create This number must be less than or equal to = students + [faculty + assistant] Yes Number 5 1 byte 1-99999 error E.g., 50

Blank or invalid data or greater than 99999: Error
Start Date Date from when to create this reservation format: DD/MM/YYYY Yes Date 10 1 byte [0-9/] error E.g., 19/12/2017

Blank or invalid data: Error
End Date Date on which reservation will expire Format: DD/MM/YYYY Yes No Date 10 1 byte [0-9/] No End Date E.g., 19/12/2018

Blank or invalid data: Error
Schedule

Code
This is a unique code for each schedule as per timetable. For e.g., M1, T3, F4, etc Yes String 3 1 byte [A-Za-z0-9] error E.g., M12

Blank or invalid data: Error
Recurrence

Pattern
If the recurrence happens every day or every week D: Daily, W: Weekly, 0: not recurring No Character 1 1 byte [0DW] 0 (not recurring) E.g., W

Blank: Not recurring

Invalid Char: Error
Recurring

Frequency
Decide if the recurrence happen every day/week or x day/week 0: not recurring 1: every 1 day/week 2: every 2 day/week 3: every 3 day/week 4: every 4 day/week No Int 1 1 byte [0-5] 0 (not recurring) E.g., 1

Blank: Not recurring

Invalid Char: Error
Daysof

Schedule
In case of reservation for multiple days (but same time), use this flag. This is bitwise operator Bit wise operation None = 0x0, Monday = 0x1(1) Tuesday = 0x2(2), Wednesday = 0x4(4), Thursday = 0x8(8), Friday = 0x10(16), Saturday = 0x20(32), Sunday = 0x40(64), No Int 2 1 byte [0/1/2/4/8/

16/32/64]
0 E.g., 1

Blank: 0 = None Invalid Char: Error
Start Time start time of the reservation Yes Time 4 1 byte [XXXX] [0-9] error E.g., 0900

Blank: Error

Invalid Char: Error
End Time end time of the reservation Yes Time 4 1 byte [XXXX] [0-9] error E.g., 1030

Blank: Error

Invalid Char: Error
Enable course

extension
If faculty can extend the reservation beyond end time No Int 1 1 byte [0-1] 0 (disable extension) E.g., 0 or 1

Blank: 0

Invalid Char: Error.

It accepts only 0 or 1 as input.
course reservation

Extension step

count
If extension allowed how many times reservation can be extended. For e.g., faculty can extend the session only maximum 5 times In case of self-study reservation, this field is for student No Int 2 1 byte [0-9] 5 (5 times

extensions

allowed if

extension

permission)
E.g., 5

If Course Extensions Enabled but this field is blank: 5 times

Invalid Char: Error
course res Extension step interval in minutes Interval in minutes for which the reservation can be extended in each extension. For e.g., each time faculty can extend the reservation only for 15 minutes In case of self-study reservation, this field is for student No Int 2 1 byte [0-9] 15 (maximum

extension

per try)
E.g., 30

If Course Extensions Enabled but this field is blank: 15 minutes

Invalid Char: Error
Enable Course Self-study Allow students to reserve VM from this reservation for self-study 0: disable self-study 1: allow self-study No Int 1 1 byte [0-1] 0 ( not enabled) E.g., 1

Blank: 0

Invalid char: Error
Self-study max count Maximum self-study VM usage from this reservation No Int 5 1 byte 1-99999 same as max

participant
E.g., 13

Blank: Same as max participant (if Self-study is enabled)

Invalid char: Error
Self-study max duration Maximum duration of self-study reservation in minutes 0: no limit X: minutes No Int 4 1 byte [0/30/60/120/

180/240/300]
0 (no limit) E.g., 120

Blank: Unlimited

Invalid char: Error
Self-study Allow time extension Allow student to extent their reservation No Int 1 1 byte [0-1] 0 (disable

extension)
E.g., 1

Blank: 0 (Not enabled)

Invalid char: Error
Self-study Window start time Self-study reservation can be used only after this time (say after university work hours) No Time 4 1 byte [XXXX] [0-9] no

limitation
E.g., 1730

Blank: No restrictions

Invalid char: Error
Self-study Window end time Self-study reservations must finish before this time (say before university work hour start) No Time 4 1 byte [XXXX] [0-9] no

limitation
E.g., 0630

Blank: No restrictions

Invalid char: Error
delete VM

after reservation

finish
Delete the linked clones after reservation end. When the reservation starts again, recreate the linked clones 0: keep the linked clones 1: delete linked clones after reservation time over (not expire) No Int 1 1 byte [0-1] 0 (keep VM) E.g., 0

Blank: 0 (Keep VMs)

Invalid char: Error
Realmname Organization name in HyLabs. It is useful when there will be multiple colleges using same HyLabs, but each college has different authentication settings and different resources No String 64 2 bytes [A-Za-z0-9-_] default E.g., Economics

Blank: Default Organization or Realm

Invalid Organization: Error
Power On VM Decides the power state of the reserved VMs on schedule start No Int 1 1 byte 0= On reservation start-Start all VMs

1= On reservation start-Specify VM Count 2= On user connect
0(Start all VMs) E.g., 0,1 or 2

Blank: Default value

Invalid char: Error
Specify VM Count No of specific VMs to be powered on, this field will only be considered if Power on VM field value is 1 No Int 5 1 byte 0-99999 0 E.g.,0,1,200

Blank: Default

Invalid char or value>99999:Error
Shutdown VM Decides power state of reserved VMs on the end of schedule and reservation No Int 1 1 byte 0= On reservation end
1= On user logout and reservation end
0(On reservation end) E.g., 0 or 1

Blank: Default value

Invalid char: Error
Inherit from deployment settings Determines whether to use custom or default deployment settings No Int 1 1 byte 0= Inherit from deployment settings
1= Use custom deployment settings
0(Inherit default deployment settings) E.g., 0 or 1

Blank: Default value

Invalid char: Error
Keep VM This field will be considered when we set Inherit from deployment setting as 1 No Int 1 1 byte 0= Shutdown
1= Powered On
1 E.g., 0 or 1

Blank: Default value

Invalid char: Error
Deployment time Determines the time when the reservation will get deployed No Int 3 1 byte 1-540 (mins) 60 E.g.,20,540


Blank: Default


Invalid char:Error
Preparation time Determined the time when reservation VMs will get prepared No Int 3 1 byte 1-180 (mins) 5 E.g.,20,180


Blank: Default


Invalid char:Error
Enable DVM reset Determine the reservation will be persistent or non-persistent No Int 1 1 byte 0=Persistent
1= Non-persistent
Blank
0 E.g., 0 or 1

Blank: Default value

I

Invalid char: Error

Classification Rules CSV

Column Description Mandatory Type Max Length I18N Allowed Characters Default Value if missing Example data and output with different inputs
Classification

RulesName
Unique name of classification rule.

If operation is added and group not found with provided name then new group will be created.

If operation is adding and group found with provided name then new rule will be added in existing group.

If operation is deleting and group not found with provided name, then throw error.
Yes String 250 2 [A-Za-z0-9-_SPACE] Error E.g., Lab1

Blank or invalid char: Error
Para-Type Rule Type:

- M: MAC address of client device.

- L: LAN IP address of client.

- W: WAN IP address of client.
Yes Char 1 1 M/L/W Error E.g., L

Blank or invalid char: Error
Add/Delete To determine add or delete rule

- A: Add new classification rule with rule or update existing rule for classification rule.

- D: Delete existing rule and if no more rules available then classification rule will be deleted
Yes Char 1 1 A- Add, D-Delete Error E.g., A

Blank or invalid char: Error
Para-Value Value for classification rule, data are allowed in following Form

1) Mac- 00:0a:95:9d:68:16 OR E6-02-9B-8A-D3-51

2) IP -172.16.4.123

3) IP Subnet- 192.168.100.14/24

4) Ip range- 172.16.0.1-172.16.0.50

Yes String 100 A-Za-z0-9:-/ Error E.g., 172.16.8.12

Blank or invalid char: Error
Realmname Organization name in HyLabs. It is useful when there will be multiple colleges using the same HyLabs, but each college has different authentication settings and different resources No String 64 2 bytes [A-Za-z0-9-_] default E.g., Economics

Blank: Default Organization or Realm

Invalid Organization: Error