diff --git a/static/api-docs/latest/Python-API/.buildinfo b/static/api-docs/latest/Python-API/.buildinfo index e835fc6916..6ce32a290d 100644 --- a/static/api-docs/latest/Python-API/.buildinfo +++ b/static/api-docs/latest/Python-API/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 57e774f05f576a704fcd294921c56ea4 +config: d834795173d4b22ce382df0eecaa2b18 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/static/api-docs/latest/Python-API/_modules/cloudshell/api/cloudshell_api.html b/static/api-docs/latest/Python-API/_modules/cloudshell/api/cloudshell_api.html index 0b0914d21e..279b4255f2 100644 --- a/static/api-docs/latest/Python-API/_modules/cloudshell/api/cloudshell_api.html +++ b/static/api-docs/latest/Python-API/_modules/cloudshell/api/cloudshell_api.html @@ -5,7 +5,7 @@ - cloudshell.api.cloudshell_api — CloudShell Python API 2026.1.0.189799 documentation + cloudshell.api.cloudshell_api — CloudShell Python API 2026.2.0.190144 documentation @@ -13,7 +13,7 @@ - + @@ -31,7 +31,7 @@
- 2026.1 + 2026.2
@@ -1727,6 +1727,48 @@

Source code for cloudshell.api.cloudshell_api

""":type : list[ResourceCommandInfo]""" CommonResponseInfo.__init__(self, xml_object, find_prefix)
+
[docs]class RunningCommandInfo(CommonResponseInfo): + def __init__(self, xml_object, find_prefix): + self.ExecutionId = str + """:type : str""" + self.ResourceFullName = str + """:type : str""" + self.CommandName = str + """:type : str""" + self.Status = str + """:type : str""" + self.StartTime = str + """:type : str""" + self.ReservationId = str + """:type : str""" + CommonResponseInfo.__init__(self, xml_object, find_prefix)
+ +
[docs]class RunningCommandListInfo(CommonResponseInfo): + def __init__(self, xml_object, find_prefix): + self.Commands = {'list': RunningCommandInfo} + """:type : list[RunningCommandInfo]""" + CommonResponseInfo.__init__(self, xml_object, find_prefix)
+ +
[docs]class BlueprintXmlInfo(CommonResponseInfo): + def __init__(self, xml_object, find_prefix): + self.Xml = str + """:type : str""" + self.Name = str + """:type : str""" + CommonResponseInfo.__init__(self, xml_object, find_prefix)
+ +
[docs]class ExportBlueprintResponseInfo(CommonResponseInfo): + def __init__(self, xml_object, find_prefix): + self.Blueprints = {'list': BlueprintXmlInfo} + """:type : list[BlueprintXmlInfo]""" + CommonResponseInfo.__init__(self, xml_object, find_prefix)
+ +
[docs]class ImportBlueprintResponseInfo(CommonResponseInfo): + def __init__(self, xml_object, find_prefix): + self.ImportedBlueprints = {'list': str} + """:type : list[str]""" + CommonResponseInfo.__init__(self, xml_object, find_prefix)
+
[docs]class TopologyCommandInfo(CommonResponseInfo): def __init__(self, xml_object, find_prefix): self.Name = str @@ -2879,7 +2921,7 @@

Source code for cloudshell.api.cloudshell_api

""" return self.generateAPIRequest(OrderedDict([('method_name', 'CreateFolder'), ('folderFullPath', folderFullPath)]))
-
[docs] def CreateImmediateReservation(self, reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid=''): +
[docs] def CreateImmediateReservation(self, reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid='', notificationRepeatMinutes=0): """ Defines a reservation to be started immediately. @@ -2891,10 +2933,11 @@

Source code for cloudshell.api.cloudshell_api

