cloudshell.api package<a class="headerlink" href="#cloudshell-api-package" title="Permalink to this headline">¶

ClearSandboxData(reservationId='')[source]¶

Clears the SandboxData content. Clears the whole list.

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

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

Run Configuration Management scripts for the apps in the blueprint.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
appConfigurations (list[AppConfiguration]) – Configuration details. Note: Running ConfigureApps with parameters that are missing from the App returns a success message.
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

ConfigureAppsInfo

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

Run Configuration Management scripts for the apps in the blueprint.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
appConfigurationsData (list[AppConfigurationData]) – Configuration details. Note: Running ConfigureAppsV2 with parameters that are missing from the App returns a success message.
printOutput (bool) – Defines whether to print the command output in the sandbox command output window.

Return type

ConfigureAppsInfo

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

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

CreateDraft(topology='', draftName='')[source]¶

Create a private draft of a blueprint.

Parameters

topology (str) – Specify the topology id, or name or the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
draftName (str) – Optionally specify the name of the draft. Leave empty for an automatically generated name based on original

Return type

DraftInfo

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

CreateImmediatePersistentReservation(reservationName='', owner='', notifyOnStart=False, notifyOnEnd=False, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False)[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.
notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.
notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.
topologyFullPath (str) – Specify the full topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: {[‘Input Name’, ‘Value’;]}.
requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) – Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.
additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’;]}.
notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

Return type

str

CreateImmediateReservation(reservationName='', owner='', durationInMinutes=0, notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False)[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)
isTerminationProtectionEnabled (bool) – Indicate whether to protect the reservation from being terminated.

Return type

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

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

Parameters

reservationName (str) – Specify the name of the reservation.
owner (str) – Specify the user name of the reservation owner.
durationInMinutes (int) – Specify the length of the reservation. (in minutes)
notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.
notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.
notificationMinutesBeforeEnd (int) – Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled)
topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: [UpdateTopologyGlobalInputsRequest(‘param-name’,’value’)]
requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) –
Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

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

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

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

for textual values = “hi there” != “hi there” startswith hi there endswith hi there contains hi there doesnotcontain hi there
additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology.
notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

Return type

CreatePersistentReservation(reservationName='', owner='', startTime='', notifyOnStart=False, notifyOnEnd=False, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False)[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.
notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.
notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.
topologyFullPath (str) – Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology. For example: {[‘Input Name’, ‘Value’;]}.
requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) – Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.
additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’;]}.
notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

Return type

str

CreateReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, isTerminationProtectionEnabled=False)[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)
isTerminationProtectionEnabled (bool) – Indicate whether to protect the reservation from being terminated.

Return type

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

Adds a new resource.

Parameters

resourceFamily (str) – Specify the name of the resource family (optional).
resourceModel (str) – Specify the resource model.
resourceName (str) – Specify the resource name.
resourceAddress (str) – Specify the resource address.
folderFullPath (str) – Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
parentResourceFullPath (str) – Specify the full path from the root to a parent resource, separated by slashes. For example: Traffic Generators/Generic.
resourceDescription (str) – Provide a short description to help identify the resource.

Return type

ResourceInfo

CreateResources(resourceInfoDtos=[])[source]¶

Adds new resources.

Parameters: resourceInfoDtos (list[ResourceInfoDto]) – List of resources to add.
Return type: str

CreateRouteInReservation(reservationId='', sourceResourceFullPath='', targetResourceFullPath='', overrideActiveRoutes=False, mappingType='', maxHops=0, routeAlias='', isShared=False)[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

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

CreateTopologyReservation(reservationName='', owner='', startTime='', endTime='', notifyOnStart=False, notifyOnEnd=False, notificationMinutesBeforeEnd=0, topologyFullPath='', globalInputs=[], requirementsInputs=[], additionalInfoInputs=[], notifyOnSetupComplete=False)[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 topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
globalInputs (list[UpdateTopologyGlobalInputsRequest]) – Global inputs associated with the specified topology.
requirementsInputs (list[UpdateTopologyRequirementsInputsRequest]) –
Requirements inputs associated with the specified topology. For example: {[‘Resource Name’, ‘Input Name’, ‘Value’, ‘AttributeType’;]}, AttributeType can be one of the following: Attributes/Models/Quantity.

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

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

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

for textual values = “hi there” != “hi there” startswith hi there endswith hi there contains hi there doesnotcontain hi there
additionalInfoInputs (list[UpdateTopologyAdditionalInfoInputsRequest]) – Additional info inputs associated with the specified topology.
notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.

Return type

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

DeleteDraft(draft='')[source]¶

Delete a private draft of a blueprint.

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

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. Important: DeleteReservation does not perform teardown and therefore does not revert and clean up the sandbox environment.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
unmap (bool) – Specify whether to keep mappings or release mapped resources when deleting the reservation.

Return type

str

DeleteResource(resourceFullPath='')[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

DeleteSavedSandbox(savedSandboxId='')[source]¶

Delete a saved sandbox

Parameters: savedSandboxId (str) – Specify the saved sandbox id
Return type: str

DeleteTopology(topologyFullPath='')[source]¶

Deletes the specified topology.

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

DeleteUser(username='')[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 list of input names and values required for executing the command. Note that to change a deployed App’s name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, “Azure Ubuntu”, [InputNameValue(“Name”, “myvm01”)]).
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

str

DeployAppToCloudProviderBulk(reservationId='', appNames=[], commandInputs=[], printOutput=False)[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 list of input names and values required for executing the command [appName, InputName, InputValue]. Note that to change a deployed App’s name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, “Azure Ubuntu”, [DeployAppInput(“Azure Ubuntu”, “Name”, “myvm01”)]).
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

BulkAppDeploymentyInfo

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

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. Please note that when modifying attributes, all the attributes in deployed app must be updated.

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, possible values are: Resource, Service, App.
commandName (str) – Specify the name of the command.
commandInputs (list[InputNameValue]) – Specify a matrix of input names and values required for executing the command.
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

str

EnqueueEnvironmentCommand(reservationId='', commandName='', commandInputs=[], printOutput=False)[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, possible values are: Resource, Service, App.
commandName (str) – Specify the name of the command.
commandInputs (list[InputNameValue]) – Specify a matrix of input names and values required for executing the command.
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

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

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

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

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

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

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, includeExcludedResources=False)[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.
includeExcludedResources (bool) – Specify whether to retrieve resources that are excluded

Return type

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 future time and date to check the resource’s availability.
untilTime (str) – Specify until which time and date to check the resource’s availability.
attributeValues (list[AttributeNameValue]) – Specify an array of one or more attributes and attribute values.
showAllDomains (bool) – Show all domains associated with the logged in user.
resourceFullName (str) – Specify part of or the full name of the resource.
exactName (bool) – Specify whether to search the exact given name or not.
includeSubResources (bool) – Specify whether to retrieve the sub resources once the parent matches the name.
resourceAddress (str) – Specify the resource address. Can be partial (e.g. ‘192.168.’).
resourceUniqueIdentifier (str) – Specify the resource unique identifier.
maxResults (int) – Specify the maximum number of resources to return.

Return type

ReservationAppsResponseInfo

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

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

GetCategories(type='')[source]¶

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

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

GetCategoriesOfTopology(topologyPath='')[source]¶

Retrieves all categories of given topology.

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

GetCurrentReservations(reservationOwner='')[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

GetModelUsageReport(modelName='')[source]¶

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

Parameters: modelName (str) – Specify the name of the model to retrieve usages for.
Return type: GetModelUsageReportResponseInfo

GetReservationAppImage(reservationId='', appName='')[source]¶

Retrieves the photo of an app.

Parameters

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

Return type

GetReservationAppImageResponseInfo

GetReservationDetails(reservationId='', disableCache=False)[source]¶

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

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
disableCache (bool) – Specify if the reservation detail is new or cached

Return type

GetReservationDescriptionResponseInfo

GetReservationInputs(reservationId='')[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

GetReservationStatus(reservationId='')[source]¶

Retrieves status for a specified reservation

Parameters: reservationId (str) – Specify the string that represents the reservation’s unique identifier.
Return type: ReservationSlimStatusInfo

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

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

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

GetReservationsInRangeResponseInfo

GetSandboxData(reservationId='')[source]¶

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

Parameters: reservationId (str) – Specify the string that represents the reservation’s unique identifier.
Return type: GetSandboxDataInfo

GetSavedSandboxes()[source]¶

Get all saved sandboxes. CreateDate default timezone is UTC.

Return type: GetSavedSandboxesResponseInfo

GetScheduledReservations(fromTime='', untilTime='', ownerName='')[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.
ownerName (str) – Specify reservation owner name

Return type

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, If category name is not provided will return all topologies in domain.
categoryValue (str) – Specify the category’s value/sub category

Return type

TopologiesByCategoryInfo

GetTopologyCategories()[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 topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
Return type: TopologyInfo

GetTopologyUrls(topologyFullPath='')[source]¶

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

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

GetUserDetails(username='')[source]¶

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

Parameters: username (str) – Specify the name of the user.
Return type: UserInfo

GetValuesForLookupAttribute(attributeName='')[source]¶

Retrieve the list of existing values for a lookup attribute.

Parameters: attributeName (str) – Specify the lookup attribute name.
Return type: LookupValuesInfo

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

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

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

MoveFolder(originalFolder='', targetFolder='')[source]¶

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

Parameters

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

Return type

str

MoveResources(resourcesName=[], targetFolder='')[source]¶

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

Parameters

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

Return type

str

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

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

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

RemapConnectionResultInfo

PrepareSandboxConnectivity(reservationId='')[source]¶

Prepare Sandbox Connectivity

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

PromoteDraft(draft='')[source]¶

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

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

RecheckConflicts(reservationId='')[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

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

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

Parameters

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

Return type

str

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

Refreshes VM Details on deployed apps.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
deployedAppNames (list[str]) – Names of deployed apps whose vm details will be refreshed.

Return type

str

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

Return type

str

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

Remap connections between resources.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
resourcesFullPath (list[str]) – Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

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

RemoveCustomShellAttribute(modelName='', attributeName='')[source]¶

Remove a custom attribute from an existing shell

Parameters

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

Return type

str

RemoveGroupsFromDomain(domainName='', groupNames=[])[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=[], deleteDeployedApps=True)[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
deleteDeployedApps (bool) – Specify false to block deletion of deployed apps when removing them from reservation - only applies to resources of that are deployed apps, when applied to other resources argument is ignored. Parameter is optional and can be left empty

Return type

ReserveResourcesResponseInfo

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

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 (name or full path), from which to remove the category. For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
categoryName (str) – Specify the category’s name which we want to remove.

Return type

str

RemoveUsersFromGroup(usernames=[], groupName='')[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

RemoveValueFromLookupAttribute(attributeName='', removeValue='', defaultValue='')[source]¶

Removes an existing value from a given lookup attribute.

Parameters

attributeName (str) – Specify the lookup attribute name.
removeValue (str) – Specify the attribute value to remove from the attribute.
defaultValue (str) – Specify the new default value for this attribute (required if removing the attribute’s current default value).

Return type

str

RenameBlueprint(topologyFullPath='', newName='')[source]¶

Rename a blueprint.

Parameters

topologyFullPath (str) – Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
newName (str) – Specify the name of the driver. Leave empty to remove associated driver.

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

ResetSandboxProvisioningStatus(reservationId='')[source]¶

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

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

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

Restore a saved sandbox

Parameters

reservationName (str) – Specify the name of the reservation.
owner (str) – Specify the user name of the reservation owner.
durationInMinutes (int) – Specify the length of the reservation. (in minutes)
notifyOnStart (bool) – Indicate whether to notify the reservation owner when the reservation starts.
notifyOnEnd (bool) – Indicate whether to notify the reservation owner when the reservation ends.
notificationMinutesBeforeEnd (int) – Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled)
savedSandboxId (str) – Specify the saved sandbox id.
startTime (str) – The start time of the restored sandbox.
endTime (str) – The end time of the restored sandbox.
notifyOnSetupComplete (bool) – Indicate whether to notify the reservation owner when the reservation setup completes.
isTerminationProtectionEnabled (bool) – Indicate whether to protect the reservation from being terminated.

Return type

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

SaveSandbox(reservationId='', savedSandboxName='', savedSandboxDescription='', owner='')[source]¶

Save the sandbox.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
savedSandboxName (str) – Specify the name of the saved sandbox
savedSandboxDescription (str) – provide a short description for the saved sandbox
owner (str) – Specify the owner of the saved sandbox

Return type

SaveSandboxResponseInfo

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

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

Set security groups for apps.

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
securityGroups (list[SecurityGroup]) – Security Groups
printOutput (bool) – Defines whether to print the command output in the reservation command output window.

Return type

str

SetAttributeValue(resourceFullPath='', attributeName='', attributeValue='')[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 list of resources, attribute names, and new attribute values (up to 10000 rows). For example: [ResourceAttributesUpdateRequest(‘resourceFullName’, [AttributeNameValue(‘attribute_name’, ‘attribute_value’)]]
Return type: str

SetBaudRate(reservationId='', resourceFullPath='', consolePortsFullPath=[], baudRate=0)[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

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: [SetConnectorRequest(‘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

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

Add a custom attribute to an existing shell model

Parameters

modelName (str) – Specify the name of the model to add the attribute to.
attributeName (str) – Specify the name of the attribute to add/update.
defaultValue (str) – Specify the default value to set for the attribute.
restrictedValues (list[str]) – Specify the restricted values for the attribute.

Return type

str

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

SetResourceShareLevel(resourceFullPath='', newShareLevel='')[source]¶

Sets a resource’s default share level.

Parameters

resourceFullPath (str) – Specify the full path of the resource. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
newShareLevel (str) – The new share level of the resource. Options: FamilyDefault, Shared or Unshared.

Return type

str

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

SetResourceVisibility(resourceFullPath='', newVisibility='')[source]¶

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

Parameters

resourceFullPath (str) – Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
newVisibility (str) – The new visibility state for the resource. options: AdminOnly, Everyone or FamilyDefault

Return type

str

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

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

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

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
sandboxDataKeyValues (list[SandboxDataKeyValue]) – sandboxDataKeyValues

Return type

str

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

SetServiceName(reservationId='', serviceName='', newServiceName='')[source]¶

Edit Service alias name

Parameters

reservationId (str) – Specify the string that represents the reservation’s unique identifier.
serviceName (str) – Specify the string that represents the service’s name.
newServiceName (str) – Specify the string that represents the new service’s name.

Return type

str

SetSetupStage(setupStage='', reservationId='')[source]¶

Set the specified setup stage for the the sandbox.

Parameters

setupStage (str) – Specify the setup stage that will be set to the reservation.
reservationId (str) – Specify the string that represents the reservation’s unique identifier.

Return type

str

SetTopologyCategory(topologyFullPath='', categoryName='', categoryValue='')[source]¶

Set a category to given topology

Parameters

topologyFullPath (str) – Specify the topology (name or full path), to associate the category to. For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
categoryName (str) – Specify the category’s name which we want to set
categoryValue (str) – Specify the category’s value

Return type

str

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 list of physical connections to update. For example: [PhysicalConnectionUpdateRequest(‘resource_a_fullname’, ‘resource_b_fullname’, ‘weight’)]
overrideExistingConnections (bool) – Overriding existing connections will automatically remove existing physical connection if they conflict with the requested new connections. If set to ‘No’, an error message will be displayed if any port is already connected and the operation will be cancelled.

Return type

str

UpdateReservationDescription(reservationId='', description='')[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 reservation. For example: [UpdateTopologyGlobalInputsRequest(‘input1’,’value1’)]

Return type

str

UpdateReservationName(reservationId='', name='')[source]¶

Modifies the name for a specified reservation.

Parameters

reservationId (str) – Specify the reservation ID.
name (str) – Provide an updated name of the reservation. This text will replace the current name.

Return type

str

UpdateResourceAddress(resourceFullPath='', resourceAddress='')[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: [UpdateRouteAliasRequest(‘source_fullname’, ‘target_fullname’, ‘alias’)]

Return type