cloudshell.api package

Submodules

cloudshell.api.cloudshell_api module

class cloudshell.api.cloudshell_api.AbstractResourceAttribute(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Type

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.AbstractResourceRequiredAttribute(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Operator

:type : str

Type

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.AbstractTemplateShortInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

CreateDate

:type : str

Description

:type : str

DomainName

:type : str

Domains

:type : list[str]

Name

:type : str

Owner

:type : str

ResourceFamilyName

:type : str

ResourceModelName

:type : str

Valid

:type : bool

class cloudshell.api.cloudshell_api.AbstractTemplateShortInfoList(xml_object, find_prefix)

Bases: CommonResponseInfo

AbstractTemplates

:type : list[AbstractTemplateShortInfo]

class cloudshell.api.cloudshell_api.ActiveTopologyInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Connectors

:type : list[Connector]

MachineName

:type : str

Name

:type : str

Resources

:type : list[ActiveTopologyResourceInfo]

Routes

:type : list[RouteInfo]

Topology

:type : str

Username

:type : str

class cloudshell.api.cloudshell_api.ActiveTopologyResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Address

:type : str

Alias

:type : str

Connections

:type : list[Connection]

FolderFullPath

:type : str

FullAddress

:type : str

LockInfo

:type : ResourceLockInfo

Locked

:type : bool

Name

:type : str

ResourceAttributes

:type : list[ResourceAttribute]

ResourceFamilyName

:type : str

ResourceModelName

:type : str

RootAddress

:type : str

class cloudshell.api.cloudshell_api.AddAppToReservationResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ReservedAppName

:type : str

class cloudshell.api.cloudshell_api.AddRestrictionRequest(FamilyName, ModelName, Alphabetic, Attributes)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AdditionalDataParam(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.ApiEditAppRequest(Name, NewName, Description, AppDetails, DefaultDeployment)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AppConfiguration(AppName, ConfigParams)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AppConfigurationConnection(xml_object, find_prefix)

Bases: CommonResponseInfo

URL

:type : str

class cloudshell.api.cloudshell_api.AppConfigurationData(AppName, ConfigurationManagementDatas)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AppConfigurationManagement(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

AnsibleInventoryGroups

:type : str

AppConfigurationConnection

:type : AppConfigurationConnection

ConnectionMethod

:type : str

ScriptParameters

:type : list[ParameterData]

Tool

:type : str

class cloudshell.api.cloudshell_api.AppDeploymentyInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

CloudProviderResourceName

:type : str

LogicalResourceName

:type : str

VisualConnectors

:type : list[AppVisualConnector]

VmUuid

:type : str

class cloudshell.api.cloudshell_api.AppDetails(ModelName, Attributes, Driver)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AppInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AppName

:type : str

class cloudshell.api.cloudshell_api.AppVisualConnector(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

Attributes

:type : list[AttributeValueInfo]

Source

:type : str

Target

:type : str

class cloudshell.api.cloudshell_api.Attribute(Name, RestrictedValue)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AttributeNameValue(Name, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.AttributeValueInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.Authentication(logon_manager)

Bases: object

logon()

property xmlrpc_token

class cloudshell.api.cloudshell_api.BulkAppDeploymentyInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ResultItems

:type : list[BulkAppDeploymentyResultItem]

class cloudshell.api.cloudshell_api.BulkAppDeploymentyResultItem(xml_object, find_prefix)

Bases: CommonResponseInfo

AppDeploymentyInfo

:type : AppDeploymentyInfo

AppName

:type : str

Error

:type : str

ErrorCode

:type : int

Success

:type : bool

class cloudshell.api.cloudshell_api.CategoriesOfTopologyInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Categories

:type : list[TopologyCategoryInfo]

class cloudshell.api.cloudshell_api.CategoryInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

Name

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.CategoryListBriefInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Categories

:type : list[CategoryInfo]

class cloudshell.api.cloudshell_api.CategoryListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Categories

:type : list[str]

class cloudshell.api.cloudshell_api.CheckoutFromPoolInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Items

:type : list[str]

class cloudshell.api.cloudshell_api.CloudShellAPISession(host, username='', password='', domain='', timezone='UTC', datetimeformat='MM/dd/yyyy HH:mm', token_id='', port=8029, uri='/ResourceManagerApiService/', cloudshell_api_scheme='http', quali_api_scheme='http', quali_api_port=9000, quali_api_uri='/Api/', use_webapi_endpoint=False, max_attempts=3)

Bases: CommonAPISession

ActivateTopology(reservationId='', topologyFullPath='')

Resolves all connectivity requests in the sandbox, and marks unshared resources as “in use”.

Parameters:

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

• topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

ActiveTopologyInfo

AddAppToReservation(reservationId='', appName='', deploymentPath='', positionX=100, positionY=100)

Add an App resource to an existing reservation.

Parameters:

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

• appName (str) – Specify the App template’s name.

• deploymentPath (str) – Specify the way the app will be deploy from a given list of options.

• positionX (float) – Specify the x coordinate of the App’s top left corner.

• positionY (float) – Specify the y coordinate of the App’s top left corner.

Return type:

str

AddAttributeRestrictedValues(addAttributeRestrictionRequests=[])

add attribute restrictions to family/model

Parameters:

addAttributeRestrictionRequests (list[AddRestrictionRequest]) – Attribute restrictions to add. For example: [AddRestrictionRequest(‘family_name’, ‘model_name’, sort_values_alphabetically, [Attribute(‘attribute_name’,’possible_value’)]

Return type:

str

AddGroupsToDomain(domainName='', groupNames=[], readOnly=False)

Add groups to a domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• groupNames (list[str]) – Specify an array of one or more groups.

• readOnly (bool) – Specify if the array of group should be added with view only permissions.

Return type:

str

AddNewDomain(domainName='', description='')

Adds a new domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• description (str) – Specify the description of the domain.

Return type:

str

AddNewGroup(groupName='', description='', groupRole='')

Adds a new users group

Parameters:

• groupName (str) – Specify the name of the group.

• description (str) – Provide a short description of the group.

• groupRole (str) – Specify the role of the group, possible values: External, Regular, DomainAdmin.

Return type:

GroupInfo

AddNewUser(username='', password='', email='', isActive=False, isAdmin=False)

Configures user login details and permissions. Use AddUsersToGroup to specify the user’s domain access.

Parameters:

• username (str) – Specify the name of the user.

• password (str) – Specify the user’s login password.

• email (str) – Specify the user’s email address.

• isActive (bool) – Grant or deny active access to the application.

• isAdmin (bool) – Add the user to the System Administrators group.

Return type:

UserInfo

AddPermittedEditorsToTopology(topologyName='', editorNames=[])

Add permitted editors to a topology.

Parameters:

• topologyName (str) – Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• editorNames (list[str]) – A list of user names to be added as permitted editors to a topology.

Return type:

str

AddPermittedUsersToReservation(reservationId='', usernames=[])

Add one or more permitted users to the specified reservation.

Parameters:

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

• usernames (list[str]) – List of users to permit access to the reservation.

Return type:

str

AddResourcesToDomain(domainName='', resourcesNames=[], includeDecendants=True)

Add resources to a domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• resourcesNames (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• includeDecendants (bool) – Specify whether to include child resources.

Return type:

str

AddResourcesToReservation(reservationId='', resourcesFullPath=[], shared=False)

Reserves resources to be locked.

Parameters:

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

• resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• shared (bool) – Specify whether all resources will be shared among other enviroments

Return type:

ReserveResourcesResponseInfo

AddRoutesToReservation(reservationId='', sourceResourcesFullPath=[], targetResourcesFullPath=[], mappingType='', maxHops=0, routeAlias='', isShared=False)

Adds (but does not connect) routes between all pairs of source and target endpoints, adding additional connectivity ports when required. Use ConnectRoutesInReservation to connect the routes.

Parameters:

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

• sourceResourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• targetResourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

• maxHops (int) – Specify the maximum number or allowed hops.

• routeAlias (str) – Specify the route’s alias.

• isShared (bool) – Specify whether these routes are shared. Shared routes can be used in more than one reservation.

Return type:

RouteInfo

AddServiceToReservation(reservationId='', serviceName='', alias='', attributes=[])

Add service resource to existing reservation.

Parameters:

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

• serviceName (str) – Specify the service name.

• alias (str) – Specify the service alias.

• attributes (list[AttributeNameValue]) – Specify a matrix of attributes and associated attribute values.

Return type:

str

AddTopologiesToDomain(domainName='', topologyNames=[], validateResourceAvailability=True)

Adds a list of one or more topologies to a domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• 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.

• validateResourceAvailability (bool) – Validates the existence of the resource resolution in the target domain. Default value: ‘True’. Note: when value ‘False’ is supplied, there is no process of associating resources and routes with the target domain.

Return type:

str

AddUsersToGroup(usernames=[], groupName='')

Adds a list of one or more users to the specified group.

Parameters:

• usernames (list[str]) – Specify an array of one or more users.

• groupName (str) – Specify the name of the group.

Return type:

str

AddValueToLookupAttribute(attributeName='', newValue='', makeDefault=False)

Adds a value to an existing lookup attribute.

Parameters:

• attributeName (str) – Specify the attribute’s name.

• newValue (str) – Specify the value to add to the attribute.

• makeDefault (bool) – Set the new value as the attribute’s default value.

Return type:

str

ApproveApprovalRequest(id=0, message='')

Approve an approval request.

Parameters:

• id (int) – Unique id of the request.

• message (str) – message (optional).

Return type:

str

ArchiveDomain(domainName='')

Archive a domain. All future reservation will be deleted.

Parameters:

domainName (str) – Specify the name of the domain.

Return type:

str

AutoLoad(resourceFullPath='')

Overrides the data of a specified L1 switch with current device settings and mappings.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

ChangeReservationOwner(reservationId='', ownerName='')

Updates the owner in a specified reservation.

Parameters:

• reservationId (str) – Specify the reservation ID.

• ownerName (str) – New owner for the reservation.

Return type:

str

CheckoutFromPool(selectionCriteriaJson='')

Request to checkout an item from a pool.

Parameters:

selectionCriteriaJson (str) – Json string that represents a selection request for an item or multiple items from a pool.

Return type:

str

CleanupSandboxConnectivity(reservationId='')

Cleanup Sandbox Connectivity

Parameters:

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

Return type:

str

ClearAndResetConsole(reservationId='', resourceFullPath='', consolePortsFullPath=[], baudRate=0)

Clears and resets specified resource console ports.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• consolePortsFullPath (list[str]) – Specify a list of console ports according to their location in the Resource Explorer. Include the full path from the root to each console port, separated by slashes. For example: Console/Ports/PortName.

• baudRate (int) – Specify the baud rate to apply to the ports.

Return type:

CommandExecutionCompletedResultInfo

ClearSandboxData(reservationId='')

Clears the SandboxData content. Clears the whole list.

Parameters:

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

Return type:

str

ConfigureApps(reservationId='', appConfigurations=[], printOutput=False)

Run Configuration Management scripts for the apps in the blueprint.

Parameters:

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

• appConfigurations (list[AppConfiguration]) – Configuration details. Note: Running ConfigureApps with parameters that are missing from the App returns a success message.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

ConfigureAppsInfo

ConfigureAppsV2(reservationId='', appConfigurationsData=[], printOutput=False)

Run Configuration Management scripts for the apps in the blueprint.

Parameters:

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

• appConfigurationsData (list[AppConfigurationData]) – Configuration details. Note: Running ConfigureAppsV2 with parameters that are missing from the App returns a success message.

• printOutput (bool) – Defines whether to print the command output in the sandbox command output window.

Return type:

ConfigureAppsInfo

ConnectRoutesInReservation(reservationId='', endpoints=[], mappingType='')

Connects requested routes. It locks the resources and adds route mappings. The routes must already exist in the reservation.

Parameters:

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

• endpoints (list[str]) – The routes’ endpoints to connect.

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

Return type:

EndPointConnectionInfo

ConsumeApprovalRequest(id=0, name='', startTime='', endTime='')

Consume an approval request.

Parameters:

• id (int) – Unique id of the request.

• name (str) – Name for the consumed entity (Sandbox name).

• startTime (str) – Start time of the request (leave empty for immediate use).

• endTime (str) – End time of the request (leave empty for unlimited duration).

Return type:

str

CopyDomainsResources(domainNameSources=[], domainNameDestination='')

Copy resources from a list of source domains to a target domain.

Parameters:

• domainNameSources (list[str]) – Specify the names of the source domains.

• domainNameDestination (str) – Specify the name of the target domain.

Return type:

str

CreateBlueprintApprovalRequest(entityId='', requestNotes='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], startTime='', endTime='', duration='')

Create a new approval request.

Parameters:

• entityId (str) – Unique identifier of the entity (Blueprint id).

• requestNotes (str) – Request description (optional).

• globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: {[‘Input Name’, ‘Value’;]}.

• requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) – Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

• additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’;]}.

• startTime (str) – Start time of the request (leave empty to immediately request approval).

• endTime (str) – End time of the request, after which the request will be invalid (leave empty for unlimited request time).

• duration (str) – Time in minutes to consume the entity. For example, sandbox duration (leave empty for unlimited consumption time).

Return type:

str

CreateDraft(topology='', draftName='')

Create a private draft of a blueprint.

Parameters:

• topology (str) – Specify the topology id, or name or the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• draftName (str) – Optionally specify the name of the draft. Leave empty for an automatically generated name based on original

Return type:

DraftInfo

CreateFolder(folderFullPath='')

Adds a new folder to the specified path.

Parameters:

folderFullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

Return type:

str

CreateImmediatePersistentReservation(reservationName='', owner='', notifyOnStart=False, notifyOnEnd=False, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False)

Defines a reservation to be started immediately.

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• topologyFullPath (str) – Specify the full topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: {[‘Input Name’, ‘Value’;]}.

• requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) – Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

• additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’;]}.

• notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

Return type:

str

CreateImmediateReservation(reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid='')

Defines a reservation to be started immediately.

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• durationInMinutes (int) – Specify the length of the reservation. (in minutes)

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• notificationMinutesBeforeEnd (int) – 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)

• isTerminationProtectionEnabled (bool) – Indicate whether to protect the reservation from being terminated.

• approvalSid (str) – Leave empty. Used for internal purposes.

Return type:

CreateReservationResponseInfo

CreateImmediateTopologyReservation(reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnSetupComplete=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[])

Defines a reservation to be started immediately. The reservation will start regardless of conflicting resources.

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• durationInMinutes (int) – Specify the length of the reservation. (in minutes)

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• notificationMinutesBeforeEnd (int) – 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)

• topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: [UpdateTopologyGlobalInputsRequest(‘param-name’,’value’)]

• requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) –

  Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

  The Value field can be used to input to requirement fields with different operator types.

  If pass value as is, it will be treated as “equals”, for example if pass “5” it will indicate to system that seek requirement that fulfills =5 Other operators (aside from equals) can be fulfilled using this convention: in the value field, write use the format symbol[space]value for example

  for numeric values > 4 < 4 >= 4 <= 4 = 4 != 4

  for textual values = “hi there” != “hi there” startswith hi there endswith hi there contains hi there doesnotcontain hi there

• additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology.

Return type:

CreateReservationResponseInfo

CreatePersistentReservation(reservationName='', owner='', startTime='', notifyOnStart=False, notifyOnEnd=False, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False)

Defines a new reservation.

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• startTime (str) – The start time of the reservation.

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: {[‘Input Name’, ‘Value’;]}.

• requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) – Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

• additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’;]}.

• notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

Return type:

str

CreateReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False, approvalSid='')

Defines a new reservation.

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• startTime (str) – The start time of the reservation.

• endTime (str) – The end time of the reservation.

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• notificationMinutesBeforeEnd (int) – 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)

• isTerminationProtectionEnabled (bool) – Indicate whether to protect the reservation from being terminated.

• approvalSid (str) – Leave empty. Used for internal purposes.

Return type:

CreateReservationResponseInfo

CreateResource(resourceFamily='', resourceModel='', resourceName='', resourceAddress='', folderFullPath='', parentResourceFullPath='', resourceDescription='')

Adds a new resource.

Parameters:

• resourceFamily (str) – Specify the name of the resource family (optional).

• resourceModel (str) – Specify the resource model.

• resourceName (str) – Specify the resource name.

• resourceAddress (str) – Specify the resource address.

• folderFullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

• parentResourceFullPath (str) – Specify the full path from the root to a parent resource, separated by slashes. For example: Traffic Generators/Generic.

• resourceDescription (str) – Provide a short description to help identify the resource.

Return type:

ResourceInfo

CreateResources(resourceInfoDtos=[])

Adds new resources.

Parameters:

resourceInfoDtos (list[ResourceInfoDto]) – List of resources to add.

Return type:

str

CreateRouteInReservation(reservationId='', sourceResourceFullPath='', targetResourceFullPath='', overrideActiveRoutes=False, mappingType='', maxHops=0, routeAlias='', isShared=False)

Creates a route between the specified source and target resources.

Parameters:

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

• sourceResourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• targetResourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• overrideActiveRoutes (bool) – Specify whether the new route can override existing routes.

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

• maxHops (int) – Specify the maximum number or allowed hops.

• routeAlias (str) – Specify the route’s alias.

• isShared (bool) – Specify whether this route is shared. Shared routes can be used in more than one reservation.

Return type:

EndPointConnectionInfo

CreateRoutesInReservation(reservationId='', sourceResourcesFullPath=[], targetResourcesFullPath=[], overrideActiveRoutes=False, mappingType='', maxHops=0, routeAlias='', isShared=False)

Create routes between the listed source and target resources. Routes will be created for each pair of source and target resources.

Parameters:

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

• sourceResourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• targetResourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• overrideActiveRoutes (bool) – Specify whether the new route can override existing routes.

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

• maxHops (int) – Specify the maximum number or allowed hops.

• routeAlias (str) – Specify the route’s alias.

• isShared (bool) – Specify whether these routes are shared. Shared routes can be used in more than one reservation.

Return type:

EndPointConnectionInfo

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

Defines a new reservation.

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• startTime (str) – The start time of the reservation.

• endTime (str) – The end time of the reservation.

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• notificationMinutesBeforeEnd (int) – 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)

• topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology.

• requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) –

  Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

  The Value field can be used to input to requirement fields with different operator types.

  If pass value as is, it will be treated as “equals”, for example if pass “5” it will indicate to system that seek requirement that fulfills =5 Other operators (aside from equals) can be fulfilled using this convention: in the value field, write use the format symbol[space]value for example

  for numeric values > 4 < 4 >= 4 <= 4 = 4 != 4

  for textual values = “hi there” != “hi there” startswith hi there endswith hi there contains hi there doesnotcontain hi there

• additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology.

Return type:

CreateReservationResponseInfo

DecryptPassword(encryptedString='')

Decrypt a password.

Parameters:

encryptedString (str) – The encrypted string for decryption.

Return type:

AttributeValueInfo

DeleteApprovalRequest(id=0)

Delete an approval request.

Parameters:

id (int) – Unique id of the request.

Return type:

str

DeleteDomain(domainName='')

Deletes a domain.

Parameters:

domainName (str) – Specify the name of the domain.

Return type:

str

DeleteDraft(draft='')

Delete a private draft of a blueprint.

Parameters:

draft (str) – Specify the draft id, or name or the full path from the root to the draft, separated by slashes. For example: FolderName/Topologies/DraftName.

Return type:

str

DeleteExecutionServer(id='')

Delete an Execution Server.

Parameters:

id (str) – Unique id of the Execution Server.

Return type:

str

DeleteFolder(folderFullPath='')

Deletes the specified folder.

Parameters:

folderFullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

Return type:

str

DeleteGroup(groupName='')

Deletes the specified group.

Parameters:

groupName (str) – Specify the name of the group.

Return type:

str

DeleteReservation(reservationId='', unmap=False)

Deletes the specified reservation. Important: DeleteReservation does not perform teardown and therefore does not revert and clean up the sandbox environment.

Parameters:

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

• unmap (bool) – Specify whether to keep mappings or release mapped resources when deleting the reservation.

Return type:

str

DeleteResource(resourceFullPath='')

Deletes the specified resource.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

DeleteResourceTemplate(resourceTemplateName='')

Deletes a specific resource template.

Parameters:

resourceTemplateName (str) – Specify the resource template name.

Return type:

str

DeleteResources(resourcesFullPath=[])

Deletes the specified resources.

Parameters:

resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

Return type:

str

DeleteSavedSandbox(savedSandboxId='')

Delete a saved sandbox

Parameters:

savedSandboxId (str) – Specify the saved sandbox id

Return type:

str

DeleteTopology(topologyFullPath='')

Deletes the specified topology.

Parameters:

topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

str

DeleteUser(username='')

Deletes the specified user.

Parameters:

username (str) – Specify the name of the user.

Return type:

str

DeployAppToCloudProvider(reservationId='', appName='', commandInputs=[], printOutput=False)

Executes deploy command for the specified app driver.

Parameters:

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

• appName (str) – Specify the name of the app.

• commandInputs (list[InputNameValue]) – Specify a list of input names and values required for executing the command. Note that to change a deployed App’s name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, “Azure Ubuntu”, [InputNameValue(“Name”, “myvm01”)]).

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

DeployAppToCloudProviderBulk(reservationId='', appNames=[], commandInputs=[], printOutput=False)

Executes deploy command for the specified apps.

Parameters:

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

• appNames (list[str]) – Specify the names of the apps to deploy.

• commandInputs (list[DeployAppInput]) – Specify a list of input names and values required for executing the command [appName, InputName, InputValue]. Note that to change a deployed App’s name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, “Azure Ubuntu”, [DeployAppInput(“Azure Ubuntu”, “Name”, “myvm01”)]).

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

BulkAppDeploymentyInfo

DisconnectRoutesInReservation(reservationId='', endpoints=[])

Disconnects requested routes. It unlocks the resources (if locked), and removes route mappings, but does not remove the route resources from the reservation.

Parameters:

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

• endpoints (list[str]) – The routes endpoints to disconnect.

Return type:

EndPointConnectionInfo

EditAppsInReservation(reservationId='', editAppsRequests=[])

Edit Apps in a reservation

Parameters:

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

• editAppsRequests (list[ApiEditAppRequest]) – Changes to implement in the App. Please note that when modifying attributes, all the attributes in deployed app must be updated.

Return type:

str

EndReservation(reservationId='', unmap=False)

Ends the specified reservation and optionally, unlocks and releases all reservation resources.

Parameters:

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

• unmap (bool) – Specify whether to keep mappings or release mapped resources when deleting the reservation.

Return type:

str

EnqueueCommand(reservationId='', targetName='', targetType='', commandName='', commandInputs=[], printOutput=False)

Enqueues a command to be executed for the specified target.

Parameters:

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

• targetName (str) – Specify the name of the target according to the target type: for resources - specify the resouce’s name, for services - the service’s alias.

• targetType (str) – Specify the target type for command execution, possible values are: Resource, Service, App.

• commandName (str) – Specify the name of the command.

• commandInputs (list[InputNameValue]) – Specify a matrix of input names and values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

EnqueueEnvironmentCommand(reservationId='', commandName='', commandInputs=[], printOutput=False)

Enqueues a command to be executed for the specified reservation.

Parameters:

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

• commandName (str) – Specify the name of the command.

• commandInputs (list[InputNameValue]) – Specify a matrix of input names and values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

EnqueueResourceCommand(reservationId='', resourceFullPath='', commandName='', parameterValues=[], printOutput=False)

[Deprecated] Enqueues a command to be executed for the specified driver.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• commandName (str) – Specify the name of the command.

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

EnqueueServiceCommand(reservationId='', serviceAlias='', commandName='', parameterValues=[], printOutput=False)

[Deprecated] Enqueues a command to be executed for the specified driver.

Parameters:

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

• serviceAlias (str) – Specify the alias of the service. The service alias is its identifier in the environment context. It can be retrieved via the environment details API and is displayed visually on the diagram.

• commandName (str) – Specify the name of the command.

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

EnqueueTopologyCommand(reservationId='', commandName='', parameterValues=[], printOutput=False)

[Deprecated] Enqueues a command to be executed for the specified reservation.

Parameters:

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

• commandName (str) – Specify the name of the command.

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

ExcludeResource(resourceFullPath='')

Excludes a specified resource.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

ExcludeResources(resourcesFullPath=[])

Excludes the specified resources.

Parameters:

resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

Return type:

str

ExecuteCommand(reservationId='', targetName='', targetType='', commandName='', commandInputs=[], printOutput=False)

Executes a command for the specified target.

Parameters:

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

• targetName (str) – Specify the name of the target according to the target type: for resources - specify the resouce’s name, for services - the service’s alias.

• targetType (str) – Specify the target type for command execution, possible values are: Resource, Service, App.

• commandName (str) – Specify the name of the command.

• commandInputs (list[InputNameValue]) – Specify a matrix of input names and values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

CommandExecutionCompletedResultInfo

ExecuteEnvironmentCommand(reservationId='', commandName='', commandInputs=[], printOutput=False)

Executes a command for the specified reservation.

Parameters:

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

• commandName (str) – Specify the name of the command.

• commandInputs (list[InputNameValue]) – Specify a matrix of input names and values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

CommandExecutionCompletedResultInfo

ExecuteResourceCommand(reservationId='', resourceFullPath='', commandName='', parameterValues=[], printOutput=False)

[Deprecated] Executes a command for the specified driver.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• commandName (str) – Specify the name of the command.

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

CommandExecutionCompletedResultInfo

ExecuteResourceConnectedCommand(reservationId='', resourceFullPath='', commandName='', commandTag='', parameterValues=[], connectedPortsFullPath=[], printOutput=False)

Executes a command for the specified driver.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: RouterA/Port1.

• commandName (str) – Specify the name of the command.