:param int notificationMinutesBeforeEnd: Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled) :param bool isTerminationProtectionEnabled: Indicate whether to protect the reservation from being terminated. :param str approvalSid: Leave empty. Used for internal purposes. + :param int notificationRepeatMinutes: Repeat the before-end notification every this many minutes until the reservation ends (0 = no repeat, minimum 15). Applies only when notificationMinutesBeforeEnd is set. :rtype: CreateReservationResponseInfo """ - return self.generateAPIRequest(OrderedDict([('method_name', 'CreateImmediateReservation'), ('reservationName', reservationName), ('owner', owner), ('durationInMinutes', durationInMinutes), ('notifyOnStart', notifyOnStart), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('isTerminationProtectionEnabled', isTerminationProtectionEnabled), ('approvalSid', approvalSid)]))
+ return self.generateAPIRequest(OrderedDict([('method_name', 'CreateImmediateReservation'), ('reservationName', reservationName), ('owner', owner), ('durationInMinutes', durationInMinutes), ('notifyOnStart', notifyOnStart), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('isTerminationProtectionEnabled', isTerminationProtectionEnabled), ('approvalSid', approvalSid), ('notificationRepeatMinutes', notificationRepeatMinutes)]))
[docs] def CreateImmediatePersistentReservation(self, reservationName='', owner='', notifyOnStart=False, notifyOnEnd=False, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False): """ @@ -2914,7 +2957,7 @@

Source code for cloudshell.api.cloudshell_api

""" return self.generateAPIRequest(OrderedDict([('method_name', 'CreateImmediatePersistentReservation'), ('reservationName', reservationName), ('owner', owner), ('notifyOnStart', notifyOnStart), ('notifyOnEnd', notifyOnEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs)), ('notifyOnSetupComplete', notifyOnSetupComplete)]))
-
[docs] def CreateImmediateTopologyReservation(self, reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[]): +
[docs] def CreateImmediateTopologyReservation(self, reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notificationRepeatMinutes=0): """ Defines a reservation to be started immediately. The reservation will start regardless of conflicting resources. @@ -2954,16 +2997,17 @@

Source code for cloudshell.api.cloudshell_api

doesnotcontain hi there :param list[UpdateTopologyAdditionalInfoInputsRequest] additionalInfoInputs: Additional info inputs associated with the specified topology. + :param int notificationRepeatMinutes: Repeat the before-end notification every this many minutes until the reservation ends (0 = no repeat, minimum 15). Applies only when notificationMinutesBeforeEnd is set. :rtype: CreateReservationResponseInfo """ if self.use_webapi_endpoint: - result = self._sendRest('/RmApi/CreateImmediateReservation', OrderedDict([('reservationName', reservationName), ('owner', owner), ('durationInMinutes', durationInMinutes), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs))])) + result = self._sendRest('/RmApi/CreateImmediateReservation', OrderedDict([('reservationName', reservationName), ('owner', owner), ('durationInMinutes', durationInMinutes), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs)), ('notificationRepeatMinutes', notificationRepeatMinutes)])) else: - result = self.generateAPIRequest(OrderedDict([('method_name', 'CreateImmediateReservation'), ('reservationName', reservationName), ('owner', owner), ('durationInMinutes', durationInMinutes), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs))])) + result = self.generateAPIRequest(OrderedDict([('method_name', 'CreateImmediateReservation'), ('reservationName', reservationName), ('owner', owner), ('durationInMinutes', durationInMinutes), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs)), ('notificationRepeatMinutes', notificationRepeatMinutes)])) return result
-
[docs] def CreateReservation(self, reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid=''): +
[docs] def CreateReservation(self, reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid='', notificationRepeatMinutes=0): """ Defines a new reservation. @@ -2976,10 +3020,11 @@

Source code for cloudshell.api.cloudshell_api

