CloudShare

Cloudshare integration.

Utilities · CloudShare

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-status

    Checks the status of a previously executed command line script.

  • cloudshare-create-class

    Creates a class.

  • cloudshare-create-env

    Creates an environment from a snapshot or from one or more VM templates.

  • cloudshare-delete-class

    Deletes a class.

  • cloudshare-delete-class-environments

    Deletes all active student environments in a class.

  • cloudshare-delete-env

    Deletes an environment.

  • cloudshare-delete-student

    Removes a student from a class.

  • cloudshare-delete-vm

    Deletes a VM.

  • cloudshare-execute-vm-command

    Executes a command line script on a VM.

  • cloudshare-extend-env

    Extends the lifetime of an environment.

  • cloudshare-generate-cloud-folder-password

    Generates a new FTP password for accessing the user's cloud folders.

  • cloudshare-get-class

    Retrieves details of a specified class.

  • cloudshare-get-classes

    Retrieves all classes visible to the user.

  • cloudshare-get-classes-countries

    Retrieves all countries that can be set as class locations.

  • cloudshare-get-classes-customfields

    Retrieves any custom class creation fields defined in a specified project.

  • cloudshare-get-classes-detailed

    Retrieves all the details of a specified class, including full student data.

  • cloudshare-get-classes-instructors

    Retrieves project member users who can be assigned to classes as instructors.

  • cloudshare-get-cloud-folders

    Retrieves the user's cloud folder and the user's projects' project folder(s).

  • cloudshare-get-env

    Retrieves properties of an environment and enables verification of the requesting user's permissions to the environment.

  • cloudshare-get-env-cloud-folders

    Shows the cloud folder on all of the environment's machines.

  • cloudshare-get-env-extended

    Retrieves details of an environment along with VM information.

  • cloudshare-get-env-extended-token

    Uses a sponsored login token to retrieve details of an environment along with VM information.

  • cloudshare-get-env-extended-vanity

    Uses the vanity name or FQDN of a VM to retrieve details of an environment and its VMs.

  • cloudshare-get-env-multiple-resources

    Retrieves 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-resource

    Retrieves the total resources that have been used by an environment.

  • cloudshare-get-env-snapshots

    Retrieves 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-envs

    Retrieves environments.

  • cloudshare-get-poc-invitations

    Retrieves POC invitations sent.

  • cloudshare-get-project

    Retrieves a specified project's details.

  • cloudshare-get-project-blueprint

    Retrieves details of a specified blueprint, including snapshots.

  • cloudshare-get-project-blueprints

    Retrieves all blueprints available in a specified project.

  • cloudshare-get-project-policies

    Retrieves 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-projects

    Retrieves all available projects.

  • cloudshare-get-regions

    Retrieves available regions.

  • cloudshare-get-snapshot

    Retrieves details of a snapshot.

  • cloudshare-get-student

    Retrieves information about a student in a class, including the student's environment and VMs.

  • cloudshare-get-students

    Retrieves information about the students in a class.

  • cloudshare-get-teams

    Retrieves all available teams in all available projects.

  • cloudshare-get-templates

    Retrieves VM templates and blueprints.

  • cloudshare-get-timezones

    Retrieves available time zones.

  • cloudshare-get-vm-remote-access-file

    Retrieves 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-poc

    Invite 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-snapshot

    Marks 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-class

    Modifies a class.

  • cloudshare-modify-env

    Adds one or more VMs to an existing environment.

  • cloudshare-modify-student

    Modifies a student's registration details.

  • cloudshare-modify-vm-hardware

    Adjusts a VM's CPU count, disk size, and RAM.

  • cloudshare-postpone-env-suspend

    Postpones an environment's suspended state Request Path.

  • cloudshare-reboot-vm

    Reboots a VM.

  • cloudshare-register-student

    Registers a student for a class.

  • cloudshare-resume-env

    Resumes an environment that was previously suspended, returning it to active running state.

  • cloudshare-revert-env

    Reverts an environment to a specified snapshot.

  • cloudshare-revert-vm

    Reverts a VM.

  • cloudshare-send-class-invitations

    Sends invitations to students to attend a class.

  • cloudshare-suspend-class-environments

    Suspends all running student environments in a specified class.

  • cloudshare-suspend-env

    Suspends an environment.

  • cloudshare-take-snapshot-env

    Takes a snapshot of an environment.

  • cloudshare-unmount-env-folders

    Hides the cloud folder on all of the environment's machines.