Skip to main content

CloudShare (Beta)

This Integration is part of the CloudShare Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

beta

This is a beta Integration, which lets you implement and test pre-release software. Since the integration is beta, it might contain bugs. Updates to the integration during the beta phase might include non-backward compatible features. We appreciate your feedback on the quality and usability of the integration to help us identify issues, fix them, and continually improve.

CloudShare#

This integration is a BETA that covers the API commands from CloudShare.

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

cloudshare-get-envs#


Retrieves environments

Base Command#

cloudshare-get-envs

Input#

Argument NameDescriptionRequired
ownedReturns only environments owned by the user. Possible values are: true, false. Default is false.Optional
visibleReturns all environments visible to the user. Possible values are: true, false. Default is false.Optional
ownerEmailOptional. Filters results by the environment owner's email address, where {ownerEmail} is the environment owner's email address.Optional
classIdOptional. Filters results to include only environments created for a specified class, including instructor and student environments, where {classId} is the ID of the class.Optional
briefOptional. Whether to return a less detailed or more detailed response. {brief_value} can be: true (default) - Returns less detail. false - Returns more detail. Possible values are: true, false. Default is true.Optional

Context Output#

PathTypeDescription
CloudShare.Environments.projectIdstringProject ID
CloudShare.Environments.policyIdstringPolicy ID
CloudShare.Environments.blueprintIdstringBlueprint ID
CloudShare.Environments.descriptionstringDescription
CloudShare.Environments.ownerEmailstringOwner email
CloudShare.Environments.regionIdstringRegion ID
CloudShare.Environments.namestringName
CloudShare.Environments.idstringID
CloudShare.Environments.statusstringStatus
CloudShare.Environments.teamIdstringTeam ID

cloudshare-get-projects#


Retrieves all available projects

Base Command#

cloudshare-get-projects

Input#

Argument NameDescriptionRequired
WhereUserIsProjectManagerReturns only projects in which the user is a project manager. Possible values are: tru, false. Default is false.Optional
WhereUserIsProjectMemberReturns only projects in which the user is a project member. Possible values are: true, false. Default is false.Optional
WhereUserCanCreateClassReturns only projects in which the user is allowed to create a class. The minimum user level allowed to create classes is set per project and can be changed by project manager users. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
CloudShare.Projects.namestringName
CloudShare.Projects.isActivebooleanIs Active
CloudShare.Projects.idstringID

cloudshare-get-project#


Retrieves a specified project's details

Base Command#

cloudshare-get-project

Input#

Argument NameDescriptionRequired
projectIdThe ID of a specific project.Required

Context Output#

PathTypeDescription
CloudShare.Projects.idstringID
CloudShare.Projects.namestringName
CloudShare.Projects.hasNonGenericPolicybooleanHas non-generic policy
CloudShare.Projects.canAddPolicybooleanCan add policy
CloudShare.Projects.awsEnabledbooleanAWS enabled
CloudShare.Projects.environmentResourceQuota.cpuCountnumberCPU count
CloudShare.Projects.environmentResourceQuota.diskSizeMBnumberDisk size(MB)
CloudShare.Projects.environmentResourceQuota.memorySizeMBnumberMemory size(MB)
CloudShare.Projects.projectResourceQuota.cpuCountnumberCPU count
CloudShare.Projects.projectResourceQuota.diskSizeMBnumberDisk size(MB)
CloudShare.Projects.projectResourceQuota.memorySizeMBnumberMemory size(MB)
CloudShare.Projects.subscriptionResourceQuota.cpuCountnumberCPU count
CloudShare.Projects.subscriptionResourceQuota.diskSizeMBnumberDisk size(MB)
CloudShare.Projects.subscriptionResourceQuota.memorySizeMBnumberMemory size(MB)
CloudShare.Projects.canCreateFromScratchbooleanCan create from scratch
CloudShare.Projects.defaultPolicyForEnvCreationstringDefault policy for env creation
CloudShare.Projects.isActivebooleanIs active

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.

Base Command#

cloudshare-get-project-policies

Input#

Argument NameDescriptionRequired
projectIdThe ID of the project.Required

Context Output#

PathTypeDescription
CloudShare.Project.Policies.allowEnvironmentCreationbooleanAllow environment creation
CloudShare.Project.Policies.idstringID
CloudShare.Project.Policies.namestringName
CloudShare.Project.Policies.projectIdstringProject ID

cloudshare-get-project-blueprints#


Retrieves all blueprints available in a specified project

Base Command#

cloudshare-get-project-blueprints

Input#

