cloudshell.api package

Submodules

cloudshell.api.cloudshell_api module

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Type = None

:type : str

Value = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Type = None

:type : str

Value = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

CreateDate = None

:type : str

Description = None

:type : str

DomainName = None

:type : str

Name = None

:type : str

Owner = None

:type : str

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

Valid = None

:type : bool

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

AbstractTemplates = None

:type : list[AbstractTemplateShortInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Connectors = None

:type : list[Connector]

MachineName = None

:type : str

Name = None

:type : str

Resources = None

:type : list[ActiveTopologyResourceInfo]

Routes = None

:type : list[RouteInfo]

Topology = None

:type : str

Username = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Address = None

:type : str

Alias = None

:type : str

Connections = None

:type : list[Connection]

FolderFullPath = None

:type : str

FullAddress = None

:type : str

LockInfo = None

:type : ResourceLockInfo

Locked = None

:type : bool

Name = None

:type : str

ResourceAttributes = None

:type : list[ResourceAttribute]

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

RootAddress = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ReservedAppName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

CloudProviderResourceName = None

:type : str

LogicalResourceName = None

:type : str

VisualConnectors = None

:type : list[AppVisualConnector]

VmUuid = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Attributes = None

:type : list[AttributeValueInfo]

Driver = None

:type : str

Model = None

:type : str

Name = None

:type : str

ScriptCommandName = None

:type : str

ScriptInputs = None

:type : list[ScriptInputValue]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

Attributes = None

:type : list[AttributeValueInfo]

Source = None

:type : str

Target = None

:type : str

class cloudshell.api.cloudshell_api.Attribute(Name, RestrictedValue)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.AttributeNameValue(Name, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Value = None

:type : str

class cloudshell.api.cloudshell_api.Attributes(Attribute)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ResultItems = None

:type : list[BulkAppDeploymentyResultItem]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

AppDeploymentyInfo = None

:type : AppDeploymentyInfo

AppInstallationInfo = None

:type : AppInstallationInfo

AppName = None

:type : str

Error = None

:type : str

ErrorCode = None

:type : int

Success = None

:type : bool

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Categories = None

:type : list[TopologyCategoryInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Categories = None

:type : list[str]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Items = None

: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/')[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPISession

ActivateTopology(reservationId='', topologyFullPath='')[source]

Activates a specified topology.

Parameters:
  • reservationId (str) – Specify the string that represents the reservation’s unique identifier.
  • 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.
Return type:

ActiveTopologyInfo
AddAppToReservation(reservationId='', appName='', positionX=100, positionY=100)[source]

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.
  • 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=[])[source]

add attribute restrictions to family/model

Parameters:addAttributeRestrictionRequests (list[AddRestrictionRequest]) – Attribute restrictions to add. For example: {[‘FamilyName’, ‘ModelName’, ‘Alphabetic’;]}.
Return type:str
AddGroupsToDomain(domainName='', groupNames=[], readOnly=False)[source]

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='')[source]

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='')[source]

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)[source]

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
AddPermittedUsersToReservation(reservationId='', usernames=[])[source]

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)[source]

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)[source]

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)[source]

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=[])[source]

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=[])[source]

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.
Return type:

str
AddTopologyToReservation(reservationId='', topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[])[source]

Reserves the specified topology.

Parameters:
  • reservationId (str) – Specify the string that represents the reservation’s unique identifier.
  • 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’;]}.
Return type:

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

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
ArchiveDomain(domainName='')[source]

Archive a domain. All future reservation will be deleted.

Parameters:domainName (str) – Specify the name of the domain.
Return type:str
AutoLoad(resourceFullPath='')[source]

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
CheckoutFromPool(selectionCriteriaJson='')[source]

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='')[source]

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)[source]

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
ConnectRoutesInReservation(reservationId='', endpoints=[], mappingType='')[source]

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
CopyDomainsResources(domainNameSources=[], domainNameDestination='')[source]

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
CreateFolder(folderFullPath='')[source]

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
CreateImmediateReservation(reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0)[source]

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)
Return type:

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

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)
  • 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’;]}.
Return type:

CreateReservationResponseInfo
CreateReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0)[source]

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)
Return type:

CreateReservationResponseInfo
CreateResource(resourceFamily='', resourceModel='', resourceName='', resourceAddress='', folderFullPath='', parentResourceFullPath='', resourceDescription='')[source]

