Configuration parameters
hostname— Hostname (required)api_id— API ID (required)api_key— API Key (required)insecure— Trust any certificate (not secure)proxy— Use system proxy settings
Commands (58)
-
cloudshare-check-vm-execution-statusChecks the status of a previously executed command line script.
-
cloudshare-create-classCreates a class.
-
cloudshare-create-envCreates an environment from a snapshot or from one or more VM templates.
-
cloudshare-delete-classDeletes a class.
-
cloudshare-delete-class-environmentsDeletes all active student environments in a class.
-
cloudshare-delete-envDeletes an environment.
-
cloudshare-delete-studentRemoves a student from a class.
-
cloudshare-delete-vmDeletes a VM.
-
cloudshare-execute-vm-commandExecutes a command line script on a VM.
-
cloudshare-extend-envExtends the lifetime of an environment.
-
cloudshare-generate-cloud-folder-passwordGenerates a new FTP password for accessing the user's cloud folders.
-
cloudshare-get-classRetrieves details of a specified class.
-
cloudshare-get-classesRetrieves all classes visible to the user.
-
cloudshare-get-classes-countriesRetrieves all countries that can be set as class locations.
-
cloudshare-get-classes-customfieldsRetrieves any custom class creation fields defined in a specified project.
-
cloudshare-get-classes-detailedRetrieves all the details of a specified class, including full student data.
-
cloudshare-get-classes-instructorsRetrieves project member users who can be assigned to classes as instructors.
-
cloudshare-get-cloud-foldersRetrieves the user's cloud folder and the user's projects' project folder(s).
-
cloudshare-get-envRetrieves properties of an environment and enables verification of the requesting user's permissions to the environment.
-
cloudshare-get-env-cloud-foldersShows the cloud folder on all of the environment's machines.
-
cloudshare-get-env-extendedRetrieves details of an environment along with VM information.
-
cloudshare-get-env-extended-tokenUses a sponsored login token to retrieve details of an environment along with VM information.
-
cloudshare-get-env-extended-vanityUses the vanity name or FQDN of a VM to retrieve details of an environment and its VMs.
-
cloudshare-get-env-multiple-resourcesRetrieves all environments that were active in a specified time range, and their resource usage. Each environment record includes total run time, total RAM-GB Hours, max disk usage and the sponsored token that was used to create the environment, if applicable.
-
cloudshare-get-env-resourceRetrieves the total resources that have been used by an environment.
-
cloudshare-get-env-snapshotsRetrieves all snapshots contained in a specified environment's blueprint. A blueprint can contain up to five snapshots, with newer snapshots displacing the oldest snapshots in the blueprint.
-
cloudshare-get-envsRetrieves environments.
-
cloudshare-get-poc-invitationsRetrieves POC invitations sent.
-
cloudshare-get-projectRetrieves a specified project's details.
-
cloudshare-get-project-blueprintRetrieves details of a specified blueprint, including snapshots.
-
cloudshare-get-project-blueprintsRetrieves all blueprints available in a specified project.
-
cloudshare-get-project-policiesRetrieves all environment policies available in a specified project. Environment policies define how long an environment will run, when it will be deleted, and what happens to it when it has been idle for a certain length of time.
-
cloudshare-get-projectsRetrieves all available projects.
-
cloudshare-get-regionsRetrieves available regions.
-
cloudshare-get-snapshotRetrieves details of a snapshot.
-
cloudshare-get-studentRetrieves information about a student in a class, including the student's environment and VMs.
-
cloudshare-get-studentsRetrieves information about the students in a class.
-
cloudshare-get-teamsRetrieves all available teams in all available projects.
-
cloudshare-get-templatesRetrieves VM templates and blueprints.
-
cloudshare-get-timezonesRetrieves available time zones.
-
cloudshare-get-vm-remote-access-fileRetrieves the content of a .rdp file that provides remote desktop access to the specified VM. An .rdp file comprising the returned content opens a remote desktop session to the VM from a Windows machine. It can also be used on Linux with FreeRDP or on Mac with Microsoft Remote Access.
-
cloudshare-invite-user-pocInvite an end user to a POC, based on a specified blueprint, and assigns a specific project member user to be the owning project member for the end user. A policy ID, blueprint ID and owning project member ID must be specified.
-
cloudshare-mark-default-snapshotMarks a specified snapshot as the default snapshot in its containing blueprint. New environments created from a blueprint are based on the default snapshot in the blueprint. This request enables you to change which snapshot is the default snapshot in a given blueprint so that new environments will be based on the snapshot of your choice.
-
cloudshare-modify-classModifies a class.
-
cloudshare-modify-envAdds one or more VMs to an existing environment.
-
cloudshare-modify-studentModifies a student's registration details.
-
cloudshare-modify-vm-hardwareAdjusts a VM's CPU count, disk size, and RAM.
-
cloudshare-postpone-env-suspendPostpones an environment's suspended state Request Path.
-
cloudshare-reboot-vmReboots a VM.
-
cloudshare-register-studentRegisters a student for a class.
-
cloudshare-resume-envResumes an environment that was previously suspended, returning it to active running state.
-
cloudshare-revert-envReverts an environment to a specified snapshot.
-
cloudshare-revert-vmReverts a VM.
-
cloudshare-send-class-invitationsSends invitations to students to attend a class.
-
cloudshare-suspend-class-environmentsSuspends all running student environments in a specified class.
-
cloudshare-suspend-envSuspends an environment.
-
cloudshare-take-snapshot-envTakes a snapshot of an environment.
-
cloudshare-unmount-env-foldersHides the cloud folder on all of the environment's machines.