Argument NameDescriptionRequired
projectIdThe Id of the project.Required
regionIdThe ID of a region. Returns all blueprints that have default snapshots on the specified region. If unspecified, returns all blueprints in the project on all regions.Optional
defaultSnapshotIf set to true - get the default snapshot for every blueprint. The returned JSON will contain a property 'CreateFromVersions', which is an array of one element - the default snapshot. If unspecified, default is false (don't return the default snapshot). Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
CloudShare.Projects.Blueprints.idstringID
CloudShare.Projects.Blueprints.namestringName
CloudShare.Projects.Blueprints.descriptionstringDescription
CloudShare.Projects.Blueprints.isEnvironmentTemplatebooleanIs template
CloudShare.Projects.Blueprints.typenumberType
CloudShare.Projects.Blueprints.imageUrlstringImage URL
CloudShare.Projects.Blueprints.tagsunknownTags
CloudShare.Projects.Blueprints.categoriesunknownCategories
CloudShare.Projects.Blueprints.resources.cpuCountnumberCPU count
CloudShare.Projects.Blueprints.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Projects.Blueprints.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Projects.Blueprints.numberOfMachinesnumberNumber of machines
CloudShare.Projects.Blueprints.hasMultipleVersionsbooleanHas multiple versions
CloudShare.Projects.Blueprints.hasDefaultVersionbooleanHas default version
CloudShare.Projects.Blueprints.disabledForRegularEnvironmentCreationbooleanDisabled for regular environment creation
CloudShare.Projects.Blueprints.disabledForTrainingEnvironmentCreationbooleanDisabled for training environment creation
CloudShare.Projects.Blueprints.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Projects.Blueprints.envTemplateScopeunknownEnvironment template scope
CloudShare.Projects.Blueprints.creationDatestringCreation date
CloudShare.Projects.Blueprints.CreateFromVersions.MachinesunknownMachines
CloudShare.Projects.Blueprints.CreateFromVersions.AuthorNamestringAuthor name
CloudShare.Projects.Blueprints.CreateFromVersions.CommentstringComment
CloudShare.Projects.Blueprints.CreateFromVersions.TypenumberType
CloudShare.Projects.Blueprints.CreateFromVersions.NamestringName
CloudShare.Projects.Blueprints.CreateFromVersions.IsDefaultbooleanIs default
CloudShare.Projects.Blueprints.CreateFromVersions.IsLatestbooleanIs latest
CloudShare.Projects.Blueprints.CreateFromVersions.NumbernumberNumber
CloudShare.Projects.Blueprints.CreateFromVersions.Resources.CpuCountnumberCPU count
CloudShare.Projects.Blueprints.CreateFromVersions.Resources.DiskSizeMBnumberDisk size(MB)
CloudShare.Projects.Blueprints.CreateFromVersions.Resources.MemorySizeMBnumberMemory size(MB)
CloudShare.Projects.Blueprints.CreateFromVersions.CreateTimestringCreate time
CloudShare.Projects.Blueprints.CreateFromVersions.DescriptionstringDescription
CloudShare.Projects.Blueprints.CreateFromVersions.ImageUrlstringImage URL
CloudShare.Projects.Blueprints.CreateFromVersions.RegionsunknownRegions
CloudShare.Projects.Blueprints.CreateFromVersions.IdstringID

cloudshare-get-project-blueprint#


Retrieves details of a specified blueprint, including snapshots.

Base Command#

cloudshare-get-project-blueprint

Input#

Argument NameDescriptionRequired
projectIdThe ID of the project in which the blueprint resides.Required
blueprintIdThe ID of the blueprint.Required

Context Output#

PathTypeDescription
CloudShare.Projects.Blueprints.idstringID
CloudShare.Projects.Blueprints.namestringName
CloudShare.Projects.Blueprints.descriptionstringDescription
CloudShare.Projects.Blueprints.isEnvironmentTemplatebooleanIs template
CloudShare.Projects.Blueprints.typenumberType
CloudShare.Projects.Blueprints.imageUrlstringImage URL
CloudShare.Projects.Blueprints.tagsunknownTags
CloudShare.Projects.Blueprints.categoriesunknownCategories
CloudShare.Projects.Blueprints.resources.cpuCountnumberCPU count
CloudShare.Projects.Blueprints.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Projects.Blueprints.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Projects.Blueprints.numberOfMachinesnumberNumber of machines
CloudShare.Projects.Blueprints.hasMultipleVersionsbooleanHas multiple versions
CloudShare.Projects.Blueprints.hasDefaultVersionbooleanHas default version
CloudShare.Projects.Blueprints.disabledForRegularEnvironmentCreationbooleanDisabled for regular environment creation
CloudShare.Projects.Blueprints.disabledForTrainingEnvironmentCreationbooleanDisabled for training environment creation
CloudShare.Projects.Blueprints.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Projects.Blueprints.envTemplateScopeunknownEnvironment template scope
CloudShare.Projects.Blueprints.creationDatestringCreation date
CloudShare.Projects.Blueprints.CreateFromVersions.MachinesunknownMachines
CloudShare.Projects.Blueprints.CreateFromVersions.AuthorNamestringAuthor name
CloudShare.Projects.Blueprints.CreateFromVersions.CommentstringComment
CloudShare.Projects.Blueprints.CreateFromVersions.TypenumberType
CloudShare.Projects.Blueprints.CreateFromVersions.NamestringName
CloudShare.Projects.Blueprints.CreateFromVersions.IsDefaultbooleanIs default
CloudShare.Projects.Blueprints.CreateFromVersions.IsLatestbooleanIs latest
CloudShare.Projects.Blueprints.CreateFromVersions.NumbernumberNumber
CloudShare.Projects.Blueprints.CreateFromVersions.Resources.CpuCountnumberCPU count
CloudShare.Projects.Blueprints.CreateFromVersions.Resources.DiskSizeMBnumberDisk size(MB)
CloudShare.Projects.Blueprints.CreateFromVersions.Resources.MemorySizeMBnumberMemory size(MB)
CloudShare.Projects.Blueprints.CreateFromVersions.CreateTimestringCreate time
CloudShare.Projects.Blueprints.CreateFromVersions.DescriptionstringDescription
CloudShare.Projects.Blueprints.CreateFromVersions.ImageUrlstringImage URL
CloudShare.Projects.Blueprints.CreateFromVersions.RegionsunknownRegions
CloudShare.Projects.Blueprints.CreateFromVersions.IdstringID

cloudshare-get-classes#


Retrieves all classes visible to the user

Base Command#

cloudshare-get-classes

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.Classes.instructorEmailstringInstructor email
CloudShare.Classes.timeZoneNamestringTimezone name
CloudShare.Classes.startDatestringStart date
CloudShare.Classes.endDatestringEnd date
CloudShare.Classes.statusstringStatus
CloudShare.Classes.nameunknownName
CloudShare.Classes.shortIdstringShort ID
CloudShare.Classes.idstringID
CloudShare.Classes.regionIdstringRegion ID

cloudshare-get-class#


Retrieves details of a specified class

Base Command#

cloudshare-get-class

Input#

Argument NameDescriptionRequired
classIdThe id of the class.Required

Context Output#

PathTypeDescription
CloudShare.Classes.idstringID
CloudShare.Classes.namestringName
CloudShare.Classes.shortIdstringShort ID
CloudShare.Classes.policyIdstringPolicy ID
CloudShare.Classes.policyNamestringPolicy name
CloudShare.Classes.isUsingClassTypesbooleanIs issuing class types
CloudShare.Classes.blueprintIdstringBlueprint ID
CloudShare.Classes.blueprintNamestringBlueprint name
CloudShare.Classes.blueprintTokenstringBlueprint token
CloudShare.Classes.cloudNamestringCloud name
CloudShare.Classes.timeZoneIdstringTimezone ID
CloudShare.Classes.projectIdstringProject ID
CloudShare.Classes.projectNamestringProject name
CloudShare.Classes.creatorNamestringCreator name
CloudShare.Classes.creatorEmailstringCreator email
CloudShare.Classes.instructorVupIdstringInstructor VUP ID
CloudShare.Classes.instructorNamestringInstructor name
CloudShare.Classes.defaultDurationInMinutesnumberDefault duration (mins)
CloudShare.Classes.allowStartDateEditingbooleanAllow start date editing
CloudShare.Classes.limitEarlyAccessnumberLimit early access
CloudShare.Classes.studentPassphrasestringStudent passphrase
CloudShare.Classes.useCustomInvitationEmailbooleanUse custom invitation email
CloudShare.Classes.showCourseAddressFieldbooleanShow course address field
CloudShare.Classes.addressstringAddress
CloudShare.Classes.customInvitationEmailSubjectstringCustom invitation email subject
CloudShare.Classes.customInvitationEmailBodystringCustom invitation email body
CloudShare.Classes.defaultInvitationEmailSubjectstringDefault invitation email subject
CloudShare.Classes.defaultInvitationEmailBodystringDefault invitation email subject
CloudShare.Classes.showPermitAccessToNonRegisteredStudentbooleanShow permit access to non-registered student
CloudShare.Classes.allowEditDefaultsWhenPermitAccessToNonRegisteredbooleanAllow edit defaults when permit access to non registered
CloudShare.Classes.permitAccessToNonRegisteredStudentbooleanPermit access to non registered student
CloudShare.Classes.showMaxStudentsFieldbooleanShow max students field
CloudShare.Classes.maxStudentsnumberMax students
CloudShare.Classes.maxLimitOnMaxStudentFieldnumberMax kimit on max student field
CloudShare.Classes.customFieldsValues.idstringID
CloudShare.Classes.customFieldsValues.ordernumberOrder
CloudShare.Classes.customFieldsValues.namestringName
CloudShare.Classes.customFieldsValues.typenumberType
CloudShare.Classes.customFieldsValues.isRequiredbooleanIs required
CloudShare.Classes.customFieldsValues.regexstringRegex
CloudShare.Classes.customFieldsValues.defaultValueunknownDefault value
CloudShare.Classes.customFieldsValues.valueunknownValue
CloudShare.Classes.instructorEmailstringInstructor email
CloudShare.Classes.timeZoneNamestringTimezone name
CloudShare.Classes.startDatestringStart date
CloudShare.Classes.endDatestringEnd date
CloudShare.Classes.statusstringStatus

cloudshare-delete-class#


Deletes a class

Base Command#

cloudshare-delete-class

Input#

Argument NameDescriptionRequired
classIdThe id of the class.Required

Context Output#

There is no context output for this command.

cloudshare-delete-class-environments#


Deletes all active student environments in a class

Base Command#

cloudshare-delete-class-environments

Input#

Argument NameDescriptionRequired
classIdThe ID of the class.Optional

Context Output#

PathTypeDescription
cloudshare.Classes.Actions.Delete.failedunknownFailed deletions
cloudshare.Classes.Actions.Delete.succeedunknownSucceeded deletions
cloudshare.Classes.Actions.Delete.succeed.idstringID
cloudshare.Classes.Actions.Delete.succeed.emailstringEmail
cloudshare.Classes.Actions.Delete.succeed.fullNamestringFull name
cloudshare.Classes.Actions.Delete.succeed.envIdstringEnvironment ID

cloudshare-get-classes-countries#


Retrieves all countries that can be set as class locations

Base Command#

cloudshare-get-classes-countries

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.Classes.Countries.codestringCode
CloudShare.Classes.Countries.englishNamestringEnglish name
CloudShare.Classes.Countries.statesunknownStates

cloudshare-get-classes-customfields#


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

Base Command#

cloudshare-get-classes-customfields

Input#

Argument NameDescriptionRequired
projectIdThe id of the project.Required

Context Output#

PathTypeDescription
CloudShare.Classes.CustomFields.idstringID
CloudShare.Classes.CustomFields.ordernumberOrder
CloudShare.Classes.CustomFields.namestringName
CloudShare.Classes.CustomFields.typenumberType
CloudShare.Classes.CustomFields.isRequiredbooleanIs required
CloudShare.Classes.CustomFields.regexstringRegex
CloudShare.Classes.CustomFields.defaultValueunknownDefault value
CloudShare.Classes.CustomFields.valueunknownValue

cloudshare-get-classes-detailed#


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

Base Command#

cloudshare-get-classes-detailed

Input#

Argument NameDescriptionRequired
classIdThe id of the class.Required

Context Output#

PathTypeDescription
CloudShare.Classes.Class.idstringID
CloudShare.Classes.Class.namestringName
CloudShare.Classes.Class.shortIdstringShort ID
CloudShare.Classes.Class.policyIdstringPolicy ID
CloudShare.Classes.Class.policyNamestringPolicy name
CloudShare.Classes.Class.isUsingClassTypesbooleanIs issuing class types
CloudShare.Classes.Class.blueprintIdstringBlueprint ID
CloudShare.Classes.Class.blueprintNamestringBlueprint name
CloudShare.Classes.Class.blueprintTokenstringBlueprint token
CloudShare.Classes.Class.cloudNamestringCloud name
CloudShare.Classes.Class.timeZoneIdstringTimezone ID
CloudShare.Classes.Class.projectIdstringProject ID
CloudShare.Classes.Class.projectNamestringProject name
CloudShare.Classes.Class.creatorNamestringCreator name
CloudShare.Classes.Class.creatorEmailstringCreator email
CloudShare.Classes.Class.instructorVupIdstringInstructor VUP ID
CloudShare.Classes.Class.instructorNamestringInstructor name
CloudShare.Classes.Class.defaultDurationInMinutesnumberDefault duration (mins)
CloudShare.Classes.Class.allowStartDateEditingbooleanAllow start date editing
CloudShare.Classes.Class.limitEarlyAccessnumberLimit early access
CloudShare.Classes.Class.studentPassphrasestringStudent passphrase
CloudShare.Classes.Class.useCustomInvitationEmailbooleanUse custom invitation email
CloudShare.Classes.Class.showCourseAddressFieldbooleanShow course address field
CloudShare.Classes.Class.addressstringAddress
CloudShare.Classes.Class.customInvitationEmailSubjectstringCustom invitation email subject
CloudShare.Classes.Class.customInvitationEmailBodystringCustom invitation email body
CloudShare.Classes.Class.defaultInvitationEmailSubjectstringDefault invitation email subject
CloudShare.Classes.Class.defaultInvitationEmailBodystringDefault invitation email subject
CloudShare.Classes.Class.showPermitAccessToNonRegisteredStudentbooleanShow permit access to non-registered student
CloudShare.Classes.Class.allowEditDefaultsWhenPermitAccessToNonRegisteredbooleanAllow edit defaults when permit access to non registered
CloudShare.Classes.Class.permitAccessToNonRegisteredStudentbooleanPermit access to non registered student
CloudShare.Classes.Class.showMaxStudentsFieldbooleanShow max students field
CloudShare.Classes.Class.maxStudentsnumberMax students
CloudShare.Classes.Class.maxLimitOnMaxStudentFieldnumberMax kimit on max student field
CloudShare.Classes.Class.customFieldsValues.idstringID
CloudShare.Classes.Class.customFieldsValues.ordernumberOrder
CloudShare.Classes.Class.customFieldsValues.namestringName
CloudShare.Classes.Class.customFieldsValues.typenumberType
CloudShare.Classes.Class.customFieldsValues.isRequiredbooleanIs required
CloudShare.Classes.Class.customFieldsValues.regexstringRegex
CloudShare.Classes.Class.customFieldsValues.defaultValueunknownDefault value
CloudShare.Classes.Class.customFieldsValues.valueunknownValue
CloudShare.Classes.Class.instructorEmailstringInstructor email
CloudShare.Classes.Class.timeZoneNamestringTimezone name
CloudShare.Classes.Class.startDatestringStart date
CloudShare.Classes.Class.endDatestringEnd date
CloudShare.Classes.Class.statusstringStatus
CloudShare.Classes.Students.firstNamestringFirst name
CloudShare.Classes.Students.lastNamestringLast name
CloudShare.Classes.Students.emailstringEmail
CloudShare.Classes.Students.companystringCompany
CloudShare.Classes.Students.jobLevelstringJob level
CloudShare.Classes.Students.address1stringAddress 1
CloudShare.Classes.Students.address2stringAddress 2
CloudShare.Classes.Students.citystringCity
CloudShare.Classes.Students.statestringState
CloudShare.Classes.Students.zipCodestringZip code
CloudShare.Classes.Students.countrystringCountry
CloudShare.Classes.Students.phonestringPhone
CloudShare.Classes.Students.regCodestringReg code
CloudShare.Classes.Students.idstringID

cloudshare-get-classes-instructors#


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

Base Command#

cloudshare-get-classes-instructors

Input#

Argument NameDescriptionRequired
policyIdThe ID of a policy.Required

Context Output#

PathTypeDescription
CloudShare.Classes.Instructors.idstringID
CloudShare.Classes.Instructors.namestringName
CloudShare.Classes.Instructors.emailstringEmail

cloudshare-create-class#


Creates a class

Base Command#

cloudshare-create-class

Input#

Argument NameDescriptionRequired
PolicyIdThe ID of the policy to apply to the class. The policy will control the runtime and storage time of each student's environment and what will happen to the environment when it is inactive.Required
BlueprintIdThe ID of the blueprint to base the class on. Students who attend the class will be served environments based on this blueprint.Required
ProjectIdThe ID of the project in which the class will be created. The specified blueprint and instructor must be from the same project.Required
InstructorVupIdThe ID of the project member user to assign to the class as the instructor.Required
RegionIdThe ID of the region the class should be created in.Optional
StartDateThe date and time at which to start the class, in MM/DD/YYYY HH:MM AM/PM format.Required
TimeZoneIdThe ID of the timezone for the startDate.Required
StudentPassphraseThe passphrase that students will need to enter in order to attend the class.Required
UseCustomInvitationEmailWhether or not the student invitation email is customized. Possible values are: false, true. Default is false.Optional
LimitEarlyAccessThis option controls access by students and instructor to a lab before scheduled class time. Possible values: 0 - Allow lab access before class (default). 1 - Allow lab access before class for instructor only. 2 - No early access allowed. Possible values are: 0, 1, 2. Default is 0.Required
CustomInvitationEmailSubjectThe subject line of the custom student invitation email. Used if UseCustomInvitationEmail is set to true.Optional
CustomInvitationEmailBodyThe body of the custom student invitation email. Used if UseCustomInvitationEmail is set to true.Optional
PermitAccessToNonRegisteredStudentWhether to permit users to self register as students for the class. Possible values are: false, true. Default is false.Optional
MaxStudentsNumeric. The maximum number of students allowed in the class (can be null). Maximum value: 60.Optional
addressThe location of the class (JSON dictionary) including keys: state, address1, address2, zipCode, city, country (To retrieve valid values for country, use cloudshare-get-classes-countries).Optional
CustomFieldsValuesSpecifies input values for custom fields defined for class creation in the project. Mandatory if project forces validation of custom fields. Fields and valid values depend on custom fields structure for the project. To retrieve custom fields structure for the project, use cloudshare-get-classes-customfields.Optional
enableStepsEnables the class to have multiple steps. Possible values are: false, true. Default is false.Optional
StudentsCanSwitchStepWhether students can change steps independently. Applies when enableSteps is set to true. Possible values are: false, true. Default is false.Optional
stepsA list of class steps (JSON dictionaries) for a multi-step class. Must be provided if enableSteps is set to true.Optional
selfPacedCreates a Self-Paced Class that allows a student to enter class at a time convenient to them. Possible values are: false, true. Default is false.Optional
allowMultipleStudentLoginWhen set to true, allows for more than one environment activation per student. Possible values are: false, true. Default is false.Optional

Context Output#

PathTypeDescription
CloudShare.Classes.idstringID

cloudshare-send-class-invitations#


Sends invitations to students to attend a class

Base Command#

cloudshare-send-class-invitations

Input#

Argument NameDescriptionRequired
classIdThe ID of the class.Required
studentIdsA list (CSV) of IDs of students to send invite invitations to.Required

Context Output#

There is no context output for this command.

cloudshare-suspend-class-environments#


Suspends all running student environments in a specified class

Base Command#

cloudshare-suspend-class-environments

Input#

Argument NameDescriptionRequired
classIdThe ID of the class.Required

Context Output#

PathTypeDescription
CloudShare.Classes.Suspended.failed.idstringID
CloudShare.Classes.Suspended.succeed.idstringID
CloudShare.Classes.Suspended.succeed.emailstringEmail
CloudShare.Classes.Suspended.succeed.fullNamestringFull name
CloudShare.Classes.Suspended.succeed.envIdstringEnvironment ID

cloudshare-modify-class#


Modifies a class

Base Command#

cloudshare-modify-class

Input#

Argument NameDescriptionRequired
instructorVupIdThe ID of the project member user to assign to the class as the instructor.Optional
startDateThe date and time at which to start the class, in MM/DD/YYYY HH:MM AM/PM format.Optional
timeZoneIdThe ID of the timezone for the startDate.Optional
studentPassphraseThe passphrase that students will need to enter in order to attend the class.Optional
useCustomInvitationEmailWhether or not the student invitation email is customized. Possible values are: false, true. Default is false.Optional
limitEarlyAccessThis option controls access by students and instructor to a lab before scheduled class time. Possible values: 0 - Allow lab access before class (default). 1 - Allow lab access before class for instructor only. 2 - No early access allowed. Possible values are: 0, 1, 2. Default is 0.Optional
customInvitationEmailSubjectThe subject line of the custom student invitation email. Used if UseCustomInvitationEmail is set to true.Optional
customInvitationEmailBodyThe body of the custom student invitation email. Used if UseCustomInvitationEmail is set to true.Optional
permitAccessToNonRegisteredStudentWhether to permit users to self register as students for the class. Possible values are: false, true. Default is false.Optional
maxStudentsNumeric. The maximum number of students allowed in the class (can be null). Maximum value: 60.Optional
addressThe location of the class (JSON dictionary) including keys: state, address1, address2, zipCode, city, country (To retrieve valid values for country, use cloudshare-get-classes-countries).Optional
customFieldsValuesSpecifies input values for custom fields defined for class creation in the project. Mandatory if project forces validation of custom fields. Fields and valid values depend on custom fields structure for the project. To retrieve custom fields structure for the project, use cloudshare-get-classes-customfields.Optional
selfPacedCreates a Self-Paced Class that allows a student to enter class at a time convenient to them. Possible values are: false, true. Default is false.Optional
allowMultipleStudentLoginWhen set to true, allows for more than one environment activation per student. Possible values are: false, true. Default is false.Optional
classIdThe ID of the class.Required
nameThe name of the class.Optional

Context Output#

PathTypeDescription
CloudShare.Classes.idstringID
CloudShare.Classes.namestringName
CloudShare.Classes.shortIdstringShort ID
CloudShare.Classes.policyIdstringPolicy ID
CloudShare.Classes.policyNamestringPolicy name
CloudShare.Classes.isUsingClassTypesbooleanIs issuing class types
CloudShare.Classes.blueprintIdstringBlueprint ID
CloudShare.Classes.blueprintNamestringBlueprint name
CloudShare.Classes.blueprintTokenstringBlueprint token
CloudShare.Classes.cloudNamestringCloud name
CloudShare.Classes.timeZoneIdstringTimezone ID
CloudShare.Classes.projectIdstringProject ID
CloudShare.Classes.projectNamestringProject name
CloudShare.Classes.creatorNamestringCreator name
CloudShare.Classes.creatorEmailstringCreator email
CloudShare.Classes.instructorVupIdstringInstructor VUP ID
CloudShare.Classes.instructorNamestringInstructor name
CloudShare.Classes.defaultDurationInMinutesnumberDefault duration (mins)
CloudShare.Classes.allowStartDateEditingbooleanAllow start date editing
CloudShare.Classes.limitEarlyAccessnumberLimit early access
CloudShare.Classes.studentPassphrasestringStudent passphrase
CloudShare.Classes.useCustomInvitationEmailbooleanUse custom invitation email
CloudShare.Classes.showCourseAddressFieldbooleanShow course address field
CloudShare.Classes.addressstringAddress
CloudShare.Classes.customInvitationEmailSubjectstringCustom invitation email subject
CloudShare.Classes.customInvitationEmailBodystringCustom invitation email body
CloudShare.Classes.defaultInvitationEmailSubjectstringDefault invitation email subject
CloudShare.Classes.defaultInvitationEmailBodystringDefault invitation email subject
CloudShare.Classes.showPermitAccessToNonRegisteredStudentbooleanShow permit access to non-registered student
CloudShare.Classes.allowEditDefaultsWhenPermitAccessToNonRegisteredbooleanAllow edit defaults when permit access to non registered
CloudShare.Classes.permitAccessToNonRegisteredStudentbooleanPermit access to non registered student
CloudShare.Classes.showMaxStudentsFieldbooleanShow max students field
CloudShare.Classes.maxStudentsnumberMax students
CloudShare.Classes.maxLimitOnMaxStudentFieldnumberMax kimit on max student field
CloudShare.Classes.customFieldsValues.idstringID
CloudShare.Classes.customFieldsValues.ordernumberOrder
CloudShare.Classes.customFieldsValues.namestringName
CloudShare.Classes.customFieldsValues.typenumberType
CloudShare.Classes.customFieldsValues.isRequiredbooleanIs required
CloudShare.Classes.customFieldsValues.regexstringRegex
CloudShare.Classes.customFieldsValues.defaultValueunknownDefault value
CloudShare.Classes.customFieldsValues.valueunknownValue
CloudShare.Classes.instructorEmailstringInstructor email
CloudShare.Classes.timeZoneNamestringTimezone name
CloudShare.Classes.startDatestringStart date
CloudShare.Classes.endDatestringEnd date
CloudShare.Classes.statusstringStatus

cloudshare-get-students#


Retrieves information about the students in a class

Base Command#

cloudshare-get-students

Input#

Argument NameDescriptionRequired
classIdThe ID of the class.Required
isFullWhether to return the details of the VMs in each student's environment as well as other details. Possible values are: false, true. Default is false.Optional

Context Output#

PathTypeDescription
CloudShare.Students.statusnumberStatus
CloudShare.Students.envStatusnumberEnvironemtn Status
CloudShare.Students.envCommandsunknownEnvironment commands
CloudShare.Students.envIdstringEnvironment ID
CloudShare.Students.firstNamestringFirst name
CloudShare.Students.lastNamestringLast name
CloudShare.Students.emailstringEmail
CloudShare.Students.idstringID
CloudShare.Students.VMs.idstringID
CloudShare.Students.VMs.namestringName

cloudshare-get-student#


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

Base Command#

cloudshare-get-student

Input#

Argument NameDescriptionRequired
classIdThe ID of the class.Required
studentIdThe ID of the student in the class.Required

Context Output#

PathTypeDescription
CloudShare.Students.statusnumberStatus
CloudShare.Students.envStatusnumberEnvironemtn Status
CloudShare.Students.envCommandsunknownEnvironment commands
CloudShare.Students.envIdstringEnvironment ID
CloudShare.Students.firstNamestringFirst name
CloudShare.Students.lastNamestringLast name
CloudShare.Students.emailstringEmail
CloudShare.Students.idstringID
CloudShare.Students.VMs.idstringID
CloudShare.Students.VMs.namestringName

cloudshare-delete-student#


Removes a student from a class

Base Command#

cloudshare-delete-student

Input#

Argument NameDescriptionRequired
classIdThe ID of the class.Required
studentIdThe ID of the student.Required

Context Output#

There is no context output for this command.

cloudshare-register-student#


Registers a student for a class

Base Command#

cloudshare-register-student

Input#

Argument NameDescriptionRequired
classIDThe ID of the class.Required
emailThe student's email address.Required
firstNameThe student's first name.Required
lastNameThe student's last name.Required

Context Output#

PathTypeDescription
CloudShare.Students.idstringID

cloudshare-modify-student#


Modifies a student's registration details

Base Command#

cloudshare-modify-student

Input#

Argument NameDescriptionRequired
classIdThe ID of the class for which the student is registered.Required
studentIdThe ID of the student.Required
emailThe student's email address. This can be changed as long as the student did not yet log in.Optional
firstNameThe student's first name.Optional
lastNameThe student's last name.Optional

Context Output#

There is no context output for this command.

cloudshare-get-regions#


Retrieves available regions

Base Command#

cloudshare-get-regions

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.Regions.idstringID
CloudShare.Regions.namestringName
CloudShare.Regions.cloudNamestringCloud name
CloudShare.Regions.friendlyNamestringFriendly name

cloudshare-get-timezones#


Retrieves available time zones

Base Command#

cloudshare-get-timezones

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.Timezones.idstringID
CloudShare.Timezones.displayNamestringDisplay name

cloudshare-get-env-resource#


Retrieves the total resources that have been used by an environment

Base Command#

cloudshare-get-env-resource

Input#

Argument NameDescriptionRequired
envIdThe environment ID.Required

Context Output#

PathTypeDescription
CloudShare.EnvironmentResources.totalRuntimeHoursnumberTotal run time
CloudShare.EnvironmentResources.totalGbhnumberTotal GB / hour
CloudShare.EnvironmentResources.maxDiskGbnumberMax disk space(GB)
CloudShare.EnvironmentResources.lastUpdateTimestringLast update time
CloudShare.EnvironmentResources.namestringName
CloudShare.EnvironmentResources.idstringID

cloudshare-get-env-extended#


Retrieves details of an environment along with VM information

Base Command#

cloudshare-get-env-extended

Input#

Argument NameDescriptionRequired
envIdThe ID of the environment.Required

Context Output#

PathTypeDescription
CloudShare.Environments.projectIdstringProject ID
CloudShare.Environments.policyIdstringPolicy ID
CloudShare.Environments.blueprintIdstringBlueprint ID
CloudShare.Environments.descriptionstringDescription
CloudShare.Environments.ownerEmailstringOwner email
CloudShare.Environments.regionIdstringRegion ID
CloudShare.Environments.namestringName
CloudShare.Environments.idstringID
CloudShare.Environments.statusstringStatus
CloudShare.Environments.teamIdstringTeam ID
CloudShare.Environments.VMs.idstringID
CloudShare.Environments.VMs.namestringName
CloudShare.Environments.VMs.descriptionstringDescription
CloudShare.Environments.VMs.statusTextstringStatus text
CloudShare.Environments.VMs.progressnumberProgress
CloudShare.Environments.VMs.imageIdstringImage ID
CloudShare.Environments.VMs.osstringOS
CloudShare.Environments.VMs.webAccessUrlstringWeb access URL
CloudShare.Environments.VMs.fqdnstringFQDN
CloudShare.Environments.VMs.externalAddressstringExternal address
CloudShare.Environments.VMs.internalAddressesunknownInternal addresses
CloudShare.Environments.VMs.cpuCountnumberCPU count
CloudShare.Environments.VMs.diskSizeGbnumberDisk size(GB)
CloudShare.Environments.VMs.memorySizeMbnumberMemory size(MB)
CloudShare.Environments.VMs.usernamestringUsername
CloudShare.Environments.VMs.passwordstringPassword
CloudShare.Environments.VMs.consoleTokenstringConsole token

cloudshare-get-env-extended-vanity#


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

Base Command#

cloudshare-get-env-extended-vanity

Input#

Argument NameDescriptionRequired
machineVanitySpecifies the vanity name or FQDN of a machine.Required

Context Output#

PathTypeDescription
CloudShare.Environments.projectIdstringProject ID
CloudShare.Environments.policyIdstringPolicy ID
CloudShare.Environments.blueprintIdstringBlueprint ID
CloudShare.Environments.descriptionstringDescription
CloudShare.Environments.ownerEmailstringOwner email
CloudShare.Environments.regionIdstringRegion ID
CloudShare.Environments.namestringName
CloudShare.Environments.idstringID
CloudShare.Environments.statusstringStatus
CloudShare.Environments.teamIdstringTeam ID
CloudShare.Environments.VMs.idstringID
CloudShare.Environments.VMs.namestringName
CloudShare.Environments.VMs.descriptionstringDescription
CloudShare.Environments.VMs.statusTextstringStatus text
CloudShare.Environments.VMs.progressnumberProgress
CloudShare.Environments.VMs.imageIdstringImage ID
CloudShare.Environments.VMs.osstringOS
CloudShare.Environments.VMs.webAccessUrlstringWeb access URL
CloudShare.Environments.VMs.fqdnstringFQDN
CloudShare.Environments.VMs.externalAddressstringExternal address
CloudShare.Environments.VMs.internalAddressesunknownInternal addresses
CloudShare.Environments.VMs.cpuCountnumberCPU count
CloudShare.Environments.VMs.diskSizeGbnumberDisk size(GB)
CloudShare.Environments.VMs.memorySizeMbnumberMemory size(MB)
CloudShare.Environments.VMs.usernamestringUsername
CloudShare.Environments.VMs.passwordstringPassword
CloudShare.Environments.VMs.consoleTokenstringConsole token

cloudshare-get-env-extended-token#


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

Base Command#

cloudshare-get-env-extended-token

Input#

Argument NameDescriptionRequired
sponsoredLoginTokenSpecifies the token.Required

Context Output#

PathTypeDescription
CloudShare.Environments.projectIdstringProject ID
CloudShare.Environments.policyIdstringPolicy ID
CloudShare.Environments.blueprintIdstringBlueprint ID
CloudShare.Environments.descriptionstringDescription
CloudShare.Environments.ownerEmailstringOwner email
CloudShare.Environments.regionIdstringRegion ID
CloudShare.Environments.namestringName
CloudShare.Environments.idstringID
CloudShare.Environments.statusstringStatus
CloudShare.Environments.teamIdstringTeam ID
CloudShare.Environments.VMs.idstringID
CloudShare.Environments.VMs.namestringName
CloudShare.Environments.VMs.descriptionstringDescription
CloudShare.Environments.VMs.statusTextstringStatus text
CloudShare.Environments.VMs.progressnumberProgress
CloudShare.Environments.VMs.imageIdstringImage ID
CloudShare.Environments.VMs.osstringOS
CloudShare.Environments.VMs.webAccessUrlstringWeb access URL
CloudShare.Environments.VMs.fqdnstringFQDN
CloudShare.Environments.VMs.externalAddressstringExternal address
CloudShare.Environments.VMs.internalAddressesunknownInternal addresses
CloudShare.Environments.VMs.cpuCountnumberCPU count
CloudShare.Environments.VMs.diskSizeGbnumberDisk size(GB)
CloudShare.Environments.VMs.memorySizeMbnumberMemory size(MB)
CloudShare.Environments.VMs.usernamestringUsername
CloudShare.Environments.VMs.passwordstringPassword
CloudShare.Environments.VMs.consoleTokenstringConsole token

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.

Base Command#

cloudshare-get-env-multiple-resources

Input#

Argument NameDescriptionRequired
subscriptionIdSpecifies a user subscription, where {subscriptionID} is the ID of the subscription. Provide the subscription if the user is a member of multiple subscriptions.Optional
starttimeSpecifies the start of the time range, where {starttime_value} is the start of the time range in the format ISO 8601. For example, "2017-01-01".Required
endtimeSpecifies the end of the time range, where {endtime_value} is the end of the time range in the format ISO 8601. For example, '2017-02-01'.Required
skipOptional. Specifies to skip the first {skip_value} records, where {skip_value} is an integer (default: 0). Can be used iteratively in conjunction with take to view distinct sets of environment records.Optional
takeOptional. Limits the number of records returned, where {take_value} is the maximum number of records to return. Integer (default: 1000, maximum: 1000).Optional

Context Output#

PathTypeDescription
CloudShare.EnvironmentResources.sponsoredLoginTokenstringSponsored login token
CloudShare.EnvironmentResources.totalRuntimeHoursnumberTotal run time (hours)
CloudShare.EnvironmentResources.totalGbhnumberTotal GB / hour
CloudShare.EnvironmentResources.maxDiskGbnumberMax disk(GB)
CloudShare.EnvironmentResources.lastUpdateTimestringLast update time
CloudShare.EnvironmentResources.namestringName
CloudShare.EnvironmentResources.idstringID

cloudshare-extend-env#


Extends the lifetime of an environment

Base Command#

cloudshare-extend-env

Input#

Argument NameDescriptionRequired
envIdSpecifies the environment, where {envId} is the environment's ID.Required

Context Output#

There is no context output for this command.

cloudshare-postpone-env-suspend#


Postpones an environment's suspended state Request Path

Base Command#

cloudshare-postpone-env-suspend

Input#

Argument NameDescriptionRequired
envIdSpecifies the environment, where {envId} is the environment's ID.Required

Context Output#

There is no context output for this command.

cloudshare-resume-env#


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

Base Command#

cloudshare-resume-env

Input#

Argument NameDescriptionRequired
envIdSpecifies the environment, where {envId} is the environment's ID.Required

Context Output#

There is no context output for this command.

cloudshare-revert-env#


Reverts an environment to a specified snapshot

Base Command#

cloudshare-revert-env

Input#

Argument NameDescriptionRequired
envIdSpecifies the environment, where {envId} is the environment's ID.Required
snapshotIdSpecifies the snapshot to which to revert the environment, where {snapshotId} is the snapshot's ID.Required

Context Output#

There is no context output for this command.

cloudshare-suspend-env#


Suspends an environment

Base Command#

cloudshare-suspend-env

Input#

Argument NameDescriptionRequired
envIdSpecifies the environment, where {envId} is the environment's ID.Required

Context Output#

There is no context output for this command.

cloudshare-get-env#


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

Base Command#

cloudshare-get-env

Input#

Argument NameDescriptionRequired
envIDThe environment's ID.Required
permissionSpecifies a type of permission to access the environment. Returns an error (status code 500) if the requesting user does not have the specified permission level. Otherwise, returns the environment properties. Possible values are: view, edit, owner.Optional

Context Output#

PathTypeDescription
CloudShare.Environments.projectIdstringProject ID
CloudShare.Environments.policyIdstringPolicy ID
CloudShare.Environments.descriptionstringDescription
CloudShare.Environments.ownerEmailstringOwner email
CloudShare.Environments.regionIdstringRegion ID
CloudShare.Environments.namestringName
CloudShare.Environments.idstringID
CloudShare.Environments.statusstringStatus
CloudShare.Environments.teamIdstringTeam ID

cloudshare-delete-env#


Deletes an environment

Base Command#

cloudshare-delete-env

Input#

Argument NameDescriptionRequired
envIDThe Id of the environment.Required

Context Output#

There is no context output for this command.

cloudshare-create-env#


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

Base Command#

cloudshare-create-env

Input#

Argument NameDescriptionRequired
environmentSpecifies details (JSON) of the environment to create. Please refer to https://docs.cloudshare.com/rest-api/v3/environments/envs/post-envs/ for the format.Required
itemsCartSpecifies templates (JSON array) from which to build the environment. Please refer to https://docs.cloudshare.com/rest-api/v3/environments/envs/post-envs/ for the format.Required

Context Output#

PathTypeDescription
CloudShare.Environments.resources.cpuCountnumberCPU count
CloudShare.Environments.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Environments.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Environments.VMs.namestringName
CloudShare.Environments.VMs.descriptionstringDescription
CloudShare.Environments.VMs.osTypeNamestringOS type name
CloudShare.Environments.VMs.imageUrlstringImage URL
CloudShare.Environments.VMs.resources.cpuCountnumberCPU count
CloudShare.Environments.VMs.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Environments.VMs.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Environments.VMs.domainNamestringDomain name
CloudShare.Environments.VMs.internalIPsunknownInternal IPs
CloudShare.Environments.VMs.macAddressesunknownMAC addresses
CloudShare.Environments.VMs.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Environments.VMs.hostNamestringHostname
CloudShare.Environments.VMs.vanityNamestringVanity name
CloudShare.Environments.VMs.httpAccessEnabledbooleanHTTP access enabled
CloudShare.Environments.VMs.startWithHttpsbooleanStart with HTTPS
CloudShare.Environments.VMs.userstringUser
CloudShare.Environments.VMs.passwordstringPassword
CloudShare.Environments.VMs.idstringID
CloudShare.Environments.environmentIdstringEnvironment ID
CloudShare.Environments.idstringID

cloudshare-modify-env#


Adds one or more VMs to an existing environment

Base Command#

cloudshare-modify-env

Input#

Argument NameDescriptionRequired
envIdThe ID of the environment.Required
itemsCartSpecifies templates (JSON array) of VMs to add to the environment. Please refer to https://docs.cloudshare.com/rest-api/v3/environments/envs/post-envs/ for the format.Required

Context Output#

PathTypeDescription
CloudShare.Environments.resources.cpuCountnumberCPU count
CloudShare.Environments.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Environments.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Environments.VMs.namestringName
CloudShare.Environments.VMs.descriptionstringDescription
CloudShare.Environments.VMs.osTypeNamestringOS type name
CloudShare.Environments.VMs.imageUrlstringImage URL
CloudShare.Environments.VMs.resources.cpuCountnumberCPU count
CloudShare.Environments.VMs.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Environments.VMs.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Environments.VMs.domainNamestringDomain name
CloudShare.Environments.VMs.internalIPsunknownInternal IPs
CloudShare.Environments.VMs.macAddressesunknownMAC addresses
CloudShare.Environments.VMs.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Environments.VMs.hostNamestringHostname
CloudShare.Environments.VMs.vanityNamestringVanity name
CloudShare.Environments.VMs.httpAccessEnabledbooleanHTTP access enabled
CloudShare.Environments.VMs.startWithHttpsbooleanStart with HTTPS
CloudShare.Environments.VMs.userstringUser
CloudShare.Environments.VMs.passwordstringPassword
CloudShare.Environments.VMs.idstringID
CloudShare.Environments.environmentIdstringEnvironment ID
CloudShare.Environments.idstringID

cloudshare-delete-vm#


Deletes a VM

Base Command#

cloudshare-delete-vm

Input#

Argument NameDescriptionRequired
VmIDThe ID of the VM.Optional

Context Output#

There is no context output for this command.

cloudshare-check-vm-execution-status#


Checks the status of a previously executed command line script

Base Command#

cloudshare-check-vm-execution-status

Input#

Argument NameDescriptionRequired
vmIDThe ID of the VM on which the script was executed.Required
executionIdThe ID returned by the execution request.Required

Context Output#

PathTypeDescription
CloudShare.VM.Executions.idstringID
CloudShare.VM.Executions.exitCodenumberExit code
CloudShare.VM.Executions.successbooleanSuccess
CloudShare.VM.Executions.standardOutputstringStandard output
CloudShare.VM.Executions.standardErrorstringStandard error
CloudShare.VM.Executions.executedPathstringExecuted path

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.

Base Command#

cloudshare-get-vm-remote-access-file

Input#

Argument NameDescriptionRequired
VmIDThe ID of the VM.Optional
desktopHeightThe height resolution of the remote access session, in pixels.Required
desktopWidthThe width resolution of the remote access session, in pixels.Required

Context Output#

PathTypeDescription
CloudShare.VM.Remote.VmIDstringVM ID
CloudShare.VM.Remote.rdpFileContentstringRDP file content
CloudShare.VM.Remote.clearTextPasswordstringClear text password

cloudshare-execute-vm-command#


Executes a command line script on a VM

Base Command#

cloudshare-execute-vm-command

Input#

Argument NameDescriptionRequired
vmIdThe ID of the VM.Required
pathPath in VM.Required

Context Output#

PathTypeDescription
CloudShare.VM.Execute.executionIdstringExecution ID

cloudshare-modify-vm-hardware#


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

Base Command#

cloudshare-modify-vm-hardware

Input#

Argument NameDescriptionRequired
vmIDThe ID of the VM.Required
numCpusNumber of CPUs.Required
memorySizeMBsRAM size, in megabytes.Required
diskSizeGBsDisk size, in gigabytes.Required

Context Output#

PathTypeDescription
CloudShare.VM.Modify.vmIDstringVM ID
CloudShare.VM.Modify.conflictsFoundbooleanConflicts found
CloudShare.VM.Modify.conflictsstringConflicts

cloudshare-reboot-vm#


Reboots a VM

Base Command#

cloudshare-reboot-vm

Input#

Argument NameDescriptionRequired
VmIDThe ID of the VM.Required

Context Output#

There is no context output for this command.

cloudshare-revert-vm#


Reverts a VM

Base Command#

cloudshare-revert-vm

Input#

Argument NameDescriptionRequired
VmIDThe ID of the VM.Required

Context Output#

There is no context output for this command.

cloudshare-get-cloud-folders#


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

Base Command#

cloudshare-get-cloud-folders

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.Folders.hoststringHost
CloudShare.Folders.pathstringPath
CloudShare.Folders.userNamestringUsername
CloudShare.Folders.passwordstringPassword
CloudShare.Folders.userFolder.namestringName
CloudShare.Folders.userFolder.quotaSizeGBstringQuota size(GB)
CloudShare.Folders.userFolder.quotaSizeInUseGBstringQuota size in use(GB)
CloudShare.Folders.userFolder.usagePercentagestringUsage percentage
CloudShare.Folders.projectFolders.namestringName
CloudShare.Folders.projectFolders.quotaSizeGBstringQuota size(GB)
CloudShare.Folders.projectFolders.quotaSizeInUseGBstringQuota size in use(GB)
CloudShare.Folders.projectFolders.usagePercentagestringUsage percentage

cloudshare-get-env-cloud-folders#


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

Base Command#

cloudshare-get-env-cloud-folders

Input#

Argument NameDescriptionRequired
EnvIdThe ID of the environment.Required

Context Output#

PathTypeDescription
CloudShare.EnvFolders.namestringName
CloudShare.EnvFolders.sanitizedNamestringSantized name
CloudShare.EnvFolders.windowsFolderstringWindows folder
CloudShare.EnvFolders.linuxFolderstringLinux folder
CloudShare.EnvFolders.tokenstringToken

cloudshare-generate-cloud-folder-password#


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

Base Command#

cloudshare-generate-cloud-folder-password

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.FoldersPassword.newPasswordstringNew password
CloudShare.FoldersPassword.newFtpUristringNew FTP URI

cloudshare-unmount-env-folders#


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

Base Command#

cloudshare-unmount-env-folders

Input#

Argument NameDescriptionRequired
EnvIdThe ID of the environment.Required

Context Output#

There is no context output for this command.

cloudshare-get-templates#


Retrieves VM templates and blueprints

Base Command#

cloudshare-get-templates

Input#

Argument NameDescriptionRequired
templateTypeFilters the results by type of template. Possible values: 0 - Returns blueprints only. 1 - Returns VM templates only. Possible values are: 0, 1.Optional
projectIdFilters the results to include only blueprints that belong to a specific project.Optional
regionIdFilters the results to include only templates that belong to a specific region.Optional
skipSpecifies to skip the first {skip} records, where {skip} is an integer.Optional
takeLimits the number of records returned, where {take_value} is the maximum number of records to return. Integer (default: 1000, maximum: 1000).Optional

Context Output#

PathTypeDescription
CloudShare.Templates.namestringName
CloudShare.Templates.descriptionstringDescription
CloudShare.Templates.isEnvironmentTemplatebooleanIs environment template
CloudShare.Templates.typenumberType
CloudShare.Templates.imageUrlstringImage URL
CloudShare.Templates.regionIdstringRegion ID
CloudShare.Templates.tagsunknownTags
CloudShare.Templates.categoriesunknownCategories
CloudShare.Templates.resources.cpuCountnumberCPU count
CloudShare.Templates.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Templates.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Templates.numberOfMachinesnumberNumber of mahcines
CloudShare.Templates.hasMultipleVersionsbooleanHas multiple versions
CloudShare.Templates.hasDefaultVersionbooleanHas default version
CloudShare.Templates.disabledForRegularEnvironmentCreationbooleanDisabled for regular environment creation
CloudShare.Templates.disabledForTrainingEnvironmentCreationbooleanDisabled for training environment creation
CloudShare.Templates.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Templates.envTemplateScopeunknownEnv template scopt
CloudShare.Templates.creationDatestringCreation date
CloudShare.Templates.idstringID

cloudshare-get-snapshot#


Retrieves details of a snapshot

Base Command#

cloudshare-get-snapshot

Input#

Argument NameDescriptionRequired
snapshotIDThe ID of the snapshot.Required

Context Output#

PathTypeDescription
CloudShare.Snapshots.authorNamestringAuthor name
CloudShare.Snapshots.commentstringComment
CloudShare.Snapshots.createTimestringCreate time
CloudShare.Snapshots.descriptionstringDescription
CloudShare.Snapshots.idstringID
CloudShare.Snapshots.imageUrlstringImage URL
CloudShare.Snapshots.isDefaultbooleanIs default
CloudShare.Snapshots.isLatestbooleanIs latest
CloudShare.Snapshots.machines.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Snapshots.machines.descriptionstringDescription
CloudShare.Snapshots.machines.domainNamestringDomain name
CloudShare.Snapshots.machines.hostNamestringHostname
CloudShare.Snapshots.machines.httpAccessEnabledbooleanHTTP access enabled
CloudShare.Snapshots.machines.idstringID
CloudShare.Snapshots.machines.idstringImage URL
CloudShare.Snapshots.machines.internalIPsunknownInternal IPs
CloudShare.Snapshots.machines.macAddressesunknownMAC addresses
CloudShare.Snapshots.machines.namestringName
CloudShare.Snapshots.machines.osTypeNamestringOS type name
CloudShare.Snapshots.machines.passwordstringPassword
CloudShare.Snapshots.machines.resources.cpuCountnumberCPU count
CloudShare.Snapshots.machines.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Snapshots.machines.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Snapshots.machines.startWithHttpsbooleanStart with HTTPS
CloudShare.Snapshots.machines.userstringUser
CloudShare.Snapshots.machines.vanityNamestringVanity name
CloudShare.Snapshots.namestringName
CloudShare.Snapshots.numbernumberNumber
CloudShare.Snapshots.resources.cpuCountnumberCPU count
CloudShare.Snapshots.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Snapshots.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Snapshots.typenumberType
CloudShare.Snapshots.regionsunknownRegions

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.

Base Command#

cloudshare-get-env-snapshots

Input#

Argument NameDescriptionRequired
envIdThe ID of the environment.Required

Context Output#

PathTypeDescription
CloudShare.Snapshots.authorNamestringAuthor name
CloudShare.Snapshots.commentstringComment
CloudShare.Snapshots.createTimestringCreate time
CloudShare.Snapshots.descriptionstringDescription
CloudShare.Snapshots.idstringID
CloudShare.Snapshots.imageUrlstringImage URL
CloudShare.Snapshots.isDefaultbooleanIs default
CloudShare.Snapshots.isLatestbooleanIs latest
CloudShare.Snapshots.machines.canAddMultipleInstancesbooleanCan add multiple instances
CloudShare.Snapshots.machines.descriptionstringDescription
CloudShare.Snapshots.machines.domainNamestringDomain name
CloudShare.Snapshots.machines.hostNamestringHostname
CloudShare.Snapshots.machines.httpAccessEnabledbooleanHTTP access enabled
CloudShare.Snapshots.machines.idstringID
CloudShare.Snapshots.machines.idstringImage URL
CloudShare.Snapshots.machines.internalIPsunknownInternal IPs
CloudShare.Snapshots.machines.macAddressesunknownMAC addresses
CloudShare.Snapshots.machines.namestringName
CloudShare.Snapshots.machines.osTypeNamestringOS type name
CloudShare.Snapshots.machines.passwordstringPassword
CloudShare.Snapshots.machines.resources.cpuCountnumberCPU count
CloudShare.Snapshots.machines.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Snapshots.machines.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Snapshots.machines.startWithHttpsbooleanStart with HTTPS
CloudShare.Snapshots.machines.userstringUser
CloudShare.Snapshots.machines.vanityNamestringVanity name
CloudShare.Snapshots.namestringName
CloudShare.Snapshots.numbernumberNumber
CloudShare.Snapshots.resources.cpuCountnumberCPU count
CloudShare.Snapshots.resources.diskSizeMBnumberDisk size(MB)
CloudShare.Snapshots.resources.memorySizeMBnumberMemory size(MB)
CloudShare.Snapshots.typenumberType
CloudShare.Snapshots.regionsunknownRegions

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.

Base Command#

cloudshare-mark-default-snapshot

Input#

Argument NameDescriptionRequired
snapshotIDThe ID of the snapshot that you want to mark as default.Required

Context Output#

There is no context output for this command.

cloudshare-take-snapshot-env#


Takes a snapshot of an environment

Base Command#

cloudshare-take-snapshot-env

Input#

Argument NameDescriptionRequired
envIdThe ID of the environment of which to take the snapshot.Required
nameA name for the new snapshot. Should not exceed 32 characters.Required
descriptionA description for the new snapshot.Optional
newBlueprintNameA name to assign to a new blueprint. If specified, the snapshot is created in a new blueprint with the specified name, rather than in the default environment blueprint. Must be null if there is not yet at least one snapshot in the default environment blueprint. If specified, otherBlueprintId must be null. If both newBlueprintName and otherBlueprintId are null, the snapshot is created in the default environment blueprint.Optional
otherBlueprintIdThe ID of an existing blueprint. If specified, the snapshot is created in the specified blueprint rather than in the default environment blueprint. Must be null if there is not yet at least one snapshot in the default environment blueprint. If specified, newBlueprintName must be null. If both newBlueprintName and otherBlueprintId are null, the snapshot is created in the default environment blueprint.Optional
setAsDefaultDefaults to true. If true, the new snapshot is marked as the default snapshot in the containing blueprint. Possible values are: true, false. Default is true.Optional

Context Output#

There is no context output for this command.

cloudshare-get-teams#


Retrieves all available teams in all available projects

Base Command#

cloudshare-get-teams

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
CloudShare.Teams.NamestringName
CloudShare.Teams.IdstringID

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.

Base Command#

cloudshare-invite-user-poc

Input#

Argument NameDescriptionRequired
policyIdThe ID of the environment policy to assign to the environment created for the end user as part of the POC. The policy will govern the life cycle of the end user's environment.Optional
blueprintIdThe ID of the blueprint based on which the end user's environment will be created (this is the POC's blueprint).Required
OwningProjectMemberIdThe ID of the project member user to whom the end user will be assigned.Required
opportunityThe name of the business opportunity to be associated with the end user.Required
validForDaysThe number of days to keep the invitation valid for.Required
emailThe recipient's email. The invitation will be sent to the specified email.Required
firstNameThe recipient's first name.Required
LastNameThe recipient's last name.Required
regionIdThe region in which to create the POC's environment.Optional
InviteeCanSetEmailIndicates whether an end user can set email when accepting the invitation. Default is true. Possible values are: true, false. Default is true.Optional
customEmailSubjectThe subject of the email. The invitation will be sent with the specified custom email subject. This value will override the custom email subject in the UI.Optional
customEmailBodyThe body of the email. The invitation will be sent with the specified custom email body. This value will override the custom email body in the UI.Optional