Adds a new resource.

Parameters:
  • resourceFamily (str) – Specify the name of the resource family.
  • 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=[])[source]

Adds new resources.

Parameters:resourceInfoDtos (list[ResourceInfoDto]) – Specify a matrix of resources to add. For example: {[‘Resource Family’,’Resource Model’,’Resource Name’,’Resource Address’,’Folder Full Path’,’Parent Resource Full Path’,’Resource Description’;]}
Return type:str
CreateRouteInReservation(reservationId='', sourceResourceFullPath='', targetResourceFullPath='', overrideActiveRoutes=False, mappingType='', maxHops=0, routeAlias='', isShared=False)[source]

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)[source]

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, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[])[source]

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)
  • 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’;]}.
Return type:

CreateReservationResponseInfo
DecryptPassword(encryptedString='')[source]

Decrypt a password.

Parameters:encryptedString (str) – The encrypted string for decryption.
Return type:AttributeValueInfo
DeleteDomain(domainName='')[source]

Deletes a domain.

Parameters:domainName (str) – Specify the name of the domain.
Return type:str
DeleteFolder(folderFullPath='')[source]

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='')[source]

Deletes the specified group.

Parameters:groupName (str) – Specify the name of the group.
Return type:str
DeleteReservation(reservationId='', unmap=False)[source]

Deletes the specified reservation and optionally, 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
DeleteResource(resourceFullPath='')[source]

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='')[source]

Deletes a specific resource template.

Parameters:resourceTemplateName (str) – Specify the resource template name.
Return type:str
DeleteResources(resourcesFullPath=[])[source]

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
DeleteTopology(topologyFullPath='')[source]

Deletes the specified topology.

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.
Return type:str
DeleteUser(username='')[source]

Deletes the specified user.

Parameters:username (str) – Specify the name of the user.
Return type:str
DeployAppToCloudProvider(reservationId='', appName='', commandInputs=[], printOutput=False)[source]

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 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
DeployAppToCloudProviderBulk(reservationId='', appNames=[], commandInputs=[], printOutput=False)[source]

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 matrix of input names and values required for executing the command [appName, InputName, InputValue].
  • printOutput (bool) – Defines whether to print the command output in the reservation command output window.
Return type:

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

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=[])[source]

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.
Return type:

str
EndReservation(reservationId='', unmap=False)[source]

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)[source]

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.
  • 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)[source]

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)[source]

[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)[source]

[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)[source]

[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='')[source]

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=[])[source]

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)[source]

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.
  • 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)[source]

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)[source]

[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)[source]

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)[source]

[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)[source]

[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()[source]

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

Return type:str
ExtendReservation(reservationId='', minutesToAdd=0)[source]

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)[source]

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.
Return type:

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

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 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='')[source]

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()[source]

Retrieve a list of abstract templates.

Return type:AbstractTemplateShortInfoList
GetActiveTopologyNames()[source]

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

Return type:TopologyListInfo
GetAllUsersDetails()[source]

Retrieves all users and their settings.

Return type:UsersInfo
GetAppsDetailsInReservation(reservationId='', appNames=[])[source]

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='')[source]

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
GetCategoriesOfTopology(topologyPath='')[source]

Retrieves all categories of given topology.

Parameters:topologyPath (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:CategoriesOfTopologyInfo
GetCurrentReservations(reservationOwner='')[source]

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='')[source]

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='')[source]

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
GetFolderContent(fullPath='', showAllDomains=False)[source]

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='')[source]

Retrieves all domains associated with a group.

Parameters:groupName (str) – Specify the name of the group.
Return type:GroupInfo
GetGroupsDetails()[source]

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

Return type:GroupsInfo
GetLockedResources(user='', machine='', folderFullPath='')[source]

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
GetReservationDetails(reservationId='')[source]

Retrieves all details and parameters for a specified reservation, including its resources, routes and route segments, topologies, and reservation conflicts.

Parameters:reservationId (str) – Specify the string that represents the reservation’s unique identifier.
Return type:GetReservationDescriptionResponseInfo
GetReservationInputs(reservationId='')[source]

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='')[source]

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='')[source]

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='')[source]

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
GetReservationsLiveStatus(reservationsId=[])[source]

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)[source]

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)[source]

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='')[source]

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='')[source]

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)[source]

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='')[source]

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='')[source]

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=[])[source]