• commandTag (str) – Specify the command tag. Connected command tags are used to define categories of functionality (e.g ‘virtualization’).

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• connectedPortsFullPath (list[str]) – Specify the list of connected ports to use in this operation. Include the full path from the root resource to each port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the connected operation on all of the specified resource’s connected ports.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

CommandExecutionCompletedResultInfo

ExecuteServiceCommand(reservationId='', serviceAlias='', commandName='', parameterValues=[], printOutput=False)

[Deprecated] Executes a command for the specified service driver.

Parameters:

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

• serviceAlias (str) – Specify the alias of the service.

• commandName (str) – Specify the name of the command.

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

CommandExecutionCompletedResultInfo

ExecuteTopologyCommand(reservationId='', commandName='', parameterValues=[], printOutput=False)

[Deprecated] Executes a command for the specified reservation.

Parameters:

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

• commandName (str) – Specify the name of the command.

• parameterValues (list[str]) – Specify the list of parameters values required for executing the command.

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

CommandExecutionCompletedResultInfo

ExportFamiliesAndModels()

Exports the resource families, models, attributes and structure configuration.

Return type:

str

ExtendReservation(reservationId='', minutesToAdd=0)

Extends the duration of the specified reservation.

Parameters:

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

• minutesToAdd (int) – Specify the number of minutes to add to the specified reservation.

Return type:

str

FindResources(resourceFamily='', resourceModel='', attributeValues=[], showAllDomains=False, resourceFullName='', exactName=True, includeSubResources=True, resourceAddress='', resourceUniqueIdentifier='', maxResults=500, includeExcludedResources=False)

Retrieves resources that match all the specified search parameters, and all reservations associated with the search results.

Parameters:

• resourceFamily (str) – Specify the name of the resource family.

• resourceModel (str) – Specify the resource model.

• attributeValues (list[AttributeNameValue]) – Specify an array of one or more attributes and attribute values.

• showAllDomains (bool) – Show all domains associated with the logged in user.

• resourceFullName (str) – Specify part of or the full name of the resource.

• exactName (bool) – Specify whether to search the exact given name or not.

• includeSubResources (bool) – Specify whether to retrieve the sub resources once the parent matches the name.

• resourceAddress (str) – Specify the resource address. Can be partial (e.g. ‘192.168.’).

• resourceUniqueIdentifier (str) – Specify the resource unique identifier.

• maxResults (int) – Specify the maximum number of resources to return.

• includeExcludedResources (bool) – Specify whether to retrieve resources that are excluded

Return type:

FindResourceListInfo

FindResourcesInTimeRange(resourceFamily='', resourceModel='', fromTime='', untilTime='', attributeValues=[], showAllDomains=False, resourceFullName='', exactName=True, includeSubResources=True, resourceAddress='', resourceUniqueIdentifier='', maxResults=500)

Retrieves resources that match all the specified search parameters, and all reservations in the specified time range associated with the search results.

Parameters:

• resourceFamily (str) – Specify the name of the resource family.

• resourceModel (str) – Specify the resource model.

• fromTime (str) – Specify from which future time and date to check the resource’s availability.

• untilTime (str) – Specify until which time and date to check the resource’s availability.

• attributeValues (list[AttributeNameValue]) – Specify an array of one or more attributes and attribute values.

• showAllDomains (bool) – Show all domains associated with the logged in user.

• resourceFullName (str) – Specify part of or the full name of the resource.

• exactName (bool) – Specify whether to search the exact given name or not.

• includeSubResources (bool) – Specify whether to retrieve the sub resources once the parent matches the name.

• resourceAddress (str) – Specify the resource address. Can be partial (e.g. ‘192.168.’).

• resourceUniqueIdentifier (str) – Specify the resource unique identifier.

• maxResults (int) – Specify the maximum number of resources to return.

Return type:

FindResourceListInfo

GenerateUtilizationReport(resourceFamilyName='', fromDate='', toDate='', resourceFullName='', resourceModelName='', includeChildResources=False, groupBy='', utilizationReportType='')

Generates a utilization report for the specified resources. To generate a report for all resources, leave the resourceFullName and resourceModel parameters blank.

Parameters:

• resourceFamilyName (str) – Specify the name of the resource family.

• fromDate (str) – Specify the start time and date.

• toDate (str) – Specify the end time and date.

• resourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName.

• resourceModelName (str) – Specify the resource model.

• includeChildResources (bool) – Specify whether to include child resources utilization.

• groupBy (str) – Specify how to group the utilization results: Resource, User, or Machine

• utilizationReportType (str) – Specify the report type: Lock or Mapping.

Return type:

str

GetAbstractTemplateList()

Retrieve a list of abstract templates.

Return type:

AbstractTemplateShortInfoList

GetActiveTopologyNames()

Retrieves all active reserved topologies for the current (logged in) user.

Return type:

TopologyListInfo

GetAllApprovalRequests()

Get all the approval requests.

Return type:

GetAllApprovalRequestsResponseInfo

GetAllUsersDetails()

Retrieves all users and their settings.

Return type:

UsersInfo

GetApprovalRequest(id=0)

Get approval request info.

Parameters:

id (int) – Specify the number that represents the request’s unique identifier.

Return type:

GetApprovalRequestResponseInfo

GetAppsDetailsInReservation(reservationId='', appNames=[])

Retrieves information on the specified apps in the reservation.

Parameters:

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

• appNames (list[str]) – Specify the apps names.

Return type:

ReservationAppsResponseInfo

GetAttributeValue(resourceFullPath='', attributeName='')

Retrieves the value of the specified attribute

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• attributeName (str) – Specify the attribute name.

Return type:

AttributeValueInfo

GetCategories(type='')

Retrieves all the logged in user’s root categories and sub categories for Topologies and Services from the ‘Environment’ catalog.

Parameters:

type (str) – Specify the categoriy type: Services, Environment or empty for both.

Return type:

CategoryListBriefInfo

GetCategoriesOfTopology(topologyPath='')

Retrieves all categories of given topology.

Parameters:

topologyPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

CategoriesOfTopologyInfo

GetCurrentReservations(reservationOwner='')

Retrieves current reservations for the specified owner. If an owner is not provided, this method retrieves all current reservations.

Parameters:

reservationOwner (str) – Specify the user name of the reservation owner.

Return type:

GetActiveReservationsResponseInfo

GetDomainDetails(domainName='')

Retrieves a domain’s details including groups, topologies and resources associated with the specified domain.

Parameters:

domainName (str) – Specify the name of the domain.

Return type:

DomainInfo

GetEnvironmentCommands(reservationId='')

Retrieves driver commands and parameters for a specified reservation.

Parameters:

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

Return type:

EnvironmentCommandListInfo

GetExecutionServers()

Get all the Execution Servers.

Return type:

str

GetFolderContent(fullPath='', showAllDomains=False)

Retrieves content for the specified path.

Parameters:

• fullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

• showAllDomains (bool) – Show all domains associated with the logged in user.

Return type:

ContentListInfo

GetGroupDomains(groupName='')

Retrieves all domains associated with a group.

Parameters:

groupName (str) – Specify the name of the group.

Return type:

GroupInfo

GetGroupsDetails()

Retrieves all groups, including members, roles and associated domains for each group.

Return type:

GroupsInfo

GetLockedResources(user='', machine='', folderFullPath='')

Retrieves locked resources for a specific user, a specific computer, or a specific folder. If none of these are specified, this method retrieves the list of locked resources for all users, on all machines, in all folders.

Parameters:

• user (str) – Specify a user name to retrieve locked resources for that user.

• machine (str) – Specify a machine name to retrieve locked resources for that computer.

• folderFullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

Return type:

ReservationInfo

GetModelUsageReport(modelName='')

Retrieves the model usages information in Resources, Apps, Abstract Resources and Abstract Templates at Blueprints, Blueprints templates and Sandboxes.

Parameters:

modelName (str) – Specify the name of the model to retrieve usages for.

Return type:

GetModelUsageReportResponseInfo

GetReservationAppImage(reservationId='', appName='')

Retrieves the photo of an app.

Parameters:

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

• appName (str) – Specify the name of the app.

Return type:

GetReservationAppImageResponseInfo

GetReservationDetails(reservationId='', disableCache=False)

Retrieves all details and parameters for a specified reservation, including its resources, routes and route segments, topologies, and reservation conflicts.The data cached for 5 seconds.

Parameters:

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

• disableCache (bool) – Specify if the reservation detail is new or cached

Return type:

GetReservationDescriptionResponseInfo

GetReservationInputs(reservationId='')

Retrieves all topology inputs for a specified reservation.

Parameters:

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

Return type:

GetReservationInputsResponseInfo

GetReservationRemainingTime(reservationId='')

Retrieves the number of minutes remaining until the end of a specified reservation. If the reservation is running overtime, the remaining time will be reported as -1 minutes.

Parameters:

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

Return type:

GetReservationRemainingTimeInfo

GetReservationResourcesPositions(reservationId='')

Retrieves the x/y coordinates for all resources in the reservation’s diagram.

Parameters:

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

Return type:

ReservationDiagramLayoutResponseInfo

GetReservationServicesPositions(reservationId='')

Retrieves the x/y coordinates for all services in the reservation’s diagram.

Parameters:

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

Return type:

ReservationDiagramLayoutResponseInfo

GetReservationStatus(reservationId='')

Retrieves status for a specified reservation

Parameters:

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

Return type:

ReservationSlimStatusInfo

GetReservationWorkOrderDetails(reservationId='', disableCache=False)

Retrieves all work order related details for a specified reservation, including abstract/request paths. The data cached for 5 seconds.

Parameters:

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

• disableCache (bool) – Specify if the reservation detail is new or cached

Return type:

str

GetReservationsLiveStatus(reservationsId=[])

Gets the live status of the reservations.

Parameters:

reservationsId (list[str]) – Specifies a string array that represents reservation unique identifiers.

Return type:

ReservationLiveStatusInfo

GetResourceAvailability(resourcesNames=[], showAllDomains=False)

Get resource availability for the resources.

Parameters:

• resourcesNames (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• showAllDomains (bool) – Show all domains associated with the logged in user.

Return type:

FindResourceListInfo

GetResourceAvailabilityInTimeRange(resourcesNames=[], startTime='', endTime='', showAllDomains=False)

Get resource availability for the resources in the specified time range.

Parameters:

• resourcesNames (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• startTime (str) – The start time of the reservation.

• endTime (str) – The end time of the reservation.

• showAllDomains (bool) – Show all domains associated with the logged in user.

Return type:

FindResourceListInfo

GetResourceCommands(resourceFullPath='')

Retrieves driver commands and parameters for a specified resource.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

ResourceCommandListInfo

GetResourceConnectedCommands(resourceFullPath='')

Gets commands which are added to the resource from connected resources such as power or virtualization.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

ResourceCommandListInfo

GetResourceDetails(resourceFullPath='', showAllDomains=False)

Retrieves resource descriptions for the specified resource, and a matrix of all its associated attributes and attribute values.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• showAllDomains (bool) – Show all domains associated with the logged in user.

Return type:

ResourceInfo

GetResourceList(folderFullPath='')

Retrieves resources and resource values for the specified folder path.

Parameters:

folderFullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

Return type:

ResourceListInfo

GetResourceLiveStatus(resourceFullPath='')

Gets the live status of the resource.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA.

Return type:

ResourceLiveStatusInfo

GetResourceMappings(resources=[])

Retrieves mappings for a list of one or more resources.

Parameters:

resources (list[str]) – Specify a list of resources.

Return type:

ResourceMappingsInfo

GetResourcesAttributeValues(resourceFullNames=[])

Retrieves resources associated attributes and attribute values.

Parameters:

resourceFullNames (list[str]) – Specify the resource names array. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

ResourceAttributeInfoList

GetResourcesLabelsInReservation(reservationId='')

Retrieves all resources associated with labels in the specified reservation.

Parameters:

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

Return type:

str

GetResourcesLabelsInTopology(topologyName='')

Retrieves all resources associated with labels in the specified topology.

Parameters:

topologyName (str) – Specify the topology name.

Return type:

str

GetRouteSegments(resource='')

Retrieves all the ports on the route from the selected endpoint to the target endpoint.

Parameters:

resource (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

EndPointConnectionInfo

GetRoutesSolution(reservationId='', sourceResourcesFullPath=[], targetResourcesFullPath=[], mappingType='', maxHops=0, isShared=False)

Calculates possible routes between the supplied endpoints and returns their details, without saving, connecting or modifying the reservation in any way.

Parameters:

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

• sourceResourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: RootResourceName/ResourceName

• targetResourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: RootResourceName/ResourceName

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

• maxHops (int) – Specify the maximum number or allowed hops.

• isShared (bool) – Specify whether these routes are shared. Shared routes can be used in more than one reservation.

Return type:

EndPointConnectionInfo

GetSandboxData(reservationId='')

Get the SandboxData content. Returns the whole list in a key:value format.

Parameters:

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

Return type:

GetSandboxDataInfo

GetSavedSandboxes()

Get all saved sandboxes. CreateDate default timezone is UTC.

Return type:

GetSavedSandboxesResponseInfo

GetScheduledReservations(fromTime='', untilTime='', ownerName='')

Retrieves all reservations scheduled between the specified start and end times.

Parameters:

• fromTime (str) – Specify from which time and date to search.

• untilTime (str) – Specify until which time and date to search.

• ownerName (str) – Specify reservation owner name

Return type:

GetReservationsInRangeResponseInfo

GetServerDateAndTime()

Retrieves the server’s UTC date and time.

Return type:

ServerTimeInfo

GetServiceCommands(serviceName='')

Retrieves driver commands and parameters for a specified service.

Parameters:

serviceName (str) – Specify the service name.

Return type:

ResourceCommandListInfo

GetServiceLiveStatus(reservationId='', serviceAlias='')

Gets the live status of a service

Parameters:

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

• serviceAlias (str) – Specify the string that represents the service’s alias.

Return type:

str

GetServices(categoryName='', serviceName='')

Retrieve a list of services and their attributes.

Parameters:

• categoryName (str) – The name of the category of the services you want to receive.

• serviceName (str) – The name of the service you want to receive.

Return type:

ServicesListInfo

GetStickyNotesInReservation(reservationId='')

Retrieves all sticky notes in the specified reservation.

Parameters:

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

Return type:

GetStickyNotesInReservationResponseInfo

GetStickyNotesInTopology(topologyName='')

Retrieves all sticky notes in the specified topology.

Parameters:

topologyName (str) – Specify the topology name.

Return type:

GetStickyNotesInTopologyResponseInfo

GetSystemInfo()

Get the system information.

Return type:

str

GetTopologiesByCategory(categoryName='', categoryValue='')

Retrives full topology path for each topology that contains given category name (and value if entered).

Parameters:

• categoryName (str) – Specify the category’s name, If category name is not provided will return all topologies in domain.

• categoryValue (str) – Specify the category’s value/sub category

Return type:

TopologiesByCategoryInfo

GetTopologyCategories()

Retrieves all root categories from ‘Environment’ catalog.

Return type:

CategoryListInfo

GetTopologyCommands(reservationId='')

[Deprecated] Retrieves driver commands and parameters for a specified reservation.

Parameters:

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

Return type:

TopologyCommandListInfo

GetTopologyDetails(topologyFullPath='')

Retrieves all resources and attributes associated with the specified topology.

Parameters:

topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

TopologyInfo

GetTopologyUrls(topologyFullPath='')

Retrieves topology urls to the blueprint for every domain that the blueprint belongs to.

Parameters:

topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

TopologyUrlsInfo

GetUserDetails(username='')

Retrieves the specified user’s configuration settings and associated domains.

Parameters:

username (str) – Specify the name of the user.

Return type:

UserInfo

GetValuesForLookupAttribute(attributeName='')

Retrieve the list of existing values for a lookup attribute.

Parameters:

attributeName (str) – Specify the lookup attribute name.

Return type:

LookupValuesInfo

IncludeResource(resourceFullPath='')

Includes a specified resource.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

IncludeResources(resourcesFullPath=[])

Includes the specified resources.

Parameters:

resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

Return type:

str

LockResource(reservationId='', resourceFullPath='')

Locks a specified resource.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

LockResources(reservationId='', resourcesFullPath=[])

Locks multiple resources.

Parameters:

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

• resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

Return type:

str

Logoff()

Logs out the current user.

Return type:

str

Logon(username='', password='', domainName='Global')

Logs in a user. If no user is specified, this method logs in the current user. If no domain is specified, this method logs the user in to the global (default) domain.

Parameters:

• username (str) – Username to logon with.

• password (str) – Specify the user’s login password.

• domainName (str) – Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain.

Return type:

LogonResponseInfo

LogoutTNSession(reservationId='', resourceFullPath='', consolePortsFullPath=[], baudRate=0)

Logs the user out from a console port TN session.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• consolePortsFullPath (list[str]) – Specify a list of console ports according to their location in the Resource Explorer. Include the full path from the root to each console port, separated by slashes. For example: Console/Ports/PortName.

• baudRate (int) – Specify the baud rate to apply to the ports.

Return type:

CommandExecutionCompletedResultInfo

MapPorts(sourcePort='', destinationPort='', mappingType='')

Maps a pair of ports on a physical (L1) switch.

Parameters:

• sourcePort (str) – Specify the source port.

• destinationPort (str) – Specify the destination port.

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

Return type:

str

MoveFolder(originalFolder='', targetFolder='')

Move a folder (and all its content, including sub folders) in the folder hierarchy.

Parameters:

• originalFolder (str) – Path of the folder to be moved.

• targetFolder (str) – The path of the new containing folder. To move a folder to root, value should be empty.

Return type:

str

MoveResource(resourceFullName='', fullTargetPath='', disconnectResource=False)

Allows to change the parent of a certain resource or change it to be a root resource.

Parameters:

• resourceFullName (str) – Specify the full name of the resource to be moved.

• fullTargetPath (str) – The full path of the target parent. Can be either a resource or a folder (to make resource a root)

• disconnectResource (bool) – When set to true all resource and child connections will be removed. If false will block move when a connection exists

Return type:

str

PowerCycleResource(reservationId='', resourceFullPath='', powerPortsFullPath=[], delay=0)

Cycles the power options for resource power ports.

Parameters:

• reservationId (str) – Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• powerPortsFullPath (list[str]) – Specify the list of power ports to use in this operation. Include the full path from the root resource to each power port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the power operation on all of the specified resource’s power ports.

• delay (float) – Specify the number of seconds to delay between each power cycle.

Return type:

CommandExecutionCompletedResultInfo

PowerOffResource(reservationId='', resourceFullPath='', powerPortsFullPath=[])

Powers off specified power ports.

Parameters:

• reservationId (str) – Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• powerPortsFullPath (list[str]) – Specify the list of power ports to use in this operation. Include the full path from the root resource to each power port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the power operation on all of the specified resource’s power ports.

Return type:

CommandExecutionCompletedResultInfo

PowerOnResource(reservationId='', resourceFullPath='', powerPortsFullPath=[])

Powers on resource power ports.

Parameters:

• reservationId (str) – Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• powerPortsFullPath (list[str]) – Specify the list of power ports to use in this operation. Include the full path from the root resource to each power port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the power operation on all of the specified resource’s power ports.

Return type:

CommandExecutionCompletedResultInfo

PrepareSandboxConnectivity(reservationId='')

Prepare Sandbox Connectivity

Parameters:

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

Return type:

str

PromoteDraft(draft='')

Overrwrite the original blueprint with the draft, and delete the draft.

Parameters:

draft (str) – Specify the draft id, or name or the full path from the root to the draft, separated by slashes. For example: FolderName/Topologies/DraftName.

Return type:

str

RecheckConflicts(reservationId='')

Updates the list of available resources for a reservation.

Parameters:

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

Return type:

str

RefreshAppInBlueprints(appTemplateName='', topologyNames=[])

Refresh Apps in the list of blueprints. This applies to blueprints in all domains and can be used by system administrators only.

Parameters:

• appTemplateName (str) – Specify the name of the App template to be used to refresh the App instances.

• topologyNames (list[str]) – Specify an optional list of blueprint names. Include the full path from the root to the blueprint, separated by slashes. For example: FolderName/Topologies/TopologyName. If the list is not specified, Apps in all blueprints will be refreshed.

Return type:

str

RefreshVMDetails(reservationId='', deployedAppNames=[])

Refreshes VM Details on deployed apps.

Parameters:

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

• deployedAppNames (list[str]) – Names of deployed apps whose vm details will be refreshed.

Return type:

str

RejectApprovalRequest(id=0, message='')

Reject an approval request.

Parameters:

• id (int) – Unique id of the request.

• message (str) – message (optional).

Return type:

str

ReleaseFromPool(values=[], poolId='', reservationId='', ownerId='')

Request to release an item from a pool.

Parameters:

• values (list[str]) – Values to release from the pool.

• poolId (str) – The specific pool where to search for the values that you want to release.

• reservationId (str) – Reservation id that is assoicated with the pool values. It can also be an empty string if the values are not associated with a reservation.

• ownerId (str) – The owner of the pool values.

Return type:

str

ReleaseResourcesFromReservation(reservationId='', resourcesFullPath=[])

Releases occupied testing resources that would not otherwise be available until the end of the current reservation.

Parameters:

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

• resourcesFullPath (list[str]) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

ReleaseTopologyResources(reservationId='', topologyFullPath='')

Releases resources used in topology. A reservation will not end until all used resources are released.

Parameters:

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

• topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

str

RemapConnections(reservationId='', resourcesFullPath=[], printOutput=False)

Remap connections between resources.

Parameters:

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

• resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

RemapConnectionResultInfo

RemoveAppFromReservation(reservationId='', appName='')

Remove a deployed App resource from existing reservation.

Parameters:

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

• appName (str) – Specify the name of the App.

Return type:

str

RemoveAttributeRestrictedValues(removeAttributeRestrictionRequests=[])

remove attribute restrictions from family/model

Parameters:

removeAttributeRestrictionRequests (list[RemoveRestrictionRequest]) – Attribute restrictions to remove”.

Return type:

str

RemoveConnectorsFromReservation(reservationId='', endpoints=[])

Removes the mapped connector between given end points.

Parameters:

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

• endpoints (list[str]) – The list of removed endpoints.

Return type:

str

RemoveCustomShellAttribute(modelName='', attributeName='')

Remove a custom attribute from an existing shell

Parameters:

• modelName (str) – Specify the name of the model to remove the attribute from.

• attributeName (str) – Specify the name of the attribute to remove.

Return type:

str

RemoveGroupsFromDomain(domainName='', groupNames=[])

Remove groups from a domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• groupNames (list[str]) – Specify an array of one or more groups.

Return type:

str

RemovePermittedEditorsFromTopology(topologyName='', editorNames=[])

Remove permitted editors from a topology.

Parameters:

• topologyName (str) – Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• editorNames (list[str]) – A list of user names to be removed as permitted editors from a topology.

Return type:

str

RemovePermittedUsersFromReservation(reservationId='', usernames=[])

Remove one or more permitted users from the specified reservation.

Parameters:

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

• usernames (list[str]) – List of permitted users to remove from the reservation.

Return type:

str

RemoveResourcesFromDomain(domainName='', resourcesNames=[])

Remove resources from a domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• resourcesNames (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

Return type:

str

RemoveResourcesFromReservation(reservationId='', resourcesFullPath=[], deleteDeployedApps=True)

Unlocks and removes resources from a reservation.

Parameters:

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

• resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• deleteDeployedApps (bool) – Specify false to block deletion of deployed apps when removing them from reservation - only applies to resources of that are deployed apps, when applied to other resources argument is ignored. Parameter is optional and can be left empty

Return type:

ReserveResourcesResponseInfo

RemoveRoutesFromReservation(reservationId='', endpoints=[], mappingType='')

Disconnects a list of endpoints and removes the mapped route between them. Will only disconnect endpoints using resources reserved to the logged-in user .

Parameters:

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

• endpoints (list[str]) – The list of removed endpoints.

• mappingType (str) – Specify bidirectional or unidirectional as the mapping type.

Return type:

EndPointConnectionInfo

RemoveServicesFromReservation(reservationId='', services=[])

Remove services and apps from existing reservation.

Parameters:

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

• services (list[str]) – List of aliases. This list should contain the aliases for both the services and apps that should be removed.

Return type:

str

RemoveTopologiesFromDomain(domainName='', topologyNames=[])

Removes a list of one or more topologies from a domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• 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:

str

RemoveTopologyCategory(topologyFullPath='', categoryName='')

Removes a category from given topology.

Parameters:

• topologyFullPath (str) – Specify the topology (name or full path), from which to remove the category. For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• categoryName (str) – Specify the category’s name which we want to remove.

Return type:

str

RemoveUsersFromGroup(usernames=[], groupName='')

Removes a list of one or more users from the specified group.

Parameters:

• usernames (list[str]) – Specify an array of one or more users.

• groupName (str) – Specify the name of the group.

Return type:

str

RemoveValueFromLookupAttribute(attributeName='', removeValue='', defaultValue='')

Removes an existing value from a given lookup attribute.

Parameters:

• attributeName (str) – Specify the lookup attribute name.

• removeValue (str) – Specify the attribute value to remove from the attribute.

• defaultValue (str) – Specify the new default value for this attribute (required if removing the attribute’s current default value).

Return type:

str

RenameBlueprint(topologyFullPath='', newName='')

Rename a blueprint.

Parameters:

• topologyFullPath (str) – Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• newName (str) – Specify the new name of the topology.

Return type:

str

RenameResource(resourceFullPath='', resourceName='')

Renames the specified resource.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• resourceName (str) – Specify a new resource name.

Return type:

str

ResetResourceDriver(reservationId='', resourceFullPath='')

Cancel the currently executing command, remove all pending command executions and reset the driver to its initial state.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

CommandExecutionCompletedResultInfo

ResetSandboxProvisioningStatus(reservationId='')

Reset the status of the sandbox from Active (with error) to Active.

Parameters:

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

Return type:

str

RestoreSavedSandbox(reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, savedSandboxId='', startTime='', endTime='', notifyOnSetupComplete=False, isTerminationProtectionEnabled=False)

Restore a saved sandbox

Parameters:

• reservationName (str) – Specify the name of the reservation.

• owner (str) – Specify the user name of the reservation owner.

• durationInMinutes (int) – Specify the length of the reservation. (in minutes)

• notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.

• notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.

• notificationMinutesBeforeEnd (int) – 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)

• savedSandboxId (str) – Specify the saved sandbox id.

• startTime (str) – The start time of the restored sandbox.

• endTime (str) – The end time of the restored sandbox.

• notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

• isTerminationProtectionEnabled (bool) – Indicate whether to protect the reservation from being terminated.

Return type:

CreateReservationResponseInfo

SaveReservationAsTopology(reservationId='', folderFullPath='', topologyName='', includeInactiveRoutes=False)

Creates a topology from an existing reservation. Leave the folder path blank to save the topology directly under the root.

Parameters:

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

• folderFullPath (str) – Full container folder path where the new topology will be saved. leaving the folder path empty will try saving the topology under the root. For example: FolderName/FolderNameA.

• topologyName (str) – Specify the new name for the new topology.

• includeInactiveRoutes (bool) – Include disconnected routes in the created topology

Return type:

TopologyInfo

SaveSandbox(reservationId='', savedSandboxName='', savedSandboxDescription='', owner='')

Save the sandbox.

Parameters:

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

• savedSandboxName (str) – Specify the name of the saved sandbox

• savedSandboxDescription (str) – provide a short description for the saved sandbox

• owner (str) – Specify the owner of the saved sandbox

Return type:

SaveSandboxResponseInfo

SecureLogon(token='', domainName='Global')

Logs in a user with a token. If no domain is specified, this method logs the user in to the global (default) domain.

Parameters:

• token (str) – Token to logon with.

• domainName (str) – Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain.

Return type:

LogonResponseInfo

SelectWorkOrderResource(reservationId='', abstractFullName='', resourceFullName='')

Selects concrete resource for work order resource in a reservation.

Parameters:

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

• abstractFullName (str) – Specifies work order resource request full name.

• resourceFullName (str) – Specify full name of the resource.

Return type:

str

SetAppSecurityGroups(reservationId='', securityGroups=[], printOutput=False)

Set security groups for apps.

Parameters:

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

• securityGroups (list[SecurityGroup]) – Security Groups

• printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type:

str

SetAttributeValue(resourceFullPath='', attributeName='', attributeValue='')

Sets the value of the specified attribute.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• attributeName (str) – Specify the attribute name.

• attributeValue (str) – Specify the attribute’s value.

Return type:

str

SetAttributesValues(resourcesAttributesUpdateRequests=[])

Sets new attribute values for the specified resources.

Parameters:

resourcesAttributesUpdateRequests (list[ResourceAttributesUpdateRequest]) – Specify a list of resources, attribute names, and new attribute values (up to 10000 rows). For example: [ResourceAttributesUpdateRequest(‘resourceFullName’, [AttributeNameValue(‘attribute_name’, ‘attribute_value’)]]

Return type:

str

SetBaudRate(reservationId='', resourceFullPath='', consolePortsFullPath=[], baudRate=0)

Sets the baud rate for one or more console ports.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• consolePortsFullPath (list[str]) – Specify a list of console ports according to their location in the Resource Explorer. Include the full path from the root to each console port, separated by slashes. For example: Console/Ports/PortName.

• baudRate (int) – Specify the baud rate to apply to the ports.

Return type:

CommandExecutionCompletedResultInfo

SetConnectorAttributes(reservationId='', sourceResourceFullName='', targetResourceFullName='', attributeRequests=[])

Sets attributes and associated values for a specified connector.

Parameters:

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

• sourceResourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• targetResourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• attributeRequests (list[AttributeNameValue]) – Specify a matrix of attributes and associated attribute values.

Return type:

str

SetConnectorAttributesViaAlias(reservationId='', connectorAlias='', attributeRequests=[])

Sets attributes and associated values for a connector specified via its alias.

Parameters:

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

• connectorAlias (str) – Specify the connector’s alias.

• attributeRequests (list[AttributeNameValue]) – Specify a matrix of attributes and associated attribute values.

Return type:

str

SetConnectorsInReservation(reservationId='', connectors=[])

Adds connectors between source and target or update existing ones.

Parameters:

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

• connectors (list[SetConnectorRequest]) – List of connectors to set in the reservation. For example: [SetConnectorRequest(‘SourceResourceFullPath’, ‘TargetResourceFullPath’, ‘Direction’, ‘Alias’)]

Return type:

str

SetConsoleForXModem(reservationId='', resourceFullPath='', consolePortsFullPath=[], baudRate=0)

Sets one or more consoles for Xmodem.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• consolePortsFullPath (list[str]) – Specify a list of console ports according to their location in the Resource Explorer. Include the full path from the root to each console port, separated by slashes. For example: Console/Ports/PortName.

• baudRate (int) – Specify the baud rate to apply to the ports.

Return type:

CommandExecutionCompletedResultInfo

SetCustomShellAttribute(modelName='', attributeName='', defaultValue='', restrictedValues=[])

Add a custom attribute to an existing shell model

Parameters:

• modelName (str) – Specify the name of the model to add the attribute to.

• attributeName (str) – Specify the name of the attribute to add/update.

• defaultValue (str) – Specify the default value to set for the attribute.

• restrictedValues (list[str]) – Specify the restricted values for the attribute.

Return type:

str

SetGroupDomainPermissions(domainName='', groupName='', viewOnly=False)

Set the permission level of a group in domain.

Parameters:

• domainName (str) – Specify the name of the domain.

• groupName (str) – Specify the group name.

• viewOnly (bool) – Specify if the group should be have view only permissions.

Return type:

str

SetReservationLiveStatus(reservationId='', liveStatusName='', additionalInfo='')

Sets the live status of the reservation

Parameters:

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

• liveStatusName (str) – Reservation live status name

• additionalInfo (str) – Reservation live status additional info

Return type:

str

SetReservationResourcePosition(reservationId='', resourceFullName='', x=0, y=0)

Sets the location of a specified resource in the reservation diagram.

Parameters:

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

• resourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName.

• x (float) – Specify the x coordinate of the resource’s top left corner.

• y (float) – Specify the y coordinate of the resource’s top left corner.

Return type:

str

SetReservationServicePosition(reservationId='', serviceAlias='', x=0, y=0)

Sets the location of a specified service in the reservation diagram.

Parameters:

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

• serviceAlias (str) – Specify the alias of the service.

• x (float) – Specify the x coordinate of the resource’s top left corner.

• y (float) – Specify the y coordinate of the resource’s top left corner.

Return type:

str

SetResourceLiveStatus(resourceFullName='', liveStatusName='', additionalInfo='')

Sets the live status of the resource

Parameters:

• resourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA.

• liveStatusName (str) – Resource live status name

• additionalInfo (str) – Resource live status additional info

Return type:

str

SetResourceShareLevel(resourceFullPath='', newShareLevel='')

Sets a resource’s default share level.

Parameters:

• resourceFullPath (str) – Specify the full path of the resource. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• newShareLevel (str) – The new share level of the resource. Options: FamilyDefault, Shared or Unshared.

Return type:

str

SetResourceSharedState(reservationId='', resourcesFullName=[], isShared=False)

Sets the resource sharing state.

Parameters:

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

• resourcesFullName (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

• isShared (bool) – Specify whether to allow sharing of the resource.

Return type:

str

SetResourceVisibility(resourceFullPath='', newVisibility='')

Set the resource visibility State - Admin Only, Everyone or Family Default.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• newVisibility (str) – The new visibility state for the resource. options: AdminOnly, Everyone or FamilyDefault

Return type:

str

SetResourcesFolder(resourcesName=[], targetFolder='')

Allows to change the folder that the specified root resources belong to.

Parameters:

• resourcesName (list[str]) – Specify the name of the root resources to move to the new target folder.

• targetFolder (str) – The path of the target folder.

Return type:

str

SetRouteAttributes(reservationId='', sourceResourceFullPath='', targetResourceFullPath='', applyChangesTo='', attributeRequests=[])

Sets attributes and associated values for a specified route.

Parameters:

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

• sourceResourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• targetResourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• applyChangesTo (str) – Specify on which resources to apply the attribute changes: Source/Target/All.Source refers to the resource connected to the source endpoint of the route. Target refers to the resource connected to the target endpoint of the route. All encompasses all route resources.

• attributeRequests (list[str]) – Specify an array of attributes and associated attribute values.

Return type:

str

SetRouteAttributesViaAlias(reservationId='', routeAlias='', applyChangesTo='', attributeRequests=[])

Sets attributes and associated values for a route specified via its alias.

Parameters:

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

• routeAlias (str) – Specify the route’s alias.

• applyChangesTo (str) – Specify on which resources to apply the attribute changes: Source/Target/All.Source refers to the resource connected to the source endpoint of the route. Target refers to the resource connected to the target endpoint of the route. All encompasses all route resources.

• attributeRequests (list[str]) – Specify an array of attributes and associated attribute values.

Return type:

str

SetSandboxData(reservationId='', sandboxDataKeyValues=[])

Sets the SandboxData. Provide a key:value input. If the key exists it will override the value, if the key doesn’t exist a new key will be created. The value is a string.

Parameters:

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

• sandboxDataKeyValues (list[SandboxDataKeyValue]) – sandboxDataKeyValues

Return type:

str

SetServiceAttributesValues(reservationId='', serviceAlias='', attributeRequests=[])

Sets attributes and associated values for a specified resource.

Parameters:

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

• serviceAlias (str) – Specify the service name.

• attributeRequests (list[AttributeNameValue]) – Specify a matrix of attributes and associated attribute values.

Return type:

str

SetServiceDriver(serviceName='', driverName='')

Sets the driver for a specified service model, if empty, removes its driver.

Parameters:

• serviceName (str) – Specify the name of the service model.

• driverName (str) – Specify the name of the driver.

Return type:

str

SetServiceLiveStatus(reservationId='', serviceAlias='', liveStatusName='', additionalInfo='')

Sets the live status of a service

Parameters:

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

• serviceAlias (str) – Specify the string that represents the service’s alias.

• liveStatusName (str) – Resource live status name

• additionalInfo (str) – Resource live status additional info

Return type:

str

SetServiceName(reservationId='', serviceName='', newServiceName='')

Edit Service alias name

Parameters:

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

• serviceName (str) – Specify the string that represents the service’s name.

• newServiceName (str) – Specify the string that represents the new service’s name.

Return type:

str

SetSetupStage(setupStage='', reservationId='')

Set the specified setup stage for the the sandbox.

Parameters:

• setupStage (str) – Specify the setup stage that will be set to the reservation.

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

Return type:

str

SetTopologyCategory(topologyFullPath='', categoryName='', categoryValue='')

Set a category to given topology

Parameters:

• topologyFullPath (str) – Specify the topology (name or full path), to associate the category to. For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• categoryName (str) – Specify the category’s name which we want to set

• categoryValue (str) – Specify the category’s value

Return type:

str

SetWorkOrderResourceComment(reservationId='', abstractFullName='', comment='')

Sets comment of a work order resource in a reservation.

Parameters:

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

• abstractFullName (str) – Specifies work order resource request full name.

• comment (str) – Specifies work order resource request comment.

Return type:

str

SetWorkOrderResourceState(reservationId='', abstractFullName='', workOrderResourceState='')

Sets state of a work order resource in a reservation.

Parameters:

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

• abstractFullName (str) – Specifies work order resource request full name.

• workOrderResourceState (str) – Specifies work order resource request state.

Return type:

str

SyncResourceFromDevice(resourceFullPath='')

Synchronizes the specified resource with current device settings and mappings.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

SyncResourceToDevice(resourceFullPath='')

Updates device settings and mappings from the specified resource.

Parameters:

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

TerminateReservation(reservationId='')

Terminates the specified reservation if the reservation is in a state of teardown.

Parameters:

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

Return type:

str

UnMapPorts(portA='', portB='')

Removes existing mapping between a pair of physical (L1) switch ports.

Parameters:

• portA (str) – Specify the source port. (i.e. Folder1/Chassis1/Blade1/Port1).

• portB (str) – Specify the destination port. (i.e. Folder1/Chassis1/Blade1/Port1).

Return type:

str

UnarchiveDomain(domainName='')

Unarchive a domain. New reservation can be created.

Parameters:

domainName (str) – Specify the name of the domain.

Return type:

str

UnlockResource(reservationId='', resourceFullPath='')

Unlocks the specified resource.

Parameters:

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

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

Return type:

str

UnlockResources(reservationId='', resourcesFullPath=[])

Unlocks multiple resources.

Parameters:

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

• resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName

Return type:

str

UnselectWorkOrderResource(reservationId='', abstractFullName='')

Unselects work order resource resolved resource in a reservation.

Parameters:

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

• abstractFullName (str) – Specifies work order resource request full name.

Return type:

str

UpdateConnectionWeight(resourceAFullPath='', resourceBFullPath='', weight=0)

Sets a weight score on a physical connection between two resources. Weights are used to optimize route resolution in physical switch scenarios.

Parameters:

• resourceAFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• resourceBFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• weight (int) – Specify a number to represent the connection weight between the specified resources.

Return type:

str

UpdateConnectorAliasInReservation(reservationId='', sourceResourceFullName='', targetResourceFullName='', direction='', alias='')

Sets alias for a specified connector.

Parameters:

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

• sourceResourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• targetResourceFullName (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• direction (str) – Specify bidirectional or unidirectional as the connector direction.

• alias (str) – Specify the connector’s alias.

Return type:

str

UpdateDomainTopologiesFolder(domainName='', topologiesFolder='')

Update the domain’s topologies folder.

Parameters:

• domainName (str) – Specify the name of the domain.

• topologiesFolder (str) – Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

Return type:

str

UpdateDriver(driverName='', driverFileName='')

Updating driver in cloudshell

Parameters:

• driverName – str

• driverFile – str

• driverFileName – str

Returns:

string

UpdateGroup(groupName='', newName='', description='', groupRole='')

Modifies the group name and description.

Parameters:

• groupName (str) – Specify the name of the group.

• newName (str) – Specify the new group name.

• description (str) – Provide a short description of the group.

• groupRole (str) – Specify the role of the group, possible values: External, Regular, DomainAdmin or Ignore (to keep the current role).

Return type:

str

UpdatePhysicalConnection(resourceAFullPath='', resourceBFullPath='', overrideExistingConnections=True)

Define a physical connection (cable link) between two resources.

Parameters:

• resourceAFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• resourceBFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. You may leave this parameter blank if you wish to disconnect the existing source resource connection.

• overrideExistingConnections (bool) – Overriding existing connections will automatically remove existing physical connection if they conflict with the requested new connections. If set to ‘No’, an error message will be displayed if any port is already connected and the operation will be cancelled.

Return type:

str

UpdatePhysicalConnections(physicalConnectionUpdateRequest=[], overrideExistingConnections=True)

Define physical connections (cable links) between resources.

Parameters:

• physicalConnectionUpdateRequest (list[PhysicalConnectionUpdateRequest]) – Specify a list of physical connections to update. For example: [PhysicalConnectionUpdateRequest(‘resource_a_fullname’, ‘resource_b_fullname’, ‘weight’)]

• overrideExistingConnections (bool) – Overriding existing connections will automatically remove existing physical connection if they conflict with the requested new connections. If set to ‘No’, an error message will be displayed if any port is already connected and the operation will be cancelled.

Return type:

str

UpdateReservationDescription(reservationId='', description='')

Modifies the description for a specified reservation.

Parameters:

• reservationId (str) – Specify the reservation ID.

• description (str) – Provide an updated description of the reservation. This text will replace the current description.

Return type:

str

UpdateReservationEndTime(reservationId='', isPersistent=False, endTime='')

Extends the duration of the specified reservation.

Parameters:

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

• isPersistent (bool) – Enable or disable Reservation Persistence.

• endTime (str) – The end time of the reservation.

Return type:

str

UpdateReservationGlobalInputs(reservationId='', globalInputs=[])

Updates the unlinked global inputs in a specified reservation.

Parameters:

• reservationId (str) – Specify the reservation ID.

• globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified reservation. For example: [UpdateTopologyGlobalInputsRequest(‘input1’,’value1’)]

Return type:

str

UpdateReservationName(reservationId='', name='')

Modifies the name for a specified reservation.

Parameters:

• reservationId (str) – Specify the reservation ID.

• name (str) – Provide an updated name of the reservation. This text will replace the current name.

Return type:

str

UpdateResourceAddress(resourceFullPath='', resourceAddress='')

Modifies the address for a specified resource.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• resourceAddress (str) – Specify the resource’s new address.

Return type:

str

UpdateResourceDescription(resourceFullPath='', resourceDescription='')

Modifies the description for a specified resource.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• resourceDescription (str) – Provide an updated description of the resource. This text will replace the current description.

Return type:

str

UpdateResourceDriver(resourceFullPath='', driverName='')

Updates the driver for a specified resource.

Parameters:

• resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.

• driverName (str) – Specify the name of the driver.

Return type:

str

UpdateRouteAliasesInReservation(reservationId='', routeAliases=[])

Update route aliases in a reservation.

Parameters:

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

• routeAliases (list[UpdateRouteAliasRequest]) – Specify a matrix of route source, route target and alias. For example: [UpdateRouteAliasRequest(‘source_fullname’, ‘target_fullname’, ‘alias’)]

Return type:

EndPointConnectionInfo

UpdateScript(scriptName='', scriptFileName='')

Updating driver in cloudshell

Parameters:

• driverName – str

• driverFile – str

• driverFileName – str

Returns:

string

UpdateTopologyDriver(topologyFullPath='', driverName='')

Update the topology driver.

Parameters:

• topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• driverName (str) – Specify the name of the driver. Leave empty to remove associated driver.

Return type:

str

UpdateTopologyOwner(topologyName='', ownerName='')

Update the topology owner.

Parameters:

• topologyName (str) – Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

• ownerName (str) – Specify the topology owner.

Return type:

str

UpdateUser(username='', email='', isActive=False)

Configures a user’s email and activity settings.

Parameters:

• username (str) – The username of the user you want to update.

• email (str) – The new email address to update to.

• isActive (bool) – Grant or deny active access to the application.

Return type:

str

UpdateUserGroups(username='', groupsNames=[])

Update an existing user’s groups (replaces existing user’s groups).

Parameters:

• username (str) – Specify the name of the user.

• groupsNames (list[str]) – Use this method to update a user’s group memberships. Activating this method will replace the user’s memberships with the specified list of groups.

Return type:

str

UpdateUserPassword(username='', password='')

Changes a user’s password.

Parameters:

• username (str) – Specify the name of the user.

• password (str) – Specify the user’s new login password.

Return type:

str

UpdateUsersLimitations(userUpdateRequests=[])

Update MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes and MaxOwnedBlueprints.

Parameters:

userUpdateRequests (list[UserUpdateRequest]) – List of Username, MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes, and MaxOwnedBlueprints of the users you wish to update. For example: [UserUpdateRequest(‘user1’,’max_reservations’,’max_duration’, ‘max_save_sandbox’, ‘max_scheduled_sandboxes’, ‘max_owned_blueprints’)]

Return type:

str

WriteMessageToReservationOutput(reservationId='', message='')

Allows sending output to the command output window in a reservation.

Parameters:

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

• message (str) – Output message to the command output window.

Return type:

str

create_headers(timezone, datetimeformat)

class cloudshell.api.cloudshell_api.CommandExecutionCancelledResultInfo(xml_object, find_prefix)

Bases: CommandExecutionResultInfo

Message

:type : str

class cloudshell.api.cloudshell_api.CommandExecutionCompletedResultInfo(xml_object, find_prefix)

Bases: CommandExecutionResultInfo

Output

:type : str

class cloudshell.api.cloudshell_api.CommandExecutionFailedResultInfo(xml_object, find_prefix)

Bases: CommandExecutionResultInfo

ErrorDescription

:type : str

ErrorName

:type : str

ErrorParameters

:type : list[ErrorParameter]

class cloudshell.api.cloudshell_api.CommandExecutionIdResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Id

:type : str

class cloudshell.api.cloudshell_api.CommandExecutionResultInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

class cloudshell.api.cloudshell_api.CommandExecutionResultListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Results

:type : list[CommandExecutionResultInfo]

class cloudshell.api.cloudshell_api.CommandNamesListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

CommandNames

:type : list[str]

class cloudshell.api.cloudshell_api.CommandParameter(xml_object, find_prefix)

Bases: CommonResponseInfo

DefaultValue

:type : str

Description

:type : str

EnumValues

:type : str

Mandatory

:type : bool

Name

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.ConfigParam(Name, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.ConfigurationManagementData(Alias, ConfigParams)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.ConfigureAppInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AppName

:type : str

Error

:type : str

ErrorCode

:type : int

Success

:type : bool

class cloudshell.api.cloudshell_api.ConfigureAppsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ResultItems

:type : list[ConfigureAppInfo]

class cloudshell.api.cloudshell_api.Connection(xml_object, find_prefix)

Bases: CommonResponseInfo

FullPath

:type : str

Weight

:type : int

class cloudshell.api.cloudshell_api.Connector(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

Attributes

:type : list[AttributeValueInfo]

Direction

:type : str

Source

:type : str

State

:type : str

Target

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.ContentListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ContentArray

:type : list[ContentShortInfo]

class cloudshell.api.cloudshell_api.ContentShortInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Permission

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.CreateApprovalRequestResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Id

:type : int

class cloudshell.api.cloudshell_api.CreateReservationResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Reservation

:type : ReservationShortInfo

class cloudshell.api.cloudshell_api.Credentials(username='', password='', domain='', token_id='')

Bases: object

class cloudshell.api.cloudshell_api.DefaultDeployment(Name, Deployment)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.DeployAppInput(AppName, Name, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.Deployment(Attributes)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.DeploymentPathInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

DeploymentService

:type : DeploymentServiceInfo

IsDefault

:type : bool

Name

:type : str

class cloudshell.api.cloudshell_api.DeploymentServiceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Attributes

:type : list[AttributeValueInfo]

CloudProvider

:type : str

Driver

:type : str

Model

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.Domain(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.DomainInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Archived

:type : str

Description

:type : str

Groups

:type : list[Group]

IsAssembleLab

:type : str

Name

:type : str

Resources

:type : list[Resource]

Topologies

:type : list[Topology]

TopologiesFolder

:type : str

class cloudshell.api.cloudshell_api.DraftInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

DraftId

:type : str

class cloudshell.api.cloudshell_api.EndPointConnectionInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Routes

:type : list[RouteInfo]

class cloudshell.api.cloudshell_api.EntityUsage(xml_object, find_prefix)

Bases: CommonResponseInfo

BlueprintTemplates

:type : list[UsageDetails]

Blueprints

:type : list[UsageDetails]

Name

:type : str

Sandboxes

:type : list[UsageDetails]

Type

:type : str

class cloudshell.api.cloudshell_api.EnvironmentCommandInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

DisplayName

:type : str

Name

:type : str

Parameters

:type : list[EnvironmentCommandParameter]

class cloudshell.api.cloudshell_api.EnvironmentCommandListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Commands

:type : list[EnvironmentCommandInfo]

class cloudshell.api.cloudshell_api.EnvironmentCommandParameter(xml_object, find_prefix)

Bases: CommonResponseInfo

DefaultValue

:type : str

Description

:type : str

DisplayName

:type : str

EnumValues

:type : str

Mandatory

:type : bool

Name

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.ErrorParameter(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.ExportConfigurationInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Configuration

:type : str

class cloudshell.api.cloudshell_api.FindResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Address

:type : str

ConnectedTo

:type : str

Description

:type : str

Excluded

:type : bool

FullAddress

:type : str

FullName

:type : str

FullPath

:type : str

Name

:type : str

Permission

:type : str

Reservations

:type : list[FindResourceReservationInfo]

ReservedStatus

:type : str

ResourceFamilyName

:type : str

ResourceModelName

:type : str

UsageSummary

:type : ResourcesUsageSummaryInfo

class cloudshell.api.cloudshell_api.FindResourceListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Resources

:type : list[FindResourceInfo]

class cloudshell.api.cloudshell_api.FindResourceReservationInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

EndTime

:type : str

Owner

:type : str

ReservationId

:type : str

ReservationName

:type : str

ResourceFullName

:type : str

Shared

:type : bool

StartTime

:type : str

class cloudshell.api.cloudshell_api.GetActiveReservationsResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Reservations

:type : list[ReservationShortInfo]

class cloudshell.api.cloudshell_api.GetAllApprovalRequestsResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ApprovalRequestResponseInfos

:type : list[GetApprovalRequestResponseInfo]

class cloudshell.api.cloudshell_api.GetApprovalRequestResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ApproveNotes

:type : str

CreationDate

:type : str

Duration

:type : int

EndTime

:type : str

EntityName

:type : str

Id

:type : int

Inputs

:type : str

IsApprover

:type : bool

ModifiedDate

:type : str

RequestNotes

:type : str

RequestedEntityId

:type : str

RequestedEntityType

:type : str

RequesterName

:type : str

StartTime

:type : str

State

:type : str

UserInfoId

:type : int

class cloudshell.api.cloudshell_api.GetExecutionServerResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

HostName

:type : str

Id

:type : str

IsIncluded

:type : bool

IsOnline

:type : bool

OperationSystem

:type : str

TotalCapacity

:type : int

class cloudshell.api.cloudshell_api.GetExecutionServersResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ExecutionServers

:type : list[GetExecutionServerResponseInfo]

class cloudshell.api.cloudshell_api.GetModelUsageReportResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ModelUsages

:type : list[EntityUsage]

class cloudshell.api.cloudshell_api.GetReservationAppImageResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AppTemplateImage

:type : str

class cloudshell.api.cloudshell_api.GetReservationDescriptionResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ReservationDescription

:type : ReservationDescriptionInfo

class cloudshell.api.cloudshell_api.GetReservationInputsResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AdditionalInfoInputs

:type : list[ReservedTopologyAdditionalInfoInputsInfo]

GlobalInputs

:type : list[ReservedTopologyGlobalInputsInfo]

RequiredInputs

:type : list[ReservedTopologyRequiredInputsInfo]

class cloudshell.api.cloudshell_api.GetReservationRemainingTimeInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

RemainingTimeInMinutes

:type : float

class cloudshell.api.cloudshell_api.GetReservationWorkOrderDescriptionResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ReservationWorkOrderDescription

:type : ReservationWorkOrderDescriptionInfo

class cloudshell.api.cloudshell_api.GetReservationsInRangeResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Reservations

:type : list[ReservationShortInfo]

class cloudshell.api.cloudshell_api.GetResourceLabelResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

LabelName

:type : str

Name

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.GetResourcesLabelsInReservationResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Resources

:type : list[GetResourceLabelResponseInfo]

class cloudshell.api.cloudshell_api.GetResourcesLabelsInTopologyResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Resources

:type : list[GetResourceLabelResponseInfo]

class cloudshell.api.cloudshell_api.GetSandboxDataInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

SandboxDataKeyValues

:type : list[SandboxDataKeyValueInfo]

class cloudshell.api.cloudshell_api.GetSavedSandboxesResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

SavedSandboxes

:type : list[SavedSandboxInfo]

class cloudshell.api.cloudshell_api.GetServerTimeZonesResponse(xml_object, find_prefix)

Bases: CommonResponseInfo

TimeZones

:type : list[TimeZoneDefinition]

class cloudshell.api.cloudshell_api.GetStickyNoteResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Color

:type : str

Content

:type : str

Id

:type : str

class cloudshell.api.cloudshell_api.GetStickyNotesInReservationResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

StickyNotes

:type : list[GetStickyNoteResponseInfo]

class cloudshell.api.cloudshell_api.GetStickyNotesInTopologyResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

StickyNotes

:type : list[GetStickyNoteResponseInfo]

class cloudshell.api.cloudshell_api.GetSystemInfoResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Version

:type : str

class cloudshell.api.cloudshell_api.Group(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

Name

:type : str

Role

:type : str

class cloudshell.api.cloudshell_api.GroupInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

GroupRole

:type : str

Name

:type : str

TestShellDomains

:type : list[TestShellDomainInfo]

Users

:type : list[UserInfo]

class cloudshell.api.cloudshell_api.GroupsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Groups

:type : list[GroupInfo]

class cloudshell.api.cloudshell_api.InputNameValue(Name, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.LogicalResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Attributes

:type : list[AttributeValueInfo]

Description

:type : str

Driver

:type : str

Family

:type : str

Model

:type : str

class cloudshell.api.cloudshell_api.LogonDomainInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

DomainId

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.LogonManager(credentials, logon, secure_logon)

Bases: object

logon()

class cloudshell.api.cloudshell_api.LogonResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Domain

:type : LogonDomainInfo

Token

:type : LogonTokenInfo

User

:type : UserInfo

class cloudshell.api.cloudshell_api.LogonTokenInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Token

:type : str

class cloudshell.api.cloudshell_api.LookupValuesInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

LookupValues

:type : list[str]

class cloudshell.api.cloudshell_api.Mapping(xml_object, find_prefix)

Bases: CommonResponseInfo

RouteType

:type : str

Source

:type : str

Target

:type : str

class cloudshell.api.cloudshell_api.NameValuePair(Name, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.NumericRange(xml_object, find_prefix)

Bases: CommonResponseInfo

End

:type : int

Start

:type : int

class cloudshell.api.cloudshell_api.ParameterData(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.PhysicalConnectionUpdateRequest(ResourceAFullName, ResourceBFullName, ConnectionWeight)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.QualiApiClient(url, port, host, quali_api_scheme, http, api_response_handler, credentials, attempts=1, headers=[])

Bases: object

enrich_logon(xml_rpc_logon)

enrich_secure_logon(xml_rpc_logon)

send_rest(operation, data, method='POST', is_xml=True, attempts=1)

class cloudshell.api.cloudshell_api.RemapConnectionResultInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ResultItems

:type : list[RemapConnectionResultItem]

class cloudshell.api.cloudshell_api.RemapConnectionResultItem(xml_object, find_prefix)

Bases: CommonResponseInfo

Error

:type : str

ErrorCode

:type : int

Output

:type : str

RemapOperationSummary

:type : str

RemapedVia

:type : str

ResourceName

:type : str

Success

:type : bool

class cloudshell.api.cloudshell_api.RemoveRestrictionRequest(FamilyName, ModelName, Attributes)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.ReplaceWithResourceResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

RootResources

:type : list[str]

class cloudshell.api.cloudshell_api.ReservationAppResource(xml_object, find_prefix)

Bases: CommonResponseInfo

AppConfigurationManagements

:type : list[AppConfigurationManagement]

AppTemplateName

:type : str

DeploymentPaths

:type : list[DeploymentPathInfo]

Description

:type : str

LogicalResource

:type : LogicalResourceInfo

Name

:type : str

class cloudshell.api.cloudshell_api.ReservationAppsResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Apps

:type : list[ReservationAppResource]

class cloudshell.api.cloudshell_api.ReservationDescriptionInfo(xml_object, find_prefix)

Bases: ReservationShortInfo

ActiveRoutesInfo

:type : list[RouteInfo]

Apps

:type : list[ReservationAppResource]

Conflicts

:type : list[ResourceConflictInfo]

Connectors

:type : list[Connector]

RequestedRoutesInfo

:type : list[RouteInfo]

ReservationLiveStatus

:type : ReservationLiveStatus

Resources

:type : list[ReservedResourceInfo]

SavedSandboxId

:type : str

Services

:type : list[ServiceInstance]

SetupStage

:type : str

TopologiesInstructionsInfo

:type : list[TopologyInstructionsInfo]

TopologiesReservedResources

:type : list[TopologyReservedResourceInfo]

TopologiesResourcesAttributeInfo

:type : list[TopologiesResourcesAttributesInfo]

TopologiesRouteInfo

:type : list[TopologyRoutesInfo]

class cloudshell.api.cloudshell_api.ReservationDiagramLayoutResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ResourceDiagramLayouts

:type : list[ResourceDiagramLayoutInfo]

class cloudshell.api.cloudshell_api.ReservationInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Created

:type : str

Id

:type : str

LockedResources

:type : list[ResourceShortInfo]

Name

:type : str

Owner

:type : str

class cloudshell.api.cloudshell_api.ReservationListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Reservations

:type : list[ReservationInfo]

class cloudshell.api.cloudshell_api.ReservationLiveStatus(xml_object, find_prefix)

Bases: CommonResponseInfo

ReservationId

:type : str

ReservationLiveStatusDescription

:type : str

ReservationLiveStatusName

:type : str

class cloudshell.api.cloudshell_api.ReservationLiveStatusInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ReservationLiveStatuses

:type : list[ReservationLiveStatus]

class cloudshell.api.cloudshell_api.ReservationShortInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ActualEndTime

:type : str

Booked

:type : bool

CreateDate

:type : str

Description

:type : str

DomainName

:type : str

EndTime

:type : str

Id

:type : str

ModificationDate

:type : str

Name

:type : str

Owner

:type : str

PermittedUsers

:type : list[str]

ProvisioningStatus

:type : str

RecurrenceType

:type : str

ReservationLiveStatusDescription

:type : str

ReservationLiveStatusName

:type : str

StartTime

:type : str

Status

:type : str

TeardownTime

:type : str

Topologies

:type : list[str]

TopologiesInfo

:type : list[TopologyShortInfo]

class cloudshell.api.cloudshell_api.ReservationSlimStatus(xml_object, find_prefix)

Bases: CommonResponseInfo

Booked

:type : bool

EndTime

:type : str

ProvisioningStatus

:type : str

ReservationId

:type : str

SetupStage

:type : str

StartTime

:type : str

Status

:type : str

class cloudshell.api.cloudshell_api.ReservationSlimStatusInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ReservationSlimStatus

:type : ReservationSlimStatus

class cloudshell.api.cloudshell_api.ReservationWorkOrderDescriptionInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AllRoutesInfo

:type : list[RouteWithWorkOrderInfo]

Connectors

:type : list[Connector]

WorkOrderResources

:type : list[WorkOrderResourceInfo]

class cloudshell.api.cloudshell_api.ReserveResourcesResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Conflicts

:type : list[ResourceConflictInfo]

class cloudshell.api.cloudshell_api.ReserveTopologyResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Conflicts

:type : list[ResourceConflictInfo]

class cloudshell.api.cloudshell_api.ReservedResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AppDetails

:type : AppInfo

AppTemplateName

:type : str

Availability

:type : str

CreatedByUser

:type : str

CreatedInDomain

:type : str

CreatedInReservation

:type : str

FolderFullPath

:type : str

FullAddress

:type : str

Locked

:type : bool

Name

:type : str

Released

:type : bool

ResourceFamilyName

:type : str

ResourceModelName

:type : str

Shared

:type : bool

VmDetails

:type : ResourceInfoVmDetails

class cloudshell.api.cloudshell_api.ReservedTopologyAdditionalInfoInputsInfo(xml_object, find_prefix)

Bases: ReservedTopologyInputsInfo

LinkedToGlobal

:type : str

PossibleValues

:type : list[str]

ResourceName

:type : str

class cloudshell.api.cloudshell_api.ReservedTopologyGlobalInputsInfo(xml_object, find_prefix)

Bases: ReservedTopologyInputsInfo

PossibleValues

:type : list[str]

class cloudshell.api.cloudshell_api.ReservedTopologyInputsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ParamName

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.ReservedTopologyRequiredInputsInfo(xml_object, find_prefix)

Bases: ReservedTopologyInputsInfo

LinkedToGlobal

:type : str

ResourceName

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.Resource(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Path

:type : str

class cloudshell.api.cloudshell_api.ResourceAttribute(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Type

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.ResourceAttributeInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

FullPath

:type : str

ResourceAttribute

:type : list[ResourceAttribute]

class cloudshell.api.cloudshell_api.ResourceAttributeInfoList(xml_object, find_prefix)

Bases: CommonResponseInfo

ResourceAttributeInfo

:type : list[ResourceAttributeInfo]

class cloudshell.api.cloudshell_api.ResourceAttributesUpdateRequest(ResourceFullName, AttributeNamesValues)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.ResourceCommandInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

DisplayName

:type : str

Name

:type : str

Parameters

:type : list[CommandParameter]

Tag

:type : str

class cloudshell.api.cloudshell_api.ResourceCommandListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Commands

:type : list[ResourceCommandInfo]

class cloudshell.api.cloudshell_api.ResourceConflictInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ConflictPlannedEndTime

:type : str

ConflictStarted

:type : str

ConflictType

:type : str

ConflictWith

:type : str

ConflictWithUser

:type : str

ResourceName

:type : str

Topology

:type : str

class cloudshell.api.cloudshell_api.ResourceDiagramLayoutInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ResourceName

:type : str

X

:type : float

Y

:type : float

class cloudshell.api.cloudshell_api.ResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Address

:type : str

ChildResources

:type : list[ResourceInfo]

Connections

:type : list[Connection]

CreateDate

:type : str

CreatedByUser

:type : str

CreatedInDomain

:type : str

CreatedInReservation

:type : str

CreatedInReservationId

:type : str

Description

:type : str

Domains

:type : list[Domain]

DriverName

:type : str

Excluded

:type : bool

FolderFullPath

:type : str

FullAddress

:type : str

LockInfo

:type : ResourceLockInfo

Locked

:type : bool

ModificationDate

:type : str

Name

:type : str

Permission

:type : str

ResourceAttributes

:type : list[ResourceAttribute]

ResourceFamilyName

:type : str

ResourceLiveStatusDescription

:type : str

ResourceLiveStatusName

:type : str

ResourceModelName

:type : str

RootAddress

:type : str

UniqeIdentifier

:type : str

Version

:type : int

VmDetails

:type : ResourceInfoVmDetails

class cloudshell.api.cloudshell_api.ResourceInfoDto(Family, Model, FullName, Address, FolderFullpath, ParentFullName, Description)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.ResourceInfoVmDetails(xml_object, find_prefix)

Bases: CommonResponseInfo

CloudProviderFullName

:type : str

InstanceData

:type : list[VmInstanceParam]

NetworkData

:type : list[VmDetailsNetworkInterface]

UID

:type : str

VmCustomParams

:type : list[VmCustomParam]

class cloudshell.api.cloudshell_api.ResourceListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Resources

:type : list[ResourceShortInfo]

class cloudshell.api.cloudshell_api.ResourceLiveStatusInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

liveStatusDescription

:type : str

liveStatusName

:type : str

class cloudshell.api.cloudshell_api.ResourceLockInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Created

:type : str

MachineName

:type : str

ReservationName

:type : str

Username

:type : str

class cloudshell.api.cloudshell_api.ResourceMappingsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Mapping

:type : Mapping

class cloudshell.api.cloudshell_api.ResourceShortInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Address

:type : str

Excluded

:type : bool

FolderFullPath

:type : str

FullAddress

:type : str

LockInfo

:type : ResourceLockInfo

Locked

:type : bool

Name

:type : str

Permission

:type : str

ResourceFamilyName

:type : str

ResourceModelName

:type : str

RootAddress

:type : str

class cloudshell.api.cloudshell_api.ResourcesUsageSummaryInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

NumOfNotInReservation

:type : int

NumOfReserved

:type : int

NumOfShared

:type : int

ResourceFullName

:type : str

class cloudshell.api.cloudshell_api.RouteAttributeInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AttributeName

:type : str

AttributeValue

:type : str

class cloudshell.api.cloudshell_api.RouteConfigurationInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Duplex

:type : int

Interface

:type : int

Speed

:type : int

SpeedSetting

:type : str

class cloudshell.api.cloudshell_api.RouteInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

Attributes

:type : list[RouteAttributeInfo]

IsTap

:type : bool

RouteConfiguration

:type : RouteConfigurationInfo

RouteType

:type : str

Segments

:type : list[RouteSegmentInfo]

Shared

:type : bool

Source

:type : str

Target

:type : str

class cloudshell.api.cloudshell_api.RouteSegmentInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Source

:type : str

Target

:type : str

class cloudshell.api.cloudshell_api.RouteWithWorkOrderInfo(xml_object, find_prefix)

Bases: RouteInfo

SourceType

:type : str

TargetType

:type : str

WorkOrder

:type : WorkOrderRouteInfo

class cloudshell.api.cloudshell_api.SandboxDataKeyValue(Key, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.SandboxDataKeyValueInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Key

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.SaveSandboxResponseInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

SavedSandboxId

:type : str

class cloudshell.api.cloudshell_api.SavedSandboxInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

CreateDate

:type : str

Description

:type : str

DomainName

:type : str

Id

:type : str

Name

:type : str

OriginatingBlueprintName

:type : str

OriginatingSandboxId

:type : str

OriginatingSandboxName

:type : str

Owner

:type : str

State

:type : str

class cloudshell.api.cloudshell_api.SecurityGroup(Name, SecurityGroupsConfigurations)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.SecurityGroupRule(FromPort, ToPort, Protocol, Source)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.SecurityGroupsConfiguration(SubnetId, Rules)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.ServerTimeInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ServerDateTime

:type : str

class cloudshell.api.cloudshell_api.ServiceAttribute(xml_object, find_prefix)

Bases: CommonResponseInfo

DefaultValue

:type : str

IsRequired

:type : bool

Name

:type : str

PossibleValues

:type : str

RestrictedValues

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.ServiceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Attributes

:type : list[ServiceAttribute]

CategoryFullPath

:type : str

Description

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.ServiceInstance(xml_object, find_prefix)

Bases: CommonResponseInfo

Address

:type : str

Alias

:type : str

Attributes

:type : list[AttributeValueInfo]

ResourceLiveStatusDescription

:type : str

ResourceLiveStatusName

:type : str

ServiceName

:type : str

class cloudshell.api.cloudshell_api.ServiceLiveStatusInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

ResourceLiveStatusDescription

:type : str

ResourceLiveStatusName

:type : str

ServiceName

:type : str

class cloudshell.api.cloudshell_api.ServicesListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Services

:type : list[ServiceInfo]

class cloudshell.api.cloudshell_api.SetConnectorRequest(SourceResourceFullName, TargetResourceFullName, Direction, Alias)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.SetSecurityGroupInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AppName

:type : str

Error

:type : str

Success

:type : bool

class cloudshell.api.cloudshell_api.SetSecurityGroupsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

ResultItems

:type : list[SetSecurityGroupInfo]

class cloudshell.api.cloudshell_api.TestShellDomainInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

Id

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.TimeZoneDefinition(xml_object, find_prefix)

Bases: CommonResponseInfo

DisplayName

:type : str

Id

:type : str

class cloudshell.api.cloudshell_api.TopologiesByCategoryInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Topologies

:type : list[str]

class cloudshell.api.cloudshell_api.TopologiesResourcesAttributesInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

AttributeName

:type : str

AttributeValue

:type : list[str]

Name

:type : str

TopologyName

:type : str

Usage

:type : str

class cloudshell.api.cloudshell_api.Topology(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.TopologyAbstractResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

Attributes

:type : list[AbstractResourceAttribute]

Quantity

:type : int

RequiredAttributes

:type : list[AbstractResourceRequiredAttribute]

ResourceFamilyName

:type : str

ResourceModelName

:type : str

Valid

:type : bool

WillBeLocked

:type : bool

class cloudshell.api.cloudshell_api.TopologyAdditionalInfoInputsInfo(xml_object, find_prefix)

Bases: TopologyInputsInfo

LinkedToGlobal

:type : str

ResourceName

:type : str

class cloudshell.api.cloudshell_api.TopologyAppResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

DeploymentPaths

:type : list[DeploymentPathInfo]

Description

:type : str

LogicalResource

:type : LogicalResourceInfo

Name

:type : str

class cloudshell.api.cloudshell_api.TopologyCategoryInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.TopologyCommandInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Description

:type : str

Name

:type : str

Parameters

:type : list[CommandParameter]

class cloudshell.api.cloudshell_api.TopologyCommandListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Commands

:type : list[TopologyCommandInfo]

class cloudshell.api.cloudshell_api.TopologyGlobalInputsInfo(xml_object, find_prefix)

Bases: TopologyInputsInfo

class cloudshell.api.cloudshell_api.TopologyInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AbstractResources

:type : list[TopologyAbstractResourceInfo]

AdditionalInfoInputs

:type : list[TopologyAdditionalInfoInputsInfo]

Alias

:type : str

Apps

:type : list[TopologyAppResourceInfo]

Connectors

:type : list[Connector]

CreateDate

:type : str

DefaultDurationSeconds

:type : str

Description

:type : str

Driver

:type : str

EstimatedSetupDuration

:type : str

EstimatedTearDownDuration

:type : str

GlobalInputs

:type : list[TopologyGlobalInputsInfo]

Instructions

:type : str

IsPersistentSandbox

:type : bool

IsPublic

:type : bool

MaxDuration

:type : str

ModificationDate

:type : str

Name

:type : str

Owner

:type : str

ParentTopology

:type : TopologyShortInfo

PermittedEditors

:type : list[str]

RequirementsInputs

:type : list[TopologyRequirementsInputsInfo]

RequiresApproval

:type : bool

Resources

:type : list[TopologyResourceInfo]

Routes

:type : list[RouteInfo]

Services

:type : list[ServiceInstance]

State

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.TopologyInputsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

AttributeId

:type : str

AttributeName

:type : str

DefaultValue

:type : str

Description

:type : str

ParamName

:type : str

PossibleValues

:type : list[str]

class cloudshell.api.cloudshell_api.TopologyInstructionsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Instructions

:type : str

TopologyName

:type : str

class cloudshell.api.cloudshell_api.TopologyListInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Topologies

:type : list[str]

class cloudshell.api.cloudshell_api.TopologyRequirementsInputsInfo(xml_object, find_prefix)

Bases: TopologyInputsInfo

InputType

:type : str

LinkedToGlobal

:type : str

ResourceName

:type : str

class cloudshell.api.cloudshell_api.TopologyReservedResourceInfo(xml_object, find_prefix)

Bases: ReservedResourceInfo

Alias

:type : str

TopologyName

:type : str

class cloudshell.api.cloudshell_api.TopologyResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Address

:type : str

Alias

:type : str

Connections

:type : list[Connection]

Excluded

:type : bool

FolderFullPath

:type : str

FullAddress

:type : str

LockInfo

:type : ResourceLockInfo

Locked

:type : bool

Name

:type : str

ResourceAttributes

:type : list[ResourceAttribute]

ResourceFamilyName

:type : str

ResourceModelName

:type : str

RootAddress

:type : str

WillBeLocked

:type : bool

class cloudshell.api.cloudshell_api.TopologyRoutesInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Routes

:type : list[RouteInfo]

TopologyName

:type : str

class cloudshell.api.cloudshell_api.TopologyShortInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

Name

:type : str

State

:type : str

Type

:type : str

class cloudshell.api.cloudshell_api.TopologyUrl(xml_object, find_prefix)

Bases: CommonResponseInfo

DomainName

:type : str

EncodedHtmlUri

:type : str

class cloudshell.api.cloudshell_api.TopologyUrlsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Alias

:type : str

Name

:type : str

TopologyUrls

:type : list[TopologyUrl]

class cloudshell.api.cloudshell_api.UpdateRouteAliasRequest(SourceResourceName, TargetResourceName, Alias)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.UpdateTopologyAdditionalInfoInputsRequest(ResourceName, ParamName, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.UpdateTopologyGlobalInputsRequest(ParamName, Value)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.UpdateTopologyRequirementsInputsRequest(ResourceName, ParamName, Value, Type)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.UsageDetails(xml_object, find_prefix)

Bases: CommonResponseInfo

Id

:type : str

Name

:type : str

class cloudshell.api.cloudshell_api.UserInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

DisplayLanguage

:type : str

DomainName

:type : str

Email

:type : str

Groups

:type : list[GroupInfo]

IsActive

:type : bool

IsAdmin

:type : bool

IsDomainAdmin

:type : bool

MaxConcurrentReservations

:type : int

MaxOwnedBlueprints

:type : int

MaxReservationDuration

:type : int

MaxSavedSandboxes

:type : int

MaxScheduledSandboxes

:type : int

Name

:type : str

Timezone

:type : str

class cloudshell.api.cloudshell_api.UserUpdateRequest(Username, MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes, MaxOwnedBlueprints)

Bases: CommonAPIRequest

class cloudshell.api.cloudshell_api.UsersInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Users

:type : list[UserInfo]

class cloudshell.api.cloudshell_api.UtilizationReport(xml_object, find_prefix)

Bases: CommonResponseInfo

UtilizationReportRows

:type : list[UtilizationReportRow]

class cloudshell.api.cloudshell_api.UtilizationReportRow(xml_object, find_prefix)

Bases: CommonResponseInfo

Children

:type : list[UtilizationReportRow]

Family

:type : str

Model

:type : str

Name

:type : str

ParentId

:type : str

Utilization

:type : float

class cloudshell.api.cloudshell_api.VisualConnectorsInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Connectors

:type : list[Connector]

class cloudshell.api.cloudshell_api.VmCustomParam(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.VmDetailsNetworkInterface(xml_object, find_prefix)

Bases: CommonResponseInfo

AdditionalData

:type : list[AdditionalDataParam]

IsPrimary

:type : bool

NetworkId

:type : str

class cloudshell.api.cloudshell_api.VmInstanceParam(xml_object, find_prefix)

Bases: CommonResponseInfo

Name

:type : str

Value

:type : str

class cloudshell.api.cloudshell_api.WorkOrderResourceInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Comment

:type : str

LastUpdateTime

:type : str

LastUpdateUsername

:type : str

ResolvedResourceFullName

:type : str

ResourceRequestFullName

:type : str

State

:type : str

class cloudshell.api.cloudshell_api.WorkOrderRouteInfo(xml_object, find_prefix)

Bases: CommonResponseInfo

Comment

:type : str

LastUpdateTime

:type : str

LastUpdateUsername

:type : str

cloudshell.api.common_cloudshell_api module

exception cloudshell.api.common_cloudshell_api.CloudShellAPIError(code, message, rawxml)

Bases: Exception

class cloudshell.api.common_cloudshell_api.CommonAPIRequest(**kwarg)

Bases: object

static toContainer(data)

class cloudshell.api.common_cloudshell_api.CommonAPISession(host, username, password, domain, connection_pool_size=25)

Bases: object

generateAPIRequest(kwargs)

Generic method for generation and sending XML requests

Parameters:

• return_type – type of returning data

• kwargs – map of the parameters that need to be send to the server

Returns:

string data or API object

class cloudshell.api.common_cloudshell_api.CommonApiResult(xml_object)

Bases: object

static importAPIClass(name)

class cloudshell.api.common_cloudshell_api.CommonResponseInfo(xml_object, find_prefix)

Bases: object

class cloudshell.api.common_cloudshell_api.XMLWrapper

Bases: object

static getAllChildNode(parent_node, child_name, find_prefix='')

static getAllChildNodeByAttr(parent_node, child_name, attr_name, attr_value)

static getChildNode(parent_node, child_name, find_prefix='')

static getChildNodeByAttr(parent_node, child_name, attr_name, attr_value)

static getNodeAttr(node, attribute_name, find_prefix='')

static getNodeName(node)

static getNodePrefix(node, prefix_name)

static getNodeText(node)

static getRootNode(node)

static getStringFromXML(node, pretty_print=False)

static parseXML(xml_str)

cloudshell.api.common_cloudshell_api.retry(func, exception, attempts=1, delay=1, *args, **kwargs)

Module contents