:param int notificationMinutesBeforeEnd: Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled) :param bool isTerminationProtectionEnabled: Indicate whether to protect the reservation from being terminated. :param str approvalSid: Leave empty. Used for internal purposes. + :param int notificationRepeatMinutes: Repeat the before-end notification every this many minutes until the reservation ends (0 = no repeat, minimum 15). Applies only when notificationMinutesBeforeEnd is set. :rtype: CreateReservationResponseInfo """ - return self.generateAPIRequest(OrderedDict([('method_name', 'CreateReservation'), ('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('endTime', endTime), ('notifyOnStart', notifyOnStart), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('isTerminationProtectionEnabled', isTerminationProtectionEnabled), ('approvalSid', approvalSid)]))
+ return self.generateAPIRequest(OrderedDict([('method_name', 'CreateReservation'), ('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('endTime', endTime), ('notifyOnStart', notifyOnStart), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('isTerminationProtectionEnabled', isTerminationProtectionEnabled), ('approvalSid', approvalSid), ('notificationRepeatMinutes', notificationRepeatMinutes)]))
[docs] def CreatePersistentReservation(self, reservationName='', owner='', startTime='', notifyOnStart=False, notifyOnEnd=False, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False): """ @@ -3000,7 +3045,7 @@

Source code for cloudshell.api.cloudshell_api

""" return self.generateAPIRequest(OrderedDict([('method_name', 'CreatePersistentReservation'), ('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('notifyOnStart', notifyOnStart), ('notifyOnEnd', notifyOnEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs)), ('notifyOnSetupComplete', notifyOnSetupComplete)]))
-
[docs] def CreateTopologyReservation(self, reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[]): +
[docs] def CreateTopologyReservation(self, reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notificationRepeatMinutes=0): """ Defines a new reservation. @@ -3041,13 +3086,14 @@

Source code for cloudshell.api.cloudshell_api

