8.0.0 TestShell API XML RPC Reference Guide


Introduction

Using the XML RPC API requires setting several http request headers. NOTE: ASCII decimal characters 0-31 are invalid inputs, not including 9, 10, and 13

Parameters

TypeNameDescription
string Content-Type
text/xml
string Content-Length
The length in bytes of the request content
string DateTimeFormat
The time format to use for sending and receiving date/time values (e.g. "MM/dd/yyyy HH:mm")
string ClientTimeZoneId
The time zone Id (e.g 'Central America Standard Time'). You can obtain the full list of time zones supported by the server using the GetServerTimeZones API request
string Authorization
A string of the format: Token=xoV3libZzEG/ii7ZQqAuqw==;MachineName=y The Authorization header must be set after successfully login after using the “Logon” or "SecureLogon" API, by using the Token returned in the Logon response. Prior to making the response the value of this header should have the value ‘Unset’
back to TOC

ActivateTopologyActivate a topology.

Activates a specified topology.

Syntax

      <ActivateTopology>
      <reservationId>{reservationId}</reservationId>
      <topologyFullPath>{topologyFullPath}</topologyFullPath>
      </ActivateTopology>
    

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.

Example


        <ActivateTopology>
        <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
        <topologyFullPath>Temp Automation Resources/TP1</topologyFullPath>
        </ActivateTopology>
      

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

          <AddRoutesToReservation>
          <reservationId>{reservationId}</reservationId>
          <sourceResourcesFullPath>
          <string>{string}</string>
          </sourceResourcesFullPath>
          <targetResourcesFullPath>
          <string>{string}</string>
          </targetResourcesFullPath>
          <mappingType>{mappingType}</mappingType>
          <maxHops>{maxHops}</maxHops>
          <routeAlias>{routeAlias}</routeAlias>
          <isShared>{isShared}</isShared>
          </AddRoutesToReservation>
        

    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.
    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.

    Example

    
            <AddRoutesToReservation>
            <reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
            <sourceResourcesFullPath>
            <string>Router 1234/Port 1</string>
            </sourceResourcesFullPath>
            <targetResourcesFullPath>
            <string>GenericResource 1234/Port 1</string>
            </targetResourcesFullPath>
            <mappingType>bi</mappingType>
            <maxHops>2</maxHops>
            <routeAlias>a route</routeAlias>
            <isShared>0</isShared>
            </AddRoutesToReservation>
          

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

    CreateImmediateReservationCreate an imminent reservation.

    Defines a reservation to be started immediately.

    Syntax

          <CreateImmediateReservation>
          <reservationName>{reservationName}</reservationName>
          <owner>{owner}</owner>
          <durationInMinutes>{durationInMinutes}</durationInMinutes>
          <notifyOnStart>{notifyOnStart}</notifyOnStart>
          <notifyOnEnd>{notifyOnEnd}</notifyOnEnd>
          <notificationMinutesBeforeEnd>{notificationMinutesBeforeEnd}</notificationMinutesBeforeEnd>
          <topologyFullPath>{topologyFullPath}</topologyFullPath>
          <globalInputs>
          <UpdateTopologyGlobalInputsRequest>
          <ParamName>{ParamName}</ParamName>
          <Value>{Value}</Value>
          </UpdateTopologyGlobalInputsRequest>
          </globalInputs>
          <requirementsInputs>
          <UpdateTopologyRequirementsInputsRequest>
          <ResourceName>{ResourceName}</ResourceName>
          <ParamName>{ParamName}</ParamName>
          <Value>{Value}</Value>
          <Type>{Type}</Type>
          </UpdateTopologyRequirementsInputsRequest>
          </requirementsInputs>
          <additionalInfoInputs>
          <UpdateTopologyAdditionalInfoInputsRequest>
          <ResourceName>{ResourceName}</ResourceName>
          <ParamName>{ParamName}</ParamName>
          <Value>{Value}</Value>
          </UpdateTopologyAdditionalInfoInputsRequest>
          </additionalInfoInputs>
          </CreateImmediateReservation>
        

    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)

    Example

    
            <CreateImmediateReservation>
            <reservationName>immediate reservation</reservationName>
            <owner>admin</owner>
            <durationInMinutes>30</durationInMinutes>
            <notifyOnStart>0</notifyOnStart>
            <notifyOnEnd>0</notifyOnEnd>
            <notificationMinutesBeforeEnd>0</notificationMinutesBeforeEnd>
            <topologyFullPath>myTopology</topologyFullPath>
            <globalInputs>
            <UpdateTopologyGlobalInputsRequest>
            <ParamName>Some global</ParamName>
            <Value>some value</Value>
            </UpdateTopologyGlobalInputsRequest>
            </globalInputs>
            <requirementsInputs>
            <UpdateTopologyRequirementsInputsRequest>
            <ResourceName>Some resource</ResourceName>
            <ParamName>Model</ParamName>
            <Value>Some resource model</Value>
            <Type>Models</Type>
            </UpdateTopologyRequirementsInputsRequest>
            </requirementsInputs>
            <additionalInfoInputs>
            <UpdateTopologyAdditionalInfoInputsRequest>
            <ResourceName>Some resource</ResourceName>
            <ParamName>Speed</ParamName>
            <Value>10 Mbps</Value>
            </UpdateTopologyAdditionalInfoInputsRequest>
            </additionalInfoInputs>
            </CreateImmediateReservation>
          

    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

          <CreateReservation>
          <reservationName>{reservationName}</reservationName>
          <owner>{owner}</owner>
          <startTime>{startTime}</startTime>
          <endTime>{endTime}</endTime>
          <notifyOnStart>{notifyOnStart}</notifyOnStart>
          <notifyOnEnd>{notifyOnEnd}</notifyOnEnd>
          <notificationMinutesBeforeEnd>{notificationMinutesBeforeEnd}</notificationMinutesBeforeEnd>
          <topologyFullPath>{topologyFullPath}</topologyFullPath>
          <globalInputs>
          <UpdateTopologyGlobalInputsRequest>
          <ParamName>{ParamName}</ParamName>
          <Value>{Value}</Value>
          </UpdateTopologyGlobalInputsRequest>
          </globalInputs>
          <requirementsInputs>
          <UpdateTopologyRequirementsInputsRequest>
          <ResourceName>{ResourceName}</ResourceName>
          <ParamName>{ParamName}</ParamName>
          <Value>{Value}</Value>
          <Type>{Type}</Type>
          </UpdateTopologyRequirementsInputsRequest>
          </requirementsInputs>
          <additionalInfoInputs>
          <UpdateTopologyAdditionalInfoInputsRequest>
          <ResourceName>{ResourceName}</ResourceName>
          <ParamName>{ParamName}</ParamName>
          <Value>{Value}</Value>
          </UpdateTopologyAdditionalInfoInputsRequest>
          </additionalInfoInputs>
          </CreateReservation>
        

    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)

    Example

    
            <CreateReservation>
            <reservationName>test reservation</reservationName>
            <owner>admin</owner>
            <startTime>01/01/2015 10:00</startTime>
            <endTime>01/01/2015 11:00</endTime>
            <notifyOnStart>1</notifyOnStart>
            <notifyOnEnd>1</notifyOnEnd>
            <notificationMinutesBeforeEnd>10</notificationMinutesBeforeEnd>
            <topologyFullPath>myTopology</topologyFullPath>
            <globalInputs>
            <UpdateTopologyGlobalInputsRequest>
            <ParamName>Some global</ParamName>
            <Value>some value</Value>
            </UpdateTopologyGlobalInputsRequest>
            </globalInputs>
            <requirementsInputs>
            <UpdateTopologyRequirementsInputsRequest>
            <ResourceName>Some resource</ResourceName>
            <ParamName>Model</ParamName>
            <Value>Some resource model</Value>
            <Type>Models</Type>
            </UpdateTopologyRequirementsInputsRequest>
            </requirementsInputs>
            <additionalInfoInputs>
            <UpdateTopologyAdditionalInfoInputsRequest>
            <ResourceName>Some resource</ResourceName>
            <ParamName>Speed</ParamName>
            <Value>10 Mbps</Value>
            </UpdateTopologyAdditionalInfoInputsRequest>
            </additionalInfoInputs>
            </CreateReservation>
          

    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

          <CreateResource>
          <resourceFamily>{resourceFamily}</resourceFamily>
          <resourceModel>{resourceModel}</resourceModel>
          <resourceName>{resourceName}</resourceName>
          <resourceAddress>{resourceAddress}</resourceAddress>
          <folderFullPath>{folderFullPath}</folderFullPath>
          <parentResourceFullPath>{parentResourceFullPath}</parentResourceFullPath>
          <resourceDescription>{resourceDescription}</resourceDescription>
          </CreateResource>
        

    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.

    Example

    
            <CreateResource>
            <resourceFamily>Generic Port</resourceFamily>
            <resourceModel>Generic Port Model</resourceModel>
            <resourceName>Port 1</resourceName>
            <resourceAddress>1</resourceAddress>
            <folderFullPath>Lab Routers</folderFullPath>
            <parentResourceFullPath>Router 1234</parentResourceFullPath>
            <resourceDescription>a generic router port</resourceDescription>
            </CreateResource>
          

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

    CreateRouteInReservationCreate a route between two resources.

    Creates a route between the specified source and target resources.

    Syntax

          <CreateRouteInReservation>
          <reservationId>{reservationId}</reservationId>
          <sourceResourceFullPath>{sourceResourceFullPath}</sourceResourceFullPath>
          <targetResourceFullPath>{targetResourceFullPath}</targetResourceFullPath>
          <overrideActiveRoutes>{overrideActiveRoutes}</overrideActiveRoutes>
          <mappingType>{mappingType}</mappingType>
          <maxHops>{maxHops}</maxHops>
          <routeAlias>{routeAlias}</routeAlias>
          <isShared>{isShared}</isShared>
          </CreateRouteInReservation>
        

    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.

    Example

    
            <CreateRouteInReservation>
            <reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
            <sourceResourceFullPath>Router 1234/Port 1</sourceResourceFullPath>
            <targetResourceFullPath>GenericResource 1234/Port 1</targetResourceFullPath>
            <overrideActiveRoutes>1</overrideActiveRoutes>
            <mappingType>bi</mappingType>
            <maxHops>2</maxHops>
            <routeAlias>a route</routeAlias>
            <isShared>0</isShared>
            </CreateRouteInReservation>
          

    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

          <CreateRoutesInReservation>
          <reservationId>{reservationId}</reservationId>
          <sourceResourcesFullPath>
          <string>{string}</string>
          </sourceResourcesFullPath>
          <targetResourcesFullPath>
          <string>{string}</string>
          </targetResourcesFullPath>
          <overrideActiveRoutes>{overrideActiveRoutes}</overrideActiveRoutes>
          <mappingType>{mappingType}</mappingType>
          <maxHops>{maxHops}</maxHops>
          <routeAlias>{routeAlias}</routeAlias>
          <isShared>{isShared}</isShared>
          </CreateRoutesInReservation>
        

    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.
    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.

    Example

    
            <CreateRoutesInReservation>
            <reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
            <sourceResourcesFullPath>
            <string>Router 1234/Port 1</string>
            </sourceResourcesFullPath>
            <targetResourcesFullPath>
            <string>GenericResource 1234/Port 2</string>
            </targetResourcesFullPath>
            <overrideActiveRoutes>1</overrideActiveRoutes>
            <mappingType>uni</mappingType>
            <maxHops>2</maxHops>
            <routeAlias>uni route</routeAlias>
            <isShared>0</isShared>
            </CreateRoutesInReservation>
          

    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
    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

    ExecuteResourceConnectedCommand

    Executes a command for the specified driver.

    Syntax

          <ExecuteResourceConnectedCommand>
          <reservationId>{reservationId}</reservationId>
          <resourceFullPath>{resourceFullPath}</resourceFullPath>
          <commandName>{commandName}</commandName>
          <commandTag>{commandTag}</commandTag>
          <parameterValues>
          <string>{string}</string>
          </parameterValues>
          <connectedPortsFullPath>
          <string>{string}</string>
          </connectedPortsFullPath>
          <printOutput>{printOutput}</printOutput>
          </ExecuteResourceConnectedCommand>
        

    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.

    Example

    
            <ExecuteResourceConnectedCommand>
            <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
            <resourceFullPath>Router 1234</resourceFullPath>
            <commandName>SpinUp</commandName>
            <commandTag>virtualization</commandTag>
            <parameterValues>
            <string>abcd</string>
            <string>2</string>
            </parameterValues>
            <connectedPortsFullPath>
            <string>Router 1234/Port1</string>
            </connectedPortsFullPath>
            <printOutput>true</printOutput>
            </ExecuteResourceConnectedCommand>
          

    Output

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

    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC
    back to TOC

    EditAppsInReservation

    Edit Apps in a reservation

    Syntax

          <EditAppsInReservation>
          <reservationId>{reservationId}</reservationId>
          <editAppsRequests>
            <ApiEditAppRequest>
              <Name></Name>
              <NewName></NewName>
              <Description></Description>
              <AppDetails>
                <ModelName></ModelName>
                <Attributes>
                  <NameValuePair>
                    <Name></Name>
                    <Value></Value>
                  </NameValuePair>    
                </Attributes>
                <Driver></Driver>
              </AppDetails>
              <DefaultDeployment>
                <Name></Name>
                <Deployment>
                  <Attributes>
                    <NameValuePair>
                      <Name></Name>
                      <Value></Value>
                    </NameValuePair>
                  </Attributes>
                </Deployment>
                <Installation>
                  <Attributes>
                    <NameValuePair>
                      <Name></Name>
                      <Value></Value>
                    </NameValuePair>
                  </Attributes>
                  <Script>
                    <Name></Name>
                    <Inputs>
                      <ScriptInput>
                        <Name></Name>
                        <Value></Value>
                      </ScriptInput>
                    </Inputs>
                  </Script>
                </Installation>
              </DefaultDeployment>
            </ApiEditAppRequest>
          </editAppsRequests>
          </EditAppsInReservation>
        

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    list editAppsRequests
    Changes to implement in the App.

    Example

    
            <EditAppsInReservation>
            <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
            <editAppsRequests>
            <ApiEditAppRequest>
            <Name>testApp</Name>
            <NewName>my new name</NewName>
            <Description>my desc</Description>
            <AppDetails>
              <ModelName>
              </ModelName>
              <Attributes>
                <NameValuePair>
                  <Name></Name>
                  <Value></Value>
                </NameValuePair>
              </Attributes>
              <Driver></Driver>
            </AppDetails>
            <DefaultDeployment>
              <Name>vCenter Clone VM From VM</Name>
              <Deployment>
                <Attributes>
                  <NameValuePair>
                    <Name></Name>
                    <Value></Value>
                  </NameValuePair>
                </Attributes>
              </Deployment>
              <Installation>
                <Attributes>
                  <NameValuePair>
                    <Name>Generic Input</Name>
                    <Value>My Input</Value>
                  </NameValuePair>
                </Attributes>
                <Script>
                  <Name>vCenterShell (1)</Name>
                  <Inputs>
                    <ScriptInput>
                      <Name></Name>
                      <Value></Value>
                    </ScriptInput>
                  </Inputs>
                </Script>
              </Installation>
            </DefaultDeployment>
            </ApiEditAppRequest>
            </editAppsRequests>
            </EditAppsInReservation>
          

    Output

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

    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

    FindResources

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

    Syntax

          <FindResources>
          <resourceFamily>{resourceFamily}</resourceFamily>
          <resourceModel>{resourceModel}</resourceModel>
          <attributeValues>
          <AttributeNameValue>
          <Name>{Name}</Name>
          <Value>{Value}</Value>
          </AttributeNameValue>
          </attributeValues>
          <showAllDomains>{showAllDomains}</showAllDomains>
          <resourceFullName>{resourceFullName}</resourceFullName>
          <exactName>{exactName}</exactName>
          <includeSubResources>{includeSubResources}</includeSubResources>
          <resourceAddress>{resourceAddress}</resourceAddress>
          <resourceUniqueIdentifier>{resourceUniqueIdentifier}</resourceUniqueIdentifier>
          <maxResults>{maxResults}</maxResults>
          </FindResources>
        

    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.

    Example

    
            <FindResources>
            <resourceFamily>Generic Chassis</resourceFamily>
            <resourceModel></resourceModel>
            <attributeValues>
            <AttributeNameValue>
            <Name>SW_Version</Name>
            <Value>1.3</Value>
            </AttributeNameValue>
            </attributeValues>
            <showAllDomains>true</showAllDomains>
            <resourceFullName></resourceFullName>
            <exactName></exactName>
            <includeSubResources>true</includeSubResources>
            <resourceAddress></resourceAddress>
            <resourceUniqueIdentifier></resourceUniqueIdentifier>
            <maxResults>500</maxResults>
            </FindResources>
          

    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

          <FindResourcesInTimeRange>
          <resourceFamily>{resourceFamily}</resourceFamily>
          <resourceModel>{resourceModel}</resourceModel>
          <fromTime>{fromTime}</fromTime>
          <untilTime>{untilTime}</untilTime>
          <attributeValues>
          <AttributeNameValue>
          <Name>{Name}</Name>
          <Value>{Value}</Value>
          </AttributeNameValue>
          </attributeValues>
          <showAllDomains>{showAllDomains}</showAllDomains>
          <resourceFullName>{resourceFullName}</resourceFullName>
          <exactName>{exactName}</exactName>
          <includeSubResources>{includeSubResources}</includeSubResources>
          <resourceAddress>{resourceAddress}</resourceAddress>
          <resourceUniqueIdentifier>{resourceUniqueIdentifier}</resourceUniqueIdentifier>
          <maxResults>{maxResults}</maxResults>
          </FindResourcesInTimeRange>
        

    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.

    Example

    
            <FindResourcesInTimeRange>
            <resourceFamily>Generic Chassis</resourceFamily>
            <resourceModel></resourceModel>
            <fromTime>03/01/2012 00:00</fromTime>
            <untilTime>05/31/2012 23:59</untilTime>
            <attributeValues>
            <AttributeNameValue>
            <Name>SW_Version</Name>
            <Value>1.3</Value>
            </AttributeNameValue>
            </attributeValues>
            <showAllDomains>true</showAllDomains>
            <resourceFullName></resourceFullName>
            <exactName></exactName>
            <includeSubResources>true</includeSubResources>
            <resourceAddress></resourceAddress>
            <resourceUniqueIdentifier></resourceUniqueIdentifier>
            <maxResults>500</maxResults>
            </FindResourcesInTimeRange>
          

    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

          <GetRoutesSolution>
          <reservationId>{reservationId}</reservationId>
          <sourceResourcesFullPath>
          <string>{string}</string>
          </sourceResourcesFullPath>
          <targetResourcesFullPath>
          <string>{string}</string>
          </targetResourcesFullPath>
          <mappingType>{mappingType}</mappingType>
          <maxHops>{maxHops}</maxHops>
          <isShared>{isShared}</isShared>
          </GetRoutesSolution>
        

    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.
    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.

    Example

    
            <GetRoutesSolution>
            <reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
            <sourceResourcesFullPath>
            <string>Router 1234/Port 1</string>
            </sourceResourcesFullPath>
            <targetResourcesFullPath>
            <string>GenericResource 1234/Port 1</string>
            </targetResourcesFullPath>
            <mappingType>bi</mappingType>
            <maxHops>2</maxHops>
            <isShared>0</isShared>
            </GetRoutesSolution>
          

    Output

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

    back to TOC

    GenerateUtilizationReportGenerate a utilization report.

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

    Syntax

          <GenerateUtilizationReport>
          <resourceFamilyName>{resourceFamilyName}</resourceFamilyName>
          <fromDate>{fromDate}</fromDate>
          <toDate>{toDate}</toDate>
          <resourceFullName>{resourceFullName}</resourceFullName>
          <resourceModelName>{resourceModelName}</resourceModelName>
          <includeChildResources>{includeChildResources}</includeChildResources>
          <groupBy>{groupBy}</groupBy>
          <utilizationReportType>{utilizationReportType}</utilizationReportType>
          </GenerateUtilizationReport>
        

    Parameters

    TypeNameDescription
    string resourceFamilyName
    Specify the name of the resource family.
    string fromDate
    Specify the start time and date.
    string toDate
    Specify the end time and date.
    string resourceFullName
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName.
    string resourceModelName
    Specify the resource model.
    boolean includeChildResources
    Specify whether to include child resources utilization.
    string groupBy
    Specify how to group the utilization results: Resource, User, or Machine
    Use 0 for Resource, 1 for User and 2 for Machine.
    string utilizationReportType
    Specify the report type: Lock or Mapping.
    Use 0 for Lock and 1 for Mapping.

    Example

    
            <GenerateUtilizationReport>
            <resourceFamilyName>Router</resourceFamilyName>
            <fromDate>03/01/2012 00:00</fromDate>
            <toDate>05/31/2012 23:59</toDate>
            <resourceFullName></resourceFullName>
            <resourceModelName></resourceModelName>
            <includeChildResources>0</includeChildResources>
            <groupBy>0</groupBy>
            <utilizationReportType>0</utilizationReportType>
            </GenerateUtilizationReport>
          

    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

    <GetGroupsDetails></GetGroupsDetails>

    Parameters

    TypeNameDescription

    Example

    <GetGroupsDetails></GetGroupsDetails>

    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

          <GetLockedResources>
          <user>{user}</user>
          <machine>{machine}</machine>
          <folderFullPath>{folderFullPath}</folderFullPath>
          </GetLockedResources>
        

    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.

    Example

    
            <GetLockedResources>
            <user>admin</user>
            <machine></machine>
            <folderFullPath></folderFullPath>
            </GetLockedResources>
          

    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

          <GetReservationDetails>
          <reservationId>{reservationId}</reservationId>
          </GetReservationDetails>
        

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.

    Example

    
            <GetReservationDetails>
            <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
            </GetReservationDetails>
          

    Output

  • resultXml
  • 
            <ResponseInfo>
            <ReservationDescription Id="caf0324e-680c-4555-8620-bcdab99de690" Name="Environment-03-02-2015 18-21" 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
    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

          <GetResourceDetails>
          <resourceFullPath>{resourceFullPath}</resourceFullPath>
          <showAllDomains>{showAllDomains}</showAllDomains>
          </GetResourceDetails>
        

    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.

    Example

    
            <GetResourceDetails>
            <resourceFullPath>Lab Routers/Router 1234</resourceFullPath>
            <showAllDomains>1</showAllDomains>
            </GetResourceDetails>
          

    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", "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

          <GetTopologyDetails>
          <topologyFullPath>{topologyFullPath}</topologyFullPath>
          </GetTopologyDetails>
        

    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.

    Example

    
            <GetTopologyDetails>
            <topologyFullPath>Temp Automation Resources/TP1</topologyFullPath>
            </GetTopologyDetails>
          

    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>
            <Apps>
            <App Name="App2222">
            <LogicalResource Family="Generic App Family" Model="Generic App Model" Description="">
            <Attributes>
            <Attribute Name="Access Mode" Value="565"></Attribute>
            </Attributes>
            </LogicalResource>
            <DeploymentPaths>
            <DeploymentPath IsDefault="true">
            <DeploymentService Name="vCenter VM From Template" Model="vCenter VM From Template" Driver="Deploy From Template Driver">
            <Attributes>
            <Attribute Name="Access Mode" Value=""></Attribute>
            <Attribute Name="vCenter Name" Value="VMWare vCenter"></Attribute>
            <Attribute Name="vCenter Template" Value=""></Attribute>
            </Attributes>
            </DeploymentService>
            </DeploymentPath>
            </DeploymentPaths>
            </App>
            </App>
            </Apps>
            <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
    back to TOC

    ReplaceServiceWithResourcereplace a service with resource

    Replace a service in reservation with resource

    Syntax

          <ReplaceServiceWithResource>
          <reservationId>{reservationId}</reservationId>
          <serviceName>{serviceName}</serviceName>
          <domainName>{domainName}</domainName>
          <resourceDriverName>{resourceDriverName}</resourceDriverName>
          <resourceCreationRequests>
          <ResourceInfoDto>
          <Family>{Family}</Family>
          <Model>{Model}</Model>
          <FullName>{FullName}</FullName>
          <Address>{Address}</Address>
          <FolderFullpath>{FolderFullpath}</FolderFullpath>
          <Description>{Description}</Description>
          <ParentFullName>{ParentFullName}</ParentFullName>
          </ResourceInfoDto>
          </resourceCreationRequests>
          <resourceAttributesToUpdate>
          <ResourceAttributesUpdateRequest>
          <ResourceFullName>{ResourceFullName}</ResourceFullName>
          <AttributeNamesValues>
          <AttributeNameValue>
          <Name>{Name}</Name>
          <Value>{Value}</Value>
          </AttributeNameValue>
          </AttributeNamesValues>
          </ResourceAttributesUpdateRequest>
          </resourceAttributesToUpdate>
          </ReplaceServiceWithResource>
        

    Parameters

    TypeNameDescription

    Example

    
            <ReplaceServiceWithResource>
            <reservationId>EAE1752D-461F-4049-BEC7-58F37AFB4557</reservationId>
            <serviceName>myService</serviceName>
            <domainName>Domain1</domainName>
            <resourceDriverName>myResourceDriver</resourceDriverName>
            <resourceCreationRequests>
            <ResourceInfoDto>
            <Family>ResourceFamily</Family>
            <Model>ResourceModel</Model>
            <FullName>MyNewResource</FullName>
            <Address>1.1.1.1</Address>
            <FolderFullpath>MyNewResourcesFolder</FolderFullpath>
            <Description>My New Resource</Description>
            <ParentFullName>MyNewResource</ParentFullName>
            </ResourceInfoDto>
            </resourceCreationRequests>
            <resourceAttributesToUpdate>
            <ResourceAttributesUpdateRequest>
            <ResourceFullName>MyNewResource</ResourceFullName>
            <AttributeNamesValues>
            <AttributeNameValue>
            <Name>NewResourceAttribute1</Name>
            <Value>Hello</Value>
            </AttributeNameValue>
            </AttributeNamesValues>
            </ResourceAttributesUpdateRequest>
            </resourceAttributesToUpdate>
            </ReplaceServiceWithResource>
          

    Output

  • resultXml
  • 
            <ResponseInfo>
            <RootResources>
            MyNewResource
            </RootResources>
            </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

    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

          <RemoveRoutesFromReservation>
          <reservationId>{reservationId}</reservationId>
          <endpoints>
          <string>{string}</string>
          </endpoints>
          <mappingType>{mappingType}</mappingType>
          </RemoveRoutesFromReservation>
        

    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.

    Example

    
            <RemoveRoutesFromReservation>
            <reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
            <endpoints>
            <string>Router 1234/Port 1</string>
            <string>GenericResource 1234/Port 1</string>
            <string>Router 1234/Port 1</string>
            <string>GenericResource 1234/Port 2</string>
            </endpoints>
            <mappingType>{mappingType}</mappingType>
            </RemoveRoutesFromReservation>
          

    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

          <SaveReservationAsTopology>
          <reservationId>{reservationId}</reservationId>
          <folderFullPath>{folderFullPath}</folderFullPath>
          <topologyName>{topologyName}</topologyName>
          <includeInactiveRoutes>{includeInactiveRoutes}</includeInactiveRoutes>
          </SaveReservationAsTopology>
        

    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

    Example

    
            <SaveReservationAsTopology>
            <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
            <folderFullPath>Temp Automation Resources</folderFullPath>
            <topologyName>TP1</topologyName>
            <includeInactiveRoutes>1</includeInactiveRoutes>
            </SaveReservationAsTopology>
          

    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

    SetRouteAttributesSet a route's attributes.

    Sets attributes and associated values for a specified route.

    Syntax

          <SetRouteAttributes>
          <reservationId>{reservationId}</reservationId>
          <sourceResourceFullPath>{sourceResourceFullPath}</sourceResourceFullPath>
          <targetResourceFullPath>{targetResourceFullPath}</targetResourceFullPath>
          <applyChangesTo>{applyChangesTo}</applyChangesTo>
          <attributeRequests>
          <string>{string}</string>
          </attributeRequests>
          </SetRouteAttributes>
        

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullPath
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    string targetResourceFullPath
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    string applyChangesTo
    Specify on which resources to apply the attribute changes: Source/Target/All.Source refers to the resource connected to the source endpoint of the route. Target refers to the resource connected to the target endpoint of the route. All encompasses all route resources.
    Use 0 for Source, 1 for Target and 2 for All.
    list attributeRequests
    Specify an array of attributes and associated attribute values.

    Example

    
            <SetRouteAttributes>
            <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
            <sourceResourceFullPath>Router 1234/Port 1</sourceResourceFullPath>
            <targetResourceFullPath>GenericResource 1234/Port 1</targetResourceFullPath>
            <applyChangesTo>2</applyChangesTo>
            <attributeRequests>
            <string>SW_Version</string>
            <string>1.3</string>
            </attributeRequests>
            </SetRouteAttributes>
          

    back to TOC
    back to TOC

    SetConnectorAttributesSet a connector's attributes.

    Sets attributes and associated values for a specified connector.

    Syntax

          <SetConnectorAttributes>
          <reservationId>{reservationId}</reservationId>
          <sourceResourceFullName>{sourceResourceFullName}</sourceResourceFullName>
          <targetResourceFullName>{targetResourceFullName}</targetResourceFullName>
          <attributeRequests>
          <AttributeNameValue>
          <Name>{Name}</Name>
          <Value>{Value}</Value>
          </AttributeNameValue>
          </attributeRequests>
          </SetConnectorAttributes>
        

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullName
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    string targetResourceFullName
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    list attributeRequests
    Specify a matrix of attributes and associated attribute values.

    Example

    
            <SetConnectorAttributes>
            <reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
            <sourceResourceFullName>Router 1234/Port 1</sourceResourceFullName>
            <targetResourceFullName>GenericResource 1234/Port 1</targetResourceFullName>
            <attributeRequests>
            <AttributeNameValue>
            <Name>Part Number</Name>
            <Value>123</Value>
            </AttributeNameValue>
            </attributeRequests>
            </SetConnectorAttributes>
          

    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

    UpdateConnectorAliasInReservationUpdate connector alias in reservation.

    Sets alias for a specified connector.

    Syntax

          <UpdateConnectorAliasInReservation>
          <reservationId>{reservationId}</reservationId>
          <sourceResourceFullName>{sourceResourceFullName}</sourceResourceFullName>
          <targetResourceFullName>{targetResourceFullName}</targetResourceFullName>
          <direction>{direction}</direction>
          <alias>{alias}</alias>
          </UpdateConnectorAliasInReservation>
        

    Parameters

    TypeNameDescription
    string reservationId
    Specify the string that represents the reservation’s unique identifier.
    string sourceResourceFullName
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    string targetResourceFullName
    Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1.
    string direction
    Specify bidirectional or unidirectional as the connector direction.
    Use 'bi' for bidirectional or 'uni' for unidirectional connector.
    string alias
    Specify the connector’s alias.

    Example

    
            <UpdateConnectorAliasInReservation>
            <reservationId>2623d08d-9d19-4b95-a8dc-d7cca5ea05fb</reservationId>
            <sourceResourceFullName>Router 1234/Port 1</sourceResourceFullName>
            <targetResourceFullName>GenericResource 1234/Port 1</targetResourceFullName>
            <direction>bi</direction>
            <alias>some alias</alias>
            </UpdateConnectorAliasInReservation>
          

    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

    UpdateRouteAliasesInReservationUpdate route aliases in a reservation

    Update route aliases in a reservation.

    Syntax

          <UpdateRouteAliasesInReservation>
          <reservationId>{reservationId}</reservationId>
          <routeAliases>
          <UpdateRouteAliasRequest>
          <SourceResourceName>{SourceResourceName}</SourceResourceName>
          <TargetResourceName>{TargetResourceName}</TargetResourceName>
          <Alias>{Alias}</Alias>
          </UpdateRouteAliasRequest>
          </routeAliases>
          </UpdateRouteAliasesInReservation>
        

    Parameters

    TypeNameDescription
    string reservationId
    Specifies the string that represents the reservation’s unique identifier.
    list routeAliases
    Specify a matrix of route source, route target and alias. For example: {['SourceResourceFullName', 'TargetFullName','Alias';'SourceResourceFullName2', 'TargetFullName2','Alias2']}.

    Example

    
            <UpdateRouteAliasesInReservation>
            <reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
            <routeAliases>
            <UpdateRouteAliasRequest>
            <SourceResourceName>SourceResourceName</SourceResourceName>
            <TargetResourceName>TargetResourceName</TargetResourceName>
            <Alias>Alias</Alias>
            </UpdateRouteAliasRequest>
            </routeAliases>
            </UpdateRouteAliasesInReservation>
          

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