This page provides information on managing render jobs in V-Ray Cloud.
Page Contents
Overview
With V-Ray Cloud you are able to submit, queue, monitor, and organize your render jobs across projects. Managing render jobs in V-Ray Cloud is done in one of two ways - using its web-based interface, or alternatively, via command-line interface.
Managing jobs with V-Ray Cloud's Interface
You can get into V-Ray Cloud's web interface by opening a web browser window and typing the following address: https://vray.cloud/. You will then be prompted to log in with your ChaosGroup account and password.
Once logged in, you will see V-Ray Cloud's main menu on the left. The button folds the menu bar in and out.
Projects
The Projects tab hosts all render jobs submitted to V-Ray Cloud. It allows organizing jobs in multiple projects, and is also where you can download the output of your render, resubmit a render, or delete a render from V-Ray Cloud. Every render job needs to be allocated to a project.
To create a new empty project, press the button on the main menu on the left. A small pop-up window will appear asking you to enter a name for your project.
If Set as default is enabled, the newly created project will become the default one, meaning that all subsequent render job submissions will be automatically allocated to that project unless changed manually before submission.
To set a new default project, press the button while mouse-hovering over a project.
To delete a project, press the button.
To rename a project, press the button while hovering over a project's name.
Clicking on a project will show its contained render items. Here you can monitor, pause, cancel or delete a render job.
To pause an ongoing render, click on the button while hovering over a render job.
To cancel an ongoing render altogether, click on the button.
To delete a completed render, press the button.
Clicking on a render job within a project will open the Job Details page, displaying the finished render (if it's finished), information about it, as well as additional controls for downloading, resubmitting, or reporting a job.
To download a render job, press the button.
To resubmit a render job, press the button.
To report a render job, if something went wrong, press the button.
The buttons switch between the render log and the render preview.
Ongoing render jobs' progress can be observed in real-time from the Job Details page.
Resubmitting a render job using the button will allow you to set new final render settings.
Queue
The Queue tab is where all newly submitted, paused, or queued render jobs appear. From here you can monitor, pause, or cancel them. No completed render jobs are listed here - they are all found at their respective project folder, allocated upon submission.
To pause an ongoing render, click on the button while hovering over it.
To cancel an ongoing render altogether, click on the button.
You can have up to 3000 Submitted render jobs, and up to 10 Active render jobs.
Managing render jobs through command-line interface in V-Ray Cloud
All functions offered by V-Ray Cloud's web-based interface can be carried out manually with any command-line tool, without opening a browser. To do so, you first have to navigate to the location of vcloud or vcloud.exe on your machine.
Default locations:
- Windows – C:\Program Files\Chaos Group\V-Ray\V-Ray Cloud Client\vcloud.exe
- macOS –
- Linux –
The tables below list all available flags and commands. All commands can be run with multiple tags.
| Command | Flag(s) | Flag meaning | Function | Examples |
|---|---|---|---|---|
auth login | – | – | Logs in to V-Ray Cloud. | vcloud auth login |
| auth logout | – | – | Logs out of V-Ray Cloud. | vcloud auth logout |
eula | – | – | Prints out the EULA. | vcloud eula |
| job cancel | --id (required) | ID of render job | Cancels a V-Ray Cloud job. | vcloud job cancel --id=X8hC6Xg2cb8JeL5 |
| job delete | --id (required) | ID of render job | Deletes a V-Ray Cloud job. | vcloud job delete --id=X8hC6Xg2cb8JeL5 |
| job download | --id (required) --no-progress --output (required) | ID of render job Do not display progress when downloading Path to output folder | Downloads outputs of a V-Ray Cloud job. | vcloud job download --id=X8hC6Xg2cb8JeL5 --output="C:\Users\Me\Desktop" |
| job pause | --id (required) | ID of render job | Pauses a V-Ray Cloud job. | vcloud job pause --id=X8hC6Xg2cb8JeL5 |
| job rename | --id (required) --title (required) | ID of render job The new title of the V-Ray Cloud job | Renames a V-Ray Cloud job. | vcloud job rename --id=X8hC6Xg2cb8JeL5 --title="Marbles" |
| job submit | --sceneFile (required) --animation --colorCorrectionsFile --exr --frameRange --frameStep --height --width --ignoreWarnings --jpg --name --no-progress --png --preserveAlpha --project --renderMode --vr | Path to .vrscene file Renders animation instead of a single shot Path to color corrections file Outputs EXR image Frame range of the animation Frame step of the animation Height of the rendered image Width of the rendered image Ignore warnings in scene file processing Outputs JPG image Name of the rendering job Do not display progress while submitting Outputs PNG image Preserve alpha channel of PNG output Name of the rendering project Specifies the render mode Renders VR-enabled image | Submits a V-Ray scene to V-Ray Cloud. | vcloud job submit --sceneFile="C:\Users\Me\Desktop\soccer.vrscene --exr --project="Project Cloud" --renderMode=progressive --width=1280 --height=720 |
| job resubmit | --sceneFile (required) --animation --colorCorrectionsFile --exr --frameRange --frameStep --height --width --ignoreWarnings --jpg --name --no-progress --png --preserveAlpha --project --renderMode --vr | Path to .vrscene file Renders animation instead of a single shot Path to color corrections file Outputs EXR image Frame range of the animation Frame step of the animation Height of the rendered image Width of the rendered image Ignore warnings in scene file processing Outputs JPG image Name of the rendering job Do not display progress while submitting Outputs PNG image Preserve alpha channel of PNG output Name of the rendering project Specifies the render mode Renders VR-enabled image | Resubmits a V-Ray scene to V-Ray Cloud. | vcloud job resubmit --sceneFile="C:\Users\Me\Desktop\soccer.vrscene --png --project="Chaosology" --renderMode=bucket --animation --frameRange=30 --ignoreWarnings |
| job start | --id (required) | ID of render job | Starts a V-Ray Cloud job. | vcloud job start --id=X40YITIaqtb_94E |
| job status | --id (required) | ID of render job | Prints status info for a V-Ray Cloud job. | |
| project create | --name (required) --default | Name of the project Marks the project as default | Creates a new project. | vcloud project create --name="Cloudy" --default |
| project delete | --name (required) | Name of the project | Deletes a project. | vcloud project delete --name="Drains" |
| project list | – | – | Lists available projects. | vcloud project list |
| project rename | --name (required) --to (required) | Name of the project The new name of the project | Renames a V-Ray Cloud project. | vcloud project rename --name="Marbles" --to="Drains" |
| update | – | – | Updates the V-Ray Cloud Client. | vcloud update |
| version | – | – | Prints V-Ray Cloud Client version info. | vcloud version |
| help | – | – | Prints command information. | vcloud help; vcloud job help; vcloud job submit help |