Retrieves mappings for a list of one or more resources.

Parameters:resources (list[str]) – Specify a list of resources.
Return type:ResourceMappingsInfo
GetRouteSegments(resource='')[source]

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)[source]

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
GetScheduledReservations(fromTime='', untilTime='')[source]

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.
Return type:

GetReservationsInRangeResponseInfo
GetServerDateAndTime()[source]

Retrieves the server’s UTC date and time.

Return type:ServerTimeInfo
GetServiceCommands(serviceName='')[source]

Retrieves driver commands and parameters for a specified service.

Parameters:serviceName (str) – Specify the service name.
Return type:ResourceCommandListInfo
GetServices(categoryName='', serviceName='')[source]

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
GetTopologiesByCategory(categoryName='', categoryValue='')[source]

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

Parameters:
  • categoryName (str) – Specify the category’s name
  • categoryValue (str) – Specify the category’s value/sub category
Return type:

TopologiesByCategoryInfo
GetTopologyCategories()[source]

Retrieves all root categories from ‘Environment’ catalog.

Return type:CategoryListInfo
GetTopologyCommands(reservationId='')[source]

[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='')[source]

Retrieves all resources and attributes associated with the specified topology.

Parameters: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.
Return type:TopologyInfo
GetUserDetails(username='')[source]

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

Parameters:username (str) – Specify the name of the user.
Return type:UserInfo
IncludeResource(resourceFullPath='')[source]

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=[])[source]

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
InstallApp(reservationId='', resourceName='', commandName='', commandInputs=[], printOutput=False)[source]

Executes install command for the specified app driver or script.

Parameters:
  • reservationId (str) – Specify the string that represents the reservation’s unique identifier.
  • resourceName (str) – Specify the name of the resource deployment command created.
  • 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
LockResource(reservationId='', resourceFullPath='')[source]

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=[])[source]

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()[source]

Logs out the current user.

Return type:str
Logon(username='', password='', domainName='Global')[source]

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)[source]

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='')[source]

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
PowerCycleResource(reservationId='', resourceFullPath='', powerPortsFullPath=[], delay=0)[source]

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=[])[source]

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=[])[source]

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='')[source]

Prepare Sandbox Connectivity

Parameters:reservationId (str) – Specify the string that represents the reservation’s unique identifier.
Return type:str
RecheckConflicts(reservationId='')[source]

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
ReleaseFromPool(values=[], poolId='', reservationId='', ownerId='')[source]

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=[])[source]

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='')[source]

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 the full topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
Return type:

str
ReloadTopology(reservationId='', topologyFullPath='')[source]

Removes and adds the specified topology back to the reservation, after re-evaluating it and all its resources.

Parameters:
  • reservationId (str) – Specify the string that represents the reservation’s unique identifier.
  • 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.
Return type:

ReserveTopologyResponseInfo
RemoveAppFromReservation(reservationId='', appName='')[source]

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=[])[source]

remove attribute restrictions from family/model

Parameters:removeAttributeRestrictionRequests (list[RemoveRestrictionRequest]) – Attribute restrictions to remove”.
Return type:str
RemoveConnectorsFromReservation(reservationId='', endpoints=[])[source]

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
RemoveGroupsFromDomain(domainName='', groupNames=[])[source]

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
RemovePermittedUsersFromReservation(reservationId='', usernames=[])[source]

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=[])[source]

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=[])[source]

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
Return type:

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

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=[])[source]

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=[])[source]

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='')[source]

Removes a category from given topology.

Parameters:
  • topologyFullPath (str) – Specify the topology we want to remove the given category from.
  • categoryName (str) – Specify the category’s name which we want to remove.
Return type:

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

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
RenameResource(resourceFullPath='', resourceName='')[source]

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='')[source]

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
SaveReservationAsTopology(reservationId='', folderFullPath='', topologyName='', includeInactiveRoutes=False)[source]

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
SecureLogon(token='', domainName='Global')[source]

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
SetAttributeValue(resourceFullPath='', attributeName='', attributeValue='')[source]

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=[])[source]

Sets new attribute values for the specified resources.