doesnotcontain hi there :param list[UpdateTopologyAdditionalInfoInputsRequest] additionalInfoInputs: Additional info inputs associated with the specified topology. + :param int notificationRepeatMinutes: Repeat the before-end notification every this many minutes until the reservation ends (0 = no repeat, minimum 15). Applies only when notificationMinutesBeforeEnd is set. :rtype: CreateReservationResponseInfo """ if self.use_webapi_endpoint: - result = self._sendRest('/RmApi/CreateReservation', OrderedDict([('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('endTime', endTime), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs))])) + result = self._sendRest('/RmApi/CreateReservation', OrderedDict([('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('endTime', endTime), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs)), ('notificationRepeatMinutes', notificationRepeatMinutes)])) else: - result = self.generateAPIRequest(OrderedDict([('method_name', 'CreateReservation'), ('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('endTime', endTime), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs))])) + result = self.generateAPIRequest(OrderedDict([('method_name', 'CreateReservation'), ('reservationName', reservationName), ('owner', owner), ('startTime', startTime), ('endTime', endTime), ('notifyOnStart', notifyOnStart), ('notifyOnSetupComplete', notifyOnSetupComplete), ('notifyOnEnd', notifyOnEnd), ('notificationMinutesBeforeEnd', notificationMinutesBeforeEnd), ('topologyFullPath', topologyFullPath), ('globalInputs', CommonAPIRequest.toContainer(globalInputs)), ('requirementsInputs', CommonAPIRequest.toContainer(requirementsInputs)), ('additionalInfoInputs', CommonAPIRequest.toContainer(additionalInfoInputs)), ('notificationRepeatMinutes', notificationRepeatMinutes)])) return result
[docs] def CreateResource(self, resourceFamily='', resourceModel='', resourceName='', resourceAddress='', folderFullPath='', parentResourceFullPath='', resourceDescription=''): @@ -4683,6 +4729,66 @@

Source code for cloudshell.api.cloudshell_api

""" return self.generateAPIRequest(OrderedDict([('method_name', 'RenameResource'), ('resourceFullPath', resourceFullPath), ('resourceName', resourceName)]))
+
[docs] def CancelResourceCommand(self, commandId=''): + """ + Cancel a queued or running resource driver command by its command execution id. If the command is still queued it is removed from the command queue; if it is already running it is cancelled. Requires system administrator permissions. + + :param str commandId: Specify the string that represents the command execution's unique identifier (as returned by EnqueueResourceCommand). + + :rtype: str + """ + return self.generateAPIRequest(OrderedDict([('method_name', 'CancelResourceCommand'), ('commandId', commandId)]))
+ +
[docs] def GetRunningCommands(self, reservationId=''): + """ + List the resource driver commands currently queued or running in a reservation, each with its command execution id (which can be passed to CancelResourceCommand), resource full name, command name, status and start time. Requires system administrator permissions. + + :param str reservationId: Specify the string that represents the reservation’s unique identifier. + + :rtype: RunningCommandListInfo + """ + return self.generateAPIRequest(OrderedDict([('method_name', 'GetRunningCommands'), ('reservationId', reservationId)]))
+ +
[docs] def GetResourceCommandExecutions(self, resourceFullName=''): + """ + List the resource driver commands currently queued or running on a specific resource, across all reservations, each with its command execution id (which can be passed to CancelResourceCommand), command name, status and the id of the reservation the command belongs to. Use this to find a command left behind by a previous sandbox that is blocking an exclusive, non-concurrent resource. Requires system administrator permissions. + + :param str resourceFullName: Specify the resource full name. For example: ResourceName/Port. + + :rtype: RunningCommandListInfo + """ + return self.generateAPIRequest(OrderedDict([('method_name', 'GetResourceCommandExecutions'), ('resourceFullName', resourceFullName)]))
+ +
[docs] def ClearResourceCommands(self, resourceFullName=''): + """ + Cancel every resource driver command currently queued or running on a specific resource, across all reservations, and return the commands that were cleared. Queued commands are dequeued and running commands are cancelled out-of-band, so this does not wait behind the very command it is clearing. Intended to be called during Setup to make sure a new sandbox starts with no residual commands from a previous one. Requires system administrator permissions. + + :param str resourceFullName: Specify the resource full name. For example: ResourceName/Port. + + :rtype: RunningCommandListInfo + """ + return self.generateAPIRequest(OrderedDict([('method_name', 'ClearResourceCommands'), ('resourceFullName', resourceFullName)]))
+ +
[docs] def ExportBlueprint(self, topologyNames=[]): + """ + Export one or more blueprints as their definition xml - the same xml CloudShell uses inside a package. Only the blueprint itself is returned: no data model, drivers, scripts, inventory resources or category definitions, so the result is safe to store in source control and cannot carry system-wide configuration. Use ImportBlueprint to bring it into another server that already has the referenced families, models, attributes, scripts, drivers and categories. + + :param list[str] topologyNames: Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. + + :rtype: ExportBlueprintResponseInfo + """ + return self.generateAPIRequest(OrderedDict([('method_name', 'ExportBlueprint'), ('topologyNames', topologyNames)]))
+ +
[docs] def ImportBlueprint(self, blueprintXml=''): + """ + Import a blueprint from its definition xml, as produced by ExportBlueprint. Inventory and system-wide configuration are never modified - the call fails if any referenced resource family, resource model, resource attribute, script, driver or category does not already exist on this server. Equivalent to creating or editing a blueprint by hand. + + :param str blueprintXml: Specify the blueprint definition xml, as returned by ExportBlueprint. + + :rtype: ImportBlueprintResponseInfo + """ + return self.generateAPIRequest(OrderedDict([('method_name', 'ImportBlueprint'), ('blueprintXml', blueprintXml)]))
+
[docs] def ResetResourceDriver(self, reservationId='', resourceFullPath=''): """ Cancel the currently executing command, remove all pending command executions and reset the driver to its initial state. diff --git a/static/api-docs/latest/Python-API/_modules/cloudshell/api/common_cloudshell_api.html b/static/api-docs/latest/Python-API/_modules/cloudshell/api/common_cloudshell_api.html index cd5aa73743..fa7cec9332 100644 --- a/static/api-docs/latest/Python-API/_modules/cloudshell/api/common_cloudshell_api.html +++ b/static/api-docs/latest/Python-API/_modules/cloudshell/api/common_cloudshell_api.html @@ -5,7 +5,7 @@ - cloudshell.api.common_cloudshell_api — CloudShell Python API 2026.1.0.189799 documentation + cloudshell.api.common_cloudshell_api — CloudShell Python API 2026.2.0.190144 documentation @@ -13,7 +13,7 @@ - + @@ -31,7 +31,7 @@
- 2026.1 + 2026.2
diff --git a/static/api-docs/latest/Python-API/_modules/index.html b/static/api-docs/latest/Python-API/_modules/index.html index a32d4cc8cd..1125e0654d 100644 --- a/static/api-docs/latest/Python-API/_modules/index.html +++ b/static/api-docs/latest/Python-API/_modules/index.html @@ -5,7 +5,7 @@ - Overview: module code — CloudShell Python API 2026.1.0.189799 documentation + Overview: module code — CloudShell Python API 2026.2.0.190144 documentation @@ -13,7 +13,7 @@ - + @@ -31,7 +31,7 @@
- 2026.1 + 2026.2
diff --git a/static/api-docs/latest/Python-API/_static/documentation_options.js b/static/api-docs/latest/Python-API/_static/documentation_options.js index 87240479f5..64f5559c49 100644 --- a/static/api-docs/latest/Python-API/_static/documentation_options.js +++ b/static/api-docs/latest/Python-API/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '2026.1.0.189799', + VERSION: '2026.2.0.190144', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/static/api-docs/latest/Python-API/cloudshell.api.html b/static/api-docs/latest/Python-API/cloudshell.api.html index 7b2a7f3e6f..d061ca145b 100644 --- a/static/api-docs/latest/Python-API/cloudshell.api.html +++ b/static/api-docs/latest/Python-API/cloudshell.api.html @@ -6,7 +6,7 @@ - cloudshell.api package — CloudShell Python API 2026.1.0.189799 documentation + cloudshell.api package — CloudShell Python API 2026.2.0.190144 documentation @@ -14,7 +14,7 @@ - + @@ -33,7 +33,7 @@
- 2026.1 + 2026.2
@@ -164,6 +164,11 @@
  • Authentication.xmlrpc_token
  • +
  • BlueprintXmlInfo +
  • BulkAppDeploymentyInfo @@ -218,10 +223,12 @@
  • CloudShellAPISession.ApproveApprovalRequest()
  • CloudShellAPISession.ArchiveDomain()
  • CloudShellAPISession.AutoLoad()
  • +
  • CloudShellAPISession.CancelResourceCommand()
  • CloudShellAPISession.ChangeReservationOwner()
  • CloudShellAPISession.CheckoutFromPool()
  • CloudShellAPISession.CleanupSandboxConnectivity()
  • CloudShellAPISession.ClearAndResetConsole()
  • +
  • CloudShellAPISession.ClearResourceCommands()
  • CloudShellAPISession.ClearSandboxData()
  • CloudShellAPISession.ConfigureApps()
  • CloudShellAPISession.ConfigureAppsV2()
  • @@ -273,6 +280,7 @@
  • CloudShellAPISession.ExecuteResourceConnectedCommand()
  • CloudShellAPISession.ExecuteServiceCommand()
  • CloudShellAPISession.ExecuteTopologyCommand()
  • +
  • CloudShellAPISession.ExportBlueprint()
  • CloudShellAPISession.ExportFamiliesAndModels()
  • CloudShellAPISession.ExtendReservation()
  • CloudShellAPISession.FindResources()
  • @@ -310,6 +318,7 @@
  • CloudShellAPISession.GetResourceApplicationLinks()
  • CloudShellAPISession.GetResourceAvailability()
  • CloudShellAPISession.GetResourceAvailabilityInTimeRange()
  • +
  • CloudShellAPISession.GetResourceCommandExecutions()
  • CloudShellAPISession.GetResourceCommands()
  • CloudShellAPISession.GetResourceConnectedCommands()
  • CloudShellAPISession.GetResourceDetails()
  • @@ -322,6 +331,7 @@
  • CloudShellAPISession.GetResourcesLabelsInTopology()
  • CloudShellAPISession.GetRouteSegments()
  • CloudShellAPISession.GetRoutesSolution()
  • +
  • CloudShellAPISession.GetRunningCommands()
  • CloudShellAPISession.GetSandboxData()
  • CloudShellAPISession.GetSavedSandboxes()
  • CloudShellAPISession.GetScheduledReservations()
  • @@ -339,6 +349,7 @@
  • CloudShellAPISession.GetTopologyUrls()
  • CloudShellAPISession.GetUserDetails()
  • CloudShellAPISession.GetValuesForLookupAttribute()
  • +
  • CloudShellAPISession.ImportBlueprint()
  • CloudShellAPISession.IncludeResource()
  • CloudShellAPISession.IncludeResources()
  • CloudShellAPISession.LockResource()
  • @@ -617,6 +628,10 @@
  • ErrorParameter.Value
  • +
  • ExportBlueprintResponseInfo +
  • ExportConfigurationInfo @@ -790,6 +805,10 @@
  • GroupsInfo.Groups
  • +
  • ImportBlueprintResponseInfo +
  • InputNameValue
  • Item
  • +
  • RunningCommandInfo +
  • +
  • RunningCommandListInfo +
  • SandboxDataKeyValue
  • SandboxDataKeyValueInfo
    Return type:
    @@ -2891,7 +2971,7 @@

    Submodules
    -CreateReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid='')[source]
    +CreateReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid='', notificationRepeatMinutes=0)[source]

    Defines a new reservation.

    Parameters:
    @@ -2905,6 +2985,7 @@

    SubmodulesReturn type: @@ -2997,7 +3078,7 @@

    Submodules
    -CreateTopologyReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[])[source]
    +CreateTopologyReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notificationRepeatMinutes=0)[source]

    Defines a new reservation.

    Parameters:
    @@ -3034,6 +3115,7 @@

    SubmodulesUpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology.

  • +
  • notificationRepeatMinutes (int) – Repeat the before-end notification every this many minutes until the reservation ends (0 = no repeat, minimum 15). Applies only when notificationMinutesBeforeEnd is set.

  • Return type:
    @@ -3581,6 +3663,20 @@

    Submodules +
    +ExportBlueprint(topologyNames=[])[source]
    +

    Export one or more blueprints as their definition xml - the same xml CloudShell uses inside a package. Only the blueprint itself is returned: no data model, drivers, scripts, inventory resources or category definitions, so the result is safe to store in source control and cannot carry system-wide configuration. Use ImportBlueprint to bring it into another server that already has the referenced families, models, attributes, scripts, drivers and categories.

    +
    +
    Parameters:
    +

    topologyNames (list[str]) – Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

    +
    +
    Return type:
    +

    ExportBlueprintResponseInfo

    +
    +
    +
    +
    ExportFamiliesAndModels()[source]
    @@ -4145,6 +4241,20 @@

    Submodules +
    +GetResourceCommandExecutions(resourceFullName='')[source]
    +

    List the resource driver commands currently queued or running on a specific resource, across all reservations, each with its command execution id (which can be passed to CancelResourceCommand), command name, status and the id of the reservation the command belongs to. Use this to find a command left behind by a previous sandbox that is blocking an exclusive, non-concurrent resource. Requires system administrator permissions.

    +
    +
    Parameters:
    +

    resourceFullName (str) – Specify the resource full name. For example: ResourceName/Port.

    +
    +
    Return type:
    +

    RunningCommandListInfo

    +
    +
    +

    +
    GetResourceCommands(resourceFullPath='')[source]
    @@ -4327,6 +4437,20 @@

    Submodules +
    +GetRunningCommands(reservationId='')[source]
    +

    List the resource driver commands currently queued or running in a reservation, each with its command execution id (which can be passed to CancelResourceCommand), resource full name, command name, status and start time. Requires system administrator permissions.

    +
    +
    Parameters:
    +

    reservationId (str) – Specify the string that represents the reservation’s unique identifier.

    +
    +
    Return type:
    +

    RunningCommandListInfo

    +
    +
    +

    +
    GetSandboxData(reservationId='')[source]
    @@ -4566,6 +4690,20 @@

    Submodules +
    +ImportBlueprint(blueprintXml='')[source]
    +

    Import a blueprint from its definition xml, as produced by ExportBlueprint. Inventory and system-wide configuration are never modified - the call fails if any referenced resource family, resource model, resource attribute, script, driver or category does not already exist on this server. Equivalent to creating or editing a blueprint by hand.

    +
    +
    Parameters:
    +

    blueprintXml (str) – Specify the blueprint definition xml, as returned by ExportBlueprint.

    +
    +
    Return type:
    +

    ImportBlueprintResponseInfo

    +
    +
    +

    +
    IncludeResource(resourceFullPath='')[source]
    @@ -7154,6 +7292,18 @@

    Submodules +
    +class cloudshell.api.cloudshell_api.ExportBlueprintResponseInfo(xml_object, find_prefix)[source]
    +

    Bases: CommonResponseInfo

    +
    +
    +Blueprints
    +

    :type : list[BlueprintXmlInfo]

    +
    + +

    +
    class cloudshell.api.cloudshell_api.ExportConfigurationInfo(xml_object, find_prefix)[source]
    @@ -7832,6 +7982,18 @@

    Submodules +
    +class cloudshell.api.cloudshell_api.ImportBlueprintResponseInfo(xml_object, find_prefix)[source]
    +

    Bases: CommonResponseInfo

    +
    +
    +ImportedBlueprints
    +

    :type : list[str]

    +
    + +

    +
    class cloudshell.api.cloudshell_api.InputNameValue(Name, Value)[source]
    @@ -9574,6 +9736,60 @@

    Submodules +
    +class cloudshell.api.cloudshell_api.RunningCommandInfo(xml_object, find_prefix)[source]
    +

    Bases: CommonResponseInfo

    +
    +
    +CommandName
    +

    :type : str

    +
    + +
    +
    +ExecutionId
    +

    :type : str

    +
    + +
    +
    +ReservationId
    +

    :type : str

    +
    + +
    +
    +ResourceFullName
    +

    :type : str

    +
    + +
    +
    +StartTime
    +

    :type : str

    +
    + +
    +
    +Status
    +

    :type : str

    +
    + +

    + +
    +
    +class cloudshell.api.cloudshell_api.RunningCommandListInfo(xml_object, find_prefix)[source]
    +

    Bases: CommonResponseInfo

    +
    +
    +Commands
    +

    :type : list[RunningCommandInfo]

    +
    + +
    +
    class cloudshell.api.cloudshell_api.SandboxDataKeyValue(Key, Value)[source]
    diff --git a/static/api-docs/latest/Python-API/cloudshell.helpers.html b/static/api-docs/latest/Python-API/cloudshell.helpers.html index f2b54cb6d1..d62fff83fb 100644 --- a/static/api-docs/latest/Python-API/cloudshell.helpers.html +++ b/static/api-docs/latest/Python-API/cloudshell.helpers.html @@ -6,7 +6,7 @@ - cloudshell.helpers package — CloudShell Python API 2026.1.0.189799 documentation + cloudshell.helpers package — CloudShell Python API 2026.2.0.190144 documentation @@ -14,7 +14,7 @@ - + @@ -32,7 +32,7 @@
    - 2026.1 + 2026.2
    diff --git a/static/api-docs/latest/Python-API/cloudshell.html b/static/api-docs/latest/Python-API/cloudshell.html index abe4c82c24..8d58abb8b6 100644 --- a/static/api-docs/latest/Python-API/cloudshell.html +++ b/static/api-docs/latest/Python-API/cloudshell.html @@ -6,7 +6,7 @@ - cloudshell package — CloudShell Python API 2026.1.0.189799 documentation + cloudshell package — CloudShell Python API 2026.2.0.190144 documentation @@ -14,7 +14,7 @@ - + @@ -32,7 +32,7 @@
    - 2026.1 + 2026.2
    @@ -196,6 +196,11 @@

    SubpackagesAuthentication.xmlrpc_token +
  • BlueprintXmlInfo +
  • BulkAppDeploymentyInfo @@ -250,10 +255,12 @@

    SubpackagesCloudShellAPISession.ApproveApprovalRequest()

  • CloudShellAPISession.ArchiveDomain()
  • CloudShellAPISession.AutoLoad()
  • +
  • CloudShellAPISession.CancelResourceCommand()
  • CloudShellAPISession.ChangeReservationOwner()
  • CloudShellAPISession.CheckoutFromPool()
  • CloudShellAPISession.CleanupSandboxConnectivity()
  • CloudShellAPISession.ClearAndResetConsole()
  • +
  • CloudShellAPISession.ClearResourceCommands()
  • CloudShellAPISession.ClearSandboxData()
  • CloudShellAPISession.ConfigureApps()
  • CloudShellAPISession.ConfigureAppsV2()
  • @@ -305,6 +312,7 @@

    SubpackagesCloudShellAPISession.ExecuteResourceConnectedCommand()
  • CloudShellAPISession.ExecuteServiceCommand()
  • CloudShellAPISession.ExecuteTopologyCommand()
  • +
  • CloudShellAPISession.ExportBlueprint()
  • CloudShellAPISession.ExportFamiliesAndModels()
  • CloudShellAPISession.ExtendReservation()
  • CloudShellAPISession.FindResources()
  • @@ -342,6 +350,7 @@

    SubpackagesCloudShellAPISession.GetResourceApplicationLinks()
  • CloudShellAPISession.GetResourceAvailability()
  • CloudShellAPISession.GetResourceAvailabilityInTimeRange()
  • +
  • CloudShellAPISession.GetResourceCommandExecutions()
  • CloudShellAPISession.GetResourceCommands()
  • CloudShellAPISession.GetResourceConnectedCommands()
  • CloudShellAPISession.GetResourceDetails()
  • @@ -354,6 +363,7 @@

    SubpackagesCloudShellAPISession.GetResourcesLabelsInTopology()
  • CloudShellAPISession.GetRouteSegments()
  • CloudShellAPISession.GetRoutesSolution()
  • +
  • CloudShellAPISession.GetRunningCommands()
  • CloudShellAPISession.GetSandboxData()
  • CloudShellAPISession.GetSavedSandboxes()
  • CloudShellAPISession.GetScheduledReservations()
  • @@ -371,6 +381,7 @@

    SubpackagesCloudShellAPISession.GetTopologyUrls()
  • CloudShellAPISession.GetUserDetails()
  • CloudShellAPISession.GetValuesForLookupAttribute()
  • +
  • CloudShellAPISession.ImportBlueprint()
  • CloudShellAPISession.IncludeResource()
  • CloudShellAPISession.IncludeResources()
  • CloudShellAPISession.LockResource()
  • @@ -649,6 +660,10 @@

    SubpackagesErrorParameter.Value +
  • ExportBlueprintResponseInfo +
  • ExportConfigurationInfo @@ -822,6 +837,10 @@

    SubpackagesGroupsInfo.Groups

  • +
  • ImportBlueprintResponseInfo +
  • InputNameValue
  • Item
  • +
  • RunningCommandInfo +
  • +
  • RunningCommandListInfo +
  • SandboxDataKeyValue
  • SandboxDataKeyValueInfo