2024.1.0 TestShell API TCL Reference Guide

ActivateTopologyActivate a topology.

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

Syntax 

::TestShellAPI::ActivateTopology reservationId topologyFullPath ?resultXml?

Parameters

TypeNameDescription
string reservationId
Specify the string that represents the reservation’s unique identifier.
string topologyFullPath
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 ?resultXml?
Specify the variable for the XML output.
If a variable is not provided, the results will be sent to stdout.

Example

::TestShellAPI::ActivateTopology $reservationId "Temp Automation Resources/TP1" resultXml

Output

  • resultXml
    • 				<ResponseInfo Name="TP1" MachineName="PRODUCT-W7 - Tcl" Username="admin" Topology="TP1">
				<Resources>
				<ResourceInfo Name="Router 1234" FolderFullPath="Lab Routers" Address="192.168.1.201" FullAddress="192.168.1.201" RootAddress="192.168.1.201" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Alias="Router 1234" Locked="false">
				<ResourceAttributes>
				<ResourceAttribute Name="SW_Version" Value="" Type="String"/>
				</ResourceAttributes>
				<LockInfo/>
				</ResourceInfo>
				<ResourceInfo Name="L1 Switch 1234/Blade 1/Port 1" FolderFullPath="Temp Automation Resources" Address="1" FullAddress="192.168.43.240/1/1" RootAddress="192.168.43.240" ResourceFamilyName="L1 Switch Port" ResourceModelName="Port EMPMC-36RJ" Alias="" Locked="true">
				<ResourceAttributes>
				<ResourceAttribute Name="Shutdown" Value="Disable" Type="Lookup"/>
				<ResourceAttribute Name="Linked" Value="False" Type="String"/>
				<ResourceAttribute Name="Shutdown Unmapped" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="LIN" Value="Disable" Type="Lookup"/>
				<ResourceAttribute Name="Auto Negotiation" Value="True" Type="Boolean"/>
				<ResourceAttribute Name="Speed" Value="10 Mbps" Type="Lookup"/>
				<ResourceAttribute Name="Duplex" Value="Full" Type="Lookup"/>
				<ResourceAttribute Name="Link Match" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="MDI" Value="AutoSense" Type="Lookup"/>
				<ResourceAttribute Name="Auto Negotiation Advertise" Value="Other/Uknown" Type="Lookup"/>
				</ResourceAttributes>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/GenericResource 1234/Port 1"/>
				</ResourceInfo>
				<ResourceInfo Name="L1 Switch 1234/Blade 1/Port 2" FolderFullPath="Temp Automation Resources" Address="2" FullAddress="192.168.43.240/1/2" RootAddress="192.168.43.240" ResourceFamilyName="L1 Switch Port" ResourceModelName="Port EMPMC-36RJ" Alias="" Locked="true">
				<ResourceAttributes>
				<ResourceAttribute Name="Shutdown" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="Linked" Value="False" Type="String"/>
				<ResourceAttribute Name="Shutdown Unmapped" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="LIN" Value="Disable" Type="Lookup"/>
				<ResourceAttribute Name="Auto Negotiation" Value="True" Type="Boolean"/>
				<ResourceAttribute Name="Speed" Value="1 Gbps" Type="Lookup"/>
				<ResourceAttribute Name="Duplex" Value="Full" Type="Lookup"/>
				<ResourceAttribute Name="Link Match" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="MDI" Value="AutoSense" Type="Lookup"/>
				<ResourceAttribute Name="Auto Negotiation Advertise" Value="Other/Uknown" Type="Lookup"/>
				</ResourceAttributes>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/GenericResource 1234/Port 2"/>
				</ResourceInfo>
				<ResourceInfo Name="L1 Switch 1234/Blade 1/Port 3" FolderFullPath="Temp Automation Resources" Address="3" FullAddress="192.168.43.240/1/3" RootAddress="192.168.43.240" ResourceFamilyName="L1 Switch Port" ResourceModelName="Port EMPMC-36RJ" Alias="" Locked="true">
				<ResourceAttributes>
				<ResourceAttribute Name="Shutdown" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="Linked" Value="False" Type="String"/>
				<ResourceAttribute Name="Shutdown Unmapped" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="LIN" Value="Disable" Type="Lookup"/>
				<ResourceAttribute Name="Auto Negotiation" Value="True" Type="Boolean"/>
				<ResourceAttribute Name="Speed" Value="1 Gbps" Type="Lookup"/>
				<ResourceAttribute Name="Duplex" Value="Full" Type="Lookup"/>
				<ResourceAttribute Name="Link Match" Value="Enable" Type="Lookup"/>
				<ResourceAttribute Name="MDI" Value="AutoSense" Type="Lookup"/>
				<ResourceAttribute Name="Auto Negotiation Advertise" Value="Other/Uknown" Type="Lookup"/>
				</ResourceAttributes>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Lab Routers/Router 1234/Port 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234" FolderFullPath="Temp Automation Resources" Address="192.168.1.20" FullAddress="192.168.1.20" RootAddress="192.168.1.20" ResourceFamilyName="Generic Resource" ResourceModelName="Generic Resource Model" Alias="GenericResource 1234" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/Port 1" FolderFullPath="Temp Automation Resources" Address="1" FullAddress="192.168.1.20/1" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 1" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/Port 2" FolderFullPath="Temp Automation Resources" Address="2" FullAddress="192.168.1.20/2" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 2" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 2"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/PowerPort 11" FolderFullPath="Temp Automation Resources" Address="11" FullAddress="192.168.1.20/11" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="PowerPort 11" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/SmartPower2L 1234/PowerPort 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/PowerPort 12" FolderFullPath="Temp Automation Resources" Address="12" FullAddress="192.168.1.20/12" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="PowerPort 12" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/SmartPower2L 1234/PowerPort 2"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/ConsolePort 21" FolderFullPath="Temp Automation Resources" Address="21" FullAddress="192.168.1.20/21" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="ConsolePort 21" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/ConsoleServer 1234/ConsolePort 1"/>
				</ResourceInfo>
				<ResourceInfo Name="Router 1234/Port 1" FolderFullPath="Lab Routers" Address="1" FullAddress="192.168.1.201/1" RootAddress="192.168.1.201" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 1" Locked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T18:03:50"/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3"/>
				</ResourceInfo>
				</Resources>
				<Routes>
				<Route Source="Temp Automation Resources/GenericResource 1234/Port 1" Target="Lab Routers/Router 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Temp Automation Resources/GenericResource 1234/Port 1" Target="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 1" Target="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3" Target="Lab Routers/Router 1234/Port 1"/>
				</Segments>
				</Route>
				<Route Source="Lab Routers/Router 1234/Port 1" Target="Temp Automation Resources/GenericResource 1234/Port 2" RouteType="uni" Shared="true">
				<Segments>
				<Segment Source="Lab Routers/Router 1234/Port 1" Target="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3" Target="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 2"/>
				<Segment Source="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 2" Target="Temp Automation Resources/GenericResource 1234/Port 2"/>
				</Segments>
				</Route>
				</Routes>
				<Connectors>
				</Connectors>
				</ResponseInfo>

    back to TOC

    AddGroupsToDomainAdd groups to a domain.

    Add groups to a domain.

    Syntax 

    ::TestShellAPI::AddGroupsToDomain domainName groupNames readOnly ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    list groupNames
    Specify an array of one or more groups.
    boolean readOnly
    Specify if the array of group should be added with view only permissions.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddGroupsToDomain Global {QA_Users RND_Users} 0 resultXml

    back to TOC

    AddNewDomainAdds a new domain.

    Adds a new domain.

    Syntax 

    ::TestShellAPI::AddNewDomain domainName description ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string description
    Specify the description of the domain.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddNewDomain Domain1 "My Domain" resultXml

    back to TOC

    AddNewGroupAdd a new group.

    Adds a new users group

    Syntax 

    ::TestShellAPI::AddNewGroup groupName description groupRole ?resultXml?

    Parameters

    TypeNameDescription
    string groupName
    Specify the name of the group.
    string description
    Provide a short description of the group.
    string groupRole
    Specify the role of the group, possible values: External, Regular, DomainAdmin.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddNewGroup QA_Users "QA users" resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="QA_Users" Description="QA users">
				<TestShellDomains/>
				</ResponseInfo>

    back to TOC

    AddNewUserAdd a new TestShell user.

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

    Syntax 

    ::TestShellAPI::AddNewUser username password email isActive isAdmin ?resultXml?

    Parameters

    TypeNameDescription
    string username
    Specify the name of the user.
    string password
    Specify the user’s login password.
    string email
    Specify the user’s email address.
    boolean isActive
    Grant or deny active access to the application.
    boolean isAdmin
    Add the user to the System Administrators group.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddNewUser User1234 pass1234 user1234@work.com 1 0 resultXml

    Output

  • resultXml
    • <ResponseInfo xsi:type="UserInfo" Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com"/>

    back to TOC

    AddPermittedUsersToReservationAdd permitted users to a reservation.

    Add one or more permitted users to the specified reservation.

    Syntax 

    ::TestShellAPI::AddPermittedUsersToReservation reservationId usernames ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list usernames
    List of users to permit access to the reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddPermittedUsersToReservation "2d2f7cde-20g3-4bac-80d2-e8cfhecef45b" {"name1"} resultXml

    back to TOC

    AddResourcesToDomainAdd resources to a domain.

    Add resources to a domain.

    Syntax 

    ::TestShellAPI::AddResourcesToDomain domainName resourcesNames includeDecendants ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    list resourcesNames
    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
    boolean includeDecendants
    Specify whether to include child resources.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddResourcesToDomain Domain1 {"Router 1234" "GenericResource 1234"} 1 resultXml

    back to TOC

    AddResourcesToReservationReserve resources for locking.

    Reserves resources to be locked.

    Syntax 

    ::TestShellAPI::AddResourcesToReservation reservationId resourcesFullPath shared ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullPath
    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
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddResourcesToReservation $reservationId {"Router 1234" "GenericResource 1234"} 1 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Conflicts/>
				</ResponseInfo>

    back to TOC

    AddRoutesToReservationReserve specified routes.

    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 

    ::TestShellAPI::AddRoutesToReservation reservationId sourceResourcesFullPath targetResourcesFullPath mappingType maxHops routeAlias isShared ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list sourceResourcesFullPath
    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
    list targetResourcesFullPath
    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 mappingType
    Specify bidirectional or unidirectional as the mapping type.
    Use 'bi' for bidirectional mapping or 'uni' for unidirectional mapping.
    number maxHops
    Specify the maximum number or allowed hops.
    string routeAlias
    Specify the route’s alias.
    boolean isShared
    Specify whether these routes are shared. Shared routes can be used in more than one reservation.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddRoutesToReservation $reservationId {"Router 1234/Port 1"} {"GenericResource 1234/Port 1"} bi 2 "a route" 0 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 1" Target="GenericResource 1234/Port 1"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

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

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

    Syntax 

    ::TestShellAPI::AddTopologiesToDomain domainName topologyNames validateResourceAvailability ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    list topologyNames
    Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
    boolean validateResourceAvailability
    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.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddTopologiesToDomain Domain1 {Topology1 Topology2} resultXml

    back to TOC

    AddUsersToGroupAdd users to a group.

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

    Syntax 

    ::TestShellAPI::AddUsersToGroup usernames groupName ?resultXml?

    Parameters

    TypeNameDescription
    list usernames
    Specify an array of one or more users.
    string groupName
    Specify the name of the group.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddUsersToGroup {User1234 User2345} QA_Users resultXml

    back to TOC

    AutoLoadOverwrite switch settings with current data.

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

    Syntax 

    ::TestShellAPI::AutoLoad resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AutoLoad "L1 Switch 1234" resultXml

    back to TOC

    AddAttributeRestrictedValuesadd attribute restrictions

    add attribute restrictions to family/model

    Syntax 

    ::TestShellAPI::AddAttributeRestrictedValues addAttributeRestrictionRequests ?resultXml?

    Parameters

    TypeNameDescription
    list addAttributeRestrictionRequests
    Attribute restrictions to add.
    string ?resultXml?
    Specify the variable for the XML output.

    Example

    ::TestShellAPI::AddAttributeRestrictedValues "a" resultXml

    Output

  • resultXml
    • <ResponseInfo Password="addAttributeRestrictionRequests">

    back to TOC

    ArchiveDomainArchive the domain

    Archive a domain. All future reservation will be deleted.

    Syntax 

    ::TestShellAPI::ArchiveDomain domainName ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ArchiveDomain "Domain1" resultXml

    back to TOC

    AddAppToReservationAdd an App resource to an existing reservation.

    Add an App resource to an existing reservation.

    Syntax 

    ::TestShellAPI::AddAppToReservation reservationId appName deploymentPath positionX positionY ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string appName
    Specify the App template's name.
    string deploymentPath
    Specify the way the app will be deploy from a given list of options.
    string positionX
    Specify the x coordinate of the App's top left corner.
    string positionY
    Specify the y coordinate of the App's top left corner.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddAppToReservation 077e6b4f-5e70-46b5-aa4b-43e6f039acc3 "Demo App Template" "vCenter VM From Template" 100 100 resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="AddAppToReservationResponseInfo" ReservedAppName="Added app">
				</ResponseInfo>

    back to TOC

    AddServiceToReservationAdd service resource to existing reservation.

    Add service resource to existing reservation.

    Syntax 

    ::TestShellAPI::AddServiceToReservation reservationId serviceName alias attributes ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string serviceName
    Specify the service name.
    string alias
    Specify the service alias.
    list attributes
    Specify a matrix of attributes and associated attribute values.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddServiceToReservation 077e6b4f-5e70-46b5-aa4b-43e6f039acc3 "serviceName" "alias" {{"attribute01" "value01"} {"attribute02" "value02"}} resultXml

    Output

  • resultXml
    • 				<ResponseInfo/>

    back to TOC

    CopyDomainsResourcesCopy resources to a domain.

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

    Syntax 

    ::TestShellAPI::CopyDomainsResources domainNameSources domainNameDestination ?resultXml?

    Parameters

    TypeNameDescription
    list domainNameSources
    Specify the names of the source domains.
    string domainNameDestination
    Specify the name of the target domain.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CopyDomainsResources {"Domain1" "Domain2"} Domain3 resultXml

    back to TOC

    ClearAndResetConsoleClear and reset consoles.

    Clears and resets specified resource console ports.

    Syntax 

    ::TestShellAPI::ClearAndResetConsole reservationId resourceFullPath consolePortsFullPath baudRate ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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.
    list consolePortsFullPath
    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 baudRate
    Specify the baud rate to apply to the ports.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ClearAndResetConsole $reservationId "GenericResource 1234" {"GenericResource 1234/ConsolePort 21" "GenericResource 1234/ConsolePort 22"} 9600 resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    ConnectRoutesInReservationConnects a list of routes.

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

    Syntax 

    ::TestShellAPI::ConnectRoutesInReservation reservationId endpoints mappingType ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list endpoints
    The routes’ endpoints to connect.
    string mappingType
    Specify bidirectional or unidirectional as the mapping type.
    Use 'bi' for bidirectional mapping or 'uni' for unidirectional mapping.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ConnectRoutesInReservation $reservationId {"Router 1234/Port 1" "GenericResource 1234/Port 1"} bi resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 1" Target="GenericResource 1234/Port 1"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    CreateFolderAdd a new folder.

    Adds a new folder to the specified path.

    Syntax 

    ::TestShellAPI::CreateFolder folderFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string folderFullPath
    Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateFolder "Lab Routers" resultXml

    back to TOC

    CreateImmediateReservationCreate an imminent reservation.

    Defines a reservation to be started immediately.

    Syntax 

    ::TestShellAPI::CreateImmediateReservation reservationName owner durationInMinutes notifyOnStart notifyOnEnd notificationMinutesBeforeEnd notifyOnSetupComplete isTerminationProtectionEnabled approvalSid ?resultXml?

    Parameters

    TypeNameDescription
    string reservationName
    Specify the name of the reservation.
    string owner
    Specify the user name of the reservation owner.
    number durationInMinutes
    Specify the length of the reservation. (in minutes)
    boolean notifyOnStart
    Indicate whether to notify the reservation owner when the reservation starts.
    boolean notifyOnEnd
    Indicate whether to notify the reservation owner when the reservation ends.
    number notificationMinutesBeforeEnd
    Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled)
    boolean isTerminationProtectionEnabled
    Indicate whether to protect the reservation from being terminated.
    string approvalSid
    Leave empty. Used for internal purposes.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateImmediateReservation "immediate reservation" "admin" 30 0 0 0 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservation Id="28cb2a71-c8fc-4f41-a22b-e65685ebed14" Name="Immediate reservation" StartTime="2012-06-20T15:05:00" EndTime="2012-06-20T15:35:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Active" ActualEndTime="" CreateDate="2012-06-20T15:05:06" ModificationDate="2012-06-20T15:05:06">
				<Topologies/>
				</Reservation>
				</ResponseInfo>

    back to TOC

    CreateImmediateTopologyReservationCreate an imminent reservation.

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

    Syntax 

    ::TestShellAPI::CreateImmediateTopologyReservation reservationName owner durationInMinutes notifyOnStart notifyOnSetupComplete notifyOnEnd notificationMinutesBeforeEnd topologyFullPath globalInputs requirementsInputs additionalInfoInputs ?resultXml?

    Parameters

    TypeNameDescription
    string reservationName
    Specify the name of the reservation.
    string owner
    Specify the user name of the reservation owner.
    number durationInMinutes
    Specify the length of the reservation. (in minutes)
    boolean notifyOnStart
    Indicate whether to notify the reservation owner when the reservation starts.
    boolean notifyOnSetupComplete
    Indicate whether to notify the reservation owner when the reservation setup completes.
    boolean notifyOnEnd
    Indicate whether to notify the reservation owner when the reservation ends.
    number notificationMinutesBeforeEnd
    Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled)
    string topologyFullPath
    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.
    list globalInputs
    Global inputs associated with the specified topology.
    list requirementsInputs
    Requirements inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value', 'AttributeType';]}, AttributeType can be one of the following: Attributes/Models/Quantity. The Value field can be used to input to requirement fields with different operator types. If pass value as is, it will be treated as "equals", for example if pass "5" it will indicate to system that seek requirement that fulfills =5 Other operators (aside from equals) can be fulfilled using this convention: in the value field, write use the format symbol[space]value for example for numeric values > 4 < 4 >= 4 <= 4 = 4 != 4 for textual values = "hi there" != "hi there" startswith hi there endswith hi there contains hi there doesnotcontain hi there
    list additionalInfoInputs
    Additional info inputs associated with the specified topology.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateImmediateTopologyReservation "immediate reservation" "admin" 30 0 0 0 "Temp Automation Resources/TP1" {{"GlobalInputName_0" "GlobalInputValue_0"} {"GlobalInputName_1" "GlobalInputValue_1"}} {{"ResourceName_0" "RequiredInputName_0" "RequiredInputValue_0" "RequiredInputType_0"}} {{"ResourceName_0" "AdditionalInfoName_0" "AdditionalInfoValue_0"}} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservation Id="28cb2a71-c8fc-4f41-a22b-e65685ebed14" Name="Immediate reservation" StartTime="2012-06-20T15:05:00" EndTime="2012-06-20T15:35:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Active" ActualEndTime="" CreateDate="2012-06-20T15:05:06" ModificationDate="2012-06-20T15:05:06">
				<Topologies/>
				</Reservation>
				</ResponseInfo>

    back to TOC

    CreateReservationCreate a reservation.

    Defines a new reservation.

    Syntax 

    ::TestShellAPI::CreateReservation reservationName owner startTime endTime notifyOnStart notifyOnEnd notifyOnSetupComplete notificationMinutesBeforeEnd isTerminationProtectionEnabled approvalSid ?resultXml?

    Parameters

    TypeNameDescription
    string reservationName
    Specify the name of the reservation.
    string owner
    Specify the user name of the reservation owner.
    string startTime
    The start time of the reservation.
    string endTime
    The end time of the reservation.
    boolean notifyOnStart
    Indicate whether to notify the reservation owner when the reservation starts.
    boolean notifyOnEnd
    Indicate whether to notify the reservation owner when the reservation ends.
    number notificationMinutesBeforeEnd
    Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled)
    boolean isTerminationProtectionEnabled
    Indicate whether to protect the reservation from being terminated.
    string approvalSid
    Leave empty. Used for internal purposes.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateReservation "test reservation" "admin" "01/01/1970 00:00" "12/21/2012 00:00" 1 1 10 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservation Id="af626b88-458b-4e7a-9054-c03d8cffa260" Name="test reservation" StartTime="2015-01-01T10:00:00" EndTime="2015-01-01T11:00:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Pending" ActualEndTime="" CreateDate="2012-06-20T10:40:47" ModificationDate="2012-06-20T10:40:47">
				<Topologies/>
				</Reservation>
				</ResponseInfo>

    back to TOC

    CreateTopologyReservationCreate a reservation.

    Defines a new reservation.

    Syntax 

    ::TestShellAPI::CreateTopologyReservation reservationName owner startTime endTime notifyOnStart notifyOnSetupComplete notifyOnEnd notificationMinutesBeforeEnd topologyFullPath globalInputs requirementsInputs additionalInfoInputs ?resultXml?

    Parameters

    TypeNameDescription
    string reservationName
    Specify the name of the reservation.
    string owner
    Specify the user name of the reservation owner.
    string startTime
    The start time of the reservation.
    string endTime
    The end time of the reservation.
    boolean notifyOnStart
    Indicate whether to notify the reservation owner when the reservation starts.
    boolean notifyOnSetupComplete
    Indicate whether to notify the reservation owner when the reservation setup completes.
    boolean notifyOnEnd
    Indicate whether to notify the reservation owner when the reservation ends.
    number notificationMinutesBeforeEnd
    Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled)
    string topologyFullPath
    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.
    list globalInputs
    Global inputs associated with the specified topology.
    list requirementsInputs
    Requirements inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value', 'AttributeType';]}, AttributeType can be one of the following: Attributes/Models/Quantity. The Value field can be used to input to requirement fields with different operator types. If pass value as is, it will be treated as "equals", for example if pass "5" it will indicate to system that seek requirement that fulfills =5 Other operators (aside from equals) can be fulfilled using this convention: in the value field, write use the format symbol[space]value for example for numeric values > 4 < 4 >= 4 <= 4 = 4 != 4 for textual values = "hi there" != "hi there" startswith hi there endswith hi there contains hi there doesnotcontain hi there
    list additionalInfoInputs
    Additional info inputs associated with the specified topology.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateTopologyReservation "test reservation" "admin" "01/01/1970 00:00" "12/21/2012 00:00" 1 1 10 "Temp Automation Resources/TP1" {{"GlobalInputName_0" "GlobalInputValue_0"} {"GlobalInputName_1" "GlobalInputValue_1"}} {{"ResourceName_0" "RequiredInputName_0" "RequiredInputValue_0" "RequiredInputType_0"}} {{"ResourceName_0" "AdditionalInfoName_0" "AdditionalInfoValue_0"}} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservation Id="af626b88-458b-4e7a-9054-c03d8cffa260" Name="test reservation" StartTime="2015-01-01T10:00:00" EndTime="2015-01-01T11:00:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Pending" ActualEndTime="" CreateDate="2012-06-20T10:40:47" ModificationDate="2012-06-20T10:40:47">
				<Topologies/>
				</Reservation>
				</ResponseInfo>

    back to TOC

    CreateResourceAdd a new resource.

    Adds a new resource.

    Syntax 

    ::TestShellAPI::CreateResource resourceFamily resourceModel resourceName resourceAddress folderFullPath parentResourceFullPath resourceDescription ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFamily
    Specify the name of the resource family (optional).
    string resourceModel
    Specify the resource model.
    string resourceName
    Specify the resource name.
    string resourceAddress
    Specify the resource address.
    string folderFullPath
    Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
    string parentResourceFullPath
    Specify the full path from the root to a parent resource, separated by slashes. For example: Traffic Generators/Generic.
    string resourceDescription
    Provide a short description to help identify the resource.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example


    #create chassis
    ::TestShellAPI::CreateResource "Generic Chassis" "Generic Chassis Model" "Router 1234" "192.168.1.200" "Lab Routers" "" "a generic router" resultXml
    #create a child port for the chassis
    ::TestShellAPI::CreateResource "Generic Port" "Generic Port Model" "Port 1" "1" "Lab Routers" "Router 1234" "a generic router port" resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="Router 1234" FolderFullPath="Lab Routers" Address="192.168.1.200" FullAddress="192.168.1.200" RootAddress="192.168.1.200" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Locked="false" Excluded="false" Description="a generic router">
				<ResourceAttributes>
				<ResourceAttribute Name="SW_Version" Value="" Type="String"/>
				</ResourceAttributes>
				<Domains/>
				<ChildResources/>
				<LockInfo/>
				</ResponseInfo>
				<ResponseInfo Name="Router 1234/Port 1" FolderFullPath="Lab Routers" Address="1" FullAddress="192.168.1.200/1" RootAddress="192.168.1.200" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Locked="false" Excluded="false" Description="a generic router port">
				<ResourceAttributes/>
				<Domains/>
				<ChildResources/>
				<LockInfo/>
				</ResponseInfo>

    back to TOC

    CreateResourcesAdds new resources.

    Adds new resources.

    Syntax 

    ::TestShellAPI::CreateResources resourceInfoDtos ?resultXml?

    Parameters

    TypeNameDescription
    list resourceInfoDtos
    List of resources to add.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example


    #create chassis
    ::TestShellAPI::CreateResources {{"Generic Chassis" "Generic Chassis Model" "Router 1234" "192.168.1.200" "Lab Routers" "" "a generic router"}} resultXml
    #create two child ports for the chassis
    ::TestShellAPI::CreateResources {{Generic Port" "Generic Port Model" "Port 1" "1" "Lab Routers" "Router 1234" "a generic router port"} {Generic Port" "Generic Port Model" "Port 2" "2" "Lab Routers" "Router 1234" "a generic router port"}} resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    CreateRouteInReservationCreate a route between two resources.

    Creates a route between the specified source and target resources.

    Syntax 

    ::TestShellAPI::CreateRouteInReservation reservationId sourceResourceFullPath targetResourceFullPath overrideActiveRoutes mappingType maxHops routeAlias isShared ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullPath
    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 targetResourceFullPath
    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.
    boolean overrideActiveRoutes
    Specify whether the new route can override existing routes.
    string mappingType
    Specify bidirectional or unidirectional as the mapping type.
    number maxHops
    Specify the maximum number or allowed hops.
    string routeAlias
    Specify the route’s alias.
    boolean isShared
    Specify whether this route is shared. Shared routes can be used in more than one reservation.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateRouteInReservation $reservationId "Router 1234/Port 1" "GenericResource 1234/Port 1" 1 bi 2 "a route" 0 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 1" Target="GenericResource 1234/Port 1"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    CreateRoutesInReservationCreate routes between the listed source and target resources.

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

    Syntax 

    ::TestShellAPI::CreateRoutesInReservation reservationId sourceResourcesFullPath targetResourcesFullPath overrideActiveRoutes mappingType maxHops routeAlias isShared ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list sourceResourcesFullPath
    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
    list targetResourcesFullPath
    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
    boolean overrideActiveRoutes
    Specify whether the new route can override existing routes.
    string mappingType
    Specify bidirectional or unidirectional as the mapping type.
    Use 'bi' for bidirectional mapping or 'uni' for unidirectional mapping.
    number maxHops
    Specify the maximum number or allowed hops.
    string routeAlias
    Specify the route’s alias.
    boolean isShared
    Specify whether these routes are shared. Shared routes can be used in more than one reservation.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateRoutesInReservation $reservationId {"Router 1234/Port 1"} {"GenericResource 1234/Port 2"} 1 uni 2 "uni route" 0 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2" RouteType="uni" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 2"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 2" Target="GenericResource 1234/Port 2"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    DeleteDomainDeletes a domain.

    Deletes a domain.

    Syntax 

    ::TestShellAPI::DeleteDomain domainName ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteDomain "Domain1" resultXml

    back to TOC

    DeleteTopologyDelete a topology.

    Deletes the specified topology.

    Syntax 

    ::TestShellAPI::DeleteTopology topologyFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string topologyFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteTopology "Temp Automation Resources/TP1" resultXml

    back to TOC

    DeleteFolderDelete a folder.

    Deletes the specified folder.

    Syntax 

    ::TestShellAPI::DeleteFolder folderFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string folderFullPath
    Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteFolder "Lab Routers" resultXml

    back to TOC

    DeleteGroupDelete a group.

    Deletes the specified group.

    Syntax 

    ::TestShellAPI::DeleteGroup groupName ?resultXml?

    Parameters

    TypeNameDescription
    string groupName
    Specify the name of the group.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteGroup QA_Users resultXml

    back to TOC

    DeleteReservationDelete a reservation.

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

    Syntax 

    ::TestShellAPI::DeleteReservation reservationId unmap ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    boolean unmap
    Specify whether to keep mappings or release mapped resources when deleting the reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteReservation $reservationId 1 resultXml

    back to TOC

    DeleteResourceDelete a resource.

    Deletes the specified resource.

    Syntax 

    ::TestShellAPI::DeleteResource resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteResource "Router 4321" resultXml

    back to TOC

    DeleteResourcesDeletes the specified resources.

    Deletes the specified resources.

    Syntax 

    ::TestShellAPI::DeleteResources resourcesFullPath ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteResources {"Router 4321"} resultXml

    back to TOC

    DeleteUserDeletes a user.

    Deletes the specified user.

    Syntax 

    ::TestShellAPI::DeleteUser username ?resultXml?

    Parameters

    TypeNameDescription
    string username
    Specify the name of the user.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteUser User1234 resultXml

    back to TOC

    DisconnectRoutesInReservationDisconnects a list of routes.

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

    Syntax 

    ::TestShellAPI::DisconnectRoutesInReservation reservationId endpoints ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list endpoints
    The routes endpoints to disconnect.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DisconnectRoutesInReservation $reservationId {"Router 1234/Port 1" "GenericResource 1234/Port 1"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Cisco Catalyst 1/Blade 1/Port 1" Target="IXIA 400T/Card 1/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Cisco Catalyst 1/Blade 1/Port 1" Target="ONPATH 3901 1/Blade01/Port15"/>
				<Segment Source="ONPATH 3901 1/Blade01/Port15" Target="ONPATH 3901 1/Blade01/Port09"/>
				<Segment Source="ONPATH 3901 1/Blade01/Port09" Target="IXIA 400T/Card 1/Port 1"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    DecryptPasswordDecrypt a password.

    Decrypt a password.

    Syntax 

    ::TestShellAPI::DecryptPassword encryptedString ?resultXml?

    Parameters

    TypeNameDescription
    string encryptedString
    The encrypted string for decryption.
    string ?resultXml?
    Specify the variable for the XML output.

    Example

    ::TestShellAPI::DecryptPassword "a" resultXml

    Output

  • resultXml
    • <ResponseInfo Password="decryptedPassword">

    back to TOC

    DeleteResourceTemplateDeletes a specific resource template.

    Deletes a specific resource template.

    Syntax 

    ::TestShellAPI::DeleteResourceTemplate resourceTemplateName ?resultXml?

    Parameters

    TypeNameDescription
    string resourceTemplateName
    Specify the resource template name.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteResourceTemplate "Resource Template 4 tests" resultXml

    back to TOC

    EndReservationEnd a reservation.

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

    Syntax 

    ::TestShellAPI::EndReservation reservationId unmap ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    boolean unmap
    Specify whether to keep mappings or release mapped resources when deleting the reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EndReservation $reservationId 1 resultXml

    back to TOC

    ExcludeResourceExclude a resource.

    Excludes a specified resource.

    Syntax 

    ::TestShellAPI::ExcludeResource resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExcludeResource "L1 Switch 1234" resultXml

    back to TOC

    ExcludeResourcesExcludes the specified resources.

    Excludes the specified resources.

    Syntax 

    ::TestShellAPI::ExcludeResources resourcesFullPath ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExcludeResources {"L1 Switch 1234/Blade 1" "L1 Switch 1234/Blade 2" resultXml

    back to TOC

    SetResourceVisibilitySet the resource visibility state.

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

    Syntax 

    ::TestShellAPI::SetResourceVisibility resourceFullPath newVisibility ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 newVisibility
    The new visibility state for the resource. options: AdminOnly, Everyone or FamilyDefault
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetResourceVisibility "L1 Switch 1234" "AdminOnly" resultXml

    back to TOC

    EnqueueResourceCommand

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

    Syntax 

    ::TestShellAPI::EnqueueResourceCommand reservationId resourceFullPath commandName parameterValues printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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 commandName
    Specify the name of the command.
    list parameterValues
    Specify the list of parameters values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EnqueueResourceCommand $reservationId "Router 1234" "ExampleCommand" {"abcd" "2"} 1 resultXml

    back to TOC

    EnqueueServiceCommand

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

    Syntax 

    ::TestShellAPI::EnqueueServiceCommand reservationId serviceAlias commandName parameterValues printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string serviceAlias
    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 commandName
    Specify the name of the command.
    list parameterValues
    Specify the list of parameters values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EnqueueServiceCommand $reservationId "Service1" "ExampleCommand" {"abcd" "2"} 1 resultXml

    back to TOC

    ExecuteResourceCommand

    [Deprecated] Executes a command for the specified driver.

    Syntax 

    ::TestShellAPI::ExecuteResourceCommand reservationId resourceFullPath commandName parameterValues printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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 commandName
    Specify the name of the command.
    list parameterValues
    Specify the list of parameters values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExecuteResourceCommand $reservationId "Router 1234" "ExampleCommand" {"abcd" "2"} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    ExecuteResourceConnectedCommand

    Executes a command for the specified driver.

    Syntax 

    ::TestShellAPI::ExecuteResourceConnectedCommand reservationId resourceFullPath commandName commandTag parameterValues connectedPortsFullPath printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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 commandName
    Specify the name of the command.
    string commandTag
    Specify the command tag. Connected command tags are used to define categories of functionality (e.g 'virtualization').
    list parameterValues
    Specify the list of parameters values required for executing the command.
    list connectedPortsFullPath
    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.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExecuteResourceConnectedCommand $reservationId "Router 1234" "SpinUp" "virtualization" {"abcd" "2"} {"Router 1234/Port1"} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    EnqueueTopologyCommandEnqueue a topology command.

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

    Syntax 

    ::TestShellAPI::EnqueueTopologyCommand reservationId commandName parameterValues printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string commandName
    Specify the name of the command.
    list parameterValues
    Specify the list of parameters values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EnqueueTopologyCommand $reservationId "ExampleCommand" {"abcd" "2"} 1 resultXml

    back to TOC

    ExecuteTopologyCommandExecute a topology command.

    [Deprecated] Executes a command for the specified reservation.

    Syntax 

    ::TestShellAPI::ExecuteTopologyCommand reservationId commandName parameterValues printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string commandName
    Specify the name of the command.
    list parameterValues
    Specify the list of parameters values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExecuteTopologyCommand $reservationId "ExampleCommand" {"abcd" "2"} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    ExtendReservationExtend a reservation.

    Extends the duration of the specified reservation.

    Syntax 

    ::TestShellAPI::ExtendReservation reservationId minutesToAdd ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    number minutesToAdd
    Specify the number of minutes to add to the specified reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExtendReservation $reservationId 60 resultXml

    back to TOC

    UpdateReservationEndTimeUpdate a reservation end time or persistence.

    Extends the duration of the specified reservation.

    Syntax 

    ::TestShellAPI::UpdateReservationEndTime reservationId isPersistent endTime ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    boolean isPersistent
    Enable or disable Reservation Persistence.
    string endTime
    The end time of the reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateReservationEndTime $reservationId $isPersistent $endTime resultXml

    back to TOC

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

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

    Syntax 

    ::TestShellAPI::ExportFamiliesAndModels ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExportFamiliesAndModels resultXml

    Output

  • resultXml
    • <ResponseInfo>

    back to TOC

    ExecuteServiceCommand

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

    Syntax 

    ::TestShellAPI::ExecuteServiceCommand reservationId serviceAlias commandName parameterValues printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string serviceAlias
    Specify the alias of the service.
    string commandName
    Specify the name of the command.
    list parameterValues
    Specify the list of parameters values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExecuteServiceCommand $reservationId "Service 1" "ExampleCommand" {"abcd" "2"} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    DeployAppToCloudProviderDeploy app to cloud provider

    Executes deploy command for the specified app driver.

    Syntax 

    ::TestShellAPI::DeployAppToCloudProvider reservationId appName commandInputs printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string appName
    Specify the name of the app.
    list commandInputs
    Specify a list of input names and values required for executing the command. Note that to change a deployed App's name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, "Azure Ubuntu", [InputNameValue("Name", "myvm01")]).
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeployAppToCloudProvider $reservationId "app name" {"abcd" "2"} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    EditAppsInReservation

    Edit Apps in a reservation

    Syntax 

    ::TestShellAPI::EditAppsInReservation reservationId editAppsRequests ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list editAppsRequests
    Changes to implement in the App. Please note that when modifying attributes, *all* the attributes in deployed app must be updated.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EditAppsInReservation $reservationId $editAppsRequests resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    PrepareSandboxConnectivity

    Prepare Sandbox Connectivity

    Syntax 

    ::TestShellAPI::PrepareSandboxConnectivity reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::PrepareSandboxConnectivity $reservationId resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    CleanupSandboxConnectivity

    Cleanup Sandbox Connectivity

    Syntax 

    ::TestShellAPI::CleanupSandboxConnectivity reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CleanupSandboxConnectivity $reservationId resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    CheckoutFromPoolCheckout from pool

    Request to checkout an item from a pool.

    Syntax 

    ::TestShellAPI::CheckoutFromPool selectionCriteriaJson ?resultXml?

    Parameters

    TypeNameDescription
    string selectionCriteriaJson
    Json string that represents a selection request for an item or multiple items from a pool.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.
    back to TOC

    ReleaseFromPoolRelease from pool

    Request to release an item from a pool.

    Syntax 

    ::TestShellAPI::ReleaseFromPool values poolId reservationId ownerId ?resultXml?

    Parameters

    TypeNameDescription
    list values
    Values to release from the pool.
    string poolId
    The specific pool where to search for the values that you want to release.
    string reservationId
    Reservation id that is assoicated with the pool values. It can also be an empty string if the values are not associated with a reservation.
    string ownerId
    The owner of the pool values.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.
    back to TOC

    EnqueueEnvironmentCommandEnqueue an environment command.

    Enqueues a command to be executed for the specified reservation.

    Syntax 

    ::TestShellAPI::EnqueueEnvironmentCommand reservationId commandName commandInputs printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string commandName
    Specify the name of the command.
    list commandInputs
    Specify a matrix of input names and values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EnqueueEnvironmentCommand $reservationId "ExampleCommand" {{"input1" "abc"}} 1 resultXml

    back to TOC

    ExecuteEnvironmentCommandExecute an environment command.

    Executes a command for the specified reservation.

    Syntax 

    ::TestShellAPI::ExecuteEnvironmentCommand reservationId commandName commandInputs printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string commandName
    Specify the name of the command.
    list commandInputs
    Specify a matrix of input names and values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExecuteEnvironmentCommand $reservationId "ExampleCommand" {{"input1" "abc"}} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    EnqueueCommandEnqueue a command.

    Enqueues a command to be executed for the specified target.

    Syntax 

    ::TestShellAPI::EnqueueCommand reservationId targetName targetType commandName commandInputs printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string targetName
    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 targetType
    Specify the target type for command execution, possible values are: Resource, Service, App.
    Use 0 for Resource, 1 for Service, 2 for App.
    string commandName
    Specify the name of the command.
    list commandInputs
    Specify a matrix of input names and values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::EnqueueCommand $reservationId "Router 1234" 0 "ExampleCommand" {{"input1" "abc"}} 1 resultXml

    back to TOC

    ExecuteCommandExecute a command.

    Executes a command for the specified target.

    Syntax 

    ::TestShellAPI::ExecuteCommand reservationId targetName targetType commandName commandInputs printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string targetName
    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 targetType
    Specify the target type for command execution, possible values are: Resource, Service, App.
    Use 0 for Resource, 1 for Service, 2 for App.
    string commandName
    Specify the name of the command.
    list commandInputs
    Specify a matrix of input names and values required for executing the command.
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ExecuteCommand $reservationId "Router 1234" 0 "ExampleCommand" {"abcd" "2"} 1 resultXml

    Output

  • resultXml
    • <ResponseInfo Output="success"/>

    back to TOC

    FindResources

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

    Syntax 

    ::TestShellAPI::FindResources resourceFamily resourceModel attributeValues showAllDomains resourceFullName exactName includeSubResources resourceAddress resourceUniqueIdentifier maxResults includeExcludedResources ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFamily
    Specify the name of the resource family.
    string resourceModel
    Specify the resource model.
    list attributeValues
    Specify an array of one or more attributes and attribute values.
    boolean showAllDomains
    Show all domains associated with the logged in user.
    string resourceFullName
    Specify part of or the full name of the resource.
    boolean exactName
    Specify whether to search the exact given name or not.
    boolean includeSubResources
    Specify whether to retrieve the sub resources once the parent matches the name.
    string resourceAddress
    Specify the resource address. Can be partial (e.g. '192.168.').
    string resourceUniqueIdentifier
    Specify the resource unique identifier.
    number maxResults
    Specify the maximum number of resources to return.
    boolean includeExcludedResources
    Specify whether to retrieve resources that are excluded
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::FindResources "Generic Chassis" resourceModel {{"SW_Version1.3"}} "true" resourceFullName exactName includeSubResources resourceAddress resourceUniqueIdentifier maxResults includeExcludedResources resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Resources>
				<Resource Name="Router 1234" Description="a new description for the resource" Address="192.168.1.201" FullName="Lab Routers/Router 1234" FullPath="Lab Routers/Router 1234" FullAddress="192.168.1.201" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Status="Available" Permission="ReadOnly">
				<Reservations/>
				<UsageSummary NumOfNotInReservation="130" NumOfReserved="14" NumOfShared="0"/>
				</Resource>
				</Resources>
				</ResponseInfo>

    back to TOC

    FindResourcesInTimeRange

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

    Syntax 

    ::TestShellAPI::FindResourcesInTimeRange resourceFamily resourceModel fromTime untilTime attributeValues showAllDomains resourceFullName exactName includeSubResources resourceAddress resourceUniqueIdentifier maxResults ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFamily
    Specify the name of the resource family.
    string resourceModel
    Specify the resource model.
    string fromTime
    Specify from which future time and date to check the resource's availability.
    string untilTime
    Specify until which time and date to check the resource's availability.
    list attributeValues
    Specify an array of one or more attributes and attribute values.
    boolean showAllDomains
    Show all domains associated with the logged in user.
    string resourceFullName
    Specify part of or the full name of the resource.
    boolean exactName
    Specify whether to search the exact given name or not.
    boolean includeSubResources
    Specify whether to retrieve the sub resources once the parent matches the name.
    string resourceAddress
    Specify the resource address. Can be partial (e.g. '192.168.').
    string resourceUniqueIdentifier
    Specify the resource unique identifier.
    number maxResults
    Specify the maximum number of resources to return.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::FindResourcesInTimeRange "Generic Chassis" resourceModel "03/01/2012 00:00" "05/31/2012 23:59" {{"SW_Version1.3"}} "false" resourceFullName exactName includeSubResources resourceAddress resourceUniqueIdentifier maxResults resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Resources>
				<Resource Name="Router 1234" Description="a new description for the resource" Address="192.168.1.201" FullName="Lab Routers/Router 1234" FullPath="Lab Routers/Router 1234" FullAddress="192.168.1.201" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Status="Available" Permission="ReadOnly">
				<Reservations/>
				<UsageSummary NumOfNotInReservation="130" NumOfReserved="14" NumOfShared="0"/>
				</Resource>
				</Resources>
				</ResponseInfo>

    back to TOC

    GetReservationResourcesPositionsGet resource positions in a reservation.

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

    Syntax 

    ::TestShellAPI::GetReservationResourcesPositions reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetReservationResourcesPositions $reservationId resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<layout/>
				</ResponseInfo>

    back to TOC

    GetRoutesSolutionGet solution for specified routes.

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

    Syntax 

    ::TestShellAPI::GetRoutesSolution reservationId sourceResourcesFullPath targetResourcesFullPath mappingType maxHops isShared ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list sourceResourcesFullPath
    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
    list targetResourcesFullPath
    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 mappingType
    Specify bidirectional or unidirectional as the mapping type.
    Use 'bi' for bidirectional mapping or 'uni' for unidirectional mapping.
    number maxHops
    Specify the maximum number or allowed hops.
    boolean isShared
    Specify whether these routes are shared. Shared routes can be used in more than one reservation.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetRoutesSolution $reservationId {"Router 1234/Port 1"} {"GenericResource 1234/Port 1"} bi 2 0 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 1" Target="GenericResource 1234/Port 1"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    GenerateUtilizationReportGenerate a utilization report.

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

    Syntax 

    ::TestShellAPI::GenerateUtilizationReport resourceFamilyName fromDate toDate resourceFullName resourceModelName includeChildResources groupBy utilizationReportType ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFamilyName
    Specify the name of the resource family.
    string fromDate
    Specify the start time and date.
    string toDate
    Specify the end time and date.
    string resourceFullName
    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 resourceModelName
    Specify the resource model.
    boolean includeChildResources
    Specify whether to include child resources utilization.
    string groupBy
    Specify how to group the utilization results: Resource, User, or Machine
    Use 0 for Resource, 1 for User and 2 for Machine.
    string utilizationReportType
    Specify the report type: Lock or Mapping.
    Use 0 for Lock and 1 for Mapping.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GenerateUtilizationReport "Router" "03/01/2012 00:00" "05/31/2012 23:59" "" "" 0 0 0 resultXml

    back to TOC

    GetActiveTopologyNamesRetrieve a user's reserved topologies.

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

    Syntax 

    ::TestShellAPI::GetActiveTopologyNames ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetActiveTopologyNames resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Topologies>
				<TopologyName>Temp Automation Resources/TP1</TopologyName>
				</Topologies>
				</ResponseInfo>

    back to TOC

    GetAllUsersDetailsRetrieve all users and user settings.

    Retrieves all users and their settings.

    Syntax 

    ::TestShellAPI::GetAllUsersDetails ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetAllUsersDetails resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Users>
				<User Name="admin" IsAdmin="true" IsActive="true" IsDomainAdmin="false">
				<Groups>
				<Group Name="System Administrators" Description="Built in group, all members have administrative rights.">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				</Group>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				</Groups>
				</User>
				<User Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com">
				<Groups>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				</Groups>
				</User>
				<User Name="User2345" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="">
				<Groups>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				</Groups>
				</User>
				</Users>
				</ResponseInfo>

    back to TOC

    GetAttributeValueRetrieve an attribute's value.

    Retrieves the value of the specified attribute

    Syntax 

    ::TestShellAPI::GetAttributeValue resourceFullPath attributeName ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 attributeName
    Specify the attribute name.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetAttributeValue "Router 1234" "SW_Version" resultXml

    Output

  • resultXml
    • <ResponseInfo Name="SW_Version" Value="1.3"/>

    back to TOC

    GetCategoriesOfTopologyRetrieves all categories of a given topology.

    Retrieves all categories of given topology.

    Syntax 

    ::TestShellAPI::GetCategoriesOfTopology topologyPath ?resultXml?

    Parameters

    TypeNameDescription
    string topologyPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example


    ::TestShellAPI::GetCategoriesOfTopology "Folder1/exampleTopology" resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="CategoriesOfTopologyInfo">
				<Categories>
				<Category Name="sampleCategory" Value="hello"/>
				<Category Name="Category2" Value="bye"/>
				</Categories>
				</ResponseInfo>

    back to TOC

    GetCurrentReservationsRetrieve current reservations.

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

    Syntax 

    ::TestShellAPI::GetCurrentReservations reservationOwner ?resultXml?

    Parameters

    TypeNameDescription
    string reservationOwner
    Specify the user name of the reservation owner.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetCurrentReservations admin resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservations>
				<Reservation Id="65b45c9b-7694-4a42-b8fa-0239109b5246" Name="Reservation" StartTime="2012-06-19T14:30:00" EndTime="2012-06-19T16:30:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Overtime" ProvisioningStatus="Ready" ActualEndTime="" CreateDate="2012-06-19T14:30:23" ModificationDate="2012-06-19T14:37:55" DomainName="Global">
				<Topologies>
				<TopologyName>Topologies/Lab 1/Topology</TopologyName>
				<TopologyName>Topologies/Lab 1/TrafficTopology</TopologyName>
				<TopologyName>Topologies/Lab 1/TrafficTopology1</TopologyName>
				</Topologies>
				</Reservation>
				</Reservations>
				</ResponseInfo>

    back to TOC

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

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

    Syntax 

    ::TestShellAPI::GetDomainDetails domainName ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetDomainDetails Domain1 resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="Domain1" Description="" TopologiesFolder="Root\Domain1 topologies">
				<Groups>
				<Group Name="Animals" Role="Regular"></Group>
				</Groups>
				<Topologies>
				<Topology Name="Topology" Description=""></Topology>
				</Topologies>
				<Resources>
				<Resource Name="b1" Path="b1"></Resource>
				</Resources>
				</ResponseInfo>

    back to TOC

    GetFolderContentRetrieve content for a specified path.

    Retrieves content for the specified path.

    Syntax 

    ::TestShellAPI::GetFolderContent fullPath showAllDomains ?resultXml?

    Parameters

    TypeNameDescription
    string fullPath
    Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
    boolean showAllDomains
    Show all domains associated with the logged in user.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetFolderContent "Lab Routers" 0 resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<ContentArray>
				<Content Name="Router 1234" Type="Resource"/>
				<Content Name="Router 4321" Type="Resource"/>
				</ContentArray>
				</ResponseInfo>

    back to TOC

    MoveFolderAllows to change the location of a folder (and all its content, including sub folders) in the folder hierarchy.

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

    Syntax 

    ::TestShellAPI::MoveFolder originalFolder targetFolder ?resultXml?

    Parameters

    TypeNameDescription
    string originalFolder
    Path of the folder to be moved.
    string targetFolder
    The path of the new containing folder. To move a folder to root, value should be empty.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::MoveFolder Folder1 Folder2 resultXml

    back to TOC

    GetGroupDomainsRetrieve a group's domains.

    Retrieves all domains associated with a group.

    Syntax 

    ::TestShellAPI::GetGroupDomains groupName ?resultXml?

    Parameters

    TypeNameDescription
    string groupName
    Specify the name of the group.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetGroupDomains QA_Users resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="QA_Users" Description="QA users">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				</ResponseInfo>

    back to TOC

    GetGroupsDetailsRetrieve all system groups.

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

    Syntax 

    ::TestShellAPI::GetGroupsDetails ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetGroupsDetails resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Groups>
				<Group Name="System Administrators" Description="Built in group, all members have administrative rights." GroupRole="SystemAdmin">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				<Users>
				<User Name="admin" IsAdmin="true" IsActive="true" IsDomainAdmin="false">
				<Groups>
				<Group Name="System Administrators" Description="Built in group, all members have administrative rights.">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				</Group>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				<Group Name="Lab1">
				<TestShellDomains>
				<TestShellDomain Name="Lab1" Description="" Id="71aa4f7e-174d-4df1-b50a-59e98f09005c"/>
				</TestShellDomains>
				</Group>
				</Groups>
				</User>
				</Users>
				</Group>
				<Group Name="Domain Administrators" Description="Built in group, all members have administrative Domain rights." GroupRole="DomainAdmin">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				<Users>
				<User Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="true" Email="">
				<Groups>
				<Group Name="Domain Administrators" Description="Built in group, all members have administrative Domain rights.">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				</Group>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				</Groups>
				</User>
				</Users>
				</Group>
				<Group Name="QA_Users" Description="QA users" GroupRole="Regular">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				<Users>
				<User Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com">
				<Groups>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				<Group Name="QA_Users" Description="QA users">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				</Group>
				</Groups>
				</User>
				<User Name="User2345" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="">
				<Groups>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				<Group Name="QA_Users" Description="QA users">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				</Group>
				</Groups>
				</User>
				</Users>
				</Group>
				<Group Name="RND_Users" GroupRole="Regular">
				<TestShellDomains>
				<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
				</TestShellDomains>
				<Users/>
				</Group>
				</Groups>
				</ResponseInfo>

    back to TOC

    GetLockedResourcesRetrieve a list of locked resources.

    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 

    ::TestShellAPI::GetLockedResources user machine folderFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string user
    Specify a user name to retrieve locked resources for that user.
    string machine
    Specify a machine name to retrieve locked resources for that computer.
    string folderFullPath
    Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetLockedResources admin "" "" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservations>
				<Reservation Name="Immediate reservation" Owner="admin" Created="2012-06-20T15:05:06">
				<LockedResources>
				<Resource Name="GenericResource 1234/Port 2" FolderFullPath="Temp Automation Resources" Address="2" FullAddress="192.168.1.20/2" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Locked="true" Excluded="false"/>
				<Resource Name="GenericResource 1234/Port 1" FolderFullPath="Temp Automation Resources" Address="1" FullAddress="192.168.1.20/1" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Locked="true" Excluded="false"/>
				</LockedResources>
				</Reservation>
				</Reservations>
				</ResponseInfo>

    back to TOC

    GetReservationDetailsRetrieve reservation details and parameters.

    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 

    ::TestShellAPI::GetReservationDetails reservationId disableCache ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    boolean disableCache
    Specify if the reservation detail is new or cached
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetReservationDetails $reservationId true resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetReservationDescriptionResponseInfo">
				<ReservationDescription Id="a97ce9c2-48eb-420e-85b7-2318106c35a3" Name="Sandbox-5-16-2017 15-59" StartTime="16/05/2017 15:59:00" EndTime="16/05/2017 17:59:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Started" ProvisioningStatus="Not Run" ActualEndTime="" CreateDate="16/05/2017 15:59:21" ModificationDate="16/05/2017 16:01:38" DomainName="Global">
				<Topologies>
				<TopologyName>Environment-03-02-2015 18-21</TopologyName>
				</Topologies>
				<TopologiesInfo>
				<Topology Name="Environment-03-02-2015 18-21" Alias="Environment-03-02-2015 18-21">
				<Type>Regular</Type>
				<State>Pending</State>
				</Topology>
				</TopologiesInfo>
				<PermittedUsers>
				<PermittedUser>admin</PermittedUser>
				</PermittedUsers>
				<Resources>
				<ReservedResource Name="Database_ec513a05" FolderFullPath="" FullAddress="NA" Shared="false" Availability="Available" Locked="false" Released="false" ResourceFamilyName="Generic App Family" ResourceModelName="Generic App Model" CreatedByUser="admin" CreatedInDomain="Global" CreatedInReservation="a97ce9c2-48eb-420e-85b7-2318106c35a3">
				<VmDetails UID="4232175a-6a64-bb3c-1cca-e8699845549b" CloudProviderFullName="testing">
				<VmCustomParams>
				<VmCustomParam Name="ip_regex" Value="" />
				<VmCustomParam Name="auto_power_on" Value="True" />
				<VmCustomParam Name="auto_power_off" Value="True" />
				<VmCustomParam Name="wait_for_ip" Value="True" />
				<VmCustomParam Name="auto_delete" Value="True" />
				<VmCustomParam Name="refresh_ip_timeout" Value="600" />
				<VmCustomParam Name="autoload" Value="True" />
				</VmCustomParams>
				</VmDetails>
				<AppDetails AppName="Database" />
				</ReservedResource>
				</Resources>
				<TopologiesReservedResources />
				<Conflicts />
				<TopologiesRouteInfo />
				<TopologiesResourcesAttributeInfo />
				<TopologiesInstructionsInfo />
				<ActiveRoutesInfo />
				<RequestedRoutesInfo />
				<Connectors />
				<Apps>
				<ReservedApp Name="MonitoringApp">
				<LogicalResource Family="Monitoring" Model="DefaultMonitoring"/>
				</ReservedApp>
				</Apps>
				<ReservationLiveStatus ReservationId="a97ce9c2-48eb-420e-85b7-2318106c35a3" />
				<SetupStage>None</SetupStage>
				<Services />
				</ReservationDescription>
				</ResponseInfo>

    back to TOC

    GetResourcesLabelsInReservationGet resources associated with labels in reservation.

    Retrieves all resources associated with labels in the specified reservation.

    Syntax 

    ::TestShellAPI::GetResourcesLabelsInReservation reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourcesLabelsInReservation "af626b88-458b-4e7a-9054-c03d8cffa260" resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetResourcesLabelsInTopologyResponseInfo">
				<Resources>				
				<Resource Name="res" Type="Resource" LabelName="label1">
				</Resource>
				<Resource Name="res2" Type="Resource" LabelName="label2">
				</Resource>
				<Resource Name="service1" Type="Service" LabelName="label3">
				</Resource>
				<Resource Name="app1" Type="App" LabelName="label4">
				</Resource>
				</Resources>
				</ResponseInfo>

    back to TOC

    GetStickyNotesInReservationGet sticky notes in reservation.

    Retrieves all sticky notes in the specified reservation.

    Syntax 

    ::TestShellAPI::GetStickyNotesInReservation reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetStickyNotesInReservation "c3e48d7d-affb-4efc-baee-31c01f0f4be2" resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetStickyNotesInReservationResponseInfo">
				<StickyNotes>
				<StickyNote Id="14acdd6f-90c9-413a-bb2f-de73421483ac" Content="Phase 1 - Planning" Color="#FFBD47">
				</StickyNote>
				<StickyNote Id="cf60f589-dbfb-4153-8da1-256b05438bc5" Content="Requirements Gathering" LabelName="#94B0DA">
				</StickyNote>
				</StickyNotes>
				</ResponseInfo>

    back to TOC

    GetReservationInputsRetrieves all topology inputs for a specified reservation.

    Retrieves all topology inputs for a specified reservation.

    Syntax 

    ::TestShellAPI::GetReservationInputs reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list globalInputs
    Global inputs associated with the specified reservation.
    list requirementsInputs
    Requirements inputs associated with the specified reservation.
    list additionalInfoInputs
    Additional info inputs associated with the specified reservation.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetReservationInputs "af626b88-458b-4e7a-9054-c03d8cffa260" resultXml

    Output

  • resultXml
    • <ResponseInfo/>

    back to TOC

    GetReservationRemainingTimeRetrieve the amount of time until the end of a reservation.

    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 

    ::TestShellAPI::GetReservationRemainingTime reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetReservationRemainingTime $reservationId resultXml

    Output

  • resultXml
    • <ResponseInfo RemainingTimeInMinutes="26.4"/>

    back to TOC

    GetResourceAvailabilityGet resource availability.

    Get resource availability for the resources.

    Syntax 

    ::TestShellAPI::GetResourceAvailability resourcesNames showAllDomains ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesNames
    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
    boolean showAllDomains
    Show all domains associated with the logged in user.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceAvailability {"Router 1234" "GenericResource 1234"} 0

    back to TOC

    GetResourceAvailabilityInTimeRangeGet resource availability during a specific time range.

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

    Syntax 

    ::TestShellAPI::GetResourceAvailabilityInTimeRange resourcesNames startTime endTime showAllDomains ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesNames
    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 startTime
    The start time of the reservation.
    string endTime
    The end time of the reservation.
    boolean showAllDomains
    Show all domains associated with the logged in user.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceAvailability {"Router 1234" "GenericResource 1234"} "03/01/2012 00:00" "05/31/2012 23:59" 0

    back to TOC

    GetResourceCommandsRetrieve resource driver commands.

    Retrieves driver commands and parameters for a specified resource.

    Syntax 

    ::TestShellAPI::GetResourceCommands resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceCommands "Router 1234" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Commands>
				<Command Name="ExampleCommand" DisplayName="Example Command" >
				<Parameters>
				<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
				<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
				</Parameters>
				</Command>
				<Command Name="ResetDriver" DisplayName="Reset Driver" >
				<Parameters/>
				</Command>
				</Commands>
				</ResponseInfo>

    back to TOC

    GetServiceCommandsRetrieve service driver commands.

    Retrieves driver commands and parameters for a specified service.

    Syntax 

    ::TestShellAPI::GetServiceCommands serviceName ?resultXml?

    Parameters

    TypeNameDescription
    string serviceName
    Specify the service name.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetServiceCommands "VLAN" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Commands>
				<Command Name="ExampleCommand" DisplayName="Example Command" >
				<Parameters>
				<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
				<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
				</Parameters>
				</Command>
				<Command Name="ResetDriver" DisplayName="Reset Driver" >
				<Parameters/>
				</Command>
				</Commands>
				</ResponseInfo>

    back to TOC

    GetResourceConnectedCommandsRetrieve resource driver commands.

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

    Syntax 

    ::TestShellAPI::GetResourceConnectedCommands resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceConnectedCommands "Router 1234" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Commands>
				<Command Name="SpinUp" Tag="virtualization" DisplayName="Example virtualiztion command" >
				<Parameters>
				<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
				<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
				</Parameters>
				</Command>
				<Command Name="PowerOn" Tag="power" DisplayName="Example power command" >
				<Parameters/>
				</Command>
				</Commands>
				</ResponseInfo>

    back to TOC

    GetResourceDetailsRetrieve the resource parameters and attributes.

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

    Syntax 

    ::TestShellAPI::GetResourceDetails resourceFullPath showAllDomains ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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.
    boolean showAllDomains
    Show all domains associated with the logged in user.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceDetails "Lab Routers/Router 1234" 0 resultXml

    Output

  • resultXml
    •         <ResponseInfo Name="Router 1234" DriverName="Router Driver" FolderFullPath="Lab Routers" Address="192.168.1.200" FullAddress="192.168.1.200" RootAddress="192.168.1.200" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Locked="false" Excluded="false" Description="a generic router" Permissions="ReadOnly" ResourceLiveStatusName="name1" ResourceLiveStatusDescription="description1" >
        <ResourceAttributes>
        <ResourceAttribute Name="SW_Version" Value="" Type="String"></ResourceAttribute>
        </ResourceAttributes>
        <Domains></Domains>
        <ChildResources>
        <ResourceInfo Name="Router 1234/Port 1" FolderFullPath="Lab Routers" Address="1" FullAddress="192.168.1.200/1" RootAddress="192.168.1.200" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Locked="false" Excluded="false" Description="a generic router port" Permissions="ReadOnly">
        <ResourceAttributes></ResourceAttributes>
        <Domains></Domains>
        <LockInfo></LockInfo>
        </ResourceInfo>
        </ChildResources>
        <LockInfo></LockInfo>
        <CreatedInReservation></CreatedInReservation>
        <CreatedByUser></CreatedByUser>
        <CreatedInDomain></CreatedInDomain>
        </ResponseInfo>

    back to TOC

    GetResourcesAttributeValuesRetrieve the resources attributes.

    Retrieves resources associated attributes and attribute values.

    Syntax 

    ::TestShellAPI::GetResourcesAttributeValues resourceFullNames ?resultXml?

    Parameters

    TypeNameDescription
    list resourceFullNames
    Specify the resource names array. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourcesAttributeValues {"Lab Routers/Router 1234"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<ResourceAttributeInfoList>
				<ResourceAttributeInfo FullPath="Lab Routers/Router 1234">
				<ResourceAttribute Name="SW_Version" Value="" Type="String">
				</ResourceAttribute>
				</ResourceAttributeInfo>
				</ResourceAttributeInfoList>
				</ResponseInfo>

    back to TOC

    GetResourceListRetrieve a list of resources for a specified path.

    Retrieves resources and resource values for the specified folder path.

    Syntax 

    ::TestShellAPI::GetResourceList folderFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string folderFullPath
    Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceList "Lab Routers" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Resources>
				<Resource Name="Router 1234" FolderFullPath="Lab Routers" Address="192.168.1.200" FullAddress="192.168.1.200" RootAddress="192.168.1.200" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Locked="false" Excluded="false">
				<LockInfo/>
				</Resource>
				<Resource Name="Router 4321" FolderFullPath="Lab Routers" Address="192.168.1.201" FullAddress="192.168.1.201" RootAddress="192.168.1.201" ResourceFamilyName="Generic Resource" ResourceModelName="Generic Resource Model" Locked="false" Excluded="false">
				<LockInfo/>
				</Resource>
				</Resources>
				</ResponseInfo>

    back to TOC

    GetResourceLiveStatusGets the live status of a resource.

    Gets the live status of the resource.

    Syntax 

    ::TestShellAPI::GetResourceLiveStatus resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceLiveStatus {"myPath"} ? resultXml ?

    Output

  • resultXml
    • 				<ResponseInfo type="ResourceLiveStatusInfo" liveStatusName="Online" liveStatusDescription="Resource was responding to pings at 12/12/2013 10:35 AM"/>
				</Response>

    back to TOC

    GetReservationsLiveStatusGets the live status the reservations.

    Gets the live status of the reservations.

    Syntax 

    ::TestShellAPI::GetReservationsLiveStatus reservationsId ?resultXml?

    Parameters

    TypeNameDescription
    list reservationsId
    Specifies a string array that represents reservation unique identifiers.
    string ?resultXml?
    Specify the variable for the XML output.

    Example

    ::TestShellAPI::GetReservationsLiveStatus {"a2f1b35e-3deb-42ee-b70d-78189dd10d56"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<ReservationLiveStatuses>
				<ReservationLiveStatus ReservationId="a2f1b35e-3deb-42ee-b70d-78189dd10d56" ReservationLiveStatusName="Pass" ReservationLiveStatusDescription="My Description"></ReservationLiveStatus>
				</ReservationLiveStatuses>
				</ResponseInfo>

    back to TOC

    GetResourceMappingsRetrieve current mappings for specified resources.

    Retrieves mappings for a list of one or more resources.

    Syntax 

    ::TestShellAPI::GetResourceMappings resources ?resultXml?

    Parameters

    TypeNameDescription
    list resources
    Specify a list of resources.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourceMappings {"L1 Switch 1234/Blade 1/Port 2"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Mapping Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 2" RouteType="uni"/>
				</ResponseInfo>

    back to TOC

    GetRouteSegmentsRetrieves all the ports on the route.

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

    Syntax 

    ::TestShellAPI::GetRouteSegments resource ?resultXml?

    Parameters

    TypeNameDescription
    string 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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetRouteSegments "Router 1234/Port 1" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 1" Target="GenericResource 1234/Port 1"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    GetScheduledReservationsRetrieve scheduled reservations for a specified time range.

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

    Syntax 

    ::TestShellAPI::GetScheduledReservations fromTime untilTime ownerName ?resultXml?

    Parameters

    TypeNameDescription
    string fromTime
    Specify from which time and date to search.
    string untilTime
    Specify until which time and date to search.
    string ownerName
    Specify reservation owner name
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetScheduledReservations "01/01/2015 08:00" "01/01/2015 12:00" resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Reservations>
				<Reservation Id="af626b88-458b-4e7a-9054-c03d8cffa260" Name="test reservation" StartTime="2015-01-01T10:00:00" EndTime="2015-01-01T12:00:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Pending" ProvisioningStatus="Ready" ActualEndTime="" CreateDate="2012-06-20T10:40:47" ModificationDate="2012-06-20T10:45:16" DomainName="Global">
				<Topologies/>
				</Reservation>
				</Reservations>
				</ResponseInfo>

    back to TOC

    GetServerDateAndTimeRetrieve the server's date and time.

    Retrieves the server’s UTC date and time.

    Syntax 

    ::TestShellAPI::GetServerDateAndTime ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetServerDateAndTime resultXml

    Output

  • resultXml
    • <ResponseInfo ServerDateTime="2012-06-21T10:52:43.4464527Z" ServerDateTimeString="06/21/2012 10:52"/>

    back to TOC

    GetTopologyCommandsRetrieve available topology commands in a reservation.

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

    Syntax 

    ::TestShellAPI::GetTopologyCommands reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetTopologyCommands $reservationId resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Commands>
				<Command Name="ExampleCommand">
				<Parameters>
				<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
				<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
				</Parameters>
				</Command>
				<Command Name="Setup">
				<Parameters/>
				</Command>
				</Commands>
				</ResponseInfo>

    back to TOC

    GetEnvironmentCommandsRetrieve available environment commands in a reservation.

    Retrieves driver commands and parameters for a specified reservation.

    Syntax 

    ::TestShellAPI::GetEnvironmentCommands reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetEnvironmentCommands $reservationId resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Commands>
				<Command Name="ExampleCommand">
				<Parameters>
				<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
				<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
				</Parameters>
				</Command>
				<Command Name="Setup">
				<Parameters/>
				</Command>
				</Commands>
				</ResponseInfo>

    back to TOC

    GetTopologyDetailsRetrieve the topology parameters and attributes.

    Retrieves all resources and attributes associated with the specified topology.

    Syntax 

    ::TestShellAPI::GetTopologyDetails topologyFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string topologyFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetTopologyDetails "Temp Automation Resources/TP1" resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="TP1" Owner="admin" Type="Build" State="Ready">
				<Resources>
				<ResourceInfo Name="Router 1234" FolderFullPath="Lab Routers" Address="192.168.1.201" FullAddress="192.168.1.201" RootAddress="192.168.1.201" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Alias="Router 1234" Locked="false" Excluded="false" WillBeLocked="false">
				<ResourceAttributes>
				<ResourceAttribute Name="SW_Version" Value="" Type="String"/>
				</ResourceAttributes>
				<LockInfo/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/ConsolePort 21" FolderFullPath="Temp Automation Resources" Address="21" FullAddress="192.168.1.20/21" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="ConsolePort 21" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/ConsoleServer 1234/ConsolePort 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/Port 2" FolderFullPath="Temp Automation Resources" Address="2" FullAddress="192.168.1.20/2" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 2" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 2"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/PowerPort 12" FolderFullPath="Temp Automation Resources" Address="12" FullAddress="192.168.1.20/12" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="PowerPort 12" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/SmartPower2L 1234/PowerPort 2"/>
				</ResourceInfo>
				<ResourceInfo Name="Router 1234/Port 1" FolderFullPath="Lab Routers" Address="1" FullAddress="192.168.1.201/1" RootAddress="192.168.1.201" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 1" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/PowerPort 11" FolderFullPath="Temp Automation Resources" Address="11" FullAddress="192.168.1.20/11" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="PowerPort 11" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/SmartPower2L 1234/PowerPort 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234" FolderFullPath="Temp Automation Resources" Address="192.168.1.20" FullAddress="192.168.1.20" RootAddress="192.168.1.20" ResourceFamilyName="Generic Resource" ResourceModelName="Generic Resource Model" Alias="GenericResource 1234" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/Port 1" FolderFullPath="Temp Automation Resources" Address="1" FullAddress="192.168.1.20/1" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 1" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 1"/>
				</ResourceInfo>
				</Resources>
				<AbstractResources/>
				<Routes>
				<Route Source="GenericResource 1234/Port 1" Target="Router 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="GenericResource 1234/Port 1" Target="Router 1234/Port 1"/>
				</Segments>
				</Route>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2" RouteType="uni" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2"/>
				</Segments>
				</Route>
				</Routes>
				<Instructions>
				Topology instructions.
				</Instructions>
				<Driver>
				ExampleTopologyDriver
				</Driver>
				<GlobalInputs ParamName="Some global input"></GlobalInputs>
				<RequirementsInputs ParamName="Model" ResourceName="test*" InputType="Models">
				<PossibleValues>Test Model</PossibleValues>
				</RequirementsInputs>
				<RequirementsInputs ParamName="Speed" ResourceName="test*" InputType="Attributes">
				<PossibleValues>10 Mbps</PossibleValues>
				<PossibleValues>100 Mbps</PossibleValues>
				<PossibleValues>1 Gbps</PossibleValues>
				<PossibleValues>10 Gbps</PossibleValues>
				</<RequirementsInputs>
				<AdditionalInfoInputs ParamName="Test" ResourceName="test*"></AdditionalInfoInputs>
				<ParentTopology Name="Template01">
				<Type>Build</Type>
				<State>Pending</State>
				</ParentTopology>
				<MaxDuration>02:00:00</MaxDuration>
				</ResponseInfo>

    back to TOC

    GetResourcesLabelsInTopologyGet resources associated with labels in topology.

    Retrieves all resources associated with labels in the specified topology.

    Syntax 

    ::TestShellAPI::GetResourcesLabelsInTopology topologyName ?resultXml?

    Parameters

    TypeNameDescription
    string topologyName
    Specify the topology name.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetResourcesLabelsInTopology "topo1" resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetResourcesLabelsInTopologyResponseInfo">
				<Resources>				
				<Resource Name="res" Type="Resource" LabelName="label1">
				</Resource>
				<Resource Name="res2" Type="Abstract Resource" LabelName="label2">
				</Resource>
				<Resource Name="service1" Type="Service" LabelName="label3">
				</Resource>
				<Resource Name="app1" Type="App" LabelName="label4">
				</Resource>
				</Resources>
				</ResponseInfo>

    back to TOC

    GetStickyNotesInTopologyGet sticky notes in topology.

    Retrieves all sticky notes in the specified topology.

    Syntax 

    ::TestShellAPI::GetStickyNotesInTopology topologyName ?resultXml?

    Parameters

    TypeNameDescription
    string topologyName
    Specify the topology name.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetStickyNotesInTopology "topo1" resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetStickyNotesInTopologyResponseInfo">
				<StickyNotes>
				<StickyNote Id="14acdd6f-90c9-413a-bb2f-de73421483ac" Content="Phase 1 - Planning" Color="#FFBD47">
				</StickyNote>
				<StickyNote Id="cf60f589-dbfb-4153-8da1-256b05438bc5" Content="Requirements Gathering" LabelName="#94B0DA">
				</StickyNote>
				</StickyNotes>
				</ResponseInfo>

    back to TOC

    GetTopologiesByCategoryRetrieves the full path of all topologies.

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

    Syntax 

    ::TestShellAPI::GetTopologiesByCategory categoryName categoryValue ?resultXml?

    Parameters

    TypeNameDescription
    string categoryName
    Specify the category's name, If category name is not provided will return all topologies in domain.
    string categoryValue
    Specify the category's value/sub category
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example


    ::TestShellAPI::GetTopologiesByCategory lookUpCategory bonjour resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Topologies>
				<FullPath>
				Root\otherTopology
				</FullPath>
				<FullPath>
				dir1/myTopology
				</FullPath>
				</Topologies>
				</ResponseInfo>

    back to TOC

    GetTopologyCategoriesRetrieves all topology categories.

    Retrieves all root categories from 'Environment' catalog.

    Syntax 

    ::TestShellAPI::GetTopologyCategories ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.

    Example

    ::TestShellAPI::GetTopologyCategories resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="CategoryListInfo">
				<Categories>
				<Name>
				category1
				</Name>
				<Name>
				otherCategory
				</Name>
				<Name>
				lookUpCategory
				</Name>
				</Categories>
				</ResponseInfo>

    back to TOC

    GetCategoriesRetrieves all the logged in user's root categories and sub categories

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

    Syntax 

    ::TestShellAPI::GetCategories type ?resultXml?

    Parameters

    TypeNameDescription
    string type
    Specify the categoriy type: Services, Environment or empty for both.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetCategories "" resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="CategoryListBriefInfo">
				<Categories>
				<Category Name="root1/bpc1" Description="blueprint category" Type="blueprint"/>
				<Category Name="root2/svcc1" Description="service category" Type="service"/>
				</Categories>
				</ResponseInfo>

    back to TOC

    GetUserDetailsRetrieve a user's settings.

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

    Syntax 

    ::TestShellAPI::GetUserDetails username ?resultXml?

    Parameters

    TypeNameDescription
    string username
    Specify the name of the user.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetUserDetails User1234 resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com">
				<Groups>
				<Group Name="Everyone">
				<TestShellDomains/>
				</Group>
				</Groups>
				</ResponseInfo>

    back to TOC

    GetAbstractTemplateListRetrieve a list of abstract templates.

    Retrieve a list of abstract templates.

    Syntax 

    ::TestShellAPI::GetAbstractTemplateList ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetAbstractTemplateList resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<AbstractTemplates>
				<AbstractTemplate ResourceFamilyName="VM Instance" ResourceModelName="VM" Name="abs" Description="" Owner="admin" DomainName="Global" CreateDate="5/18/2014 6:09:07 AM" Valid="true"></AbstractTemplate>
				<AbstractTemplate ResourceFamilyName="VM Instance" ResourceModelName="VM" Name="abs2" Description="" Owner="admin" DomainName="Global" CreateDate="5/18/2014 6:09:07 AM" Valid="true"></AbstractTemplate>
				</AbstractTemplates>
				</ResponseInfo>

    back to TOC

    GetServicesRetrieve a list of services and their attributes.

    Retrieve a list of services and their attributes.

    Syntax 

    ::TestShellAPI::GetServices categoryName serviceName ?resultXml?

    Parameters

    TypeNameDescription
    string categoryName
    The name of the category of the services you want to receive.
    string serviceName
    The name of the service you want to receive.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetServices resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Services>
				<Service Name="ServiceModel1" Description="">
				<Attributes>
				<Attribute Name="Alarm State" Type="String" IsRequired="false" DefaultValue="On" PossibleValues="On,Off"> </Attribute>
				<Attribute Name="Part Number" Type="String" IsRequired="false" DefaultValue="1" PossibleValues=""> </Attribute>
				</Attributes>
				</Service>
				</Services>
				</ResponseInfo>

    back to TOC

    GetReservationServicesPositionsGet service positions in a reservation.

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

    Syntax 

    ::TestShellAPI::GetReservationServicesPositions reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetReservationServicesPositions $reservationId resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<layout/>
				</ResponseInfo>

    back to TOC

    IncludeResourceInclude a resource.

    Includes a specified resource.

    Syntax 

    ::TestShellAPI::IncludeResource resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::IncludeResource "L1 Switch 1234" resultXml

    back to TOC

    IncludeResourcesIncludes the specified resources.

    Includes the specified resources.

    Syntax 

    ::TestShellAPI::IncludeResources resourcesFullPath ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::IncludeResources "L1 Switch 1234" resultXml

    back to TOC

    LockResourceLock a resource.

    Locks a specified resource.

    Syntax 

    ::TestShellAPI::LockResource reservationId resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::LockResource $reservationId "GenericResource 1234/Port 1" resultXml

    back to TOC

    LockResourcesLock multiple resources.

    Locks multiple resources.

    Syntax 

    ::TestShellAPI::LockResources reservationId resourcesFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::LockResources $reservationId {"GenericResource 1234/Port 1" "GenericResource 1234/Port 2"} resultXml

    back to TOC

    LogoffLogoff from resource manager service.

    Logs out the current user.

    Syntax 

    ::TestShellAPI::Logoff token ?resultXml?

    Parameters

    TypeNameDescription
    string ?token?
    Specify the token to be revoked (optional).
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::Logoff YCrgRMAu/kOntENgVTqNlg== resultXml

    back to TOC

    LogonLog in to the TestShell service.

    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 

    ::TestShellAPI::Logon username password domainName ?resultXml?

    Parameters

    TypeNameDescription
    string username
    Username to logon with.
    string password
    Specify the user’s login password.
    string domainName
    Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::Logon admin admin Global resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="LogonResponseInfo">
				<Domain Name="Global" Description="A domain that includes all available resources" DomainId="dbaf480c-09f7-46d3-a2e2-e35d3e374a16" />
				<User Name="admin" IsAdmin="false" IsActive="false" IsDomainAdmin="false" />
				<Token Token="Yzhumq0qVkyIwyMkxzk7wQ==" />
				</ResponseInfo>

    back to TOC

    LogoutTNSessionLogout from a console port TN session.

    Logs the user out from a console port TN session.

    Syntax 

    ::TestShellAPI::LogoutTNSession reservationId resourceFullPath consolePortsFullPath baudRate ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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.
    list consolePortsFullPath
    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 baudRate
    Specify the baud rate to apply to the ports.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::LogoutTNSession $reservationId "GenericResource 1234" {"GenericResource 1234/ConsolePort 21"} 9600 resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    MapPortsMap ports on a L1 switch.

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

    Syntax 

    ::TestShellAPI::MapPorts sourcePort destinationPort mappingType ?resultXml?

    Parameters

    TypeNameDescription
    string sourcePort
    Specify the source port.
    string destinationPort
    Specify the destination port.
    string mappingType
    Specify bidirectional or unidirectional as the mapping type.
    Use 'bi' for Bidirectional mapping or 'uni' for Unidirectional mapping.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::MapPorts "L1 Switch 1234/Blade 1/Port 1" "L1 Switch 1234/Blade 1/Port 3" bi resultXml

    back to TOC

    PowerCycleResourceCycle power for resource power ports.

    Cycles the power options for resource power ports.

    Syntax 

    ::TestShellAPI::PowerCycleResource reservationId resourceFullPath powerPortsFullPath delay ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.
    string resourceFullPath
    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.
    list powerPortsFullPath
    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.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::PowerCycleResource $reservationId "GenericResource 1234" {"GenericResource 1234/PowerPort 11"} 2 resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    PowerOffResourcePower off resource power ports.

    Powers off specified power ports.

    Syntax 

    ::TestShellAPI::PowerOffResource reservationId resourceFullPath powerPortsFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.
    string resourceFullPath
    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.
    list powerPortsFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::PowerOffResource $reservationId "GenericResource 1234" {"GenericResource 1234/PowerPort 11"} resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    PowerOnResourcePower on resource power ports.

    Powers on resource power ports.

    Syntax 

    ::TestShellAPI::PowerOnResource reservationId resourceFullPath powerPortsFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources.
    string resourceFullPath
    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.
    list powerPortsFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::PowerOnResource $reservationId "GenericResource 1234" {"GenericResource 1234/PowerPort 11"} resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    RemoveAttributeRestrictedValuesremove attribute restrictions

    remove attribute restrictions from family/model

    Syntax 

    ::TestShellAPI::RemoveAttributeRestrictedValues removeAttributeRestrictionRequests ?resultXml?

    Parameters

    TypeNameDescription
    list removeAttributeRestrictionRequests
    Attribute restrictions to remove".
    string ?resultXml?
    Specify the variable for the XML output.
    back to TOC

    RecheckConflictsView which resources are available for a reservation.

    Updates the list of available resources for a reservation.

    Syntax 

    ::TestShellAPI::RecheckConflicts reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RecheckConflicts $reservationId resultXml

    back to TOC

    ReleaseResourcesFromReservationRelease occupied testing resources.

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

    Syntax 

    ::TestShellAPI::ReleaseResourcesFromReservation reservationId resourcesFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ReleaseResourcesFromReservation $reservationId {"GenericResource 1234" "Router 1234/Port 1"} resultXml

    back to TOC

    ReleaseTopologyResourcesRelease resources used in topology.

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

    Syntax 

    ::TestShellAPI::ReleaseTopologyResources reservationId topologyFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string topologyFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ReleaseTopologyResources $reservationId "Temp Automation Resources/TP1" resultXml

    back to TOC

    RemoveGroupsFromDomainRemove groups from a domain.

    Remove groups from a domain.

    Syntax 

    ::TestShellAPI::RemoveGroupsFromDomain domainName groupNames ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    list groupNames
    Specify an array of one or more groups.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveGroupsFromDomain Global {QA_Users} resultXml

    back to TOC

    RemovePermittedUsersFromReservationRemove permitted users from a reservation.

    Remove one or more permitted users from the specified reservation.

    Syntax 

    ::TestShellAPI::RemovePermittedUsersFromReservation reservationId usernames ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list usernames
    List of permitted users to remove from the reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemovePermittedUsersFromReservation "2d2f7cde-20g3-4bac-80d2-e8cfhecef45b" {"name1"} resultXml

    back to TOC

    RemoveResourcesFromDomainRemove resources from a domain.

    Remove resources from a domain.

    Syntax 

    ::TestShellAPI::RemoveResourcesFromDomain domainName resourcesNames ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    list resourcesNames
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveResourcesFromDomain Domain1 {"Router 1234" "GenericResource 1234"} resultXml

    back to TOC

    RemoveResourcesFromReservationRemove resources from a reservation.

    Unlocks and removes resources from a reservation.

    Syntax 

    ::TestShellAPI::RemoveResourcesFromReservation reservationId resourcesFullPath deleteDeployedApps ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullPath
    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
    boolean deleteDeployedApps
    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
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveResourcesFromReservation $reservationId {"Router 1234" "GenericResource 1234"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Conflicts/>
				</ResponseInfo>

    back to TOC

    RemoveConnectorsFromReservationRemove connectors from a reservation.

    Removes the mapped connector between given end points.

    Syntax 

    ::TestShellAPI::RemoveConnectorsFromReservation reservationId endpoints ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list endpoints
    The list of removed endpoints.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveConnectorsFromReservation $reservationId {"Router 1234/Port 1" "GenericResource 1234/Port 1" "Router 1234/Port 1" "GenericResource 1234/Port 2"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Connectors>
				<Connector Alias="a connector" Type="Default" ResourceMappingType="bi" Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1">
				</Connector>
				<Connector Alias="uni connector" Type="Default" ResourceMappingType="uni" Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2">
				</Connector>
				</Connectors>
				</ResponseInfo>

    back to TOC

    RemoveRoutesFromReservationRemove routes from a reservation.

    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 

    ::TestShellAPI::RemoveRoutesFromReservation reservationId endpoints mappingType ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list endpoints
    The list of removed endpoints.
    string mappingType
    Specify bidirectional or unidirectional as the mapping type.
    Use 'bi' for bidirectional mapping or 'uni' for unidirectional mapping.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveRoutesFromReservation $reservationId {"Router 1234/Port 1" "GenericResource 1234/Port 1" "Router 1234/Port 1" "GenericResource 1234/Port 2"} bi resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1" Alias="a route" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 1"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 1" Target="GenericResource 1234/Port 1"/>
				</Segments>
				</Route>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2" Alias="uni route" RouteType="uni" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 2"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 2" Target="GenericResource 1234/Port 2"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

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

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

    Syntax 

    ::TestShellAPI::RemoveTopologiesFromDomain domainName topologyNames ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    list topologyNames
    Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveTopologiesFromDomain Domain1 {"Topology1"} resultXml

    back to TOC

    RemoveUsersFromGroupRemove users from a group.

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

    Syntax 

    ::TestShellAPI::RemoveUsersFromGroup usernames groupName ?resultXml?

    Parameters

    TypeNameDescription
    list usernames
    Specify an array of one or more users.
    string groupName
    Specify the name of the group.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveUsersFromGroup {User1234 User2345} QA_Users resultXml

    back to TOC

    RemoveTopologyCategoryRemoves a category from given topology.

    Removes a category from given topology.

    Syntax 

    ::TestShellAPI::RemoveTopologyCategory topologyFullPath categoryName ?resultXml?

    Parameters

    TypeNameDescription
    string topologyFullPath
    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 categoryName
    Specify the category's name which we want to remove.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example


    ::TestShellAPI::RemoveTopologyCategory "myDir/myTopology" lookUpCategory resultXml

    back to TOC

    SetResourcesFolderSet the folder of multiple resources.

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

    Syntax 

    ::TestShellAPI::SetResourcesFolder resourcesName targetFolder ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesName
    Specify the name of the root resources to move to the new target folder.
    string targetFolder
    The path of the target folder.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetResourcesFolder {resourcesName} targetFolder resultXml

    back to TOC

    RenameResourceRename a resource.

    Renames the specified resource.

    Syntax 

    ::TestShellAPI::RenameResource resourceFullPath resourceName ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 resourceName
    Specify a new resource name.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RenameResource "Router 1234" "Router 4321" resultXml

    back to TOC

    ResetResourceDriverReset a resource driver and cancel its commands.

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

    Syntax 

    ::TestShellAPI::ResetResourceDriver reservationId resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ResetResourceDriver $reservationId "Router 1234" resultXml

    Output

  • resultXml
    • <ResponseInfo Output="Reset completed"/>

    back to TOC

    RemoveAppFromReservationRemove app resource from existing reservation.

    Remove a deployed App resource from existing reservation.

    Syntax 

    ::TestShellAPI::RemoveAppFromReservation reservationId appName ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string appName
    Specify the name of the App.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveAppFromReservation 077e6b4f-5e70-46b5-aa4b-43e6f039acc3 "App in reservation" resultXml

    Output

  • resultXml
    • 				<ResponseInfo/>

    back to TOC

    GetAppsDetailsInReservationRetrieves information on Apps in the reservation.

    Retrieves information on Apps in the reservation.

    Syntax 

    ::TestShellAPI::GetAppsDetailsInReservation reservationId appNames ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list appNames
    Specify the name of the Apps.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetAppsDetailsInReservation 077e6b4f-5e70-46b5-aa4b-43e6f039acc3 {{"App1" "App2"}} resultXml

    Output

  • resultXml
    • 				<ResponseInfo/>

    back to TOC

    RemoveServicesFromReservationRemove services and apps from existing reservation.

    Remove services and apps from existing reservation.

    Syntax 

    ::TestShellAPI::RemoveServicesFromReservation reservationId services ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list services
    List of aliases. This list should contain the aliases for both the services and apps that should be removed.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemoveServicesFromReservation "b8ed1fb9-7903-40de-b5b4-f6cba31f6fa0" {"alias1" "alias2"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo/>

    back to TOC

    SaveReservationAsTopologyCreate a topology from an existing active reservation.

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

    Syntax 

    ::TestShellAPI::SaveReservationAsTopology reservationId folderFullPath topologyName includeInactiveRoutes ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string folderFullPath
    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 topologyName
    Specify the new name for the new topology.
    boolean includeInactiveRoutes
    Include disconnected routes in the created topology
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SaveReservationAsTopology $reservationId "Temp Automation Resources" TP1 1 resultXml

    Output

  • resultXml
    • 				<ResponseInfo Name="TP1">
				<Resources>
				<ResourceInfo Name="Router 1234/Port 1" FolderFullPath="Lab Routers" Address="1" FullAddress="192.168.1.201/1" RootAddress="192.168.1.201" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 1" Locked="true" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Studio" Username="admin" Created="2012-06-20T17:20:37"/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 3"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/Port 1" FolderFullPath="Temp Automation Resources" Address="1" FullAddress="192.168.1.20/1" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 1" Locked="true" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Studio" Username="admin" Created="2012-06-20T17:20:37"/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/Port 2" FolderFullPath="Temp Automation Resources" Address="2" FullAddress="192.168.1.20/2" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="Port 2" Locked="true" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo ReservationName="Immediate reservation" MachineName="PRODUCT-W7 - Tcl" Username="admin" Created="2012-06-20T17:20:37"/>
				<Connections FullPath="Temp Automation Resources/L1 Switch 1234/Blade 1/Port 2"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/PowerPort 11" FolderFullPath="Temp Automation Resources" Address="11" FullAddress="192.168.1.20/11" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="PowerPort 11" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/SmartPower2L 1234/PowerPort 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/PowerPort 12" FolderFullPath="Temp Automation Resources" Address="12" FullAddress="192.168.1.20/12" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="PowerPort 12" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/SmartPower2L 1234/PowerPort 2"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234/ConsolePort 21" FolderFullPath="Temp Automation Resources" Address="21" FullAddress="192.168.1.20/21" RootAddress="192.168.1.20" ResourceFamilyName="Generic Port" ResourceModelName="Generic Port Model" Alias="ConsolePort 21" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				<Connections FullPath="Temp Automation Resources/ConsoleServer 1234/ConsolePort 1"/>
				</ResourceInfo>
				<ResourceInfo Name="GenericResource 1234" FolderFullPath="Temp Automation Resources" Address="192.168.1.20" FullAddress="192.168.1.20" RootAddress="192.168.1.20" ResourceFamilyName="Generic Resource" ResourceModelName="Generic Resource Model" Alias="GenericResource 1234" Locked="false" Excluded="false" WillBeLocked="true">
				<ResourceAttributes/>
				<LockInfo/>
				</ResourceInfo>
				<ResourceInfo Name="Router 1234" FolderFullPath="Lab Routers" Address="192.168.1.201" FullAddress="192.168.1.201" RootAddress="192.168.1.201" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Alias="Router 1234" Locked="false" Excluded="false" WillBeLocked="false">
				<ResourceAttributes>
				<ResourceAttribute Name="SW_Version" Value="" Type="String"/>
				</ResourceAttributes>
				<LockInfo/>
				</ResourceInfo>
				</Resources>
				<AbstractResources/>
				<Routes>
				<Route Source="GenericResource 1234/Port 1" Target="Router 1234/Port 1" RouteType="bi" Shared="true">
				<Segments>
				<Segment Source="GenericResource 1234/Port 1" Target="Router 1234/Port 1"/>
				</Segments>
				</Route>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2" RouteType="uni" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    SecureLogonLog in to the TestShell service using the AuthToken.

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

    Syntax 

    ::TestShellAPI::SecureLogon token domainName ?resultXml?

    Parameters

    TypeNameDescription
    string token
    Token to logon with.
    string domainName
    Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SecureLogon xoV3libZzEG/ii7ZQqAuqw== Global resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="LogonResponseInfo">
				<Domain Name="Global" Description="A domain that includes all available resources" DomainId="dbaf480c-09f7-46d3-a2e2-e35d3e374a16" />
				<User Name="admin" IsAdmin="false" IsActive="false" IsDomainAdmin="false" />
				<Token Token="Yzhumq0qVkyIwyMkxzk7wQ==" />
				</ResponseInfo>

    back to TOC

    SetAttributeValueSet an attribute value.

    Sets the value of the specified attribute.

    Syntax 

    ::TestShellAPI::SetAttributeValue resourceFullPath attributeName attributeValue ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 attributeName
    Specify the attribute name.
    string attributeValue
    Specify the attribute’s value.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetAttributeValue "Router 1234" "SW_Version" "1.3" resultXml

    back to TOC

    SetAttributesValuesSets new attribute values for the specified resources.

    Sets new attribute values for the specified resources.

    Syntax 

    ::TestShellAPI::SetAttributesValues resourcesAttributesUpdateRequests ?resultXml?

    Parameters

    TypeNameDescription
    list resourcesAttributesUpdateRequests
    Specify a list of resources, attribute names, and new attribute values (up to 10000 rows).
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetAttributesValues {{resource01 {attribute01 value01 attribute02 value02}} {resource02 {attribute01 value01 attribute02 value02}}} resultXml

    back to TOC

    SetBaudRateSet console port baud rate.

    Sets the baud rate for one or more console ports.

    Syntax 

    ::TestShellAPI::SetBaudRate reservationId resourceFullPath consolePortsFullPath baudRate ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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.
    list consolePortsFullPath
    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 baudRate
    Specify the baud rate to apply to the ports.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetBaudRate $reservationId "GenericResource 1234" {"GenericResource 1234/ConsolePort 21"} 9600 resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    SetConsoleForXModemSet a console for Xmodem.

    Sets one or more consoles for Xmodem.

    Syntax 

    ::TestShellAPI::SetConsoleForXModem reservationId resourceFullPath consolePortsFullPath baudRate ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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.
    list consolePortsFullPath
    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 baudRate
    Specify the baud rate to apply to the ports.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetConsoleForXModem $reservationId "GenericResource 1234" {"GenericResource 1234/ConsolePort 21"} 9600 resultXml

    Output

  • resultXml
    • <ResponseInfo Output=""/>

    back to TOC

    SetResourceLiveStatusSets the live status of a resource.

    Sets the live status of the resource

    Syntax 

    ::TestShellAPI::SetResourceLiveStatus resourceFullName liveStatusName additionalInfo ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullName
    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 liveStatusName
    Resource live status name
    string additionalInfo
    Resource live status additional info
    string ?resultXml?
    Resource live status additional info
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetResourceLiveStatus {"myPath"} {"Online"} {"Resource was responding to pings at 12/12/2013 10:35 AM"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo type="ResourceLiveStatusInfo" liveStatusName="Online" liveStatusDescription="Resource was responding to pings at 12/12/2013 10:35 AM"/>
				</Response>

    back to TOC

    SetReservationLiveStatusSets the live status of the reservation.

    Sets the live status of the reservation

    Syntax 

    ::TestShellAPI::SetReservationLiveStatus reservationId liveStatusName additionalInfo ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specifies the string that represents the reservation’s unique identifier.
    string liveStatusName
    Reservation live status name
    string additionalInfo
    Reservation live status additional info
    string ?resultXml?
    Reservations live status additional info.

    Example

    ::TestShellAPI::SetReservationLiveStatus {DCFF5355-58F9-41F8-ABD0-2E666AC9B0FB} {"Pass"} {"Reservation was responding to pings at 12/12/2013 10:35 AM"} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<ReservationLiveStatuses>
				<ReservationLiveStatus reservationId="344c2d21-578c-4653-a826-54c2035ff998" ReservationLiveStatusName="Pass"></ReservationLiveStatus>
				</ReservationLiveStatuses>
				</ResponseInfo>

    back to TOC

    SetResourceSharedStateSet the resource sharing state.

    Sets the resource sharing state.

    Syntax 

    ::TestShellAPI::SetResourceSharedState reservationId resourcesFullName isShared ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullName
    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
    boolean isShared
    Specify whether to allow sharing of the resource.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetResourceSharedState $reservationId {"Router 1234"} 1 resultXml

    back to TOC

    SetRouteAttributesSet a route's attributes.

    Sets attributes and associated values for a specified route.

    Syntax 

    ::TestShellAPI::SetRouteAttributes reservationId sourceResourceFullPath targetResourceFullPath applyChangesTo attributeRequests ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullPath
    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 targetResourceFullPath
    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 applyChangesTo
    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.
    Use 0 for Source, 1 for Target and 2 for All.
    list attributeRequests
    Specify an array of attributes and associated attribute values.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetRouteAttributes $reservationId "Router 1234/Port 1" "GenericResource 1234/Port 1" 2 {"SW_Version" "1.3"} resultXml

    back to TOC

    SetRouteAttributesViaAliasSet a route's attributes.

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

    Syntax 

    ::TestShellAPI::SetRouteAttributesViaAlias reservationId routeAlias applyChangesTo attributeRequests ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string routeAlias
    Specify the route’s alias.
    string applyChangesTo
    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.
    Use 0 for Source, 1 for Target and 2 for All.
    list attributeRequests
    Specify an array of attributes and associated attribute values.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetRouteAttributesViaAlias $reservationId "route1" 2 {"SW_Version" "1.3"} resultXml

    back to TOC

    SetConnectorAttributesSet a connector's attributes.

    Sets attributes and associated values for a specified connector.

    Syntax 

    ::TestShellAPI::SetConnectorAttributes reservationId sourceResourceFullName targetResourceFullName attributeRequests ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullName
    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 targetResourceFullName
    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.
    list attributeRequests
    Specify a matrix of attributes and associated attribute values.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetConnectorAttributes "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "Router 1234/Port 1" "GenericResource 1234/Port 1" {{"SW_Version" "1.3"}} ?resultXml

    back to TOC

    SetConnectorAttributesViaAliasSet a connector's attributes.

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

    Syntax 

    ::TestShellAPI::SetConnectorAttributesViaAlias reservationId connectorAlias attributeRequests ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string connectorAlias
    Specify the connector’s alias.
    list attributeRequests
    Specify a matrix of attributes and associated attribute values.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetConnectorAttributesViaAlias "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "connector1" {{"SW_Version" "1.3"}} ?resultXml

    back to TOC

    SetGroupDomainPermissionsSet the permission level of a group in domain.

    Set the permission level of a group in domain.

    Syntax 

    ::TestShellAPI::SetGroupDomainPermissions domainName groupName viewOnly ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string groupName
    Specify the group name.
    boolean viewOnly
    Specify if the group should be have view only permissions.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetGroupDomainPermissions Global RND_Users 1 resultXml

    back to TOC

    SetConnectorsInReservationReserve specified connectors.

    Adds connectors between source and target or update existing ones.

    Syntax 

    ::TestShellAPI::SetConnectorsInReservation reservationId connectors ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list connectors
    List of connectors to set in the reservation.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetConnectorsInReservation "28cb2a71-c8fc-4f41-a22b-e65685ebed14" {{"bridge1/port1" "bridge2/port1" "bi" "some alias"}} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Connectors>
				<Connector Alias="some alias" Type="Default" ResourceMappingType="bi" Source="bridge1/port1" Target="bridge2/port1"></Connector>
				</Connectors>
				</ResponseInfo>

    back to TOC

    SetTopologyCategorySets a category to a topology.

    Set a category to given topology

    Syntax 

    ::TestShellAPI::SetTopologyCategory topologyFullPath categoryName categoryValue ?resultXml?

    Parameters

    TypeNameDescription
    string topologyFullPath
    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 categoryName
    Specify the category's name which we want to set
    string categoryValue
    Specify the category's value
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example


    ::TestShellAPI::SetTopologyCategory "dir1/myTopology" lookUpCategory bonjour resultXml

    back to TOC

    SyncResourceFromDeviceUpdate a resource with current device settings and mappings.

    Synchronizes the specified resource with current device settings and mappings.

    Syntax 

    ::TestShellAPI::SyncResourceFromDevice resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SyncResourceFromDevice "L1 Switch 1234" resultXml

    back to TOC

    SyncResourceToDeviceUpdate device settings and mappings from the resource.

    Updates device settings and mappings from the specified resource.

    Syntax 

    ::TestShellAPI::SyncResourceToDevice resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SyncResourceToDevice "L1 Switch 1234" resultXml

    back to TOC

    SetReservationResourcePositionSet resource position in a reservation.

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

    Syntax 

    ::TestShellAPI::SetReservationResourcePosition reservationId resourceFullName x y ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullName
    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.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetReservationResourcePosition $reservationId $resourceFullName $x $y resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				</ResponseInfo>

    back to TOC

    SetServiceDriverSets a service model driver.

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

    Syntax 

    ::TestShellAPI::SetServiceDriver serviceName driverName ?resultXml?

    Parameters

    TypeNameDescription
    string serviceName
    Specify the name of the service model.
    string driverName
    Specify the name of the driver.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetServiceDriver "Example_service_model" "NewDriver" resultXml

    back to TOC

    SetServiceLiveStatusSets the live status of a service.

    Sets the live status of a service

    Syntax 

    ::TestShellAPI::SetServiceLiveStatus reservationId serviceAlias liveStatusName additionalInfo ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation's unique identifier.
    string serviceAlias
    Specify the string that represents the service's alias.
    string liveStatusName
    Resource live status name
    string additionalInfo
    Resource live status additional info
    string ?resultXml?
    Resource live status additional info
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetServiceLiveStatus "0e937c16-2865-4ad1-b843-aa7608282e56" "My Service" "Online" "Resource was responding to pings at 12/12/2013 10:35 AM" resultXml

    Output

  • resultXml
    • 			<ResponseInfo/>
			</Response>

    back to TOC

    GetServiceLiveStatusGets the live status of a service.

    Gets the live status of a service

    Syntax 

    ::TestShellAPI::GetServiceLiveStatus reservationId serviceAlias ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation's unique identifier.
    string serviceAlias
    Specify the string that represents the service's alias.
    string ?resultXml?
    Resource live status additional info
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetServiceLiveStatus "0e937c16-2865-4ad1-b843-aa7608282e56" "My Service" resultXml

    Output

  • resultXml
    • 				<ResponseInfo/>
				</Response>

    back to TOC

    SetReservationServicePositionSet service position in a reservation.

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

    Syntax 

    ::TestShellAPI::SetReservationServicePosition reservationId serviceAlias x y ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string serviceAlias
    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.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetReservationServicePosition $reservationId $serviceAlias $x $y

    Output

  • resultXml
    • 				<ResponseInfo>
				</ResponseInfo>

    back to TOC

    SetServiceAttributesValuesSet a resource's attributes.

    Sets attributes and associated values for a specified resource.

    Syntax 

    ::TestShellAPI::SetServiceAttributesValues reservationId serviceAlias attributeRequests ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string serviceAlias
    Specify the service name.
    list attributeRequests
    Specify a matrix of attributes and associated attribute values.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::SetServiceAttributesValues "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "Service1" {{"SW_Version" "1.3"}}

    back to TOC

    TerminateReservationTerminate a reservation.

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

    Syntax 

    ::TestShellAPI::TerminateReservation reservationId ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::TerminateReservation $reservationId resultXml

    back to TOC

    UnlockResourceUnlock a resource.

    Unlocks the specified resource.

    Syntax 

    ::TestShellAPI::UnlockResource reservationId resourceFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string resourceFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UnlockResource $reservationId "GenericResource 1234/Port 1" resultXml

    back to TOC

    UnlockResourcesUnlock multiple resources.

    Unlocks multiple resources.

    Syntax 

    ::TestShellAPI::UnlockResources reservationId resourcesFullPath ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullPath
    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 ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UnlockResources $reservationId {"GenericResource 1234/Port 1" "GenericResource 1234/Port 2"} resultXml

    back to TOC

    UnMapPortsRemove mapping for a pair of mapped ports.

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

    Syntax 

    ::TestShellAPI::UnMapPorts portA portB ?resultXml?

    Parameters

    TypeNameDescription
    string portA
    Specify the source port. (i.e. Folder1/Chassis1/Blade1/Port1).
    string portB
    Specify the destination port. (i.e. Folder1/Chassis1/Blade1/Port1).
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UnMapPorts "L1 Switch 1234/Blade 1/Port 1" "L1 Switch 1234/Blade 1/Port 3" resultXml

    back to TOC

    UpdateConnectorAliasInReservationUpdate connector alias in reservation.

    Sets alias for a specified connector.

    Syntax 

    ::TestShellAPI::UpdateConnectorAliasInReservation reservationId sourceResourceFullName targetResourceFullName direction alias ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullName
    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 targetResourceFullName
    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.
    Use 'bi' for bidirectional or 'uni' for unidirectional connector.
    string alias
    Specify the connector’s alias.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateConnectorAliasInReservation "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "Router 1234/Port 1" "GenericResource 1234/Port 1" "bi" "some alias" ?resultXml

    back to TOC

    UpdateConnectionWeightUpdate the connection weight between two resources.

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

    Syntax 

    ::TestShellAPI::UpdateConnectionWeight resourceAFullPath resourceBFullPath weight ?resultXml?

    Parameters

    TypeNameDescription
    string resourceAFullPath
    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 resourceBFullPath
    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.
    number weight
    Specify a number to represent the connection weight between the specified resources.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateConnectionWeight "Router 1234/Port 1" "L1 Switch 1234/Blade 1/Port 3" 5 resultXml

    back to TOC

    UpdateDomainTopologiesFolderUpdate the domain’s topologies folder.

    Update the domain’s topologies folder.

    Syntax 

    ::TestShellAPI::UpdateDomainTopologiesFolder domainName topologiesFolder ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string topologiesFolder
    Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateDomainTopologiesFolder "Domain1" "Domain Topologies" resultXml

    back to TOC

    UnarchiveDomainUn archive the domain

    Unarchive a domain. New reservation can be created.

    Syntax 

    ::TestShellAPI::UnarchiveDomain domainName ?resultXml?

    Parameters

    TypeNameDescription
    string domainName
    Specify the name of the domain.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UnarchiveDomain "Domain1" resultXml

    back to TOC

    UpdateGroup

    Modifies the group name and description.

    Syntax 

    ::TestShellAPI::UpdateGroup groupName newName description groupRole ?resultXml?

    Parameters

    TypeNameDescription
    string groupName
    Specify the name of the group.
    string newName
    Specify the new group name.
    string description
    Provide a short description of the group.
    string groupRole
    Specify the role of the group, possible values: External, Regular, DomainAdmin or Ignore (to keep the current role).
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateGroup QA_Users QAUsers "QA users group" resultXml

    back to TOC

    UpdatePhysicalConnectionDefine the physical connection between two resources.

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

    Syntax 

    ::TestShellAPI::UpdatePhysicalConnection resourceAFullPath resourceBFullPath overrideExistingConnections ?resultXml?

    Parameters

    TypeNameDescription
    string resourceAFullPath
    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 resourceBFullPath
    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.
    boolean overrideExistingConnections
    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.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdatePhysicalConnection "Router 1234/Port 1" "L1 Switch 1234/Blade 1/Port 3" 1 resultXml

    back to TOC

    UpdatePhysicalConnectionsDefine physical connections between resources.

    Define physical connections (cable links) between resources.

    Syntax 

    ::TestShellAPI::UpdatePhysicalConnections physicalConnectionUpdateRequest overrideExistingConnections ?resultXml?

    Parameters

    TypeNameDescription
    list physicalConnectionUpdateRequest
    Specify a list of physical connections to update.
    boolean overrideExistingConnections
    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.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdatePhysicalConnections {{resource001 resource002 100} {"Router 1234/Port 1" "L1 Switch 1234/Blade 1/Port 3"}} 1 resultXml

    back to TOC

    RemapConnectionsRemap connections between resources.

    Remap connections between resources.

    Syntax 

    ::TestShellAPI::RemapConnections reservationId resourcesFullPath printOutput ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list resourcesFullPath
    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
    boolean printOutput
    Defines whether to print the command output in the reservation command output window.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemapConnections $reservationId {"Router 1234" "GenericResource 1234"} 1 resultXml

    Output

  • resultXml
    • 				<ResponseInfo/>

    back to TOC

    UpdateReservationDescriptionChange a reservation description.

    Modifies the description for a specified reservation.

    Syntax 

    ::TestShellAPI::UpdateReservationDescription reservationId description ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation ID.
    string description
    Provide an updated description of the reservation. This text will replace the current description.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateReservationDescription $reservationId "New Description" resultXml

    back to TOC

    UpdateReservationNameChange a reservation name.

    Modifies the name for a specified reservation.

    Syntax 

    ::TestShellAPI::UpdateReservationName reservationId name ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation ID.
    string name
    Provide an updated name of the reservation. This text will replace the current name.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateReservationName $reservationId "New Name" resultXml

    back to TOC

    UpdateReservationGlobalInputsUpdates the unlinked global inputs in a specified reservation.

    Updates the unlinked global inputs in a specified reservation.

    Syntax 

    ::TestShellAPI::UpdateReservationGlobalInputs reservationId globalInputs ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation ID.
    list globalInputs
    Global inputs associated with the specified reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateReservationGlobalInputs "af626b88-458b-4e7a-9054-c03d8cffa260" {{"attribute" "new value"}} resultXml

    back to TOC

    ChangeReservationOwnerUpdates the owner in a specified reservation.

    Updates the owner in a specified reservation.

    Syntax 

    ::TestShellAPI::ChangeReservationOwner reservationId ownerName ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the reservation ID.
    string ownerName
    New owner for the reservation.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ChangeReservationOwner "af626b88-458b-4e7a-9054-c03d8cffa260" "admin"

    back to TOC

    UpdateResourceAddressUpdate a resource address.

    Modifies the address for a specified resource.

    Syntax 

    ::TestShellAPI::UpdateResourceAddress resourceFullPath resourceAddress ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 resourceAddress
    Specify the resource’s new address.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateResourceAddress "Router 1234" "192.168.1.201" resultXml

    back to TOC

    UpdateResourceDescriptionChange a resource description.

    Modifies the description for a specified resource.

    Syntax 

    ::TestShellAPI::UpdateResourceDescription resourceFullPath resourceDescription ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 resourceDescription
    Provide an updated description of the resource. This text will replace the current description.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateResourceDescription "Router 1234" "a new description for the resource" resultXml

    back to TOC

    UpdateResourceDriverUpdate a resource driver.

    Updates the driver for a specified resource.

    Syntax 

    ::TestShellAPI::UpdateResourceDriver resourceFullPath driverName ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullPath
    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 driverName
    Specify the name of the driver.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateResourceDriver "Router 1234" "NewDriver" resultXml

    back to TOC

    UpdateTopologyOwnerUpdate the topology owner.

    Update the topology owner.

    Syntax 

    ::TestShellAPI::UpdateTopologyOwner topologyName ownerName ?resultXml?

    Parameters

    TypeNameDescription
    string topologyName
    Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
    string ownerName
    Specify the topology owner.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateTopologyOwner "Temp Automation Resources/TP1" "admin" resultXml

    back to TOC

    AddPermittedEditorsToTopologyAdd permitted editors to a topology.

    Add permitted editors to a topology.

    Syntax 

    ::TestShellAPI::AddPermittedEditorsToTopology topologyName editorNames ?resultXml?

    Parameters

    TypeNameDescription
    string topologyName
    Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
    list editorNames
    A list of user names to be added as permitted editors to a topology.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::AddPermittedEditorsToTopology "Temp Automation Resources/TP1" {{"admin"} {"John Doe"}} resultXml

    back to TOC

    RemovePermittedEditorsFromTopologyRemove permitted editors from a topology.

    Remove permitted editors from a topology.

    Syntax 

    ::TestShellAPI::RemovePermittedEditorsFromTopology topologyName editorNames ?resultXml?

    Parameters

    TypeNameDescription
    string topologyName
    Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName.
    list editorNames
    A list of user names to be removed as permitted editors from a topology.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RemovePermittedEditorsFromTopology "Temp Automation Resources/TP1" {{"admin"} {"John Doe"}} resultXml

    back to TOC

    UpdateTopologyDriverUpdate the topology driver.

    Update the topology driver.

    Syntax 

    ::TestShellAPI::UpdateTopologyDriver topologyFullPath driverName ?resultXml?

    Parameters

    TypeNameDescription
    string topologyFullPath
    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 driverName
    Specify the name of the driver. Leave empty to remove associated driver.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateTopologyDriver "Topologies/Topology1" "Topology Driver" resultXml

    back to TOC

    UpdateUser

    Configures a user's email and activity settings.

    Syntax 

    ::TestShellAPI::UpdateUser username email isActive ?resultXml?

    Parameters

    TypeNameDescription
    string username
    The username of the user you want to update.
    string email
    The new email address to update to.
    boolean isActive
    Grant or deny active access to the application.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateUser User1234 "user1234@work.com" 1 resultXml

    back to TOC

    UpdateUsersLimitations

    Update MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes and MaxOwnedBlueprints.

    Syntax 

    ::TestShellAPI::UpdateUsersLimitations userUpdateRequests ?resultXml?

    Parameters

    TypeNameDescription
    list userUpdateRequests
    List of Username, MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes, and MaxOwnedBlueprints of the users you wish to update.
    string ?resultXml?
    Specify the variable for the XML output.

    Example

    ::TestShellAPI::UpdateUsersLimitations {{"username1" "1" "" "" ""} {"username2" "100" "50" "20" "10" "10"}} resultXml

    back to TOC

    UpdateUserGroupsModify a user's group memberships.

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

    Syntax 

    ::TestShellAPI::UpdateUserGroups username groupsNames ?resultXml?

    Parameters

    TypeNameDescription
    string username
    Specify the name of the user.
    list groupsNames
    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.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateUserGroups User1234 {QA_Users Testers_Users} resultXml

    back to TOC

    UpdateUserPasswordModify a user's password.

    Changes a user's password.

    Syntax 

    ::TestShellAPI::UpdateUserPassword username password ?resultXml?

    Parameters

    TypeNameDescription
    string username
    Specify the name of the user.
    string password
    Specify the user's new login password.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateUserPassword User1234 Pass1234 resultXml

    back to TOC

    UpdateRouteAliasesInReservationUpdate route aliases in a reservation

    Update route aliases in a reservation.

    Syntax 

    ::TestShellAPI::UpdateRouteAliasesInReservation reservationId routeAliases ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specifies the string that represents the reservation’s unique identifier.
    list routeAliases
    Specify a matrix of route source, route target and alias.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateRouteAliasesInReservation $reservationId {{"Router 1234/Port 1" "GenericResource 1234/Port 2" "uni route"}} resultXml

    Output

  • resultXml
    • 				<ResponseInfo>
				<Routes>
				<Route Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2" RouteType="uni" Shared="true">
				<Segments>
				<Segment Source="Router 1234/Port 1" Target="L1 Switch 1234/Blade 1/Port 3"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 2"/>
				<Segment Source="L1 Switch 1234/Blade 1/Port 2" Target="GenericResource 1234/Port 2"/>
				</Segments>
				</Route>
				</Routes>
				</ResponseInfo>

    back to TOC

    UpdateDriverUpdate Driver

    Uploads a new version of an existing driver

    Syntax 

    ::TestShellAPI::UpdateDriver driverName driverFile driverFileName ?resultXml?

    Parameters

    TypeNameDescription
    string driverName
    Specify the driver name.
    string driverFileName
    Specify the driver file name/full path.
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateDriver "TestDriver" "23423234....==" "TestDriver_Update.zip" resultXml

    back to TOC

    UpdateScriptUpdate Script

    Uploads a new version of an existing script

    Syntax 

    ::TestShellAPI::UpdateScript scriptName scriptFile scriptFileName ?resultXml?

    Parameters

    TypeNameDescription
    string scriptName
    Specify the script name.
    string scriptFile
    Specify the script file data (base64 file representation).
    string scriptFileName
    Specify the script file name(optional).
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::UpdateScript "TestScript" "23423234....==" "TestScript_Update.zip" resultXml

    back to TOC

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

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

    Syntax 

    ::TestShellAPI::WriteMessageToReservationOutput reservationId message ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string message
    Output message to the command output window.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::WriteMessageToReservationOutput "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "this is an output from API"

    back to TOC

    GetAllApprovalRequestsGet all approval requests.

    Get all the approval requests.

    Syntax 

    ::TestShellAPI::GetAllApprovalRequests ?resultXml?

    Parameters

    TypeNameDescription
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetAllApprovalRequests resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetAllApprovalRequestsResponseInfo">
				<ApprovalRequestResponseInfos>				
				<ApprovalRequest Id="1" RequestedEntityId="de6f5e37-e3e3-46d0-b915-07a1f30c07d4" RequestedEntityType="Blueprint" UserInfoId="3" StartTime="01/02/2023" EndTime="02/02/2023 14:00:00" State="Pending" CreationDate="30/01/2023 13:18:42" ModifiedDate="30/01/2023 13:18:42" EntityName="BlueprintName" IsApprover="true" RequesterName="userA">
				<Duration>60</Duration>
				</ApprovalRequest>
				</ApprovalRequestResponseInfos>
				</ResponseInfo>

    back to TOC

    GetApprovalRequestGet Approval request.

    Get approval request info.

    Syntax 

    ::TestShellAPI::GetApprovalRequest id ?resultXml?

    Parameters

    TypeNameDescription
    number id
    Specify the number that represents the request’s unique identifier.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetApprovalRequestResponseInfo" Id="1" RequestedEntityId="de6f5e37-e3e3-46d0-b915-07a1f30c07d4" RequestedEntityType="Blueprint" UserInfoId="3" StartTime="01/02/2023" EndTime="02/02/2023 14:00:00" State="Pending" CreationDate="30/01/2023 13:18:42" ModifiedDate="30/01/2023 13:18:42" EntityName="BlueprintName" IsApprover="true" RequesterName="userA">
				<Duration>60</Duration>
				</ResponseInfo>

    back to TOC

    CreateBlueprintApprovalRequestCreate a new blueprint approval request.

    Create a new approval request.

    Syntax 

    ::TestShellAPI::CreateBlueprintApprovalRequest entityId requestNotes globalInputs requirementsInputs additionalInfoInputs startTime endTime duration ?resultXml?

    Parameters

    TypeNameDescription
    string entityId
    Unique identifier of the entity (Blueprint id).
    string requestNotes
    Request description (optional).
    list globalInputs
    Global inputs associated with the specified topology. For example: {['Input Name', 'Value';]}.
    list requirementsInputs
    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.
    list additionalInfoInputs
    Additional info inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value';]}.
    string startTime
    Start time of the request (leave empty to immediately request approval).
    string endTime
    End time of the request, after which the request will be invalid (leave empty for unlimited request time).
    string duration
    Time in minutes to consume the entity. For example, sandbox duration (leave empty for unlimited consumption time).
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::CreateBlueprintApprovalRequest de6f5e37-e3e3-46d0-b915-07a1f30c07d4 "request notes" {{"GlobalInputName_0" "GlobalInputValue_0"} {"GlobalInputName_1" "GlobalInputValue_1"}} {{"ResourceName_0" "RequiredInputName_0" "RequiredInputValue_0" "RequiredInputType_0"}} {{"ResourceName_0" "AdditionalInfoName_0" "AdditionalInfoValue_0"}} 2023-01-01T12:00:00 2023-02-0212:00:00 60 resultXml

    Output

  • resultXml
    • <ResponseInfo xsi:type="CreateApprovalRequestResponseInfo" Id="3"/>

    back to TOC

    DeleteApprovalRequestDelete an approval request.

    Delete an approval request.

    Syntax 

    ::TestShellAPI::DeleteApprovalRequest id ?resultXml?

    Parameters

    TypeNameDescription
    number id
    Unique id of the request.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteApprovalRequest 3

    back to TOC

    ApproveApprovalRequestApprove an approval request.

    Approve an approval request.

    Syntax 

    ::TestShellAPI::ApproveApprovalRequest id message ?resultXml?

    Parameters

    TypeNameDescription
    number id
    Unique id of the request.
    string message
    message (optional).
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ApproveApprovalRequest 3, "approve message"

    back to TOC

    RejectApprovalRequestReject an approval request.

    Reject an approval request.

    Syntax 

    ::TestShellAPI::RejectApprovalRequest id message ?resultXml?

    Parameters

    TypeNameDescription
    number id
    Unique id of the request.
    string message
    message (optional).
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::RejectApprovalRequest 3, message

    back to TOC

    ConsumeApprovalRequestConsume an approval request.

    Consume an approval request.

    Syntax 

    ::TestShellAPI::ConsumeApprovalRequest id name startTime endTime ?resultXml?

    Parameters

    TypeNameDescription
    number id
    Unique id of the request.
    string name
    Name for the consumed entity (Sandbox name).
    string startTime
    Start time of the request (leave empty for immediate use).
    string endTime
    End time of the request (leave empty for unlimited duration).
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::ConsumeApprovalRequest 3 NewReservation 2023-01-01T14:00:00 2023-01-0114:30:00

    Output

  • resultXml
    • <ResponseInfo xsi:type="ConsumeApprovalRequest" Id="3"/>

    back to TOC

    MoveResourceMove resource to a new parent.

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

    Syntax 

    ::TestShellAPI::MoveResource resourceFullName fullTargetPath disconnectResource ?resultXml?

    Parameters

    TypeNameDescription
    string resourceFullName
    Specify the full name of the resource to be moved.
    string fullTargetPath
    The full path of the target parent. Can be either a resource or a folder (to make resource a root)
    string disconnectResource
    When set to true all resource and child connections will be removed. If false will block move when a connection exists
    string ?resultXml?
    Specify the variable for the XML output. If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::MoveResource "Router 1/Port 1" "Router 2" "True"

    back to TOC

    GetSystemInfoGet system information

    Get the system information.

    Syntax 

    ::TestShellAPI::GetSystemInfo ?resultXml?

    Parameters

    TypeNameDescription
    string version
    System version.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetSystemInfo resultXml

    Output

  • resultXml
    • 				<ResponseInfo xsi:type="GetSystemInfoResponseInfo" Version="2024.1">				
				</ResponseInfo>

    back to TOC

    GetExecutionServersGet all Execution Servers.

    Get all the Execution Servers.

    Syntax 

    ::TestShellAPI::GetExecutionServers ?resultXml?

    Parameters

    TypeNameDescription
    list ExecutionServers
    Execution Servers details.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::GetExecutionServers resultXml

    back to TOC

    DeleteExecutionServerDelete an Execution Server.

    Delete an Execution Server.

    Syntax 

    ::TestShellAPI::DeleteExecutionServer id ?resultXml?

    Parameters

    TypeNameDescription
    string id
    Unique id of the Execution Server.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::DeleteExecutionServer "2642aad7-c446-4b79-98db-29c1d9ed33ba"

    back to TOC

    SetWorkOrderResourceStateSets state of a work order resource in a reservation.

    Sets state of a work order resource in a reservation.

    Syntax 

    ::TestShellAPI::SetWorkOrderResourceState reservationId abstractFullName workOrderResourceState ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string abstractFullName
    Specifies work order resource request full name.
    string workOrderResourceState
    Specifies work order resource request state.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::workOrderResourceState "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "AbstractBlade" "Completed"

    back to TOC

    SetWorkOrderResourceCommentSets comment of a work order resource in a reservation.

    Sets comment of a work order resource in a reservation.

    Syntax 

    ::TestShellAPI::SetWorkOrderResourceComment reservationId abstractFullName comment ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string abstractFullName
    Specifies work order resource request full name.
    string comment
    Specifies work order resource request comment.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::comment "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "AbstractBlade" "comment for abstract blade"

    back to TOC

    UnselectWorkOrderResourceUnselects work order resource resolved resource in a reservation.

    Unselects work order resource resolved resource in a reservation.

    Syntax 

    ::TestShellAPI::UnselectWorkOrderResource reservationId abstractFullName ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string abstractFullName
    Specifies work order resource request full name.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::comment "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "AbstractBlade"

    back to TOC

    SelectWorkOrderResourceSelects concrete resource for work order resource in a reservation.

    Selects concrete resource for work order resource in a reservation.

    Syntax 

    ::TestShellAPI::SelectWorkOrderResource reservationId abstractFullName resourceFullName ?resultXml?

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string abstractFullName
    Specifies work order resource request full name.
    string resourceFullName
    Specify full name of the resource.
    string ?resultXml?
    Specify the variable for the XML output.
    If a variable is not provided, the results will be sent to stdout.

    Example

    ::TestShellAPI::comment "2623d08d-9d19-4b95-a8dc-d7cca5ea05fb" "abstractBlade" "Blade2/Port1"

    back to TOC