Parameters:resourcesAttributesUpdateRequests (list[ResourceAttributesUpdateRequest]) – Specify a matrix of resources, attribute names, and new attribute values (up to 10000 rows). For example: {[‘ResourceFullName’, ‘AttributeName’,’AttributeValue’;’ResourceFullName2’, ‘AttributeName2’,’AttributeValue2’]}.
Return type:str
SetBaudRate(reservationId='', resourceFullPath='', consolePortsFullPath=[], baudRate=0)[source]

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=[])[source]

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=[])[source]

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=[])[source]

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: {[‘SourceResourceFullPath’, ‘TargetResourceFullPath’, ‘Direction’, ‘Alias’;]}.
Return type:

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

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
SetGroupDomainPermissions(domainName='', groupName='', viewOnly=False)[source]

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='')[source]

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)[source]

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)[source]

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='')[source]

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
SetResourceSharedState(reservationId='', resourcesFullName=[], isShared=False)[source]

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
SetRouteAttributes(reservationId='', sourceResourceFullPath='', targetResourceFullPath='', applyChangesTo='', attributeRequests=[])[source]

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=[])[source]

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
SetServiceAttributesValues(reservationId='', serviceAlias='', attributeRequests=[])[source]

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='')[source]

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='')[source]

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
SetTopologyCategory(topologyFullPath='', categoryName='', categoryValue='')[source]

Set a category to given topology

Parameters:
  • topologyFullPath (str) – Specify the topology we want to set the given category to
  • categoryName (str) – Specify the category’s name which we want to set
  • categoryValue (str) – Specify the category’s value
Return type:

str
SyncResourceFromDevice(resourceFullPath='')[source]

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='')[source]

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='')[source]

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='')[source]

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='')[source]

Unarchive a domain. New reservation can be created.

Parameters:domainName (str) – Specify the name of the domain.
Return type:str
UnlockResource(reservationId='', resourceFullPath='')[source]

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=[])[source]

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
UpdateConnectionWeight(resourceAFullPath='', resourceBFullPath='', weight=0)[source]

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='')[source]

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='')[source]

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='')[source]

Updating driver in cloudshell

Parameters:
  • driverName – str
  • driverFile – str
  • driverFileName – str
Returns:

string
UpdateGroup(groupName='', newName='', description='', groupRole='')[source]

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)[source]

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)[source]

Define physical connections (cable links) between resources.

Parameters:
  • physicalConnectionUpdateRequest (list[PhysicalConnectionUpdateRequest]) – Specify a matrix of physical connections to update. For example: {[‘ResourceA’,’ResourceB’;’ResourceC’,ResourceD’]}
  • 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='')[source]

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
UpdateReservationGlobalInputs(reservationId='', globalInputs=[])[source]

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 topology. For example: {[‘Input Name’, ‘Value’;]}.
Return type:

str
UpdateResourceAddress(resourceFullPath='', resourceAddress='')[source]

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='')[source]

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='')[source]

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=[])[source]

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: {[‘SourceResourceFullName’, ‘TargetFullName’,’Alias’;’SourceResourceFullName2’, ‘TargetFullName2’,’Alias2’]}.
Return type:

EndPointConnectionInfo
UpdateScript(scriptName='', scriptFileName='')[source]

Updating driver in cloudshell

Parameters:
  • driverName – str
  • driverFile – str
  • driverFileName – str
Returns:

string
UpdateTopologyDriver(topologyFullPath='', driverName='')[source]

Update the topology driver.

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.
  • driverName (str) – Specify the name of the driver. Leave empty to remove associated driver.
Return type:

str
UpdateTopologyOwner(topologyName='', ownerName='')[source]

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)[source]

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=[])[source]

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='')[source]

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=[])[source]

Update MaxConcurrentReservations and MaxReservationDuration.

Parameters:userUpdateRequests (list[UserUpdateRequest]) – List of Username, MaxConcurrentReservations and MaxReservationDuration of the users you wish to update. For example: {[‘Username1’,‘1’,‘1’;’Username2’,‘12’,‘10’]}
Return type:str
WriteMessageToReservationOutput(reservationId='', message='')[source]

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
class cloudshell.api.cloudshell_api.CommandExecutionCancelledResultInfo(xml_object, find_prefix)[source]

Bases: cloudshell.api.cloudshell_api.CommandExecutionResultInfo

Message = None

:type : str

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

Bases: cloudshell.api.cloudshell_api.CommandExecutionResultInfo

Output = None

:type : str

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

Bases: cloudshell.api.cloudshell_api.CommandExecutionResultInfo

