8.0.0 TestShell API TCL Reference Guide


ActivateTopologyActivate a topology.

Activates a specified topology.

Syntax

::TestShellAPI::ActivateTopology reservationId topologyFullPath ?resultXml?

Parameters

TypeNameDescription
string reservationId
Specify the string that represents the reservation’s unique identifier.
string topologyFullPath
Specify the full 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::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 ?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::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

    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 ?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)
    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 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 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 the full topology name. Include 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. 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 ?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 notificationMinutesBeforeEnd ?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)
    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 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 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 the full topology name. Include 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. 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 ?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
    Specify a matrix of resources to add. For example: {['Resource Family','Resource Model','Resource Name','Resource Address','Folder Full Path','Parent Resource Full Path','Resource Description';]}
    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 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::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 and optionally, releases all reservation resources.

    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

    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

    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

    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 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::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.
    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
    back to TOC
    back to TOC
    back to TOC
    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 ?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.
    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 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 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
    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
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    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.

    Syntax

    ::TestShellAPI::GetReservationDetails 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::GetReservationDetails $reservationId resultXml

    Output

  • resultXml
  •         <ResponseInfo>
            <ReservationDescription Id="caf0324e-680c-4555-8620-bcdab99de690" Name="Rerservation" StartTime="03/02/2015 18:21:00" EndTime="03/02/2015 20:21:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Started" ProvisioningStatus="Not Run" ActualEndTime="" CreateDate="03/02/2015 18:21:56" ModificationDate="03/02/2015 18:21:56" 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/>
            <TopologiesReservedResources/>
            <Conflicts/>
            <TopologiesRouteInfo/>
            <TopologiesResourcesAttributeInfo/>
            <TopologiesInstructionsInfo>
            <TopologyInstructions TopologyName="Environment-03-02-2015 18-21">
            <Instructions/>
            </TopologyInstructions>
            </TopologiesInstructionsInfo>
            <ActiveRoutesInfo/>
            <RequestedRoutesInfo/>
            <Connectors/>
            <ReservationLiveStatus ReservationId="caf0324e-680c-4555-8620-bcdab99de690"/>
            <Services/>
            </ReservationDescription>
            <Apps>
            <ReservedApp Name="MonitoringApp">
            <LogicalResource Family="Monitoring" Model="DefaultMonitoring"/>
            </ReservedApp>
            </Apps>
            </ResponseInfo>
          

    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    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
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    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 the full 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::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
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC

    RemoveAttributeRestrictedValuesremove attribute restrictions

    remove attribute restrictions from family/model

    Syntax

    ::TestShellAPI::RemoveAttributeRestrictedValues removeAttributeRestrictionRequests ?resultXml?

    Parameters

    TypeNameDescription
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    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
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    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
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC