TestShell API Guide

ActivateTopology

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

Syntax

ActivateTopology(reservationId,topologyFullPath,out activatedTopology,out resources,out attributes,out routes,out connectors, out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Topology Full Path	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.
out String matrix	Activated Topology	The activated topology and its associated values.
out String matrix	Resources	List of resources and resource values associated with the activated topology.
out String matrix	Attributes	Attributes and attribute values for resources associated with the specified topology.
out String matrix	Routes	Routes and route values associated with the activated topologies.
out String matrix	Connectors	Visual connectors and their values associated with the activated topologies.
out String matrix	Segments	Segment details for topology routes in the specified reservation. Each route is comprised of one or more segments.
out String	Result XML	Specify the variable for the XML output.

AddGroupsToDomain

Add groups to a domain.

Syntax

AddGroupsToDomain(domainName,groupNames,viewOnly);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String vector	Groups Names	Specify an array of one or more groups.
String	View Only	Specify if the array of group should be added with view only permissions.

AddNewDomain

Adds a new domain.

Syntax

AddNewDomain(domainName,description);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String	Description	Specify the description of the domain.

AddNewGroup

Adds a new users group

Syntax

AddNewGroup(groupName,description,groupRole);

Parameters

Type	Name	Description
String	Group Name	Specify the name of the group.
String	Description	Provide a short description of the group.
String	Group Role	Specify the role of the group, possible values: External, Regular, DomainAdmin.

AddNewUser

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

Syntax

AddNewUser(username,password,email,isActive,isAdmin);

Parameters

Type	Name	Description
String	Username	Specify the name of the user.
String	Password	Specify the user’s login password.
String	Email	Specify the user’s email address.
String	Is Active	Grant or deny active access to the application.
String	Is Admin	Add the user to the System Administrators group.

AddPermittedUsersToReservation

Add one or more permitted users to the specified reservation.

Syntax

AddPermittedUsersToReservation(reservationId,usernames);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	User Names	List of users to permit access to the reservation.

AddResourcesToDomain

Add resources to a domain.

Syntax

AddResourcesToDomain(domainName,resourcesNames,includeDecendants);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String vector	Resources Full Path	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
String	Include Child Resources	Specify whether to include child resources.

AddResourcesToReservation

Reserves resources to be locked.

Syntax

AddResourcesToReservation(reservationId,resourcesFullPath,shared,out conflicts,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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
String	Shared	Specify whether all resources will be shared among other enviroments
out String matrix	Resource Conflicts	Resource conflicts and their associated values for the specified reservation.
out String	Result XML	Specify the variable for the XML output.

AddRoutesToReservation

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

Syntax

AddRoutesToReservation(reservationId,sourceResourcesFullPath,targetResourcesFullPath,mappingType,maxHops,routeAlias,isShared,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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
String vector	Resources Full Path	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
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.
Numeric	Maximum Hops	Specify the maximum number or allowed hops.
String	Route Alias	Specify the route’s alias.
String	Is Shared	Specify whether these routes are shared. Shared routes can be used in more than one reservation.
out String matrix	Routes	Routes and route values associated with the activated topologies.
out String	Result XML	Specify the variable for the XML output.

AddTopologiesToDomain

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

Syntax

AddTopologiesToDomain(domainName,topologyNames);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String vector	Topologies Full Path	Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
String	Validate Resource Availability	Validates the existence of the resource resolution in the target domain. Default value: 'True'. Note: when value 'False' is supplied, there is no process of associating resources and routes with the target domain.

AddUsersToGroup

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

Syntax

AddUsersToGroup(usernames,groupName);

Parameters

Type	Name	Description
String vector	Usernames	Specify an array of one or more users.
String	Group Name	Specify the name of the group.

AutoLoad

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

Syntax

AutoLoad(resourceFullPath,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String	Result XML	Specify the variable for the XML output.

ArchiveDomain

Archive a domain. All future reservation will be deleted.

Syntax

ArchiveDomain(domainName,out resultXml);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
out String	Result XML	Specify the variable for the XML output.

AddAppToReservation

Add an App resource to an existing reservation.

Syntax

AddAppToReservation(reservationId, appName, deploymentPath, positionX, positionY, out createdAppName, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	App Template Name	Specify the App template's name.
String	Deployment Path	Specify the way the app will be deploy from a given list of options.
String	Position X	Specify the x coordinate of the App's top left corner.
String	Position Y	Specify the y coordinate of the App's top left corner.
out String	Created App Name	The name of the App to be created.

AddServiceToReservation

Add service resource to existing reservation.

Syntax

AddServiceToReservation(reservationId,serviceName,alias,attributes);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Service Name	Specify the service name.
String	Service Alias	Specify the service alias.
String matrix	Service Attributes	Specify a matrix of attributes and associated attribute values.

CopyDomainsResources

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

Syntax

CopyDomainsResources(sourceDomains,targetDomain);

Parameters

Type	Name	Description
String vector	Source Domains	Specify the names of the source domains.
String	Target Domain	Specify the name of the target domain.

ClearAndResetConsole

Clears and resets specified resource console ports.

Syntax

ClearAndResetConsole(reservationId,resourceFullPath,consolePortsFullPath,baudRate,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
String vector	Console Ports	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.
String	Baud Rate	Specify the baud rate to apply to the ports.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

ConnectRoutesInReservation

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

Syntax

ConnectRoutesInReservation(reservationId,endpoints,mappingType,out routes,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String matrix	Endpoints	The routes’ endpoints to connect.
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.
out String matrix	Routes	The routes that were connected.
out String matrix	Segments	The segments details of the connected routes.
out String	Result XML	Specify the variable for the XML output.

CreateFolder

Adds a new folder to the specified path.

Syntax

CreateFolder(folderFullPath);

Parameters

Type	Name	Description
String	Folder Full Path	Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

CreateImmediateReservation

Defines a reservation to be started immediately.

Syntax

CreateImmediateReservation(reservationName,owner,durationInMinutes,notifyOnStart,notifyOnSetupComplete,notifyOnEnd,notificationMinutesBeforeEnd,topology,globalInputs,requirementsInputs,additionalInfoInputs,out reservationId,out resultXml);

Parameters

Type	Name	Description
String	Reservation Name	Specify the name of the reservation.
String	Reservation Owner	Specify the user name of the reservation owner.
Numeric	Duration	Specify the length of the reservation. (in minutes)
String	Notify On Start	Indicate whether to notify the reservation owner when the reservation starts.
String	Notify On End	Indicate whether to notify the reservation owner when the reservation ends.
Numeric	Notification Minutes Before End	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)
String	Topology Full Path	Specify the full topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
String matrix	Global Inputs	Global inputs associated with the specified topology. For example: {['Input Name', 'Value';]}.
String matrix	Requirements Inputs	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.
String matrix	Additional Info Inputs	Additional info inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value';]}.
String	Notify On Setup Complete	Indicate whether to notify the reservation owner when the reservation setup completes.
String	Protects the sandbox from being terminated	Indicate whether to protect the reservation from being terminated.
out String	Reservation ID	Specifies the string that represents the reservation’s unique identifier.
out String	Result XML	Specify the variable for the XML output.

CreateReservation

Defines a new reservation.

Syntax

CreateReservation(reservationName,owner,startTime,endTime,notifyOnStart,notifyOnSetupComplete,notifyOnEnd,notificationMinutesBeforeEnd, topology, globalInputs, requirementsInputs, additionalInfoInputs, out reservationId,out resultXml);

Parameters

Type	Name	Description
String	Reservation Name	Specify the name of the reservation.
String	Reservation Owner	Specify the user name of the reservation owner.
String	Start Time	The start time of the reservation.
String	End Time	The end time of the reservation.
String	Notify On Start	Indicate whether to notify the reservation owner when the reservation starts.
String	Notify On End	Indicate whether to notify the reservation owner when the reservation ends.
Numeric	Notification Minutes Before End	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)
String	Topology Full Path	Specify the full topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
String matrix	Global Inputs	Global inputs associated with the specified topology. For example: {['Input Name', 'Value';]}.
String matrix	Requirements Inputs	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.
String matrix	Additional Info Inputs	Additional info inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value';]}.
String	Notify On Setup Complete	Indicate whether to notify the reservation owner when the reservation setup completes.
String	Protects the sandbox from being terminated	Indicate whether to protect the reservation from being terminated.
out String	Reservation ID	Specifies the string that represents the reservation’s unique identifier.
out String	Result XML	Specify the variable for the XML output.

CreateResource

Adds a new resource.

Syntax

CreateResource(resourceFamily,resourceModel,resourceName,resourceAddress,folderFullPath,parentResourceFullPath,resourceDescription,out resource,out attributes,out resultXml);

Parameters

Type	Name	Description
String	Resource Family	Specify the name of the resource family (optional).
String	Resource Model	Specify the resource model.
String	Resource Name	Specify the resource name.
String	Resource Address	Specify the resource address.
String	Folder Full Path	Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
String	Parent Resource Full Path	Specify the full path from the root to a parent resource, separated by slashes. For example: Traffic Generators/Generic.
String	Resource Description	Provide a short description to help identify the resource.
out String matrix	Resource	Details associated with the specified resource.
out String matrix	Attributes	Attributes and attribute values associated with the new resource.
out String	Result XML	Specify the variable for the XML output.

CreateResources

Adds new resources.

Syntax

CreateResources(resourceCreationRequests);

Parameters

Type	Name	Description
String matrix	Resources	List of resources to add.

CreateRouteInReservation

Creates a route between the specified source and target resources.

Syntax

CreateRouteInReservation(reservationId,sourceResourceFullPath,targetResourceFullPath,overrideActiveRoutes,mappingType,maxHops,routeAlias,isShared,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Source Resource	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.
String	Target Resource	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.
String	Override Active Routes	Specify whether the new route can override existing routes.
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.
Numeric	Maximum Hops	Specify the maximum number or allowed hops.
String	Route Alias	Specify the route’s alias.
String	Is Shared	Specify whether this route is shared. Shared routes can be used in more than one reservation.
out String matrix	Route	Routes and route values associated with the activated topologies.
out String	Result XML	Specify the variable for the XML output.

CreateRoutesInReservation

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

Syntax

CreateRoutesInReservation(reservationId,sourceResourcesFullPath,targetResourcesFullPath,overrideActiveRoutes,mappingType,maxHops,routeAlias,isShared,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Source Resources	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
String vector	Target Resources	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
String	Override Active Routes	Specify whether the new route can override existing routes.
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.
Numeric	Maximum Hops	Specify the maximum number or allowed hops.
String	Route Alias	Specify the route’s alias.
String	Is Shared	Specify whether these routes are shared. Shared routes can be used in more than one reservation.
out String matrix	Route	Routes and route values associated with the activated topologies.
out String	Result XML	Specify the variable for the XML output.

DeleteDomain

Deletes a domain.

Syntax

DeleteDomain(domainName);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.

DeleteTopology

Deletes the specified topology.

Syntax

DeleteTopology(topologyFullPath);

Parameters

Type	Name	Description
String	Topology Full Path	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.

DeleteFolder

Deletes the specified folder.

Syntax

DeleteFolder(folderFullPath);

Parameters

Type	Name	Description
String	Folder Full Path	Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.

DeleteGroup

Deletes the specified group.

Syntax

DeleteGroup(groupName);

Parameters

Type	Name	Description
String	Group Name	Specify the name of the group.

DeleteReservation

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

Syntax

DeleteReservation(reservationId,unmap);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Unmap Resources	Specify whether to keep mappings or release mapped resources when deleting the reservation.

DeleteResource

Deletes the specified resource.

Syntax

DeleteResource(resourceFullPath);

Parameters

Type	Name	Description
String	Resource Full Path	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.

DeleteResources

Deletes the specified resources.

Syntax

DeleteResources(resourcesFullPath);

Parameters

Type	Name	Description
String vector	Resources Full Path	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

DeleteUser

Deletes the specified user.

Syntax

DeleteUser(username);

Parameters

Type	Name	Description
String	Username	Specify the name of the user.

DisconnectRoutesInReservation

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

Syntax

DisconnectRoutesInReservation(reservationId,endpoints,out routes,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String matrix	Endpoints	The routes endpoints to disconnect.
out String matrix	Routes	The routes that were disconnected.
out String matrix	Segments	The segments details of the disconnected routes.
out String	Result XML	Specify the variable for the XML output.

DeleteResourceTemplate

Deletes a specific resource template.

Syntax

DeleteResourceTemplate(resourceTemplateName);

Parameters

Type	Name	Description
String	Resource Template Name	Specify the resource template name.

EndReservation

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

Syntax

EndReservation(reservationId,unmap);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Unmap resources	Specify whether to keep mappings or release mapped resources when deleting the reservation.

ExcludeResource

Excludes a specified resource.

Syntax

ExcludeResource(resourceFullPath);

Parameters

Type	Name	Description
String	Resource Full Path	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.

ExcludeResources

Excludes the specified resources.

Syntax

ExcludeResources(resourcesFullPath);

Parameters

Type	Name	Description
String vector	Resources Full Path	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

SetResourceVisibility

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

Syntax

SetResourceVisibility(resourceFullPath, newVisibility);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	New Admin Only State	The new visibility state for the resource. options: AdminOnly, Everyone or FamilyDefault

EnqueueResourceCommand

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

Syntax

EnqueueResourceCommand(reservationId,resourceFullPath,commandName,parameterValues,printOutput);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
String	Command Name	Specify the name of the command.
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.

EnqueueServiceCommand

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

Syntax

EnqueueServiceCommand(reservationId,serviceAlias,commandName,parameterValues,printOutput);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Service Alias	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.
String	Command Name	Specify the name of the command.
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.

ExecuteResourceCommand

[Deprecated] Executes a command for the specified driver.

Syntax

ExecuteResourceCommand(reservationId,resourceFullPath,commandName,parameterValues,printOutput,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
String	Command Name	Specify the name of the command.
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

ExecuteResourceConnectedCommand

Executes a command for the specified driver.

Syntax

ExecuteResourceConnectedCommand(reservationId,resourceFullPath,commandName,commandTag, parameterValues, connectedPortsFullPath,printOutput, out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Name	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.
String	Command Name	Specify the name of the command.
String	Command Tag	Specify the command tag. Connected command tags are used to define categories of functionality (e.g 'virtualization').
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String vector	Connected Ports	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.
String	Print Output	Defines whether to print the command output in the reservation command output window.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

EnqueueTopologyCommand

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

Syntax

EnqueueTopologyCommand(reservationId,commandName,parameterValues,printOutput);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Command Name	Specify the name of the command.
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.

ExecuteTopologyCommand

[Deprecated] Executes a command for the specified reservation.

Syntax

ExecuteTopologyCommand(reservationId,commandName,parameterValues,printOutput,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Command Name	Specify the name of the command.
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

ExtendReservation

Extends the duration of the specified reservation.

Syntax

ExtendReservation(reservationId,minutesToAdd);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
Numeric	Minutes To Add	Specify the number of minutes to add to the specified reservation.

ExportFamiliesAndModels

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

Syntax

ExportFamiliesAndModels(out resultXml);

Parameters

Type	Name	Description
out String	Result XML	Specify the variable for the XML output.

ExecuteServiceCommand

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

Syntax

ExecuteServiceCommand(reservationId, serviceAlias, commandName, parameterValues, printOutput, out output, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Service Alias	Specify the alias of the service.
String	Command Name	Specify the name of the command.
String vector	Command Parameters	Specify the list of parameters values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

EditAppsInReservation

Edit Apps in a reservation

Syntax

EditAppsInReservation(reservationId, editAppsRequests, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String matrix	Edit App Request	Changes to implement in the App. Please note that when modifying attributes, all the attributes in deployed app must be updated.
out String	Result XML	Specify the variable for the XML output.

PrepareSandboxConnectivity

Prepare Sandbox Connectivity

Syntax

PrepareSandboxConnectivity(reservationId, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String	Result XML	Specify the variable for the XML output.

CleanupSandboxConnectivity

Cleanup Sandbox Connectivity

Syntax

CleanupSandboxConnectivity(reservationId, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String	Result XML	Specify the variable for the XML output.

EnqueueEnvironmentCommand

Enqueues a command to be executed for the specified reservation.

Syntax

EnqueueEnvironmentCommand(reservationId,commandName,commandInputs,printOutput);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Command Name	Specify the name of the command.
String matrix	Command Inputs	Specify a matrix of input names and values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.

ExecuteEnvironmentCommand

Executes a command for the specified reservation.

Syntax

ExecuteEnvironmentCommand(reservationId,commandName,commandInputs,printOutput,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Command Name	Specify the name of the command.
String matrix	Command Inputs	Specify a matrix of input names and values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

EnqueueCommand

Enqueues a command to be executed for the specified target.

Syntax

EnqueueCommand(reservationId,targetName,targetType,commandName,commandInputs,printOutput);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Target Name	Specify the name of the target according to the target type: for resources - specify the resouce's name, for services - the service's alias.
String	Target Type	Specify the target type for command execution, possible values are: Resource, Service, App.
String	Command Name	Specify the name of the command.
String matrix	Command Inputs	Specify a matrix of input names and values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.

ExecuteCommand

Executes a command for the specified target.

Syntax

ExecuteCommand(reservationId,targetName,targetType,commandName,commandInputs,printOutput,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Target Name	Specify the name of the target according to the target type: for resources - specify the resouce's name, for services - the service's alias.
String	Target Type	Specify the target type for command execution, possible values are: Resource, Service, App.
String	Command Name	Specify the name of the command.
String matrix	Command Inputs	Specify a matrix of input names and values required for executing the command.
String	Print Output	Defines whether to print the command output in the reservation command output window.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

FindResources

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

Syntax

FindResources(resourceFamily,resourceModel,attributeValues,showAllDomains,resourceFullName,exactName,includeSubResources,resourceAddress,resourceUniqueIdentifier,maxResults,includeExcludedResources,out resources,out reservations,out usageSummary,out resultXml);

Parameters

Type	Name	Description
String	Resource Family	Specify the name of the resource family.
String	Resource Model	Specify the resource model.
String matrix	Attribute Values	Specify an array of one or more attributes and attribute values.
out String matrix	Resources	All resources that match the specified query conditions.
String	Show All Domains	Show all domains associated with the logged in user.
String	Resource Full Name	Specify part of or the full name of the resource.
String	Exact Name	Specify whether to search the exact given name or not.
String	Include Sub Resources	Specify whether to retrieve the sub resources once the parent matches the name.
String	Resource Address	Specify the resource address. Can be partial (e.g. '192.168.').
String	Resource Unique Identifier	Specify the resource unique identifier.
Numeric	Max Results	Specify the maximum number of resources to return.
String	Include Excluded Resources	Specify whether to retrieve resources that are excluded
out String matrix	Reservations	All reservations for the resources that match the specified query conditions.
out String matrix	Usage Summary	Specify the number used connected resources, this data will be available only on top level resource.
out String	Result XML	Specify the variable for the XML output.

FindResourcesInTimeRange

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

Syntax

FindResourcesInTimeRange(resourceFamily,resourceModel,fromTime,untilTime,attributeValues,showAllDomains,resourceFullName,exactName,includeSubResources,resourceAddress,resourceUniqueIdentifier,maxResults,out resources,out reservations,out usageSummary,out resultXml);

Parameters

Type	Name	Description
String	Resource Family	Specify the name of the resource family.
String	Resource Model	Specify the resource model.
String	From Date Time	Specify from which future time and date to check the resource's availability.
String	Until Date Time	Specify until which time and date to check the resource's availability.
String matrix	Attribute Values	Specify an array of one or more attributes and attribute values.
String	Show All Domains	Show all domains associated with the logged in user.
String	Resource Full Name	Specify part of or the full name of the resource.
String	Exact Name	Specify whether to search the exact given name or not.
String	Include Sub Resources	Specify whether to retrieve the sub resources once the parent matches the name.
String	Resource Address	Specify the resource address. Can be partial (e.g. '192.168.').
String	Resource Unique Identifier	Specify the resource unique identifier.
Numeric	Max Results	Specify the maximum number of resources to return.
out String matrix	Resources	All resources that match the specified query conditions.
out String matrix	Reservations	All reservations for the resources that match the specified query conditions.
out String matrix	Usage Summary	Specify the number used connected resources, this data will be available only on top level resource.
out String	Result XML	Specify the variable for the XML output.

GetReservationResourcesPositions

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

Syntax

GetReservationResourcesPositions(reservationId,out layout,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String matrix	Diagram Layout	All the resources and their positions in the diagram.
out String	Result XML	Specify the variable for the XML output.

GetRoutesSolution

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

Syntax

GetRoutesSolution(reservationId,sourceResourcesFullName,targetResourcesFullName,mappingType,maxHops,isShared,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Name	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
String vector	Resources Full Name	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
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.
Numeric	Maximum Hops	Specify the maximum number or allowed hops.
String	Is Shared	Specify whether these routes are shared. Shared routes can be used in more than one reservation.
out String matrix	Routes	Routes and route values associated with the activated topologies.
out String	Result XML	Specify the variable for the XML output.

GenerateUtilizationReport

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

Syntax

GenerateUtilizationReport(resourceFamilyName,fromDate,toDate,resourceFullName,resourceModelName,includeChildResources,groupBy,utilizationReportType,out resultXml);

Parameters

Type	Name	Description
String	Resource Family	Specify the name of the resource family.
String	From Date	Specify the start time and date.
String	To Date	Specify the end time and date.
String	Resource Full Name	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.
String	Resource Model	Specify the resource model.
String	Include Child Resources	Specify whether to include child resources utilization.
String	Group By	Specify how to group the utilization results: Resource, User, or Machine
String	Report Type	Specify the report type: Lock or Mapping.
out String	Result XML	Specify the variable for the XML output.

GetActiveTopologyNames

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

Syntax

GetActiveTopologyNames(out reservedTopologyNames,out resultXml);

Parameters

Type	Name	Description
out String vector	Topologies	The list of active topologies reserved for the current user.
out String	Result XML	Specify the variable for the XML output.

GetAllUsersDetails

Retrieves all users and their settings.

Syntax

GetAllUserDetails(out userDetails,out resultXml);

Parameters

Type	Name	Description
out String matrix	Users Details	User settings for the specified user.
out String	Result XML	Specify the variable for the XML output.

GetAttributeValue

Retrieves the value of the specified attribute

Syntax

GetAttributeValue(resourceFullPath,attributeName,out attributeValue,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Attribute Name	Specify the attribute name.
out String	Attribute Value	The attribute value.
out String	Result XML	Specify the variable for the XML output.

GetCategoriesOfTopology

Retrieves all categories of given topology.

Syntax

GetCategoriesOfTopology(topologyPath, out categories, out resultXml);

Parameters

Type	Name	Description
String	Topology Full Path	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.
out String	Topology's Categories	Specify a list of all categories belong to given topology.
out String	Result XML	Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

GetCurrentReservations

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

Syntax

GetCurrentReservations(reservationOwner,out reservations,out permittedUsers,out resultXml);

Parameters

Type	Name	Description
String	Reservation Owner	Specify the user name of the reservation owner.
out String matrix	Reservations	All current reservations for the specified owner, or all current reservations (if no owner is specified).
out String matrix	Permitted Users	Lists users with [active \| full] access to the specified reservation.
out String	Result XML	Specify the variable for the XML output.

GetDomainDetails

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

Syntax

GetDomainDetails(domainName,out domainTopologiesFolder,out domainGroups,out domainTopologies,out domainResources,out resultXml);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
out String	Domain Topologies Folder	The topologies folder of the domain.
out String matrix	Groups	Groups and their associated values for the specified domain.
out String matrix	Topologies	Topologies and their associated values for the specified domain.
out String matrix	Resources	Resources and their associated values for the specified domain.
out String	Result XML	Specify the variable for the XML output.

GetFolderContent

Retrieves content for the specified path.

Syntax

GetFolderContent(fullPath, showAllDomains,out content,out resultXml);

Parameters

Type	Name	Description
String	Folder Full Path	Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
String	Show All Domains	Show all domains associated with the logged in user.
out String matrix	Content	Content and content parameters for the specified resource.
out String	Result XML	Specify the variable for the XML output.

MoveFolder

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

Syntax

MoveFolder(originalFolder,targetFolder);

Parameters

Type	Name	Description
String	Original Folder	Path of the folder to be moved.
String	Target Folder	The path of the new containing folder. To move a folder to root, value should be empty.
out String	Result XML	Specify the variable for the XML output.

GetGroupDomains

Retrieves all domains associated with a group.

Syntax

GetGroupDomains(groupName,out domains,out resultXml);

Parameters

Type	Name	Description
String	Group Name	Specify the name of the group.
out String matrix	Domains	All domains associated with the specified group.
out String	Result XML	Specify the variable for the XML output.

GetGroupsDetails

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

Syntax

GetGroupsDetails(out groups,out resultXml);

Parameters

Type	Name	Description
out String matrix	Groups	Retrieves all groups in the system, together with the description and role for each group.
out String	Result XML	Specify the variable for the XML output.

GetLockedResources

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.

Syntax

GetLockedResources(user,machine,folderFullPath,out reservations,out resources,out resultXml);

Parameters

Type	Name	Description
String	Username	Specify a user name to retrieve locked resources for that user.
String	Machine Name	Specify a machine name to retrieve locked resources for that computer.
String	Folder Full Path	Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
out String matrix	Reservations	Retrieves all reservations for the resources that match the specified query conditions.
out String matrix	Resources	Resources and resource values associated with the specified topology.
out String	Result XML	Specify the variable for the XML output.

GetReservationDetails

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.

Syntax

GetReservationDetails(reservationId, disableCache, out name, out description, out creationTime, out startTime, out endTime,out reservationStatus, out provisioningStatus, out resources, out conflicts, out topologies,out topologyResources, out topologyRoutes, out topologyRouteSegments, out topologyInstructions, out connectedRoutes,out connectedRoutesSegments,out reservationRoutes, out reservationRouteSegments, out permittedUsers, out domainName, out topologyResourcesAttributes, out connectors, out connectorAttributes, out liveStatus,out services, out serviceAttributes, out apps,out setupStage, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Disable Cache	Specify if the reservation detail is new or cached
out String	Reservation Name	The name of the reservation associated with the specified reservation ID.
out String	Description	The description of the reservation associated with the specified reservation ID.
out String	Creation Date Time	The creation time and date for the specified reservation.
out String	Start Date Time	The start time and date for the specified reservation.
out String	End Date Time	The end time and date for the specified reservation.
out String	Reservation Status	Indicates the current reservation status.
out String	Provisioning Status	Indicates the current provisioning status.
out String matrix	Resources	Resources and their associated values for the specified reservation.
out String matrix	Resource Conflicts	Resource conflicts and their associated values for the specified reservation.
out String matrix	Topologies	Topologies and their associated values for the specified reservation.
out String matrix	Topology Resources	Topology resources and their associated values for the specified reservation.
out String matrix	Route	Topology routes in the specified reservation.
out String matrix	Segments	Segment details for topology routes in the specified reservation. Each route is comprised of one or more segments.
out String matrix	Topology Instructions	Topology instructions.
out String matrix	Connected Routes	Routes currently connected in the specified reservation.
out String matrix	Connected Routes Segments	Segment details for connected routes in the specified reservation. Each route is comprised of one or more segments.
out String matrix	Reservation Routes	Routes in the specified reservation.
out String matrix	Reservation Route Segments	Segment details for routes in the specified reservation. Each route is comprised of one or more segments.
out String matrix	Permitted Users	Lists users with [active \| full] access to the specified reservation.
out String	Domain Name	The domain name of the specified reservation.
out String matrix	Topology Resources Attributes	Topology resources and their associated attribute changes for the specified reservation.
out String matrix	Connectors	Visual connectors associated with the specified reservation.
out String matrix	ConnectorAttributes	Visual connectors attributes associated with a specified connector.
out String matrix	liveStatus	Gets the live status of the reservations.
out String matrix	Services	Matrix of service instances.
out String matrix	ServiceAttributes	Matrix of attributes of the services.
out String matrix	Apps	Apps associated with the specified reservation..
out String	Apps	Reservation's setup stage
out String	Result XML	Specify the variable for the XML output.

GetReservationInputs

Retrieves all topology inputs for a specified reservation.

Syntax

GetReservationInputs(reservationId, out globalInputs, out requirementsInputs, out additionalInfoInputs, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String matrix	Global Inputs	Global inputs associated with the specified reservation.
out String matrix	Requirements Inputs	Requirements inputs associated with the specified reservation.
out String matrix	Additional Info Inputs	Additional info inputs associated with the specified reservation.
out String	Result XML	Specify the variable for the XML output.

GetReservationRemainingTime

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.

Syntax

GetReservationRemainingTime(reservationId,out reservationRemainingTimeInMinutes,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String	Remaining Time	The number of minutes remaining until the reservation ends.
out String	Result XML	Specify the variable for the XML output.

GetResourceAvailability

Get resource availability for the resources.

Syntax

GetResourceAvailability(resourcesNames,out resources,out reservations,out usageSummary,showAllDomains,out resultXml);

Parameters

Type	Name	Description
String vector	Resources Full Path	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
out String matrix	Resources	All resources that match the specified query conditions.
out String matrix	Reservations	All reservations for the resources that match the specified query conditions.
out String matrix	Usage Summary	Specify the number used connected resources, this data will be available only on top level resource
String	Show All Domains	Show all domains associated with the logged in user.
out String	Result XML	Specify the variable for the XML output.

GetResourceAvailabilityInTimeRange

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

Syntax

GetResourceAvailabilityInTimeRange(resourcesNames,startTime,endTime,showAllDomains,out resources,out reservations,out usageSummary,out resultXml);

Parameters

Type	Name	Description
String vector	Resources Full Path	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
String	Start Time	The start time of the reservation.
String	End Time	The end time of the reservation.
String	Show All Domains	Show all domains associated with the logged in user.
out String matrix	Resources	All resources that match the specified query conditions.
out String matrix	Reservations	All reservations for the resources that match the specified query conditions.
out String matrix	Usage Summary	Specify the number used connected resources, this data will be available only on top level resource
out String	Result XML	Specify the variable for the XML output.

GetResourceCommands

Retrieves driver commands and parameters for a specified resource.

Syntax

GetResourceCommands(resourceFullPath,out commands,out parameters,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String matrix	Commands	All commands for drivers associated with the specified resource.
out String matrix	Command Parameters	Parameters associated with each command.
out String	Result XML	Specify the variable for the XML output.

GetServiceCommands

Retrieves driver commands and parameters for a specified service.

Syntax

GetServiceCommands(serviceName,out commands,out parameters,out resultXml);

Parameters

Type	Name	Description
String	Service Name	Specify the service name.
out String matrix	Commands	All commands for drivers associated with the specified service.
out String matrix	Command Parameters	Parameters associated with each command.
out String	Result XML	Specify the variable for the XML output.

GetResourceConnectedCommands

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

Syntax

GetResourceConnectedCommands(resourceFullPath,out commands,out parameters,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String matrix	Commands	All commands for drivers associated with the specified resource.
out String matrix	Command Parameters	Parameters associated with each command.
out String	Result XML	Specify the variable for the XML output.

GetResourceDetails

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

Syntax

GetResourceDetails(resourceFullPath, showAllDomains,out resource,out attributes,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Show All Domains	Show all domains associated with the logged in user.
out String matrix	Resource	Details associated with the specified resource.
out String matrix	Attributes	Attributes and attribute values for the specified resource.
out String	Result XML	Specify the variable for the XML output.

GetResourceList

Retrieves resources and resource values for the specified folder path.

Syntax

GetResourceList(folderFullPath,out resources,out resultXml);

Parameters

Type	Name	Description
String	Folder Full Path	Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
out String matrix	Resources	Resources and resource values for the specified path.
out String	Result XML	Specify the variable for the XML output.

GetResourceLiveStatus

Gets the live status of the resource.

Syntax

GetResourceLiveStatus(resourceFullPath,out liveStatusName,out additionalInfo,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String	Live Status Name	Resource live status name
out String	Additional Info	Resource live status additional info
out String	Result XML	Specify the variable for the XML output.

GetReservationsLiveStatus

Gets the live status of the reservations.

Syntax

GetReservationsLiveStatus(reservationsId,out statusesArray);

Parameters

Type	Name	Description
String vector	Reservations IDs	Specifies a string array that represents reservation unique identifiers.
out String matrix	Reservations Live Status	Returns an array with reservation's live status.

GetResourceMappings

Retrieves mappings for a list of one or more resources.

Syntax

GetResourceMappings(resources,out mappings,out resultXml);

Parameters

Type	Name	Description
String vector	Resource Names	Specify a list of resources.
out String matrix	Mappings	All mappings associated with the listed resources.
out String	Result XML	Specify the variable for the XML output.

GetRouteSegments

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

Syntax

GetRouteSegments(resource,out segments,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String matrix	Segments	The segments details for the specified route.
out String	Result XML	Specify the variable for the XML output.

GetScheduledReservations

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

Syntax

GetScheduledReservations(fromTime,untilTime,out reservations,out permittedUsers,out resultXml);

Parameters

Type	Name	Description
String	From Date Time	Specify from which time and date to search.
String	Until Date Time	Specify until which time and date to search.
String	Owner Name	Specify reservation owner name
out String matrix	Reservations	Scheduled reservations for the provided time range. Reservations will be listed for the specified owner, or all current reservations (if no owner is specified).
out String matrix	Permitted Users	Lists users with [active \| full] access to the specified reservation.
out String	Result XML	Specify the variable for the XML output.

GetServerDateAndTime

Retrieves the server’s UTC date and time.

Syntax

GetServerDateAndTime(out serverDateTime,out resultXml);

Parameters

Type	Name	Description
out String	Server Date and Time	The server’s UTC date and time.
out String	Result XML	Specify the variable for the XML output.

GetTopologyCommands

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

Syntax

GetTopologyCommands(reservationId,out commands,out parameters,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String matrix	Commands	All commands for driver associated with a topology in the specified reservation.
out String matrix	Command Parameters	Parameters associated with each command.
out String	Result XML	Specify the variable for the XML output.

GetEnvironmentCommands

Retrieves driver commands and parameters for a specified reservation.

Syntax

GetEnvironmentCommands(reservationId,out commands,out parameters,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String matrix	Commands	All commands for driver associated with a topology in the specified reservation.
out String matrix	Command Parameters	Parameters associated with each command.
out String	Result XML	Specify the variable for the XML output.

GetTopologyDetails

Retrieves all resources and attributes associated with the specified topology.

Syntax

GetTopologyDetails(topologyFullPath,out owner,out instructions,out resources,out attributes,out abstractResources,out abstractResourcesAttributes,out abstractResourcesRequiredAttributes,out routes,out driver,out globalInputs,out requirementsInputs,out additionalInfoInputs,out connectors,out connectorAttributes,out alias,out type,out state,out parentTopology,out services,out serviceAttributes,out apps, out maxDuration, out resultXml);

Parameters

Type	Name	Description
String	Topology Full Path	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.
out String	Owner	Owner of the topology.
out String	Instructions	Topology instructions.
out String matrix	Resources	Resources and resource values associated with the specified topology.
out String matrix	Attributes	Attributes and attribute values for resources associated with the specified topology.
out String matrix	Abstract Resources	Abstract resources and their associated values for the specified topology.
out String matrix	Abstract Resources Attributes	Attributes and attribute values for all abstract resources associated with the specified topology.
out String matrix	Abstract Resources Required Attributes	Required attributes and attribute values for all abstract resources associated with the specified topology (multiple possible values for a single attribute are displayed in different rows).
out String matrix	Route	Routes and route endpoints associated with the specified topology.
out String	Driver Name	The name of the driver associated with this topology.
out String matrix	Global Inputs	Global inputs associated with the specified topology.
out String matrix	Requirements Inputs	Requirements inputs associated with the specified topology.
out String matrix	Additional Info Inputs	Additional info inputs associated with the specified topology.
out String matrix	Connector	Connectors associated with the specified topology.
out String matrix	ConnectorAttributes	Visual connectors attributes associated with a specified connector.
out String	Topology Type	The Type of the topology.
out String	Topology State	The State of the topology.
out String matrix	Parent Topology	The Topology from which this topology was created.
out String matrix	Services	Matrix of service instances.
out String matrix	ServiceAttributes	Matrix of attributes of the services.
out String matrix	Apps	Matrix of apps.
out String	Maximum Duration	The maximun amount of time this topology can be reserved.
out String	Result XML	Specify the variable for the XML output.

GetTopologiesByCategory

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

Syntax

GetTopologiesByCategory(categoryName, categoryValue, out categoriesFullPath, out resultXml);

Parameters

Type	Name	Description
String	Category Name	Specify the category's name, If category name is not provided will return all topologies in domain.
String	Category Value	Specify the category's value/sub category
out String	Topologies Full Path	Specify full topology path for each topology that contains given category
out String	Result XML	Specify the variable for the XML output.

GetTopologyCategories

Retrieves all root categories from 'Environment' catalog.

Syntax

GetTopologyCategories(out categories, out resultXml);

Parameters

Type	Name	Description
out String vector	Categories	List of categories.
out String	Result XML	Specify the variable for the XML output.

GetCategories

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

Syntax

GetCategories(type, out resultXml);

Parameters

Type	Name	Description
String	type	Specify the categoriy type: Services, Environment or empty for both.
out String	Result XML	Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

GetUserDetails

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

Syntax

GetUserDetails(username,out userDetails,out resultXml);

Parameters

Type	Name	Description
String	Username	Specify the name of the user.
out String matrix	Users Details	User settings for the specified user.
out String	Result XML	Specify the variable for the XML output.

GetAbstractTemplateList

Retrieve a list of abstract templates.

Syntax

GetAbstractTemplateList(out abstractTemplates,out resultXml);

Parameters

Type	Name	Description
out String matrix	Abstract Templates	Abstract templates details.
out String	Result XML	Specify the variable for the XML output.

GetServices

Retrieve a list of services and their attributes.

Syntax

GetServices(categoryName,serviceName,out services,out serviceAttributes,out resultXml);

Parameters

Type	Name	Description
String	Category Name	The name of the category of the services you want to receive.
String	Service Name	The name of the service you want to receive.
out String matrix	Services	Matrix of services.
out String matrix	Service Attributes	Matrix of attributes of the services.
out String	Result XML	Specify the variable for the XML output.

GetReservationServicesPositions

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

Syntax

GetReservationServicesPositions(reservationId,out layout,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
out String matrix	Diagram Layout	All the services and their positions in the diagram.
out String	Result XML	Specify the variable for the XML output.

IncludeResource

Includes a specified resource.

Syntax

IncludeResource(resourceFullPath);

Parameters

Type	Name	Description
String	Resource Full Path	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.

IncludeResources

Includes the specified resources.

Syntax

IncludeResources(resourcesFullPath);

Parameters

Type	Name	Description
String vector	Resources Full Path	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

LockResource

Locks a specified resource.

Syntax

LockResource(reservationId,resourceFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.

LockResources

Locks multiple resources.

Syntax

LockResources(reservationId,resourcesFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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

Logoff

Logs out the current user.

Syntax

Logoff();

Parameters

Type	Name	Description

Logon

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.

Syntax

Logon(username,password,domainName);

Parameters

Type	Name	Description
String	Username	Username to logon with.
String	Password	Specify the user’s login password.
String	Domain Name	Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain.

LogoutTNSession

Logs the user out from a console port TN session.

Syntax

LogoutTNSession(reservationId,resourceFullPath,consolePortsFullPath,baudRate,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
String vector	Console Ports	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.
String	Baud Rate	Specify the baud rate to apply to the ports.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

MapPorts

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

Syntax

MapPorts(sourcePort,destinationPort,mappingType);

Parameters

Type	Name	Description
String	Source Port	Specify the source port.
String	Destination Port	Specify the destination port.
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.

PowerCycleResource

Cycles the power options for resource power ports.

Syntax

PowerCycleResource(reservationId,resourceFullPath,powerPortsFullPath,delay,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.
String	Resource Full Path	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.
String vector	Power Ports	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.
String	Delay	Specify the number of seconds to delay between each power cycle.
out String	Command Output	The power cycle results.
out String	Result XML	Specify the variable for the XML output.

PowerOffResource

Powers off specified power ports.

Syntax

PowerOffResource(reservationId,resourceFullPath,powerPortsFullPath,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.
String	Resource Full Path	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.
String vector	Power Ports	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.
out String	Command Output	The power off results.
out String	Result XML	Specify the variable for the XML output.

PowerOnResource

Powers on resource power ports.

Syntax

PowerOnResource(reservationId,resourceFullPath,powerPortsFullPath,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.
String	Resource Full Path	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.
String vector	Power Ports	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.
out String	Command Output	The power on results.
out String	Result XML	Specify the variable for the XML output.

RecheckConflicts

Updates the list of available resources for a reservation.

Syntax

RecheckConflicts(reservationId);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.

ReleaseResourcesFromReservation

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

Syntax

ReleaseResourcesFromReservation(reservationId,resourcesFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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.

ReleaseTopologyResources

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

Syntax

ReleaseTopologyResources(reservationId, topologyFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Topology Full Path	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.

RemoveGroupsFromDomain

Remove groups from a domain.

Syntax

RemoveGroupsFromDomain(domainName,groupNames);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String vector	Groups Names	Specify an array of one or more groups.

RemovePermittedUsersFromReservation

Remove one or more permitted users from the specified reservation.

Syntax

RemovePermittedUsersFromReservation(reservationId,usernames);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	User Names	List of permitted users to remove from the reservation.

RemoveResourcesFromDomain

Remove resources from a domain.

Syntax

RemoveResourcesFromDomain(domainName,resourcesNames);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String vector	Resources Full Path	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

RemoveResourcesFromReservation

Unlocks and removes resources from a reservation.

Syntax

RemoveResourcesFromReservation(reservationId,resourcesFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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
String	Shared	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

RemoveConnectorsFromReservation

Removes the mapped connector between given end points.

Syntax

RemoveConnectorsFromReservation(reservationId,endpoints,out connectors,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String matrix	Endpoints	The list of removed endpoints.
out String matrix	Removed Connectors	The list of removed connectors.
out String	Result XML	Specify the variable for the XML output.

RemoveRoutesFromReservation

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

Syntax

RemoveRoutesFromReservation(reservationId,endpoints,mappingType,out routes,out segments,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String matrix	Endpoints	The list of removed endpoints.
String	Mapping Type	Specify bidirectional or unidirectional as the mapping type.
out String matrix	Removed Routes	The list of removed routes.
out String matrix	Segments	The list of removed segments.
out String	Result XML	Specify the variable for the XML output.

RemoveTopologiesFromDomain

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

Syntax

RemoveTopologiesFromDomain(domainName,topologyNames);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String vector	Topologies Full Path	Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

RemoveUsersFromGroup

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

Syntax

RemoveUsersFromGroup(usernames,groupName);

Parameters

Type	Name	Description
String vector	Usernames	Specify an array of one or more users.
String	Group Name	Specify the name of the group.

RemoveTopologyCategory

Removes a category from given topology.

Syntax

RemoveTopologyCategory(topologyFullPath, categoryName);

Parameters

Type	Name	Description
String	Topology Full Path	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.
String	Category Name	Specify the category's name which we want to remove.

MoveResources

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

Syntax

MoveResources(resourcesName,targetFolder);

Parameters

Type	Name	Description
String vector	Resources Name	Specify the name of the root resources to move to the new target folder.
String	Target Folder	The path of the target folder.
out String	Result XML	Specify the variable for the XML output.

RenameResource

Renames the specified resource.

Syntax

RenameResource(resourceFullPath,resourceName);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Resource Name	Specify a new resource name.

ResetResourceDriver

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

Syntax

ResetResourceDriver(reservationId,resourceFullPath,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

RemoveAppFromReservation

Remove a deployed App resource from existing reservation.

Syntax

RemoveAppFromReservation(reservationId,appName);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	App Name	Specify the name of the App.

GetAppsDetailsInReservation

Retrieves information on Apps in the reservation.

Syntax

GetAppsDetailsInReservation(reservationId,appNames,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Apps Names	Specify the name of the Apps.

RemoveServicesFromReservation

Remove services and apps from existing reservation.

Syntax

RemoveServicesFromReservation(reservationId,services);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	List of aliases	List of aliases. This list should contain the aliases for both the services and apps that should be removed.

SaveReservationAsTopology

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

Syntax

SaveReservationAsTopology(reservationId,folderFullPath,topologyName,includeInactiveRoutes,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Folder Full Path	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.
String	Topology Name	Specify the new name for the new topology.
String	Include Inactive Routes	Include disconnected routes in the created topology
out String	Result XML	Specify the variable for the XML output.

SecureLogon

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

Syntax

SecureLogon(token,domainName);

Parameters

Type	Name	Description
String	Token	Token to logon with.
String	Domain Name	Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain.

SetAttributeValue

Sets the value of the specified attribute.

Syntax

SetAttributeValue(resourceFullPath,attributeName,attributeValue);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Attribute Name	Specify the attribute name.
String	Attribute Value	Specify the attribute’s value.

SetAttributesValues

Sets new attribute values for the specified resources.

Syntax

SetAttributesValues(resourcesAttributesUpdateRequests);

Parameters

Type	Name	Description
String matrix	Resources, Attributes, and Values	Specify a list of resources, attribute names, and new attribute values (up to 10000 rows).

SetBaudRate

Sets the baud rate for one or more console ports.

Syntax

SetBaudRate(reservationId,resourceFullPath,consolePortsFullPath,baudRate,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
String vector	Console Ports	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.
String	Baud Rate	Specify the baud rate to apply to the ports.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

SetConsoleForXModem

Sets one or more consoles for Xmodem.

Syntax

SetConsoleForXModem(reservationId,resourceFullPath,consolePortsFullPath,baudRate,out output,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.
String vector	Console Ports	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.
String	Baud Rate	Specify the baud rate to apply to the ports.
out String	Command Output	The command results.
out String	Result XML	Specify the variable for the XML output.

SetResourceLiveStatus

Sets the live status of the resource

Syntax

SetResourceLiveStatus(resourceFullPath,liveStatusName,additionalInfo,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Live Status Name	Resource live status name
String	Additional Info	Resource live status additional info
out String	Result XML	Resource live status additional info

SetReservationLiveStatus

Sets the live status of the reservation

Syntax

SetReservationLiveStatus(reservationId, liveStatusName, additionalInfo);

Parameters

Type	Name	Description
String	Reservation id	Specifies the string that represents the reservation’s unique identifier.
String	Live Status Name	Reservation live status name
String	Additional Info	Reservation live status additional info

SetResourceSharedState

Sets the resource sharing state.

Syntax

SetResourceSharedState(reservationId,resourcesFullName,isShared);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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
String	Is Shared	Specify whether to allow sharing of the resource.

SetRouteAttributes

Sets attributes and associated values for a specified route.

Syntax

SetRouteAttributes(reservationId,sourceResourceFullPath,targetResourceFullPath,applyChangesTo,attributeRequests);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Source Resource	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.
String	Target Resource	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.
String	Apply Changes To	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.
String vector	Attribute Requests	Specify an array of attributes and associated attribute values.

SetRouteAttributesViaAlias

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

Syntax

SetRouteAttributesViaAlias(reservationId,routeAlias,applyChangesTo,attributeRequests);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Route Alias	Specify the route’s alias.
String	Apply Changes To	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.
String vector	Attribute Requests	Specify an array of attributes and associated attribute values.

SetConnectorAttributes

Sets attributes and associated values for a specified connector.

Syntax

SetConnectorAttributes(reservationId,sourceResourceFullPath,targetResourceFullPath,attributeRequests);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Source Resource	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.
String	Target Resource	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.
String matrix	Attribute Requests	Specify a matrix of attributes and associated attribute values.

SetConnectorAttributesViaAlias

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

Syntax

SetConnectorAttributesViaAlias(reservationId,connectorAlias,attributeRequests);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Connector Alias	Specify the connector’s alias.
String matrix	Attribute Requests	Specify a matrix of attributes and associated attribute values.

SetGroupDomainPermissions

Set the permission level of a group in domain.

Syntax

SetGroupDomainPermission(domainName,groupName,viewOnly);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String	Groups Name	Specify the group name.
String	View Only	Specify if the group should be have view only permissions.

SetConnectorsInReservation

Adds connectors between source and target or update existing ones.

Syntax

SetConnectorsInReservation(reservationId, connectors, out setConnectors);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String matrix	Connectors	List of connectors to set in the reservation.
out String matrix	Connectors	Visual connectors associated with the specified reservation.

SetTopologyCategory

Set a category to given topology

Syntax

SetTopologyCategory(topologyFullPath, categoryName, categoryValue);

Parameters

Type	Name	Description
String	Topology Full Path	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.
String	Category Name	Specify the category's name which we want to set
String	Category Value	Specify the category's value

SyncResourceFromDevice

Synchronizes the specified resource with current device settings and mappings.

Syntax

SyncResourceFromDevice(resourceFullPath,out errorMessage,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String	Error Message	Returns any error messages from the resource synchronization.
out String	Result XML	Specify the variable for the XML output.

SyncResourceToDevice

Updates device settings and mappings from the specified resource.

Syntax

SyncResourceToDevice(resourceFullPath,out errorMessage,out resultXml);

Parameters

Type	Name	Description
String	Resource Full Path	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.
out String	Error Message	Returns any error messages from the resource synchronization.
out String	Result XML	Specify the variable for the XML output.

SetReservationResourcePosition

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

Syntax

SetReservationResourcePosition(reservationId,resourceFullPath,x,y);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Name	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.
String	x	Specify the x coordinate of the resource's top left corner.
String	y	Specify the y coordinate of the resource's top left corner.
out String	Result XML	Specify the variable for the XML output.

SetServiceDriver

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

Syntax

SetServiceDriver(serviceName,driverName);

Parameters

Type	Name	Description
String	Service Name	Specify the name of the service model.
String	Driver Name	Specify the name of the driver.
out String	Result XML	Specify the variable for the XML output.

SetServiceLiveStatus

Sets the live status of a service

Syntax

SetServiceLiveStatus(reservationId, serviceAlias, liveStatusName, additionalInfo);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation's unique identifier.
String	Service Alias	Specify the string that represents the service's alias.
String	Live Status Name	Resource live status name
String	Additional Info	Resource live status additional info

SetReservationServicePosition

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

Syntax

SetReservationServicePosition(reservationId,serviceAlias,x,y);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Service Alias	Specify the alias of the service.
String	x	Specify the x coordinate of the resource's top left corner.
String	y	Specify the y coordinate of the resource's top left corner.

SetServiceAttributesValues

Sets attributes and associated values for a specified resource.

Syntax

SetServiceAttributesValues(reservationId,serviceAlias,attributeRequests);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Service Alias	Specify the service name.
String matrix	Attribute Requests	Specify a matrix of attributes and associated attribute values.
out String	Result XML	Specify the variable for the XML output.

TerminateReservation

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

Syntax

TerminateReservation(reservationId);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.

UnlockResource

Unlocks the specified resource.

Syntax

UnlockResource(reservationId,resourceFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Resource Full Path	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.

UnlockResources

Unlocks multiple resources.

Syntax

UnlockResources(reservationId,resourcesFullPath);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String vector	Resources Full Path	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

UnMapPorts

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

Syntax

UnMapPorts(portA,portB);

Parameters

Type	Name	Description
String	Port A	Specify the source port. (i.e. Folder1/Chassis1/Blade1/Port1).
String	Port B	Specify the destination port. (i.e. Folder1/Chassis1/Blade1/Port1).

UpdateConnectorAliasInReservation

Sets alias for a specified connector.

Syntax

UpdateConnectorAliasInReservation(reservationId,sourceResourceFullName,targetResourceFullName,direction,alias);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Source Resource	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.
String	Target Resource	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.
String	Direction	Specify bidirectional or unidirectional as the connector direction.
String	Connector Alias	Specify the connector’s alias.

UpdateConnectionWeight

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

Syntax

UpdateConnectionWeight(resourceAFullPath,resourceBFullPath,weight);

Parameters

Type	Name	Description
String	Resource A Full Path	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.
String	Resource B Full Path	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.
Numeric	Physical Connection Weight	Specify a number to represent the connection weight between the specified resources.

UpdateDomainTopologiesFolder

Update the domain’s topologies folder.

Syntax

UpdateDomainTopologiesFolder(domainName,topologiesFolder);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
String	Topology Full Path	Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.

UnarchiveDomain

Unarchive a domain. New reservation can be created.

Syntax

UnarchiveDomain(domainName,out resultXml);

Parameters

Type	Name	Description
String	Domain Name	Specify the name of the domain.
out String	Result XML	Specify the variable for the XML output.

UpdateGroup

Modifies the group name and description.

Syntax

UpdateGroup(groupName,newName,description,groupRole);

Parameters

Type	Name	Description
String	Group Name	Specify the name of the group.
String	New Group Name	Specify the new group name.
String	Description	Provide a short description of the group.
String	Group Role	Specify the role of the group, possible values: External, Regular, DomainAdmin or Ignore (to keep the current role).

UpdatePhysicalConnection

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

Syntax

UpdatePhysicalConnection(resourceAFullPath,resourceBFullPath,overrideExistingConnections);

Parameters

Type	Name	Description
String	Resource A Full Path	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.
String	Resource B Full Path	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.
String	Override existing	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.

UpdatePhysicalConnections

Define physical connections (cable links) between resources.

Syntax

UpdatePhysicalConnections(physicalConnectionsUpdateRequests,overrideExistingConnections);

Parameters

Type	Name	Description
String matrix	Physical Connections	Specify a list of physical connections to update.
String	Override existing	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.

UpdateReservationDescription

Modifies the description for a specified reservation.

Syntax

UpdateReservationDescription(reservationId,description);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation ID.
String	Description	Provide an updated description of the reservation. This text will replace the current description.

UpdateReservationName

Modifies the name for a specified reservation.

Syntax

UpdateReservationName(reservationId,name);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation ID.
String	Name	Provide an updated name of the reservation. This text will replace the current name.

UpdateReservationGlobalInputs

Updates the unlinked global inputs in a specified reservation.

Syntax

UpdateReservationGlobalInputs(reservationId, globalInputs,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation ID.
String matrix	Global Inputs	Global inputs associated with the specified reservation.

ChangeReservationOwner

Updates the owner in a specified reservation.

Syntax

ChangeReservationOwner(reservationId, ownerName, out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specify the reservation ID.
String	Owner Name	New owner for the reservation.

UpdateResourceAddress

Modifies the address for a specified resource.

Syntax

UpdateResourceAddress(resourceFullPath,resourceAddress);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Resource Address	Specify the resource’s new address.

UpdateResourceDescription

Modifies the description for a specified resource.

Syntax

UpdateResourceDescription(resourceFullPath,resourceDescription);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Resource description	Provide an updated description of the resource. This text will replace the current description.

UpdateResourceDriver

Updates the driver for a specified resource.

Syntax

UpdateResourceDriver(resourceFullPath,driverName);

Parameters

Type	Name	Description
String	Resource Full Path	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.
String	Driver Name	Specify the name of the driver.

UpdateTopologyOwner

Update the topology owner.

Syntax

UpdateTopologyOwner(topologyName,ownerName);

Parameters

Type	Name	Description
String	Topology Full Path	Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
String	Topology Owner	Specify the topology owner.

UpdateTopologyDriver

Update the topology driver.

Syntax

UpdateTopologyDriver(topologyFullPath,driverName);

Parameters

Type	Name	Description
String	Topology Full Path	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.
String	Driver Name	Specify the name of the driver. Leave empty to remove associated driver.

UpdateUser

Configures a user's email and activity settings.

Syntax

UpdateUser(username,email,isActive);

Parameters

Type	Name	Description
String	Username	The username of the user you want to update.
String	Email	The new email address to update to.
String	Is Active	Grant or deny active access to the application.

UpdateUsersLimitations

Update MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes and MaxOwnedBlueprints.

Syntax

UpdateUsersLimitations(userUpdateRequests);

Parameters

Type	Name	Description
String matrix	UserUpdateRequests	List of Username, MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes, and MaxOwnedBlueprints of the users you wish to update.

UpdateUserGroups

Update an existing user's groups (replaces existing user's groups).

Syntax

UpdateUserGroups(username,groupsNames);

Parameters

Type	Name	Description
String	Username	Specify the name of the user.
String vector	Groups Names	Use this method to update a user's group memberships. Activating this method will replace the user's memberships with the specified list of groups.

UpdateUserPassword

Changes a user's password.

Syntax

UpdateUserPassword(username,newPassword);

Parameters

Type	Name	Description
String	Username	Specify the name of the user.
String	Password	Specify the user's new login password.

UpdateRouteAliasesInReservation

Update route aliases in a reservation.

Syntax

UpdateRouteAliasesInReservation(reservationId,routeAliases,out resultXml);

Parameters

Type	Name	Description
String	Reservation ID	Specifies the string that represents the reservation’s unique identifier.
String matrix	Source Target Alias	Specify a matrix of route source, route target and alias.
out String	Result XML	Specify the variable for the XML output.

UpdateDriver

Uploads a new version of an existing driver

Syntax

UpdateDriver(driverName, pathToDriver);

Parameters

Type	Name	Description
String	Driver Name	Specify the driver name.
String	Drive File Data	Specify the driver file data (base64 file representation).
String	Driver File Name	Specify the driver file name(optional).

UpdateScript

Uploads a new version of an existing script

Syntax

UpdateScript(scriptName, pathToScript);

Parameters

Type	Name	Description
String	Script Name	Specify the script name.
String	Script File Data	Specify the script file data (base64 file representation).
String	Script File Name	Specify the script file name(optional).

WriteMessageToReservationOutput

Allows sending output to the command output window in a reservation.

Syntax

WriteMessageToReservationOutput(reservationId, message);

Parameters

Type	Name	Description
String	Reservation ID	Specify the string that represents the reservation’s unique identifier.
String	Output message	Output message to the command output window.
out String	Result XML	Specify the variable for the XML output.