ErrorDescription = None

:type : str

ErrorName = None

:type : str

ErrorParameters = None

:type : list[ErrorParameter]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Id = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Results = None

:type : list[CommandExecutionResultInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

CommandNames = None

:type : list[str]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DefaultValue = None

:type : str

Description = None

:type : str

EnumValues = None

:type : str

Mandatory = None

:type : bool

Name = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

FullPath = None

:type : str

Weight = None

:type : int

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

Attributes = None

:type : list[AttributeValueInfo]

Direction = None

:type : str

Source = None

:type : str

State = None

:type : str

Target = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ContentArray = None

:type : list[ContentShortInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Permission = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Reservation = None

:type : ReservationShortInfo

class cloudshell.api.cloudshell_api.DefaultDeployment(Name, Deployment, Installation)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.DeployAppInput(AppName, Name, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.Deployment(Attributes)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DeploymentService = None

:type : DeploymentServiceInfo

InstallationService = None

:type : AppInstallationInfo

IsDefault = None

:type : bool

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Attributes = None

:type : list[AttributeValueInfo]

Driver = None

:type : str

Model = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Archived = None

:type : str

Description = None

:type : str

Groups = None

:type : list[Group]

Name = None

:type : str

Resources = None

:type : list[Resource]

Topologies = None

:type : list[Topology]

TopologiesFolder = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Routes = None

:type : list[RouteInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

DisplayName = None

:type : str

Name = None

:type : str

Parameters = None

:type : list[EnvironmentCommandParameter]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Commands = None

:type : list[EnvironmentCommandInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DefaultValue = None

:type : str

Description = None

:type : str

DisplayName = None

:type : str

EnumValues = None

:type : str

Mandatory = None

:type : bool

Name = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Value = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Configuration = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Address = None

:type : str

ConnectedTo = None

:type : str

Description = None

:type : str

Excluded = None

:type : bool

FullAddress = None

:type : str

FullName = None

:type : str

FullPath = None

:type : str

Name = None

:type : str

Permission = None

:type : str

Reservations = None

:type : list[FindResourceReservationInfo]

ReservedStatus = None

:type : str

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

UsageSummary = None

:type : ResourcesUsageSummaryInfo

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Resources = None

:type : list[FindResourceInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

EndTime = None

:type : str

Owner = None

:type : str

ReservationId = None

:type : str

ReservationName = None

:type : str

ResourceFullName = None

:type : str

Shared = None

:type : bool

StartTime = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Reservations = None

:type : list[ReservationShortInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ReservationDescription = None

:type : ReservationDescriptionInfo

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

AdditionalInfoInputs = None

:type : list[ReservedTopologyAdditionalInfoInputsInfo]

GlobalInputs = None

:type : list[ReservedTopologyGlobalInputsInfo]

RequiredInputs = None

:type : list[ReservedTopologyRequiredInputsInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

RemainingTimeInMinutes = None

:type : float

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Reservations = None

:type : list[ReservationShortInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

TimeZones = None

:type : list[TimeZoneDefinition]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

Name = None

:type : str

Role = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

GroupRole = None

:type : str

Name = None

:type : str

TestShellDomains = None

:type : list[TestShellDomainInfo]

Users = None

:type : list[UserInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Groups = None

:type : list[GroupInfo]

class cloudshell.api.cloudshell_api.InputNameValue(Name, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.Installation(Attributes, Script)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Attributes = None

:type : list[AttributeValueInfo]

Driver = None

:type : str

IsDefault = None

:type : bool

Model = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Attributes = None

:type : list[AttributeValueInfo]

Description = None

:type : str

Driver = None

:type : str

Family = None

:type : str

Model = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

DomainId = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Domain = None

:type : LogonDomainInfo

Token = None

:type : LogonTokenInfo

User = None

:type : UserInfo

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Token = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

RouteType = None

:type : str

Source = None

:type : str

Target = None

:type : str

class cloudshell.api.cloudshell_api.NameValuePair(Name, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

End = None

:type : int

Start = None

:type : int

class cloudshell.api.cloudshell_api.PhysicalConnectionUpdateRequest(ResourceAFullName, ResourceBFullName, ConnectionWeight)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.RemoveRestrictionRequest(FamilyName, ModelName, Attributes)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

RootResources = None

:type : list[str]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DeploymentPaths = None

:type : list[DeploymentPathInfo]

Description = None

:type : str

LogicalResource = None

:type : LogicalResourceInfo

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Apps = None

:type : list[ReservationAppResource]

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

Bases: cloudshell.api.cloudshell_api.ReservationShortInfo

ActiveRoutesInfo = None

:type : list[RouteInfo]

Apps = None

:type : list[ReservationAppResource]

Conflicts = None

:type : list[ResourceConflictInfo]

Connectors = None

:type : list[Connector]

RequestedRoutesInfo = None

:type : list[RouteInfo]

ReservationLiveStatus = None

:type : ReservationLiveStatus

Resources = None

:type : list[ReservedResourceInfo]

Services = None

:type : list[ServiceInstance]

TopologiesInstructionsInfo = None

:type : list[TopologyInstructionsInfo]

TopologiesReservedResources = None

:type : list[TopologyReservedResourceInfo]

TopologiesResourcesAttributeInfo = None

:type : list[TopologiesResourcesAttributesInfo]

TopologiesRouteInfo = None

:type : list[TopologyRoutesInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ResourceDiagramLayouts = None

:type : list[ResourceDiagramLayoutInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Created = None

:type : str

Id = None

:type : str

LockedResources = None

:type : list[ResourceShortInfo]

Name = None

:type : str

Owner = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Reservations = None

:type : list[ReservationInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ReservationId = None

:type : str

ReservationLiveStatusDescription = None

:type : str

ReservationLiveStatusName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ReservationLiveStatuses = None

:type : list[ReservationLiveStatus]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ActualEndTime = None

:type : str

Booked = None

:type : bool

CreateDate = None

:type : str

Description = None

:type : str

DomainName = None

:type : str

EndTime = None

:type : str

Id = None

:type : str

ModificationDate = None

:type : str

Name = None

:type : str

Owner = None

:type : str

PermittedUsers = None

:type : list[str]

ProvisioningStatus = None

:type : str

RecurrenceType = None

:type : str

ReservationLiveStatusDescription = None

:type : str

ReservationLiveStatusName = None

:type : str

StartTime = None

:type : str

Status = None

:type : str

Topologies = None

:type : list[str]

TopologiesInfo = None

:type : list[TopologyShortInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Conflicts = None

:type : list[ResourceConflictInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Conflicts = None

:type : list[ResourceConflictInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Availability = None

:type : str

CreatedByUser = None

:type : str

CreatedInDomain = None

:type : str

CreatedInReservation = None

:type : str

FolderFullPath = None

:type : str

FullAddress = None

:type : str

Locked = None

:type : bool

Name = None

:type : str

Released = None

:type : bool

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

Shared = None

:type : bool

VmDetails = None

:type : ResourceInfoVmDetails

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

Bases: cloudshell.api.cloudshell_api.ReservedTopologyInputsInfo

LinkedToGlobal = None

:type : str

PossibleValues = None

:type : list[str]

ResourceName = None

:type : str

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

Bases: cloudshell.api.cloudshell_api.ReservedTopologyInputsInfo

PossibleValues = None

:type : list[str]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ParamName = None

:type : str

Value = None

:type : str

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

Bases: cloudshell.api.cloudshell_api.ReservedTopologyInputsInfo

LinkedToGlobal = None

:type : str

ResourceName = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Path = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Type = None

:type : str

Value = None

:type : str

class cloudshell.api.cloudshell_api.ResourceAttributesUpdateRequest(ResourceFullName, AttributeNamesValues)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

DisplayName = None

:type : str

Name = None

:type : str

Parameters = None

:type : list[CommandParameter]

Tag = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Commands = None

:type : list[ResourceCommandInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ConflictPlannedEndTime = None

:type : str

ConflictStarted = None

:type : str

ConflictType = None

:type : str

ConflictWith = None

:type : str

ConflictWithUser = None

:type : str

ResourceName = None

:type : str

Topology = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ResourceName = None

:type : str

X = None

:type : float

Y = None

:type : float

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Address = None

:type : str

ChildResources = None

:type : list[ResourceInfo]

Connections = None

:type : list[Connection]

CreatedByUser = None

:type : str

CreatedInDomain = None

:type : str

CreatedInReservation = None

:type : str

Description = None

:type : str

Domains = None

:type : list[Domain]

DriverName = None

:type : str

Excluded = None

:type : bool

FolderFullPath = None

:type : str

FullAddress = None

:type : str

LockInfo = None

:type : ResourceLockInfo

Locked = None

:type : bool

Name = None

:type : str

Permission = None

:type : str

ResourceAttributes = None

:type : list[ResourceAttribute]

ResourceFamilyName = None

:type : str

ResourceLiveStatusDescription = None

:type : str

ResourceLiveStatusName = None

:type : str

ResourceModelName = None

:type : str

RootAddress = None

:type : str

UniqeIdentifier = None

:type : str

VmDetails = None

:type : ResourceInfoVmDetails

class cloudshell.api.cloudshell_api.ResourceInfoDto(Family, Model, FullName, Address, FolderFullpath, ParentFullName, Description)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

CloudProviderFullName = None

:type : str

UID = None

:type : str

VmCustomParams = None

:type : list[VmCustomParam]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Resources = None

:type : list[ResourceShortInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

liveStatusDescription = None

:type : str

liveStatusName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Created = None

:type : str

MachineName = None

:type : str

ReservationName = None

:type : str

Username = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Mapping = None

:type : Mapping

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Address = None

:type : str

Excluded = None

:type : bool

FolderFullPath = None

:type : str

FullAddress = None

:type : str

LockInfo = None

:type : ResourceLockInfo

Locked = None

:type : bool

Name = None

:type : str

Permission = None

:type : str

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

RootAddress = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

NumOfNotInReservation = None

:type : int

NumOfReserved = None

:type : int

NumOfShared = None

:type : int

ResourceFullName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

AttributeName = None

:type : str

AttributeValue = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Duplex = None

:type : long

Interface = None

:type : long

Speed = None

:type : long

SpeedSetting = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

Attributes = None

:type : list[RouteAttributeInfo]

IsTap = None

:type : bool

RouteConfiguration = None

:type : RouteConfigurationInfo

RouteType = None

:type : str

Segments = None

:type : list[RouteSegmentInfo]

Shared = None

:type : bool

Source = None

:type : str

Target = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Source = None

:type : str

Target = None

:type : str

class cloudshell.api.cloudshell_api.Script(Name, Inputs)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.ScriptInput(Name, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Value = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

ServerDateTime = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DefaultValue = None

:type : str

IsRequired = None

:type : bool

Name = None

:type : str

PossibleValues = None

:type : str

RestrictedValues = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Attributes = None

:type : list[ServiceAttribute]

CategoryFullPath = None

:type : str

Description = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

Attributes = None

:type : list[AttributeValueInfo]

ServiceName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Services = None

:type : list[ServiceInfo]

class cloudshell.api.cloudshell_api.SetConnectorRequest(SourceResourceFullName, TargetResourceFullName, Direction, Alias)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

Id = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DisplayName = None

:type : str

Id = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Topologies = None

:type : list[str]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

AttributeName = None

:type : str

AttributeValue = None

:type : list[str]

Name = None

:type : str

TopologyName = None

:type : str

Usage = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

Attributes = None

:type : list[AbstractResourceAttribute]

Quantity = None

:type : int

RequiredAttributes = None

:type : list[AbstractResourceRequiredAttribute]

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

Valid = None

:type : bool

WillBeLocked = None

:type : bool

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

Bases: cloudshell.api.cloudshell_api.TopologyInputsInfo

LinkedToGlobal = None

:type : str

ResourceName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DeploymentPaths = None

:type : list[DeploymentPathInfo]

Description = None

:type : str

LogicalResource = None

:type : LogicalResourceInfo

Name = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Value = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Description = None

:type : str

Name = None

:type : str

Parameters = None

:type : list[CommandParameter]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Commands = None

:type : list[TopologyCommandInfo]

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

Bases: cloudshell.api.cloudshell_api.TopologyInputsInfo

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

AbstractResources = None

:type : list[TopologyAbstractResourceInfo]

AdditionalInfoInputs = None

:type : list[TopologyAdditionalInfoInputsInfo]

Alias = None

:type : str

Apps = None

:type : list[TopologyAppResourceInfo]

Connectors = None

:type : list[Connector]

Driver = None

:type : str

GlobalInputs = None

:type : list[TopologyGlobalInputsInfo]

Instructions = None

:type : str

Name = None

:type : str

Owner = None

:type : str

ParentTopology = None

:type : TopologyShortInfo

RequirementsInputs = None

:type : list[TopologyRequirementsInputsInfo]

Resources = None

:type : list[TopologyResourceInfo]

Routes = None

:type : list[RouteInfo]

Services = None

:type : list[ServiceInstance]

State = None

:type : str

Type = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DefaultValue = None

:type : str

Description = None

:type : str

ParamName = None

:type : str

PossibleValues = None

:type : list[str]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Instructions = None

:type : str

TopologyName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Topologies = None

:type : list[str]

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

Bases: cloudshell.api.cloudshell_api.TopologyInputsInfo

InputType = None

:type : str

LinkedToGlobal = None

:type : str

ResourceName = None

:type : str

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

Bases: cloudshell.api.cloudshell_api.ReservedResourceInfo

Alias = None

:type : str

TopologyName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Address = None

:type : str

Alias = None

:type : str

Connections = None

:type : list[Connection]

Excluded = None

:type : bool

FolderFullPath = None

:type : str

FullAddress = None

:type : str

LockInfo = None

:type : ResourceLockInfo

Locked = None

:type : bool

Name = None

:type : str

ResourceAttributes = None

:type : list[ResourceAttribute]

ResourceFamilyName = None

:type : str

ResourceModelName = None

:type : str

RootAddress = None

:type : str

WillBeLocked = None

:type : bool

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Routes = None

:type : list[RouteInfo]

TopologyName = None

:type : str

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Alias = None

:type : str

Name = None

:type : str

State = None

:type : str

Type = None

:type : str

class cloudshell.api.cloudshell_api.UpdateRouteAliasRequest(SourceResourceName, TargetResourceName, Alias)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.UpdateTopologyAdditionalInfoInputsRequest(ResourceName, ParamName, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.UpdateTopologyGlobalInputsRequest(ParamName, Value)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

class cloudshell.api.cloudshell_api.UpdateTopologyRequirementsInputsRequest(ResourceName, ParamName, Value, Type)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

DomainName = None

:type : str

Email = None

:type : str

Groups = None

:type : list[GroupInfo]

IsActive = None

:type : bool

IsAdmin = None

:type : bool

IsDomainAdmin = None

:type : bool

Name = None

:type : str

class cloudshell.api.cloudshell_api.UserUpdateRequest(Username, MaxConcurrentReservations, MaxReservationDuration)[source]

Bases: cloudshell.api.common_cloudshell_api.CommonAPIRequest

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Users = None

:type : list[UserInfo]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

UtilizationReportRows = None

:type : list[UtilizationReportRow]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Children = None

:type : list[UtilizationReportRow]

Family = None

:type : str

Model = None

:type : str

Name = None

:type : str

ParentId = None

:type : str

Utilization = None

:type : float

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Connectors = None

:type : list[Connector]

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

Bases: cloudshell.api.common_cloudshell_api.CommonResponseInfo

Name = None

:type : str

Value = None

:type : str

cloudshell.api.common_cloudshell_api module

exception cloudshell.api.common_cloudshell_api.CloudShellAPIError(code, message, rawxml)[source]

Bases: exceptions.Exception

class cloudshell.api.common_cloudshell_api.CommonAPIRequest(**kwarg)[source]
static toContainer(data)[source]
class cloudshell.api.common_cloudshell_api.CommonAPISession(host, username, password, domain)[source]
generateAPIRequest(kwargs)[source]

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)[source]
static importAPIClass(name)[source]
class cloudshell.api.common_cloudshell_api.CommonResponseInfo(xml_object, find_prefix)[source]
class cloudshell.api.common_cloudshell_api.XMLWrapper[source]
static getAllChildNode(parent_node, child_name, find_prefix='')[source]
static getAllChildNodeByAttr(parent_node, child_name, attr_name, attr_value)[source]
static getChildNode(parent_node, child_name, find_prefix='')[source]
static getChildNodeByAttr(parent_node, child_name, attr_name, attr_value)[source]
static getNodeAttr(node, attribute_name, find_prefix='')[source]
static getNodeName(node)[source]
static getNodePrefix(node, prefix_name)[source]
static getNodeText(node)[source]
static getRootNode(node)[source]
static getStringFromXML(node, pretty_print=False)[source]
static parseXML(xml_str)[source]

Module contents