Context Output#

PathTypeDescription
CloudShare.Invites.invitationDetailsUrlstringInvitation details URL
CloudShare.Invites.acceptInvitationUrlstringAccept invitation URL
CloudShare.Invites.messagestringMessage

cloudshare-get-poc-invitations#


Retrieves POC invitations sent.

Base Command#

cloudshare-get-poc-invitations

Input#

Argument NameDescriptionRequired
fromRetrieve invites from a particular time (Example: "last 7 days").Optional
sentByFilter based on who sent the invite (default is anyone).Optional
skipSpecifies to skip the first {skip} records, where {skip} is an integer (default: 0). Can be used iteratively in conjunction with take to view distinct sets of template records.Optional
sortByThe filed to sort by.Optional
statusCategoryThe status categoey to filter by.Optional
takeLimits the number of records returned, where {take} is the maximum number of records to return. Integer (default: 1000, maximum: 1000).Optional

Context Output#

PathTypeDescription
CloudShare.POCInvites.blueprintShortIdstringBlueprint short ID
CloudShare.POCInvites.projectNamestringProject name
CloudShare.POCInvites.createdOnstringCreated on
CloudShare.POCInvites.owningSestringOwning SE
CloudShare.POCInvites.environmentIdstringEnvironment ID
CloudShare.POCInvites.pocUserstringPOC user
CloudShare.POCInvites.startDatestringStart date
CloudShare.POCInvites.statusnumberStatus
CloudShare.POCInvites.opportunitystringOpportunity
CloudShare.POCInvites.owningSeUserIdstringOwning SE user ID
CloudShare.POCInvites.projectIdstringProject ID
CloudShare.POCInvites.randomTokenstringRandom token
CloudShare.POCInvites.idstringID
CloudShare.POCInvites.expirationDatestringExpiration date
CloudShare.POCInvites.blueprintNamestringBlueprint name