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
| Type | Name | Description |
|---|---|---|
| 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’
|
ActivateTopologyActivate a topology.
Resolves all connectivity requests in the sandbox, and marks unshared resources as "in use".
Syntax
<ActivateTopology>
<reservationId>{reservationId}</reservationId>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
</ActivateTopology>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<ActivateTopology>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<topologyFullPath>Temp Automation Resources/TP1</topologyFullPath>
</ActivateTopology>
Output
<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>
AddGroupsToDomainAdd groups to a domain.
Add groups to a domain.
Syntax
<AddGroupsToDomain>
<domainName>{domainName}</domainName>
<groupNames>
<string>{string}</string>
</groupNames>
<readOnly>{readOnly}</readOnly>
</AddGroupsToDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<AddGroupsToDomain>
<domainName>Global</domainName>
<groupNames>
<string>QA_Users</string>
<string>RND_Users</string>
</groupNames>
<readOnly>true</readOnly>
</AddGroupsToDomain>
AddNewDomainAdds a new domain.
Adds a new domain.
Syntax
<AddNewDomain>
<domainName>{domainName}</domainName>
<description>{description}</description>
</AddNewDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
| string | description | Specify the description of the domain. |
Example
<AddNewDomain>
<domainName>Domain1</domainName>
<description>My Domain</description>
</AddNewDomain>
AddNewGroupAdd a new group.
Adds a new users group
Syntax
<AddNewGroup>
<groupName>{groupName}</groupName>
<description>{description}</description>
<groupRole>{groupRole}</groupRole>
</AddNewGroup>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<AddNewGroup>
<groupName>QA_Users</groupName>
<description>QA users</description>
<groupRole>Regular</groupRole>
</AddNewGroup>
Output
<ResponseInfo Name="QA_Users" Description="QA users">
<TestShellDomains/>
</ResponseInfo>
AddNewUserAdd a new TestShell user.
Configures user login details and permissions. Use AddUsersToGroup to specify the user’s domain access.
Syntax
<AddNewUser>
<username>{username}</username>
<password>{password}</password>
<email>{email}</email>
<isActive>{isActive}</isActive>
<isAdmin>{isAdmin}</isAdmin>
</AddNewUser>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Specify the name of the user. |
| string | password | Specify the user’s login password. |
| string | 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. |
Example
<AddNewUser>
<username>User1234</username>
<password>pass1234</password>
<email>user1234@work.com</email>
<isActive>1</isActive>
<isAdmin>0</isAdmin>
</AddNewUser>
Output
<ResponseInfo xsi:type="UserInfo" Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com"/>AddPermittedUsersToReservationAdd permitted users to a reservation.
Add one or more permitted users to the specified reservation.
Syntax
<AddPermittedUsersToReservation>
<reservationId>{reservationId}</reservationId>
<usernames>
<string>{string}</string>
</usernames>
</AddPermittedUsersToReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | usernames | List of users to permit access to the reservation. |
Example
<AddPermittedUsersToReservation>
<reservationId>2d2f7cde-20g3-4bac-80d2-e8cfhecef45b</reservationId>
<usernames>
<string>{name1}</string>
</usernames>
</AddPermittedUsersToReservation>
AddResourcesToDomainAdd resources to a domain.
Add resources to a domain.
Syntax
<AddResourcesToDomain>
<domainName>{domainName}</domainName>
<resourcesNames>
<string>{string}</string>
</resourcesNames>
<includeDecendants>{includeDecendants}</includeDecendants>
</AddResourcesToDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<AddResourcesToDomain>
<domainName>Domain1</domainName>
<resourcesNames>
<string>Router 1234</string>
<string>GenericResource 1234</string>
</resourcesNames>
<includeDecendants>1</includeDecendants>
</AddResourcesToDomain>
AddResourcesToReservationReserve resources for locking.
Reserves resources to be locked.
Syntax
<AddResourcesToReservation>
<reservationId>{reservationId}</reservationId>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
<shared>{shared}</shared>
</AddResourcesToReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<AddResourcesToReservation>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourcesFullPath>
<string>Router 1234</string>
<string>GenericResource 1234</string>
</resourcesFullPath>
<shared>1</shared>
</AddResourcesToReservation>
Output
<ResponseInfo>
<Conflicts/>
</ResponseInfo>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
AddTopologiesToDomainAdds a list of one or more topologies to a domain.
Adds a list of one or more topologies to a domain.
Syntax
<AddTopologiesToDomain>
<domainName>{domainName}</domainName>
<topologyNames>
<string>{string}</string>
</topologyNames>
<validateResourceAvailability>{validateResourceAvailability}</validateResourceAvailability>
</AddTopologiesToDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
| list | topologyNames | Specify a list of topology names. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| boolean | validateResourceAvailability | Validates the existence of the resource resolution in the target domain. Default value: 'True'. Note: when value 'False' is supplied, there is no process of associating resources and routes with the target domain. |
Example
<AddTopologiesToDomain>
<domainName>Domain1</domainName>
<topologyNames>
<string>Topology1</string>
</topologyNames>
<validateResourceAvailability>{validateResourceAvailability}</validateResourceAvailability>
</AddTopologiesToDomain>
AddUsersToGroupAdd users to a group.
Adds a list of one or more users to the specified group.
Syntax
<AddUsersToGroup>
<usernames>
<string>{string}</string>
</usernames>
<groupName>{groupName}</groupName>
</AddUsersToGroup>
Parameters
| Type | Name | Description |
|---|---|---|
| list | usernames | Specify an array of one or more users. |
| string | groupName | Specify the name of the group. |
Example
<AddUsersToGroup>
<usernames>
<string>User1234</string>
<string>User2345</string>
</usernames>
<groupName>QA_Users</groupName>
</AddUsersToGroup>
AutoLoadOverwrite switch settings with current data.
Overrides the data of a specified L1 switch with current device settings and mappings.
Syntax
<AutoLoad>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</AutoLoad>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<AutoLoad>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
</AutoLoad>
AddAttributeRestrictedValuesadd attribute restrictions
add attribute restrictions to family/model
Syntax
<AddAttributeRestrictedValues>
<addAttributeRestrictionRequests>
<AddRestrictionRequest>
<FamilyName>{FamilyName}</FamilyName>
<ModelName>{ModelName}</ModelName>
<Alphabetic>{Alphabetic}</Alphabetic>
<Attributes>
<Attribute>
<Name>{Name}</Name>
<RestrictedValue>{RestrictedValue}</RestrictedValue>
</Attribute>
</Attributes>
</AddRestrictionRequest>
</addAttributeRestrictionRequests>
</AddAttributeRestrictedValues>
Parameters
| Type | Name | Description |
|---|---|---|
| list | addAttributeRestrictionRequests | Attribute restrictions to add. |
Example
<AddAttributeRestrictedValues>
<addAttributeRestrictionRequests>
<AddRestrictionRequest>
<FamilyName>Bridge</FamilyName>
<ModelName>Bridge Model</ModelName>
<Alphabetic>true</Alphabetic>
<Attributes>
<Attribute>
<Name>Cluster</Name>
<RestrictedValue>Org-2</RestrictedValue>
<RestrictedValue>Org-2</RestrictedValue>
</Attribute>
</Attributes>
</AddRestrictionRequest>
</addAttributeRestrictionRequests>
</AddAttributeRestrictedValues>
Output
<ResponseInfo>ArchiveDomainArchive the domain
Archive a domain. All future reservation will be deleted.
Syntax
<ArchiveDomain>
<domainName>{domainName}</domainName>
</ArchiveDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
Example
<ArchiveDomain>
<domainName>Domain1</domainName>
</ArchiveDomain>
AddAppToReservationAdd an App resource to an existing reservation.
Add an App resource to an existing reservation.
Syntax
<AddAppToReservation>
<reservationId>{reservationId}</reservationId>
<appName>{appName}</appName>
<deploymentPath>{deploymentPath}</deploymentPath>
<positionX>{positionX}</positionX>
<positionY>{positionY}</positionY>
</AddAppToReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<AddAppToReservation>
<reservationId>077e6b4f-5e70-46b5-aa4b-43e6f039acc3</reservationId>
<appName>Demo App Template Name</appName>
<deploymentPath>vCenter VM From Template</deploymentPath>
<positionX>100</positionX>
<positionY>100</positionY>
</AddAppToReservation>
Output
<ResponseInfo xsi:type="AddAppToReservationResponseInfo" ReservedAppName="Added app">
</ResponseInfo>
AddServiceToReservationAdd service resource to existing reservation.
Add service resource to existing reservation.
Syntax
<AddServiceToReservation>
<reservationId>{reservationId}</reservationId>
<serviceName>{serviceName}</serviceName>
<alias>{alias}</alias>
<attributes>
<AttributeNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</AttributeNameValue>
</attributes>
</AddServiceToReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<AddServiceToReservation>
<reservationId>077e6b4f-5e70-46b5-aa4b-43e6f039acc3</reservationId>
<serviceName>Service Name</serviceName>
<alias>Alias </alias>
<attributes>
<AttributeNameValue>
<Name>Version</Name>
<Value>5.5</Value>
</AttributeNameValue>
</attributes>
</AddServiceToReservation>
Output
<ResponseInfo/>
CopyDomainsResourcesCopy resources to a domain.
Copy resources from a list of source domains to a target domain.
Syntax
<CopyDomainsResources>
<domainNameSources>
<string>{string}</string>
</domainNameSources>
<domainNameDestination>{domainNameDestination}</domainNameDestination>
</CopyDomainsResources>
Parameters
| Type | Name | Description |
|---|---|---|
| list | domainNameSources | Specify the names of the source domains. |
| string | domainNameDestination | Specify the name of the target domain. |
Example
<CopyDomainsResources>
<domainNameSources>
<string>Domain1</string>
<string>Domain2</string>
</domainNameSources>
<domainNameDestination>Domain3</domainNameDestination>
</CopyDomainsResources>
ClearAndResetConsoleClear and reset consoles.
Clears and resets specified resource console ports.
Syntax
<ClearAndResetConsole>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<consolePortsFullPath>
<string>{string}</string>
</consolePortsFullPath>
<baudRate>{baudRate}</baudRate>
</ClearAndResetConsole>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ClearAndResetConsole>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<consolePortsFullPath>
<string>GenericResource 1234/ConsolePort 21</string>
</consolePortsFullPath>
<baudRate>9600</baudRate>
</ClearAndResetConsole>
Output
<ResponseInfo Output=""/>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
<ConnectRoutesInReservation>
<reservationId>{reservationId}</reservationId>
<endpoints>
<string>{string}</string>
</endpoints>
<mappingType>{mappingType}</mappingType>
</ConnectRoutesInReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ConnectRoutesInReservation>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<endpoints>
<string>Router 1234/Port 1</string>
<string>GenericResource 1234/Port 1</string>
</endpoints>
<mappingType>bi</mappingType>
</ConnectRoutesInReservation>
Output
<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>
CreateFolderAdd a new folder.
Adds a new folder to the specified path.
Syntax
<CreateFolder>
<folderFullPath>{folderFullPath}</folderFullPath>
</CreateFolder>
Parameters
| Type | Name | Description |
|---|---|---|
| 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
<CreateFolder>
<folderFullPath>Lab Routers</folderFullPath>
</CreateFolder>
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>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<isTerminationProtectionEnabled>{isTerminationProtectionEnabled}</isTerminationProtectionEnabled>
<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
| Type | Name | Description |
|---|---|---|
| string | reservationName | Specify the name of the reservation. |
| string | owner | Specify the user name of the reservation owner. |
| number | durationInMinutes | Specify the length of the reservation. (in minutes) |
| boolean | notifyOnStart | Indicate whether to notify the reservation owner when the reservation starts. |
| boolean | notifyOnEnd | Indicate whether to notify the reservation owner when the reservation ends. |
| number | notificationMinutesBeforeEnd | Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled) |
| boolean | isTerminationProtectionEnabled | Indicate whether to protect the reservation from being terminated. |
Example
<CreateImmediateReservation>
<reservationName>immediate reservation</reservationName>
<owner>admin</owner>
<durationInMinutes>30</durationInMinutes>
<notifyOnStart>0</notifyOnStart>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<isTerminationProtectionEnabled>True</isTerminationProtectionEnabled>
<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
<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>
CreateImmediatePersistentReservationCreate an immediate persistent reservation.
Defines a reservation to be started immediately.
Syntax
<CreateImmediatePersistentReservation>
<reservationName>{reservationName}</reservationName>
<owner>{owner}</owner>
<notifyOnStart>{notifyOnStart}</notifyOnStart>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<notifyOnEnd>{notifyOnEnd}</notifyOnEnd>
<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>
</CreateImmediatePersistentReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationName | Specify the name of the reservation. |
| string | owner | Specify the user name of the reservation owner. |
| 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. |
| 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';]}. |
| boolean | notifyOnSetupComplete | Indicate whether to notify the reservation owner when the reservation setup completes. |
Example
<CreateImmediatePersistentReservation>
<reservationName>immediate reservation</reservationName>
<owner>admin</owner>
<notifyOnStart>0</notifyOnStart>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<notifyOnEnd>0</notifyOnEnd>
<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>
</CreateImmediatePersistentReservation>
Output
<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>
CreateImmediateTopologyReservationCreate an imminent reservation.
Defines a reservation to be started immediately. The reservation will start regardless of conflicting resources.
Syntax
<CreateImmediateReservation>
<reservationName>{reservationName}</reservationName>
<owner>{owner}</owner>
<durationInMinutes>{durationInMinutes}</durationInMinutes>
<notifyOnStart>{notifyOnStart}</notifyOnStart>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<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
| Type | Name | Description |
|---|---|---|
| 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 topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| list | globalInputs | Global inputs associated with the specified topology. |
| list | requirementsInputs |
Requirements inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value', 'AttributeType';]}, AttributeType can be one of the following: Attributes/Models/Quantity.
The Value field can be used to input to requirement fields with different operator types.
If pass value as is, it will be treated as "equals", for example if pass "5" it will indicate to system that seek requirement that fulfills =5
Other operators (aside from equals) can be fulfilled using this convention:
in the value field, write use the format symbol[space]value
for example
for numeric values
> 4
< 4
>= 4
<= 4
= 4
!= 4
for textual values
= "hi there"
!= "hi there"
startswith hi there
endswith hi there
contains hi there
doesnotcontain hi there
|
| list | additionalInfoInputs | Additional info inputs associated with the specified topology. |
| boolean | notifyOnSetupComplete | Indicate whether to notify the reservation owner when the reservation setup completes. |
Example
<CreateImmediateReservation>
<reservationName>immediate reservation</reservationName>
<owner>admin</owner>
<durationInMinutes>30</durationInMinutes>
<notifyOnStart>0</notifyOnStart>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<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
<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>
CreateReservationCreate a reservation.
Defines a new reservation.
Syntax
<CreateReservation>
<reservationName>{reservationName}</reservationName>
<owner>{owner}</owner>
<startTime>{startTime}</startTime>
<endTime>{endTime}</endTime>
<notifyOnStart>{notifyOnStart}</notifyOnStart>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<isTerminationProtectionEnabled>{isTerminationProtectionEnabled}</isTerminationProtectionEnabled>
<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
| Type | Name | Description |
|---|---|---|
| string | reservationName | Specify the name of the reservation. |
| string | owner | Specify the user name of the reservation owner. |
| string | startTime | The start time of the reservation. |
| string | endTime | The end time of the reservation. |
| boolean | notifyOnStart | Indicate whether to notify the reservation owner when the reservation starts. |
| boolean | notifyOnEnd | Indicate whether to notify the reservation owner when the reservation ends. |
| number | notificationMinutesBeforeEnd | Indicate the number of minutes before the end of the reservation to send out a Notify On End alert to the reservation owner. (0 = disabled) |
| boolean | isTerminationProtectionEnabled | Indicate whether to protect the reservation from being terminated. |
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>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<isTerminationProtectionEnabled>True</isTerminationProtectionEnabled>
<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
<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>
CreatePersistentReservationCreate a reservation.
Defines a new reservation.
Syntax
<CreatePersistentReservation>
<reservationName>{reservationName}</reservationName>
<owner>{owner}</owner>
<startTime>{startTime}</startTime>
<notifyOnStart>{notifyOnStart}</notifyOnStart>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<notifyOnEnd>{notifyOnEnd}</notifyOnEnd>
<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>
</CreatePersistentReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
| 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. |
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| list | globalInputs | Global inputs associated with the specified topology. 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';]}. |
| boolean | notifyOnSetupComplete | Indicate whether to notify the reservation owner when the reservation setup completes. |
Example
<CreatePersistentReservation>
<reservationName>test reservation</reservationName>
<owner>admin</owner>
<startTime>01/01/2015 10:00</startTime>
<notifyOnStart>1</notifyOnStart>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<notifyOnEnd>1</notifyOnEnd>
<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>
</CreatePersistentReservation>
Output
<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>
CreateTopologyReservationCreate a reservation.
Defines a new reservation.
Syntax
<CreateReservation>
<reservationName>{reservationName}</reservationName>
<owner>{owner}</owner>
<startTime>{startTime}</startTime>
<endTime>{endTime}</endTime>
<notifyOnStart>{notifyOnStart}</notifyOnStart>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<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
| Type | Name | Description |
|---|---|---|
| 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 topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| list | globalInputs | Global inputs associated with the specified topology. |
| list | requirementsInputs |
Requirements inputs associated with the specified topology. For example: {['Resource Name', 'Input Name', 'Value', 'AttributeType';]}, AttributeType can be one of the following: Attributes/Models/Quantity.
The Value field can be used to input to requirement fields with different operator types.
If pass value as is, it will be treated as "equals", for example if pass "5" it will indicate to system that seek requirement that fulfills =5
Other operators (aside from equals) can be fulfilled using this convention:
in the value field, write use the format symbol[space]value
for example
for numeric values
> 4
< 4
>= 4
<= 4
= 4
!= 4
for textual values
= "hi there"
!= "hi there"
startswith hi there
endswith hi there
contains hi there
doesnotcontain hi there
|
| list | additionalInfoInputs | Additional info inputs associated with the specified topology. |
| boolean | notifyOnSetupComplete | Indicate whether to notify the reservation owner when the reservation setup completes. |
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>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<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
<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>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
CreateResourcesAdds new resources.
Adds new resources.
Syntax
<CreateResources>
<resourceInfoDtos>
<ResourceInfoDto>
<Family>{Family}</Family>
<Model>{Model}</Model>
<FullName>{FullName}</FullName>
<Address>{Address}</Address>
<FolderFullpath>{FolderFullpath}</FolderFullpath>
<ParentFullName>{ParentFullName}</ParentFullName>
<Description>{Description}</Description>
</ResourceInfoDto>
</resourceInfoDtos>
</CreateResources>
Parameters
| Type | Name | Description |
|---|---|---|
| list | resourceInfoDtos | List of resources to add. |
Example
<CreateResources>
<resourceInfoDtos>
<ResourceInfoDto>
<Family>Generic Chassis</Family>
<Model>Generic Chassis Model</Model>
<FullName>Chassis1/Blade1</FullName>
<Address>192.168.1.200</Address>
<FolderFullpath>Lab Routers</FolderFullpath>
<ParentFullName>Chassis1</ParentFullName>
<Description>a generic router</Description>
</ResourceInfoDto>
</resourceInfoDtos>
</CreateResources>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
DeleteDomainDeletes a domain.
Deletes a domain.
Syntax
<DeleteDomain>
<domainName>{domainName}</domainName>
</DeleteDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
Example
<DeleteDomain>
<domainName>Domain1</domainName>
</DeleteDomain>
DeleteTopologyDelete a topology.
Deletes the specified topology.
Syntax
<DeleteTopology>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
</DeleteTopology>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<DeleteTopology>
<topologyFullPath>Topology1</topologyFullPath>
</DeleteTopology>
DeleteFolderDelete a folder.
Deletes the specified folder.
Syntax
<DeleteFolder>
<folderFullPath>{folderFullPath}</folderFullPath>
</DeleteFolder>
Parameters
| Type | Name | Description |
|---|---|---|
| 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
<DeleteFolder>
<folderFullPath>Lab Routers</folderFullPath>
</DeleteFolder>
DeleteGroupDelete a group.
Deletes the specified group.
Syntax
<DeleteGroup>
<groupName>{groupName}</groupName>
</DeleteGroup>
Parameters
| Type | Name | Description |
|---|---|---|
| string | groupName | Specify the name of the group. |
Example
<DeleteGroup>
<groupName>QA_Users</groupName>
</DeleteGroup>
DeleteReservationDelete a reservation.
Deletes the specified reservation.
Important: DeleteReservation does not perform teardown and therefore does not revert and clean up the sandbox environment.
Syntax
<DeleteReservation>
<reservationId>{reservationId}</reservationId>
<unmap>{unmap}</unmap>
</DeleteReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<DeleteReservation>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<unmap>1</unmap>
</DeleteReservation>
DeleteResourceDelete a resource.
Deletes the specified resource.
Syntax
<DeleteResource>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</DeleteResource>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<DeleteResource>
<resourceFullPath>Router 4321</resourceFullPath>
</DeleteResource>
DeleteResourcesDeletes the specified resources.
Deletes the specified resources.
Syntax
<DeleteResources>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
</DeleteResources>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<DeleteResources>
<resourcesFullPath>
<string>Router 4321</string>
</resourcesFullPath>
</DeleteResources>
DeleteUserDeletes a user.
Deletes the specified user.
Syntax
<DeleteUser>
<username>{username}</username>
</DeleteUser>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Specify the name of the user. |
Example
<DeleteUser>
<username>User1234</username>
</DeleteUser>
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
<DisconnectRoutesInReservation>
<reservationId>{reservationId}</reservationId>
<endpoints>
<string>{string}</string>
</endpoints>
</DisconnectRoutesInReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | endpoints | The routes endpoints to disconnect. |
Example
<DisconnectRoutesInReservation>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<endpoints>
<string>Router 1234/Port 1</string>
<string>GenericResource 1234/Port 1</string>
</endpoints>
</DisconnectRoutesInReservation>
Output
<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>
DecryptPasswordDecrypt a password.
Decrypt a password.
Syntax
<DecryptPassword>
<encryptedString>{encryptedString}</encryptedString>
</DecryptPassword>
Parameters
| Type | Name | Description |
|---|---|---|
| string | encryptedString | The encrypted string for decryption. |
Example
<DecryptPassword>
<encryptedString>mypassword</encryptedString>
</DecryptPassword>
Output
<ResponseInfo Password="decryptedPassword">DeleteResourceTemplateDeletes a specific resource template.
Deletes a specific resource template.
Syntax
<DeleteResourceTemplate>
<resourceTemplateName>{resourceTemplateName}</resourceTemplateName>
</DeleteResourceTemplate>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceTemplateName | Specify the resource template name. |
Example
<DeleteResourceTemplate>
<resourceTemplateName>Resource Template 4 tests</resourceTemplateName>
</DeleteResourceTemplate>
EndReservationEnd a reservation.
Ends the specified reservation and optionally, unlocks and releases all reservation resources.
Syntax
<EndReservation>
<reservationId>{reservationId}</reservationId>
<unmap>{unmap}</unmap>
</EndReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<EndReservation>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<unmap>1</unmap>
</EndReservation>
ExcludeResourceExclude a resource.
Excludes a specified resource.
Syntax
<ExcludeResource>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</ExcludeResource>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ExcludeResource>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
</ExcludeResource>
ExcludeResourcesExcludes the specified resources.
Excludes the specified resources.
Syntax
<ExcludeResources>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
</ExcludeResources>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<ExcludeResources>
<resourcesFullPath>
<string>L1 Switch 1234</string>
</resourcesFullPath>
</ExcludeResources>
SetResourceVisibilitySet the resource visibility state.
Set the resource visibility State - Admin Only, Everyone or Family Default.
Syntax
<SetResourceVisibility>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<newVisibility>{newVisibility}</newVisibility>
</SetResourceVisibility>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | newVisibility | The new visibility state for the resource. options: AdminOnly, Everyone or FamilyDefault |
Example
<SetResourceVisibility>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
<newVisibility>AdminOnly</newVisibility>
</SetResourceVisibility>
SetResourceShareLevel
Sets a resource's default share level.
Syntax
<SetResourceShareLevel>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<newShareLevel>{newShareLevel}</newShareLevel>
</SetResourceShareLevel>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the full path of the resource. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | newShareLevel | The new share level of the resource. Options: FamilyDefault, Shared or Unshared. |
Example
<SetResourceShareLevel>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
<newShareLevel>Shared</newShareLevel>
</SetResourceShareLevel>
EnqueueResourceCommand
[Deprecated] Enqueues a command to be executed for the specified driver.
Syntax
<EnqueueResourceCommand>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<commandName>{commandName}</commandName>
<parameterValues>
<string>{string}</string>
</parameterValues>
<printOutput>{printOutput}</printOutput>
</EnqueueResourceCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<EnqueueResourceCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourceFullPath>Router 1234</resourceFullPath>
<commandName>ExampleCommand</commandName>
<parameterValues>
<string>abcd</string>
<string>2</string>
</parameterValues>
<printOutput>true</printOutput>
</EnqueueResourceCommand>
EnqueueServiceCommand
[Deprecated] Enqueues a command to be executed for the specified driver.
Syntax
<EnqueueServiceCommand>
<reservationId>{reservationId}</reservationId>
<serviceAlias>{serviceAlias}</serviceAlias>
<commandName>{commandName}</commandName>
<parameterValues>
<string>{string}</string>
</parameterValues>
<printOutput>{printOutput}</printOutput>
</EnqueueServiceCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<EnqueueServiceCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<serviceAlias>Service1</serviceAlias>
<commandName>ExampleCommand</commandName>
<parameterValues>
<string>abcd</string>
<string>2</string>
</parameterValues>
<printOutput>true</printOutput>
</EnqueueServiceCommand>
ExecuteResourceCommand
[Deprecated] Executes a command for the specified driver.
Syntax
<ExecuteResourceCommand>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<commandName>{commandName}</commandName>
<parameterValues>
<string>{string}</string>
</parameterValues>
<printOutput>{printOutput}</printOutput>
</ExecuteResourceCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ExecuteResourceCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourceFullPath>Router 1234</resourceFullPath>
<commandName>ExampleCommand</commandName>
<parameterValues>
<string>abcd</string>
<string>2</string>
</parameterValues>
<printOutput>true</printOutput>
</ExecuteResourceCommand>
Output
<ResponseInfo Output="success"/>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
| Type | Name | Description |
|---|---|---|
| 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
<ResponseInfo Output="success"/>EnqueueTopologyCommandEnqueue a topology command.
[Deprecated] Enqueues a command to be executed for the specified reservation.
Syntax
<EnqueueTopologyCommand>
<reservationId>{reservationId}</reservationId>
<commandName>{commandName}</commandName>
<parameterValues>
<string>{string}</string>
</parameterValues>
<printOutput>{printOutput}</printOutput>
</EnqueueTopologyCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<EnqueueTopologyCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<commandName>ExampleCommand</commandName>
<parameterValues>
<string>abcd</string>
<string>2</string>
</parameterValues>
<printOutput>true</printOutput>
</EnqueueTopologyCommand>
ExecuteTopologyCommandExecute a topology command.
[Deprecated] Executes a command for the specified reservation.
Syntax
<ExecuteTopologyCommand>
<reservationId>{reservationId}</reservationId>
<commandName>{commandName}</commandName>
<parameterValues>
<string>{string}</string>
</parameterValues>
<printOutput>{printOutput}</printOutput>
</ExecuteTopologyCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ExecuteTopologyCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<commandName>ExampleCommand</commandName>
<parameterValues>
<string>abcd</string>
<string>2</string>
</parameterValues>
<printOutput>true</printOutput>
</ExecuteTopologyCommand>
Output
<ResponseInfo Output="success"/>ExtendReservationExtend a reservation.
Extends the duration of the specified reservation.
Syntax
<ExtendReservation>
<reservationId>{reservationId}</reservationId>
<minutesToAdd>{minutesToAdd}</minutesToAdd>
</ExtendReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ExtendReservation>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<minutesToAdd>60</minutesToAdd>
</ExtendReservation>
ExportFamiliesAndModelsExports the resource families, models, attributes and structure configuration.
Exports the resource families, models, attributes and structure configuration.
Syntax
<ExportFamiliesAndModels></ExportFamiliesAndModels>
Parameters
| Type | Name | Description |
|---|
Example
<ExportFamiliesAndModels></ExportFamiliesAndModels>Output
<ResponseInfo>ExecuteServiceCommand
[Deprecated] Executes a command for the specified service driver.
Syntax
<ExecuteServiceCommand>
<reservationId>{reservationId}</reservationId>
<serviceAlias>{serviceAlias}</serviceAlias>
<commandName>{commandName}</commandName>
<parameterValues>
<string>{string}</string>
</parameterValues>
<printOutput>{printOutput}</printOutput>
</ExecuteServiceCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ExecuteServiceCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<serviceAlias>Service 1</serviceAlias>
<commandName>ExampleCommand</commandName>
<parameterValues>
<string>abcd</string>
<string>2</string>
</parameterValues>
<printOutput>true</printOutput>
</ExecuteServiceCommand>
Output
<ResponseInfo Output="success"/>DeployAppToCloudProviderDeploy app to cloud provider
Executes deploy command for the specified app driver.
Syntax
<DeployAppToCloudProvider>
<reservationId>{reservationId}</reservationId>
<appName>{appName}</appName>
<commandInputs>
<InputNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</InputNameValue>
</commandInputs>
<printOutput>{printOutput}</printOutput>
</DeployAppToCloudProvider>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | appName | Specify the name of the app. |
| list | commandInputs | Specify a list of input names and values required for executing the command. Note that to change a deployed App's name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, "Azure Ubuntu", [InputNameValue("Name", "myvm01")]). |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<DeployAppToCloudProvider>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<appName>App1</appName>
<commandInputs>
<InputNameValue>
<Name>input1</Name>
<Value>abc</Value>
</InputNameValue>
</commandInputs>
<printOutput>true</printOutput>
</DeployAppToCloudProvider>
Output
<ResponseInfo Output="success"/>DeployAppToCloudProviderBulk
Executes deploy command for the specified apps.
Syntax
<DeployAppToCloudProviderBulk>
<reservationId>{reservationId}</reservationId>
<appNames>
<string>{string}</string>
</appNames>
<commandInputs>
<DeployAppInput>
<AppName>{AppName}</AppName>
<Name>{Name}</Name>
<Value>{Value}</Value>
</DeployAppInput>
</commandInputs>
<printOutput>{printOutput}</printOutput>
</DeployAppToCloudProviderBulk>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | appNames | Specify the names of the apps to deploy. |
| list | commandInputs | Specify a list of input names and values required for executing the command [appName, InputName, InputValue]. Note that to change a deployed App's name, specify the new name as an input value - for example: api.DeployAppToCloudProvider(reservation_id, "Azure Ubuntu", [DeployAppInput("Azure Ubuntu", "Name", "myvm01")]). |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<DeployAppToCloudProviderBulk>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<appNames>
<string>app1</string>
<string>app2</string>
</appNames>
<commandInputs>
<DeployAppInput>
<AppName>app1</AppName>
<Name>input1</Name>
<Value>abc</Value>
</DeployAppInput>
<DeployAppInput>
<AppName>app2</AppName>
<Name>input2</Name>
<Value>abc</Value>
</DeployAppInput>
</commandInputs>
<printOutput>true</printOutput>
</DeployAppToCloudProviderBulk>
Output
<ResponseInfo Output="success"/>RefreshAppInBlueprintsRefresh Apps in multiple blueprints from the App template
Refresh Apps in the list of blueprints. This applies to blueprints in all domains and can be used by system administrators only.
Syntax
<RefreshAppInBlueprints>
<appTemplateName>{appTemplateName}</appTemplateName>
<topologyNames>
<string>{string}</string>
</topologyNames>
</RefreshAppInBlueprints>
Parameters
| Type | Name | Description |
|---|---|---|
| string | appTemplateName | Specify the name of the App template to be used to refresh the App instances. |
| list | topologyNames | Specify an optional list of blueprint names. Include the full path from the root to the blueprint, separated by slashes. For example: FolderName/Topologies/TopologyName. If the list is not specified, Apps in all blueprints will be refreshed. |
Example
<RefreshAppInBlueprints>
<appTemplateName>testApp</appTemplateName>
<topologyNames>
<string>Topology1</string>
</topologyNames>
</RefreshAppInBlueprints>
Output
<ResponseInfo>
<Topologies>
<TopologyName>Topology1</TopologyName>
</Topologies>
</ResponseInfo>
RefreshVMDetails
Refreshes VM Details on deployed apps.
Syntax
<RefreshVMDetails>
<reservationId>{reservationId}</reservationId>
<deployedAppNames>
<string>{string}</string>
</deployedAppNames>
</RefreshVMDetails>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | deployedAppNames | Names of deployed apps whose vm details will be refreshed. |
Example
<RefreshVMDetails>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<deployedAppNames>
<string>app1</string>
<string>app2</string>
</deployedAppNames>
</RefreshVMDetails>
Output
<ResponseInfo Output="success"/>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>
</DefaultDeployment>
</ApiEditAppRequest>
</editAppsRequests>
</EditAppsInReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | editAppsRequests | Changes to implement in the App. Please note that when modifying attributes, *all* the attributes in deployed app must be updated. |
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>
</DefaultDeployment>
</ApiEditAppRequest>
</editAppsRequests>
</EditAppsInReservation>
Output
<ResponseInfo Output="success"/>PrepareSandboxConnectivity
Prepare Sandbox Connectivity
Syntax
<PrepareSandboxConnectivity>
<reservationId>{reservationId}</reservationId>
</PrepareSandboxConnectivity>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<PrepareSandboxConnectivity>
<reservationId>{reservationId}</reservationId>
</PrepareSandboxConnectivity>
Output
<ResponseInfo Output="success"/>CleanupSandboxConnectivity
Cleanup Sandbox Connectivity
Syntax
<CleanupSandboxConnectivity>
<reservationId>{reservationId}</reservationId>
</CleanupSandboxConnectivity>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<CleanupSandboxConnectivity>
<reservationId>{reservationId}</reservationId>
</CleanupSandboxConnectivity>
Output
<ResponseInfo Output="success"/>ConfigureApps
Run Configuration Management scripts for the apps in the blueprint.
Syntax
<ConfigureApps>
<reservationId>{reservationId}</reservationId>
<appConfigurations>
<AppConfiguration>
<AppName>{AppName}</AppName>
<ConfigParams>
<ConfigParam>
<Name>{Name}</Name>
<Value>{Value}</Value>
</ConfigParam>
</ConfigParams>
</AppConfiguration>
</appConfigurations>
<printOutput>{printOutput}</printOutput>
</ConfigureApps>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | appConfigurations | Configuration details. Note: Running ConfigureApps with parameters that are missing from the App returns a success message. |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<ConfigureApps>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<appConfigurations>
<AppConfiguration>
<AppName>App1</AppName>
<ConfigParams>
<ConfigParam>
<Name>param1</Name>
<Value>12345</Value>
</ConfigParam>
</ConfigParams>
</AppConfiguration>
</appConfigurations>
<printOutput>true</printOutput>
</ConfigureApps>
Output
<ResponseInfo Output="success"/>ConfigureAppsV2
Run Configuration Management scripts for the apps in the blueprint.
Syntax
<ConfigureAppsV2>
<reservationId>{reservationId}</reservationId>
<appConfigurationsData>
<AppConfigurationData>
<AppName>{AppName}</AppName>
<ConfigurationManagementDatas>
<ConfigurationManagementData>
<Alias>{Alias}</Alias>
<ConfigParams>
<ConfigParam>
<Name>{Name}</Name>
<Value>{Value}</Value>
</ConfigParam>
</ConfigParams>
</ConfigurationManagementData>
</ConfigurationManagementDatas>
</AppConfigurationData>
</appConfigurationsData>
<printOutput>{printOutput}</printOutput>
</ConfigureAppsV2>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | appConfigurationsData | Configuration details. Note: Running ConfigureAppsV2 with parameters that are missing from the App returns a success message. |
| boolean | printOutput | Defines whether to print the command output in the sandbox command output window. |
Example
<ConfigureAppsV2>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<appConfigurationsData>
<AppConfigurationData>
<AppName>App1</AppName>
<ConfigurationManagementDatas>
<ConfigurationManagementData>
<Alias>alias</Alias>
<ConfigParams>
<ConfigParam>
<Name>configName</Name>
<Value>configValue</Value>
</ConfigParam>
</ConfigParams>
</ConfigurationManagementData>
</ConfigurationManagementDatas>
</AppConfigurationData>
</appConfigurationsData>
<printOutput>True</printOutput>
</ConfigureAppsV2>
Output
<ResponseInfo Output="success"/>CheckoutFromPoolCheckout from pool
Request to checkout an item from a pool.
Syntax
<CheckoutFromPool>
<selectionCriteriaJson>{selectionCriteriaJson}</selectionCriteriaJson>
</CheckoutFromPool>
Parameters
| Type | Name | Description |
|---|---|---|
| string | selectionCriteriaJson | Json string that represents a selection request for an item or multiple items from a pool. |
Example
<CheckoutFromPool>
<selectionCriteriaJson>jsonRequest</selectionCriteriaJson>
</CheckoutFromPool>
GetModelUsageReportGet model usages
Retrieves the model usages information in Resources, Apps, Abstract Resources and Abstract Templates at Blueprints, Blueprints templates and Sandboxes.
Syntax
<GetModelUsageReport>
<modelName>{modelName}</modelName>
</GetModelUsageReport>
Parameters
| Type | Name | Description |
|---|---|---|
| string | modelName | Specify the name of the model to retrieve usages for. |
Example
<GetModelUsageReport>
<modelName>GenericChassis</modelName>
</GetModelUsageReport>
Output
<ResponseInfo/>
SetCustomShellAttributeAdd a custom attribute to an existing shell
Add a custom attribute to an existing shell model
Syntax
<SetCustomShellAttribute>
<modelName>{modelName}</modelName>
<attributeName>{attributeName}</attributeName>
<defaultValue>{defaultValue}</defaultValue>
<restrictedValues>
<string>{string}</string>
</restrictedValues>
</SetCustomShellAttribute>
Parameters
| Type | Name | Description |
|---|---|---|
| string | modelName | Specify the name of the model to add the attribute to. |
| string | attributeName | Specify the name of the attribute to add/update. |
| string | defaultValue | Specify the default value to set for the attribute. |
| list | restrictedValues | Specify the restricted values for the attribute. |
Example
<SetCustomShellAttribute>
<modelName>NXOS</modelName>
<attributeName>Execution Server Selector</attributeName>
<defaultValue>Lab 1</defaultValue>
<restrictedValues>
<string>Lab 1</string>
<string>Lab 2</string>
</restrictedValues>
</SetCustomShellAttribute>
RemoveCustomShellAttributeRemove a custom attribute from an existing shell
Remove a custom attribute from an existing shell
Syntax
<RemoveCustomShellAttribute>
<modelName>{modelName}</modelName>
<attributeName>{attributeName}</attributeName>
</RemoveCustomShellAttribute>
Parameters
| Type | Name | Description |
|---|---|---|
| string | modelName | Specify the name of the model to remove the attribute from. |
| string | attributeName | Specify the name of the attribute to remove. |
Example
<RemoveCustomShellAttribute>
<modelName>NXOS</modelName>
<attributeName>Execution Server Selector</attributeName>
</RemoveCustomShellAttribute>
ReleaseFromPoolRelease from pool
Request to release an item from a pool.
Syntax
<ReleaseFromPool>
<values>
<string>{string}</string>
</values>
<poolId>{poolId}</poolId>
<reservationId>{reservationId}</reservationId>
<ownerId>{ownerId}</ownerId>
</ReleaseFromPool>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ReleaseFromPool>
<values>
<string>20</string>
</values>
<poolId>somePool</poolId>
<reservationId>reservationId</reservationId>
<ownerId>someOwner</ownerId>
</ReleaseFromPool>
Output
<ResponseInfo Output="success"/>EnqueueEnvironmentCommandEnqueue an environment command.
Enqueues a command to be executed for the specified reservation.
Syntax
<EnqueueEnvironmentCommand>
<reservationId>{reservationId}</reservationId>
<commandName>{commandName}</commandName>
<commandInputs>
<InputNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</InputNameValue>
</commandInputs>
<printOutput>{printOutput}</printOutput>
</EnqueueEnvironmentCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | commandName | Specify the name of the command. |
| list | commandInputs | Specify a matrix of input names and values required for executing the command. |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<EnqueueEnvironmentCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<commandName>ExampleCommand</commandName>
<commandInputs>
<InputNameValue>
<Name>input1</Name>
<Value>abc</Value>
</InputNameValue>
</commandInputs>
<printOutput>true</printOutput>
</EnqueueEnvironmentCommand>
ExecuteEnvironmentCommandExecute an environment command.
Executes a command for the specified reservation.
Syntax
<ExecuteEnvironmentCommand>
<reservationId>{reservationId}</reservationId>
<commandName>{commandName}</commandName>
<commandInputs>
<InputNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</InputNameValue>
</commandInputs>
<printOutput>{printOutput}</printOutput>
</ExecuteEnvironmentCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | commandName | Specify the name of the command. |
| list | commandInputs | Specify a matrix of input names and values required for executing the command. |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<ExecuteEnvironmentCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<commandName>ExampleCommand</commandName>
<commandInputs>
<InputNameValue>
<Name>input1</Name>
<Value>abc</Value>
</InputNameValue>
</commandInputs>
<printOutput>true</printOutput>
</ExecuteEnvironmentCommand>
Output
<ResponseInfo Output="success"/>EnqueueCommandEnqueue a command.
Enqueues a command to be executed for the specified target.
Syntax
<EnqueueCommand>
<reservationId>{reservationId}</reservationId>
<targetName>{targetName}</targetName>
<targetType>{targetType}</targetType>
<commandName>{commandName}</commandName>
<commandInputs>
<InputNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</InputNameValue>
</commandInputs>
<printOutput>{printOutput}</printOutput>
</EnqueueCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | targetName | Specify the name of the target according to the target type: for resources - specify the resouce's name, for services - the service's alias. |
| string | targetType | Specify the target type for command execution, possible values are: Resource, Service, App. Use 0 for Resource, 1 for Service, 2 for App. |
| string | commandName | Specify the name of the command. |
| list | commandInputs | Specify a matrix of input names and values required for executing the command. |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<EnqueueCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<targetName>Router 1234</targetName>
<targetType>0</targetType>
<commandName>ExampleCommand</commandName>
<commandInputs>
<InputNameValue>
<Name>input1</Name>
<Value>abc</Value>
</InputNameValue>
</commandInputs>
<printOutput>true</printOutput>
</EnqueueCommand>
ExecuteCommandExecute a command.
Executes a command for the specified target.
Syntax
<ExecuteCommand>
<reservationId>{reservationId}</reservationId>
<targetName>{targetName}</targetName>
<targetType>{targetType}</targetType>
<commandName>{commandName}</commandName>
<commandInputs>
<InputNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</InputNameValue>
</commandInputs>
<printOutput>{printOutput}</printOutput>
</ExecuteCommand>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | targetName | Specify the name of the target according to the target type: for resources - specify the resouce's name, for services - the service's alias. |
| string | targetType | Specify the target type for command execution, possible values are: Resource, Service, App. Use 0 for Resource, 1 for Service, 2 for App. |
| string | commandName | Specify the name of the command. |
| list | commandInputs | Specify a matrix of input names and values required for executing the command. |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<ExecuteCommand>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<targetName>Router 1234</targetName>
<targetType>0</targetType>
<commandName>ExampleCommand</commandName>
<commandInputs>
<InputNameValue>
<Name>input1</Name>
<Value>abc</Value>
</InputNameValue>
</commandInputs>
<printOutput>true</printOutput>
</ExecuteCommand>
Output
<ResponseInfo Output="success"/>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>
<includeExcludedResources>{includeExcludedResources}</includeExcludedResources>
</FindResources>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFamily | Specify the name of the resource family. |
| string | resourceModel | Specify the resource model. |
| list | attributeValues | Specify an array of one or more attributes and attribute values. |
| boolean | showAllDomains | Show all domains associated with the logged in user. |
| string | resourceFullName | Specify part of or the full name of the resource. |
| boolean | exactName | Specify whether to search the exact given name or not. |
| boolean | includeSubResources | Specify whether to retrieve the sub resources once the parent matches the name. |
| string | resourceAddress | Specify the resource address. Can be partial (e.g. '192.168.'). |
| string | resourceUniqueIdentifier | Specify the resource unique identifier. |
| number | maxResults | Specify the maximum number of resources to return. |
| boolean | includeExcludedResources | Specify whether to retrieve resources that are excluded |
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>true</exactName>
<includeSubResources>true</includeSubResources>
<resourceAddress></resourceAddress>
<resourceUniqueIdentifier></resourceUniqueIdentifier>
<maxResults>500</maxResults>
<includeExcludedResources>false</includeExcludedResources>
</FindResources>
Output
<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>
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
| Type | Name | Description |
|---|---|---|
| string | resourceFamily | Specify the name of the resource family. |
| string | resourceModel | Specify the resource model. |
| string | fromTime | Specify from which future time and date to check the resource's availability. |
| string | untilTime | Specify until which time and date to check the resource's availability. |
| list | attributeValues | Specify an array of one or more attributes and attribute values. |
| boolean | showAllDomains | Show all domains associated with the logged in user. |
| string | resourceFullName | Specify part of or the full name of the resource. |
| boolean | exactName | Specify whether to search the exact given name or not. |
| boolean | includeSubResources | Specify whether to retrieve the sub resources once the parent matches the name. |
| string | resourceAddress | Specify the resource address. Can be partial (e.g. '192.168.'). |
| string | resourceUniqueIdentifier | Specify the resource unique identifier. |
| number | maxResults | Specify the maximum number of resources to return. |
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
<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>
GetReservationResourcesPositionsGet resource positions in a reservation.
Retrieves the x/y coordinates for all resources in the reservation's diagram.
Syntax
<GetReservationResourcesPositions>
<reservationId>{reservationId}</reservationId>
</GetReservationResourcesPositions>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<GetReservationResourcesPositions>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetReservationResourcesPositions>
Output
<ResponseInfo>
<layout/>
</ResponseInfo>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
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
| Type | Name | Description |
|---|---|---|
| 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>
GetActiveTopologyNamesRetrieve a user's reserved topologies.
Retrieves all active reserved topologies for the current (logged in) user.
Syntax
<GetActiveTopologyNames></GetActiveTopologyNames>
Parameters
| Type | Name | Description |
|---|
Example
<GetActiveTopologyNames></GetActiveTopologyNames>Output
<ResponseInfo>
<Topologies>
<TopologyName>Temp Automation Resources/TP1</TopologyName>
</Topologies>
</ResponseInfo>
GetAllUsersDetailsRetrieve all users and user settings.
Retrieves all users and their settings.
Syntax
<GetAllUsersDetails></GetAllUsersDetails>
Parameters
| Type | Name | Description |
|---|
Example
<GetAllUsersDetails></GetAllUsersDetails>Output
<ResponseInfo>
<Users>
<User Name="admin" IsAdmin="true" IsActive="true" IsDomainAdmin="false">
<Groups>
<Group Name="System Administrators" Description="Built in group, all members have administrative rights.">
<TestShellDomains>
<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
</TestShellDomains>
</Group>
<Group Name="Everyone">
<TestShellDomains/>
</Group>
</Groups>
</User>
<User Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com">
<Groups>
<Group Name="Everyone">
<TestShellDomains/>
</Group>
</Groups>
</User>
<User Name="User2345" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="">
<Groups>
<Group Name="Everyone">
<TestShellDomains/>
</Group>
</Groups>
</User>
</Users>
</ResponseInfo>
GetAttributeValueRetrieve an attribute's value.
Retrieves the value of the specified attribute
Syntax
<GetAttributeValue>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<attributeName>{attributeName}</attributeName>
</GetAttributeValue>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | attributeName | Specify the attribute name. |
Example
<GetAttributeValue>
<resourceFullPath>Router 1234</resourceFullPath>
<attributeName>SW_Version</attributeName>
</GetAttributeValue>
Output
<ResponseInfo Name="SW_Version" Value="1.3"/>GetCategoriesOfTopologyRetrieves all categories of a given topology.
Retrieves all categories of given topology.
Syntax
<GetCategoriesOfTopology>
<topologyPath>{topologyPath}</topologyPath>
</GetCategoriesOfTopology>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<GetCategoriesOfTopology>
<topologyPath>Folder1/exampleTopology</topologyPath>
</GetCategoriesOfTopology>
Output
<ResponseInfo xsi:type="CategoriesOfTopologyInfo">
<Categories>
<Category Name="sampleCategory" Value="hello"/>
<Category Name="Category2" Value="bye"/>
</Categories>
</ResponseInfo>
GetCurrentReservationsRetrieve current reservations.
Retrieves current reservations for the specified owner. If an owner is not provided, this method retrieves all current reservations.
Syntax
<GetCurrentReservations>
<reservationOwner>{reservationOwner}</reservationOwner>
</GetCurrentReservations>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationOwner | Specify the user name of the reservation owner. |
Example
<GetCurrentReservations>
<reservationOwner>admin</reservationOwner>
</GetCurrentReservations>
Output
<ResponseInfo>
<Reservations>
<Reservation Id="65b45c9b-7694-4a42-b8fa-0239109b5246" Name="Reservation" StartTime="2012-06-19T14:30:00" EndTime="2012-06-19T16:30:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Overtime" ProvisioningStatus="Ready" ActualEndTime="" CreateDate="2012-06-19T14:30:23" ModificationDate="2012-06-19T14:37:55" DomainName="Global">
<Topologies>
<TopologyName>Topologies/Lab 1/Topology</TopologyName>
<TopologyName>Topologies/Lab 1/TrafficTopology</TopologyName>
<TopologyName>Topologies/Lab 1/TrafficTopology1</TopologyName>
</Topologies>
<permittedUsers></permittedUsers>
</Reservation>
</Reservations>
</ResponseInfo>
GetDomainDetailsRetrieves a domain's details including groups, topologies and resources associated with the specified domain.
Retrieves a domain's details including groups, topologies and resources associated with the specified domain.
Syntax
<GetDomainDetails>
<domainName>{domainName}</domainName>
</GetDomainDetails>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
Example
<GetDomainDetails>
<domainName>Domain1</domainName>
</GetDomainDetails>
Output
<ResponseInfo Name="Domain1" Description="" TopologiesFolder="Root\Domain1 topologies">
<Groups>
<Group Name="Animals" Role="Regular"></Group>
</Groups>
<Topologies>
<Topology Name="Topology" Description=""></Topology>
</Topologies>
<Resources>
<Resource Name="b1" Path="b1"></Resource>
</Resources>
</ResponseInfo>
GetFolderContentRetrieve content for a specified path.
Retrieves content for the specified path.
Syntax
<GetFolderContent>
<fullPath>{fullPath}</fullPath>
<showAllDomains>{showAllDomains}</showAllDomains>
</GetFolderContent>
Parameters
| Type | Name | Description |
|---|---|---|
| string | fullPath | Specify the full folder name. Include the full path from the root to a specific folder, separated by slashes. For example: ResourceFamilyFolder/ResourceModelFolder. |
| boolean | showAllDomains | Show all domains associated with the logged in user. |
Example
<GetFolderContent>
<fullPath>Lab Routers</fullPath>
<showAllDomains>true</showAllDomains>
</GetFolderContent>
Output
<ResponseInfo>
<ContentArray>
<Content Name="Router 1234" Type="Resource" Permissions="ReadOnly"/>
<Content Name="Router 4321" Type="Resource" Permissions="ReadOnly"/>
</ContentArray>
</ResponseInfo>
MoveFolderAllows to change the location of a folder (and all its content, including sub folders) in the folder hierarchy.
Move a folder (and all its content, including sub folders) in the folder hierarchy.
Syntax
<MoveFolder>
<originalFolder>{originalFolder}</originalFolder>
<targetFolder>{targetFolder}</targetFolder>
</MoveFolder>
Parameters
| Type | Name | Description |
|---|---|---|
| string | originalFolder | Path of the folder to be moved. |
| string | targetFolder | The path of the new containing folder. To move a folder to root, value should be empty. |
Example
<MoveFolder>
<originalFolder>MyFolder</originalFolder>
<targetFolder>MyCompanyFolder</targetFolder>
</MoveFolder>
Output
<ResponseInfo/>
GetGroupDomainsRetrieve a group's domains.
Retrieves all domains associated with a group.
Syntax
<GetGroupDomains>
<groupName>{groupName}</groupName>
</GetGroupDomains>
Parameters
| Type | Name | Description |
|---|---|---|
| string | groupName | Specify the name of the group. |
Example
<GetGroupDomains>
<groupName>QA_Users</groupName>
</GetGroupDomains>
Output
<ResponseInfo Name="QA_Users" Description="QA users">
<TestShellDomains>
<TestShellDomain Name="Global" Description="A domain that includes all available resources" Id="dbaf480c-09f7-46d3-a2e2-e35d3e374a16"/>
</TestShellDomains>
</ResponseInfo>
GetGroupsDetailsRetrieve all system groups.
Retrieves all groups, including members, roles and associated domains for each group.
Syntax
<GetGroupsDetails></GetGroupsDetails>
Parameters
| Type | Name | Description |
|---|
Example
<GetGroupsDetails></GetGroupsDetails>Output
<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>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
GetReservationDetailsRetrieve reservation details and parameters.
Retrieves all details and parameters for a specified reservation, including its resources, routes and route segments, topologies, and reservation conflicts.The data cached for 5 seconds.
Syntax
<GetReservationDetails>
<reservationId>{reservationId}</reservationId>
<disableCache>{disableCache}</disableCache>
</GetReservationDetails>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| boolean | disableCache | Specify if the reservation detail is new or cached |
Example
<GetReservationDetails>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<disableCache>true</disableCache>
</GetReservationDetails>
Output
<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>
<ReservedResource Name="bridge" FolderFullPath="" FullAddress="1" Shared="true" Availability="Available" Locked="false" Released="true" ResourceFamilyName="Bridge" ResourceModelName="Bridge Generic Model" CreatedByUser="admin" CreatedInDomain="Global">
<AppDetails AppName="TestApp" />
</ReservedResource>
<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>
GetReservationAppImageRetrieve the photo of an app template.
Retrieves the photo of an app.
Syntax
<GetReservationAppImage>
<reservationId>{reservationId}</reservationId>
<appName>{appName}</appName>
</GetReservationAppImage>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | appName | Specify the name of the app. |
Example
<GetReservationAppImage>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<appName>MyApp</appName>
</GetReservationAppImage>
Output
<ResponseInfo>
<AppTemplateImage>iVBORw0KGgoAAAANSUhEUgAAAG0AAAAgCAYAAAAYPvbkAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAACAJJREFUeNrsWwuQjVUcP3fvXbRrSa3HkgiV11qVRw8l6SFNNTIpRekhGb1Vqgmp1CS9PFJIidXopUZRSYymtUVh2YTkkcdKilbrcXf39v/P/X3tcZxzv/PdvQ8z9j/zG3e/e777nXN+//f5+AITCoSF+AknEtoQuhM6E1oQGhCqEcoJ/xC2EgoJeYTF+PuAqBKWcwl3EQ5L12oSxgaHZK+UB6ZOXN2a/ulP6IRLywgzadwa/sPnQpoP5PQh3EI4w8Mkg4SvCW8SFhL2H+ekDSC8rbnei8j4BGTxft9KGA9CZSkh3E+YFojwkLqEmwmPE+pFMclUwpUAk/Ys4VtC2XFKWshiTBfCFIKOlzQYwMYUw83sBmcQXomSMFXYpX5EeJRQo8pTajR84moOQQ8ZCHOE+XpEN6AjYRbcYizlJMJzhIaEoYpvr5IwIRdajLtAJa29JWFFSDZ+ha9lLcki5BA6IBaa5B7Eu6GWLuN4Ed6z6jZGKZPWmDAhAmHlSCzeIKwg7CMUE0qhJez2ahMaEW4gDMTfJuLWwn9XScX+FiIzjyRrHdI4bR/MpmcYuJvwIIGznH8NDywBdhKWE94hjCH0NCQpIwiLYK2qm/Br7inDc9wkoLH0EJTL1k2xxrckNIPihbAHqwnblGRKN99yrwkXZZClFNcmWZA20SGtHQc4w6D1hH6oFbwIa01vwmgEWFVOIQxHiivLnVAgPxbvh6K8THjf5ZnsLSYTToULFiDgc8JIg8I5UgO11AAoWh2Q75OI589cU40jzEFtej3hKcIhKcv7Bmvb7XHPZhPOwx74NUrLJcN7AUx2sCFrYavpS/gpSpM/SBhGyIC7VKUbIRsa7IgTG2VrOYASxE14LW2hELL8bLBeR9iqniFcB8uJJGfDi/SBMtbC/bJshTcRHq3tIFkb12KrQNzJ+OpvEDaZxzBR9RGDdDK0EoQ5UgpXmA1NVi2jH4iVXUu0dU7I0oXKwnUku6UmHu/riUx4cZRzNRHHFjuJyJsK5WPl3UbXD8v+/2JCuub+DwlfxijIFkE728F9qO2dZMkV3GFAOy4aydFYWUyESGL3vskUtLsZ7uP48VcM58HmPYhwlnI9C2QWJJiwVoiTkQjbg9hcAhffVsmIfbFuFpCFZSCuFRBxRbiWhWfn07XiALRFl3ysi/EmHUZWqZLGfvv0BJNWAwrU2vD9b+gGLYWXCOKeTCj5w5WwTjfJQBJTm8jaCcVg0vYSbuQyK6AJ2gKE7YjDhFZAa9OUSTZMsJW1QfKlkwWE+wi/aL7bihg/jzAd3aNYSwh7kg04UuDEyhRDPGO3GI+u/B9SKi7XbOkJJMyPWFZNV7gS7jYQpo7jZvrvcZpjmaEW/r8wNBWYvjhtmE8kV/hc8HLDd6PhGm1kA+GlZCwgBQWi0MSZDMM9mUjTuajshFTZtiZpoNHwoEvRG2tJ18RVgc5MnsffmmXYv7gKx7TNqNVUn98Y7kwWzpzGKl0M1sy56DrkuRDQQZNtHYhxlhpyuZ6OgliVpcgWvQjH5/wIlhs3S1upud5EU3/wYsdr2k7cn+Mqfj6BC8LuEbKiHENavUFJo6MtVlMMsUp1jzrZLry/GlGK5CTh7vELw3f9JAtkEvkQs79LvOKU9APCKM3m3AsL1rXKViobUa6ZZ8ByPdVjbKHxuq9SpLF579J814NwDT4fgv8eIMKnz28Rthh+sw7qjJlKynqa0Pf/CsSRB6KHNKT5LTPMgKbjolqwyQVyODghivDSLBmk7UGLSScvEC5CgfkuapMXUcfwMU5voe9N8gZdha6K4y75FIGPd/ZJ43Zonl0ijj5GSbWs5dIsOhQlmljN0gVJlhfhGN85GaQFsXF/Gqwml9BVs3COAR+D1CcMdV1LuNWBqOhfJZwjwscnBxEHv1fu2Y3vVGlusZ52FmN4nrpjpqao37zI7eLot6YSQppAMTnSMIY7Jp+J8DGE7iSas8XnRbjrXahxbbVBErtUPtXeiAKWCX1S83uczRYbSItESqZLzHVkLzJdnYwSFe8aukkXtLNEskhzao5cw7iaKCT5pPk2EX7/sR7iTCoytmVoDW2PoJWLsbH1kXUVGWKcrgTgZw4xZJf14X4vslz3QqFv09VFInV1hCwzA7F+ljC/ThH3Ok3WwOEIyKbFc1E6DQXlMljFPiQKdZAdZkV4XgvExh9E+H2TQjx3Bz4HkZTwIWB7zf13YNNy8dzqouJl2ks8rHs9XPUYzXd86j0H3mU+iu4glLMpCOthUVokhDSWTbCI110KxloR6jEb6aS4oXXo5f2Iv6cgkcnUZJF9gdJKtsVmgOgehvLlWsBJ65PdftO6R0c2wgW+JhL3Hv6Z4sh3/r6DlrspXGU2kl3zA8LuZN70HLbAtccCaU4q/hg0Or+SzyhDAb/eZVxPpZ02LIpeIKfySzyMX4eyZX4U6wohzk8/VkgTSLs/JfRCp2Ohx9/m2DQXQZ1jzqVIVBYJ/Xscl4nwf/KQOyU3wY3ZyAK4s3yP69yM9Q3CZxvZBHc+Qqk75ef5LK3VJmwJuTERsHQjs5EmN0LNxu91tEI5UAsk7EdGuAobl6f084qR+uciaclBstEcaIp4ukSq3bZgMyejrXY+npmOzskuuDee31ei4oA1KNV6vMY1ouIVN51wYjUVNWVXWH1HzCkN3oKbECuQpMyDUrEsR6ngNASqwYJVMnmeT4sjzxPTNO6V92kc1lkmEbYd8xT/CTAAmAbgA3C38T4AAAAASUVORK5CYII==</AppTemplateImage>
</ResponseInfo>
GetReservationStatusRetrieve reservation status
Retrieves status for a specified reservation
Syntax
<GetReservationStatus>
<reservationId>{reservationId}</reservationId>
</GetReservationStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | startTime | The start time and date for the specified reservation. |
| string | endTime | The end time and date for the specified reservation. |
| string | reservationStatus | Indicates the current reservation status. |
| string | provisioningStatus | Indicates the current provisioning status. |
| boolean | fullyBooked | Indicates if the current reservation is fully booked. |
Example
<GetReservationStatus>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetReservationStatus>
Output
<ResponseInfo>
</ResponseInfo>
GetReservationInputsRetrieves all topology inputs for a specified reservation.
Retrieves all topology inputs for a specified reservation.
Syntax
<GetReservationInputs>
<reservationId>{reservationId}</reservationId>
</GetReservationInputs>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | globalInputs | Global inputs associated with the specified reservation. |
| list | requirementsInputs | Requirements inputs associated with the specified reservation. |
| list | additionalInfoInputs | Additional info inputs associated with the specified reservation. |
Example
<GetReservationInputs>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetReservationInputs>
Output
<ResponseInfo/>GetReservationRemainingTimeRetrieve the amount of time until the end of a reservation.
Retrieves the number of minutes remaining until the end of a specified reservation. If the reservation is running overtime, the remaining time will be reported as -1 minutes.
Syntax
<GetReservationRemainingTime>
<reservationId>{reservationId}</reservationId>
</GetReservationRemainingTime>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<GetReservationRemainingTime>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetReservationRemainingTime>
Output
<ResponseInfo RemainingTimeInMinutes="26.4"/>GetResourceAvailabilityGet resource availability.
Get resource availability for the resources.
Syntax
<GetResourceAvailability>
<resourcesNames>
<string>{string}</string>
</resourcesNames>
<showAllDomains>{showAllDomains}</showAllDomains>
</GetResourceAvailability>
Parameters
| Type | Name | Description |
|---|---|---|
| list | resourcesNames | Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName |
| boolean | showAllDomains | Show all domains associated with the logged in user. |
Example
<GetResourceAvailability>
<resourcesNames>
<string>Bridge</string>
</resourcesNames>
<showAllDomains>1</showAllDomains>
</GetResourceAvailability>
GetResourceAvailabilityInTimeRangeGet resource availability during a specific time range.
Get resource availability for the resources in the specified time range.
Syntax
<GetResourceAvailabilityInTimeRange>
<resourcesNames>
<string>{string}</string>
</resourcesNames>
<startTime>{startTime}</startTime>
<endTime>{endTime}</endTime>
<showAllDomains>{showAllDomains}</showAllDomains>
</GetResourceAvailabilityInTimeRange>
Parameters
| Type | Name | Description |
|---|---|---|
| list | resourcesNames | Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName |
| string | startTime | The start time of the reservation. |
| string | endTime | The end time of the reservation. |
| boolean | showAllDomains | Show all domains associated with the logged in user. |
Example
<GetResourceAvailabilityInTimeRange>
<resourcesNames>
<string>{string}</string>
</resourcesNames>
<startTime>{startTime}</startTime>
<endTime>{endTime}</endTime>
<showAllDomains>{showAllDomains}</showAllDomains>
</GetResourceAvailabilityInTimeRange>
GetResourceCommandsRetrieve resource driver commands.
Retrieves driver commands and parameters for a specified resource.
Syntax
<GetResourceCommands>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</GetResourceCommands>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<GetResourceCommands>
<resourceFullPath>Router 1234</resourceFullPath>
</GetResourceCommands>
Output
<ResponseInfo>
<Commands>
<Command Name="ExampleCommand" DisplayName="Example Command" >
<Parameters>
<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
</Parameters>
</Command>
<Command Name="ResetDriver" DisplayName="Reset Driver">
<Parameters/>
</Command>
</Commands>
</ResponseInfo>
GetServiceCommandsRetrieve service driver commands.
Retrieves driver commands and parameters for a specified service.
Syntax
<GetServiceCommands>
<serviceName>{serviceName}</serviceName>
</GetServiceCommands>
Parameters
| Type | Name | Description |
|---|---|---|
| string | serviceName | Specify the service name. |
Example
<GetServiceCommands>
<serviceName>VLAN</serviceName>
</GetServiceCommands>
Output
<ResponseInfo>
<Commands>
<Command Name="ExampleCommand" DisplayName="Example Command" >
<Parameters>
<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
</Parameters>
</Command>
<Command Name="ResetDriver" DisplayName="Reset Driver">
<Parameters/>
</Command>
</Commands>
</ResponseInfo>
GetResourceConnectedCommandsRetrieve resource driver commands.
Gets commands which are added to the resource from connected resources such as power or virtualization.
Syntax
<GetResourceConnectedCommands>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</GetResourceConnectedCommands>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<GetResourceConnectedCommands>
<resourceFullPath>Router 1234</resourceFullPath>
</GetResourceConnectedCommands>
Output
<ResponseInfo>
<Commands>
<Command Name="SpinUp" Tag="virtualization" DisplayName="Example virtualiztion command" >
<Parameters>
<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
</Parameters>
</Command>
<Command Name="PowerOn" Tag="power" DisplayName="Example power command" >
<Parameters/>
</Command>
</Commands>
</ResponseInfo>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
GetResourceListRetrieve a list of resources for a specified path.
Retrieves resources and resource values for the specified folder path.
Syntax
<GetResourceList>
<folderFullPath>{folderFullPath}</folderFullPath>
</GetResourceList>
Parameters
| Type | Name | Description |
|---|---|---|
| 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
<GetResourceList>
<folderFullPath>Lab Routers</folderFullPath>
</GetResourceList>
Output
<ResponseInfo>
<Resources>
<Resource Name="Router 1234" FolderFullPath="Lab Routers" Address="192.168.1.200" FullAddress="192.168.1.200" RootAddress="192.168.1.200" ResourceFamilyName="Generic Chassis" ResourceModelName="Generic Chassis Model" Locked="false" Excluded="false">
<LockInfo/>
</Resource>
<Resource Name="Router 4321" FolderFullPath="Lab Routers" Address="192.168.1.201" FullAddress="192.168.1.201" RootAddress="192.168.1.201" ResourceFamilyName="Generic Resource" ResourceModelName="Generic Resource Model" Locked="false" Excluded="false">
<LockInfo/>
</Resource>
</Resources>
</ResponseInfo>
GetResourceLiveStatusGets the live status of a resource.
Gets the live status of the resource.
Syntax
<GetResourceLiveStatus>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</GetResourceLiveStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<GetResourceLiveStatus>
<resourceFullPath>{path}</resourceFullPath>
</GetResourceLiveStatus>
GetReservationsLiveStatusGets the live status the reservations.
Gets the live status of the reservations.
Syntax
<GetReservationsLiveStatus>
<reservationsId>
<string>{string}</string>
</reservationsId>
</GetReservationsLiveStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| list | reservationsId | Specifies a string array that represents reservation unique identifiers. |
Example
<GetReservationsLiveStatus>
<reservationsId>
<string>a2f1b35e-3deb-42ee-b70d-78189dd10d56</string>
</reservationsId>
</GetReservationsLiveStatus>
GetResourceMappingsRetrieve current mappings for specified resources.
Retrieves mappings for a list of one or more resources.
Syntax
<GetResourceMappings>
<resources>
<string>{string}</string>
</resources>
</GetResourceMappings>
Parameters
| Type | Name | Description |
|---|---|---|
| list | resources | Specify a list of resources. |
Example
<GetResourceMappings>
<resources>
<string>L1 Switch 1234/Blade 1/Port 2</string>
</resources>
</GetResourceMappings>
Output
<ResponseInfo>
<Mapping Source="L1 Switch 1234/Blade 1/Port 3" Target="L1 Switch 1234/Blade 1/Port 2" RouteType="uni"/>
</ResponseInfo>
GetRouteSegmentsRetrieves all the ports on the route.
Retrieves all the ports on the route from the selected endpoint to the target endpoint.
Syntax
<GetRouteSegments>
<resource>{resource}</resource>
</GetRouteSegments>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resource | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
Example
<GetRouteSegments>
<resource>Router 1234/Port 1</resource>
</GetRouteSegments>
Output
<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>
GetScheduledReservationsRetrieve scheduled reservations for a specified time range.
Retrieves all reservations scheduled between the specified start and end times.
Syntax
<GetScheduledReservations>
<fromTime>{fromTime}</fromTime>
<untilTime>{untilTime}</untilTime>
<ownerName>{ownerName}</ownerName>
</GetScheduledReservations>
Parameters
| Type | Name | Description |
|---|---|---|
| string | fromTime | Specify from which time and date to search. |
| string | untilTime | Specify until which time and date to search. |
| string | ownerName | Specify reservation owner name |
Example
<GetScheduledReservations>
<fromTime>01/01/2015 08:00</fromTime>
<untilTime>01/01/2015 12:00</untilTime>
<ownerName>admin</ownerName>
</GetScheduledReservations>
Output
<ResponseInfo>
<Reservations>
<Reservation Id="af626b88-458b-4e7a-9054-c03d8cffa260" Name="test reservation" StartTime="2015-01-01T10:00:00" EndTime="2015-01-01T12:00:00" RecurrenceType="None" Owner="admin" Booked="true" Status="Pending" ProvisioningStatus="Ready" ActualEndTime="" CreateDate="2012-06-20T10:40:47" ModificationDate="2012-06-20T10:45:16" DomainName="Global" ReservationLiveStatusName="Pass" ReservationLiveStatusDescription="Reservation" >
<Topologies/>
<permittedUsers/><permittedUser/> name1<permittedUser/>;<permittedUsers/>
</Reservation>
</Reservations>
</ResponseInfo>
CreateDraftCreate a private draft of a blueprint.
Create a private draft of a blueprint.
Syntax
<CreateDraft>
<topology>{topology}</topology>
<draftName>{draftName}</draftName>
</CreateDraft>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topology | Specify the topology id, or name or the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| string | draftName | Optionally specify the name of the draft. Leave empty for an automatically generated name based on original |
Example
<CreateDraft>
<topology>Topologies/Topology1</topology>
<draftName>New Name</draftName>
</CreateDraft>
PromoteDraftOverrwrite the original blueprint with the draft, and delete the draft.
Overrwrite the original blueprint with the draft, and delete the draft.
Syntax
<PromoteDraft>
<draft>{draft}</draft>
</PromoteDraft>
Parameters
| Type | Name | Description |
|---|---|---|
| string | draft | Specify the draft id, or name or the full path from the root to the draft, separated by slashes. For example: FolderName/Topologies/DraftName. |
Example
<PromoteDraft>
<draft>Topologies/draft1</draft>
</PromoteDraft>
DeleteDraftDelete a draft.
Delete a private draft of a blueprint.
Syntax
<DeleteDraft>
<draft>{draft}</draft>
</DeleteDraft>
Parameters
| Type | Name | Description |
|---|---|---|
| string | draft | Specify the draft id, or name or the full path from the root to the draft, separated by slashes. For example: FolderName/Topologies/DraftName. |
Example
<DeleteDraft>
<draft>Topologies/draft1</draft>
</DeleteDraft>
GetServerDateAndTimeRetrieve the server's date and time.
Retrieves the server’s UTC date and time.
Syntax
<GetServerDateAndTime></GetServerDateAndTime>
Parameters
| Type | Name | Description |
|---|
Example
<GetServerDateAndTime></GetServerDateAndTime>Output
<ResponseInfo ServerDateTime="2012-06-21T10:52:43.4464527Z" ServerDateTimeString="06/21/2012 10:52"/>GetTopologyCommandsRetrieve available topology commands in a reservation.
[Deprecated] Retrieves driver commands and parameters for a specified reservation.
Syntax
<GetTopologyCommands>
<reservationId>{reservationId}</reservationId>
</GetTopologyCommands>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<GetTopologyCommands>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetTopologyCommands>
Output
<ResponseInfo>
<Commands>
<Command Name="ExampleCommand">
<Parameters>
<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
</Parameters>
</Command>
<Command Name="Setup">
<Parameters/>
</Command>
</Commands>
</ResponseInfo>
GetEnvironmentCommandsRetrieve available environment commands in a reservation.
Retrieves driver commands and parameters for a specified reservation.
Syntax
<GetEnvironmentCommands>
<reservationId>{reservationId}</reservationId>
</GetEnvironmentCommands>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<GetEnvironmentCommands>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetEnvironmentCommands>
Output
<ResponseInfo>
<Commands>
<Command Name="ExampleCommand">
<Parameters>
<Parameter Name="userParam1" Type="String" Mandatory="false" DefaultValue="Hello"/>
<Parameter Name="userParam2" Type="Numeric" Mandatory="false" DefaultValue="42"/>
</Parameters>
</Command>
<Command Name="Setup">
<Parameters/>
</Command>
</Commands>
</ResponseInfo>
GetTopologyUrlsRetrieve Topology Urls.
Retrieves topology urls to the blueprint for every domain that the blueprint belongs to.
Syntax
<GetTopologyUrls>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
</GetTopologyUrls>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<GetTopologyUrls>
<topologyFullPath>example topology</topologyFullPath>
</GetTopologyUrls>
Output
<ResponseInfo Name="example topology" Alias="example topology">
<TopologyUrls>
<TopologyUrlsInfo DomainName="Global" EncodedHtmlUri="/RM/Diagram/Index/4ef90912-5f07-461a-9db9-3b6ef4fd42ac?diagramType=Topology&domainId=dbaf480c-09f7-46d3-a2e2-e35d3e374a16">
</TopologyUrlsInfo>
</TopologyUrls>
</ResponseInfo>
GetTopologyDetailsRetrieve the topology parameters and attributes.
Retrieves all resources and attributes associated with the specified topology.
Syntax
<GetTopologyDetails>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
</GetTopologyDetails>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<GetTopologyDetails>
<topologyFullPath>Temp Automation Resources/TP1</topologyFullPath>
</GetTopologyDetails>
Output
<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>
GetTopologiesByCategoryRetrieves the full path of all topologies.
Retrives full topology path for each topology that contains given category name (and value if entered).
Syntax
<GetTopologiesByCategory>
<categoryName>{categoryName}</categoryName>
<categoryValue>{categoryValue}</categoryValue>
</GetTopologiesByCategory>
Parameters
| Type | Name | Description |
|---|---|---|
| string | categoryName | Specify the category's name, If category name is not provided will return all topologies in domain. |
| string | categoryValue | Specify the category's value/sub category |
Example
<GetTopologiesByCategory>
<categoryName>lookUpCategory</categoryName>
<categoryValue>bonjour</categoryValue>
</GetTopologiesByCategory>
Output
<ResponseInfo xsi:type="TopologiesByCategoryInfo">
<Topologies>
<FullPath>
dir1/myTopology
</FullPath>
<FullPath>
Root\otherTopology
</FullPath>
</Topologies>
</ResponseInfo>
GetTopologyCategoriesRetrieves all topology categories.
Retrieves all root categories from 'Environment' catalog.
Syntax
<GetTopologyCategories>
</GetTopologyCategories>
Parameters
| Type | Name | Description |
|---|
Example
<GetTopologyCategories>
</GetTopologyCategories>
Output
<ResponseInfo xsi:type="CategoryListInfo">
<Categories>
<Name>
category1
</Name>
<Name>
otherCategory
</Name>
<Name>
lookUpCategory
</Name>
</Categories>
</ResponseInfo>
GetCategoriesRetrieves all the logged in user's root categories and sub categories
Retrieves all the logged in user's root categories and sub categories for Topologies and Services from the 'Environment' catalog.
Syntax
<GetCategories>
<type>{type}</type>
</GetCategories>
Parameters
| Type | Name | Description |
|---|---|---|
| string | type | Specify the categoriy type: Services, Environment or empty for both. |
Example
<GetCategories>
<type></type>
</GetCategories>
Output
<ResponseInfo xsi:type="CategoryListBriefInfo">
<Categories>
<Category Name="root1/bpc1" Description="blueprint category" Type="blueprint"/>
<Category Name="root2/svcc1" Description="service category" Type="service"/>
</Categories>
</ResponseInfo>
GetUserDetailsRetrieve a user's settings.
Retrieves the specified user's configuration settings and associated domains.
Syntax
<GetUserDetails>
<username>{username}</username>
</GetUserDetails>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Specify the name of the user. |
Example
<GetUserDetails>
<username>User1234</username>
</GetUserDetails>
Output
<ResponseInfo Name="User1234" IsAdmin="false" IsActive="true" IsDomainAdmin="false" Email="user1234@work.com">
<Groups>
<Group Name="Everyone">
<TestShellDomains/>
</Group>
</Groups>
</ResponseInfo>
GetAbstractTemplateListRetrieve a list of abstract templates.
Retrieve a list of abstract templates.
Syntax
<GetAbstractTemplateList></GetAbstractTemplateList>
Parameters
| Type | Name | Description |
|---|
Example
<GetAbstractTemplateList></GetAbstractTemplateList>
Output
<?xml version="1.0" encoding="utf-8"?>
<Response CommandName="GetAbstractTemplateList" Success="true" xmlns="http://schemas.qualisystems.com/ResourceManagement/ApiCommandResult.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ErrorCode>0</ErrorCode>
<ResponseInfo xsi:type="AbstractTemplateShortInfoList">
<AbstractTemplates>
<AbstractTemplate ResourceFamilyName="VM Instance" ResourceModelName="VM" Name="abs1" Description="" Owner="admin" DomainName="Global" CreateDate="18/05/2014 06:09:07" Valid="true"/>
<AbstractTemplate ResourceFamilyName="VM Instance" ResourceModelName="VM" Name="abs2" Description="" Owner="admin" DomainName="Global" CreateDate="18/05/2014 06:09:07" Valid="true"/>
</AbstractTemplates>
</ResponseInfo>
</Response>
GetServicesRetrieve a list of services and their attributes.
Retrieve a list of services and their attributes.
Syntax
<GetServices>
<categoryName>{categoryName}</categoryName>
<serviceName>{serviceName}</serviceName>
</GetServices>
Parameters
| Type | Name | Description |
|---|---|---|
| string | categoryName | The name of the category of the services you want to receive. |
| string | serviceName | The name of the service you want to receive. |
Example
<GetServices>
<categoryName>{categoryName}</categoryName>
<serviceName>{serviceName}</serviceName>
</GetServices>
Output
<ResponseInfo>
<Services>
<Service Name="ServiceModel1" Description="">
<Attributes>
<Attribute Name="Alarm State" Type="String" IsRequired="false" DefaultValue="On" PossibleValues="On,Off"> </Attribute>
<Attribute Name="Part Number" Type="String" IsRequired="false" DefaultValue="1" PossibleValues=""> </Attribute>
</Attributes>
</Service>
</Services>
</ResponseInfo>
GetReservationServicesPositionsGet service positions in a reservation.
Retrieves the x/y coordinates for all services in the reservation's diagram.
Syntax
<GetReservationServicesPositions>
<reservationId>{reservationId}</reservationId>
</GetReservationServicesPositions>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<GetReservationServicesPositions>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</GetReservationServicesPositions>
Output
<ResponseInfo>
<layout/>
</ResponseInfo>
IncludeResourceInclude a resource.
Includes a specified resource.
Syntax
<IncludeResource>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</IncludeResource>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<IncludeResource>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
</IncludeResource>
IncludeResourcesIncludes the specified resources.
Includes the specified resources.
Syntax
<IncludeResources>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
</IncludeResources>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<IncludeResources>
<resourcesFullPath>
<string>L1 Switch 1234</string>
</resourcesFullPath>
</IncludeResources>
LockResourceLock a resource.
Locks a specified resource.
Syntax
<LockResource>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</LockResource>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<LockResource>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234/Port 1</resourceFullPath>
</LockResource>
LockResourcesLock multiple resources.
Locks multiple resources.
Syntax
<LockResources>
<reservationId>{reservationId}</reservationId>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
</LockResources>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<LockResources>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourcesFullPath>
<string>GenericResource 1234/Port 1</string>
<string>GenericResource 1234/Port 2</string>
</resourcesFullPath>
</LockResources>
LogoffLogoff from resource manager service.
Logs out the current user.
Syntax
<Logoff>
<token>{token}</token>
</Logoff>
Parameters
| Type | Name | Description |
|---|
Example
<Logoff>
<token>YCrgRMAu/kOntENgVTqNlg==</token>
</Logoff>
LogonLog in to the TestShell service.
Logs in a user. If no user is specified, this method logs in the current user. If no domain is specified, this method logs the user in to the global (default) domain.
Syntax
<Logon>
<username>{username}</username>
<password>{password}</password>
<domainName>{domainName}</domainName>
</Logon>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Username to logon with. |
| string | password | Specify the user’s login password. |
| string | domainName | Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain. |
Example
<Logon>
<username>admin</username>
<password>admin</password>
<domainName>Global</domainName>
</Logon>
Output
<ResponseInfo xsi:type="LogonResponseInfo">
<Domain Name="Global" Description="A domain that includes all available resources" DomainId="dbaf480c-09f7-46d3-a2e2-e35d3e374a16" />
<User Name="admin" IsAdmin="false" IsActive="false" IsDomainAdmin="false" />
<Token Token="Yzhumq0qVkyIwyMkxzk7wQ==" />
</ResponseInfo>
LogoutTNSessionLogout from a console port TN session.
Logs the user out from a console port TN session.
Syntax
<LogoutTNSession>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<consolePortsFullPath>
<string>{string}</string>
</consolePortsFullPath>
<baudRate>{baudRate}</baudRate>
</LogoutTNSession>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<LogoutTNSession>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<consolePortsFullPath>
<string>GenericResource 1234/ConsolePort 21</string>
</consolePortsFullPath>
<baudRate>9600</baudRate>
</LogoutTNSession>
Output
<ResponseInfo Output=""/>MapPortsMap ports on a L1 switch.
Maps a pair of ports on a physical (L1) switch.
Syntax
<MapPorts>
<sourcePort>{sourcePort}</sourcePort>
<destinationPort>{destinationPort}</destinationPort>
<mappingType>{mappingType}</mappingType>
</MapPorts>
Parameters
| Type | Name | Description |
|---|---|---|
| string | sourcePort | Specify the source port. |
| string | destinationPort | Specify the destination port. |
| string | mappingType | Specify bidirectional or unidirectional as the mapping type. |
Example
<MapPorts>
<sourcePort>L1 Switch 1234/Blade 1/Port 1</sourcePort>
<destinationPort>L1 Switch 1234/Blade 1/Port 3</destinationPort>
<mappingType>bi</mappingType>
</MapPorts>
PowerCycleResourceCycle power for resource power ports.
Cycles the power options for resource power ports.
Syntax
<PowerCycleResource>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<powerPortsFullPath>
<string>{string}</string>
</powerPortsFullPath>
<delay>{delay}</delay>
</PowerCycleResource>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources. |
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| list | powerPortsFullPath | Specify the list of power ports to use in this operation. Include the full path from the root resource to each power port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the power operation on all of the specified resource’s power ports. |
| string | delay | Specify the number of seconds to delay between each power cycle. |
Example
<PowerCycleResource>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<powerPortsFullPath>
<string>GenericResource 1234/PowerPort 11</string>
</powerPortsFullPath>
<delay>2</delay>
</PowerCycleResource>
Output
<ResponseInfo Output=""/>PowerOffResourcePower off resource power ports.
Powers off specified power ports.
Syntax
<PowerOffResource>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<powerPortsFullPath>
<string>{string}</string>
</powerPortsFullPath>
</PowerOffResource>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources. |
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| list | powerPortsFullPath | Specify the list of power ports to use in this operation. Include the full path from the root resource to each power port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the power operation on all of the specified resource’s power ports. |
Example
<PowerOffResource>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<powerPortsFullPath>
<string>GenericResource 1234/PowerPort 11</string>
</powerPortsFullPath>
</PowerOffResource>
Output
<ResponseInfo Output=""/>PowerOnResourcePower on resource power ports.
Powers on resource power ports.
Syntax
<PowerOnResource>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<powerPortsFullPath>
<string>{string}</string>
</powerPortsFullPath>
</PowerOnResource>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation’s unique identifier. Admin users may leave this parameter blank to perform power operations on excluded resources. |
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| list | powerPortsFullPath | Specify the list of power ports to use in this operation. Include the full path from the root resource to each power port, separated by slashes. For example: Switch20/Blade5/PowerPort1. Leave blank to perform the power operation on all of the specified resource’s power ports. |
Example
<PowerOnResource>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<powerPortsFullPath>
<string>GenericResource 1234/PowerPort 11</string>
</powerPortsFullPath>
</PowerOnResource>
Output
<ResponseInfo Output=""/>RemoveAttributeRestrictedValuesremove attribute restrictions
remove attribute restrictions from family/model
Syntax
<RemoveAttributeRestrictedValues>
<removeAttributeRestrictionRequests>
<RemoveRestrictionRequest>
<FamilyName>{FamilyName}</FamilyName>
<ModelName>{ModelName}</ModelName>
<Attributes>
<Attribute>
<Name>{Name}</Name>
<RestrictedValue>{RestrictedValue}</RestrictedValue>
</Attribute>
</Attributes>
</RemoveRestrictionRequest>
</removeAttributeRestrictionRequests>
</RemoveAttributeRestrictedValues>
Parameters
| Type | Name | Description |
|---|---|---|
| list | removeAttributeRestrictionRequests | Attribute restrictions to remove". |
Example
<RemoveAttributeRestrictedValues>
<removeAttributeRestrictionRequests>
<RemoveRestrictionRequest>
<FamilyName>Bridge</FamilyName>
<ModelName>Bridge Model</ModelName>
<Attributes>
<Attribute>
<Name>Cluster</Name>
<RestrictedValue>Org-2</RestrictedValue>
<RestrictedValue>Org-2</RestrictedValue>
</Attribute>
</Attributes>
</RemoveRestrictionRequest>
</removeAttributeRestrictionRequests>
</RemoveAttributeRestrictedValues>
Output
<ResponseInfo>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
| Type | Name | Description |
|---|---|---|
| string | reservationId | The id of the reservation. |
| string | serviceName | The name of the service in reservation. |
| string | domainName | The name of the domain new resources will be added to. (leave empty for Global domain) |
| string | resourceDriverName | The driver name that would be set on the new resources that will be created. |
| list | resourceCreationRequests | Requests for creating new resources. |
| list | resourceAttributesToUpdate | Attributes to update on new resources. |
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
<ResponseInfo>
<RootResources>
MyNewResource
</RootResources>
</ResponseInfo>
RecheckConflictsView which resources are available for a reservation.
Updates the list of available resources for a reservation.
Syntax
<RecheckConflicts>
<reservationId>{reservationId}</reservationId>
</RecheckConflicts>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<RecheckConflicts>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</RecheckConflicts>
ReleaseResourcesFromReservationRelease occupied testing resources.
Releases occupied testing resources that would not otherwise be available until the end of the current reservation.
Syntax
<ReleaseResourcesFromReservation>
<reservationId>{reservationId}</reservationId>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
</ReleaseResourcesFromReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | resourcesFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
Example
<ReleaseResourcesFromReservation>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourcesFullPath>
<string>GenericResource 1234</string>
<string>Router 1234</string>
</resourcesFullPath>
</ReleaseResourcesFromReservation>
ReleaseTopologyResourcesRelease resources used in topology.
Releases resources used in topology. A reservation will not end until all used resources are released.
Syntax
<ReleaseTopologyResources>
<reservationId>{reservationId}</reservationId>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
</ReleaseTopologyResources>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<ReleaseTopologyResources>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<topologyFullPath>Temp Automation Resources/TP1</topologyFullPath>
</ReleaseTopologyResources>
RemoveGroupsFromDomainRemove groups from a domain.
Remove groups from a domain.
Syntax
<RemoveGroupsFromDomain>
<domainName>{domainName}</domainName>
<groupNames>
<string>{string}</string>
</groupNames>
</RemoveGroupsFromDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
| list | groupNames | Specify an array of one or more groups. |
Example
<RemoveGroupsFromDomain>
<domainName>Global</domainName>
<groupNames>
<string>QA_Users</string>
</groupNames>
</RemoveGroupsFromDomain>
RemovePermittedUsersFromReservationRemove permitted users from a reservation.
Remove one or more permitted users from the specified reservation.
Syntax
<RemovePermittedUsersFromReservation>
<reservationId>{reservationId}</reservationId>
<usernames>
<string>{string}</string>
</usernames>
</RemovePermittedUsersFromReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | usernames | List of permitted users to remove from the reservation. |
Example
<RemovePermittedUsersFromReservation>
<reservationId>2d2f7cde-20g3-4bac-80d2-e8cfhecef45b</reservationId>
<usernames>
<string>
{name1}
</string>
</usernames>
</RemovePermittedUsersFromReservation>
RemoveResourcesFromDomainRemove resources from a domain.
Remove resources from a domain.
Syntax
<RemoveResourcesFromDomain>
<domainName>{domainName}</domainName>
<resourcesNames>
<string>{string}</string>
</resourcesNames>
</RemoveResourcesFromDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<RemoveResourcesFromDomain>
<domainName>Domain1</domainName>
<resourcesNames>
<string>Router 1234</string>
<string>GenericResource 1234</string>
</resourcesNames>
</RemoveResourcesFromDomain>
RemoveResourcesFromReservationRemove resources from a reservation.
Unlocks and removes resources from a reservation.
Syntax
<RemoveResourcesFromReservation>
<reservationId>{reservationId}</reservationId>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
<deleteDeployedApps>{deleteDeployedApps}</deleteDeployedApps>
</RemoveResourcesFromReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | resourcesFullPath | Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName |
| boolean | deleteDeployedApps | Specify false to block deletion of deployed apps when removing them from reservation - only applies to resources of that are deployed apps, when applied to other resources argument is ignored. Parameter is optional and can be left empty |
Example
<RemoveResourcesFromReservation>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourcesFullPath>
<string>Router 1234</string>
<string>GenericResource 1234</string>
</resourcesFullPath>
<deleteDeployedApps>true</deleteDeployedApps>
</RemoveResourcesFromReservation>
Output
<ResponseInfo>
<Conflicts/>
</ResponseInfo>
RemoveConnectorsFromReservationRemove connectors from a reservation.
Removes the mapped connector between given end points.
Syntax
<RemoveConnectorsFromReservation>
<reservationId>{reservationId}</reservationId>
<endpoints>
<string>{string}</string>
</endpoints>
</RemoveConnectorsFromReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | endpoints | The list of removed endpoints. |
Example
<RemoveConnectorsFromReservation>
<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>
</RemoveConnectorsFromReservation>
Output
<ResponseInfo>
<Connectors>
<Connector Alias="a connector" Type="Default" ResourceMappingType="bi" Source="Router 1234/Port 1" Target="GenericResource 1234/Port 1">
</Connector>
<Connector Alias="uni connector" Type="Default" ResourceMappingType="uni" Source="Router 1234/Port 1" Target="GenericResource 1234/Port 2">
</Connector>
</Connectors>
</ResponseInfo>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
RemoveTopologiesFromDomainRemoves a list of one or more topologies from a domain.
Removes a list of one or more topologies from a domain.
Syntax
<RemoveTopologiesFromDomain>
<domainName>{domainName}</domainName>
<topologyNames>
<string>{string}</string>
</topologyNames>
</RemoveTopologiesFromDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<RemoveTopologiesFromDomain>
<domainName>Domain1</domainName>
<topologyNames>
<string>Topology1</string>
</topologyNames>
</RemoveTopologiesFromDomain>
RemoveUsersFromGroupRemove users from a group.
Removes a list of one or more users from the specified group.
Syntax
<RemoveUsersFromGroup>
<usernames>
<string>{string}</string>
</usernames>
<groupName>{groupName}</groupName>
</RemoveUsersFromGroup>
Parameters
| Type | Name | Description |
|---|---|---|
| list | usernames | Specify an array of one or more users. |
| string | groupName | Specify the name of the group. |
Example
<RemoveUsersFromGroup>
<usernames>
<string>User1234</string>
<string>User2345</string>
</usernames>
<groupName>QA_Users</groupName>
</RemoveUsersFromGroup>
RemoveTopologyCategoryRemoves a category from given topology.
Removes a category from given topology.
Syntax
<RemoveTopologyCategory>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
<categoryName>{categoryName}</categoryName>
</RemoveTopologyCategory>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyFullPath | Specify the topology (name or full path), from which to remove the category. For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| string | categoryName | Specify the category's name which we want to remove. |
Example
<RemoveTopologyCategory>
<topologyFullPath>myDir/myTopology</topologyFullPath>
<categoryName>lookUpCategory</categoryName>
</RemoveTopologyCategory>
MoveResourcesMove multiple resources.
Allows to change the folder that the specified root resources belong to.
Syntax
<MoveResources>
<resourcesName>
<string>{string}</string>
</resourcesName>
<targetFolder>{targetFolder}</targetFolder>
</MoveResources>
Parameters
| Type | Name | Description |
|---|---|---|
| list | resourcesName | Specify the name of the root resources to move to the new target folder. |
| string | targetFolder | The path of the target folder. |
Example
<MoveResources>
<resourcesName>
<string>Bridge1</string>
<string>Bridge2</string>
</resourcesName>
<targetFolder>MyBridges</targetFolder>
</MoveResources>
Output
<ResponseInfo/>
RenameResourceRename a resource.
Renames the specified resource.
Syntax
<RenameResource>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<resourceName>{resourceName}</resourceName>
</RenameResource>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | resourceName | Specify a new resource name. |
Example
<RenameResource>
<resourceFullPath>Router 1234</resourceFullPath>
<resourceName>Router 4321</resourceName>
</RenameResource>
ResetResourceDriverReset a resource driver and cancel its commands.
Cancel the currently executing command, remove all pending command executions and reset the driver to its initial state.
Syntax
<ResetResourceDriver>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</ResetResourceDriver>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<ResetResourceDriver>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourceFullPath>Router 1234</resourceFullPath>
</ResetResourceDriver>
Output
<ResponseInfo Output="Reset completed"/>RemoveAppFromReservationRemove app resource from existing reservation.
Remove a deployed App resource from existing reservation.
Syntax
<RemoveAppFromReservation>
<reservationId>{reservationId}</reservationId>
<appName>{appName}</appName>
</RemoveAppFromReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | appName | Specify the name of the App. |
Example
<RemoveAppFromReservation>
<reservationId>077e6b4f-5e70-46b5-aa4b-43e6f039acc3</reservationId>
<appName>App in reservation</appName>
</RemoveAppFromReservation>
Output
<ResponseInfo/>
GetAppsDetailsInReservationRetrieves information on Apps in the reservation.
Retrieves information on Apps in the reservation.
Syntax
<GetAppsDetailsInReservation>
<reservationId>{reservationId}</reservationId>
<appNames>
<string>{string}</string>
</appNames>
</GetAppsDetailsInReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | appNames | Specify the name of the Apps. |
Example
<GetAppsDetailsInReservation>
<reservationId>077e6b4f-5e70-46b5-aa4b-43e6f039acc3</reservationId>
<appNames>
<string>{string}</string>
</appNames>
</GetAppsDetailsInReservation>
Output
<ResponseInfo/>
RemoveServicesFromReservationRemove services and apps from existing reservation.
Remove services and apps from existing reservation.
Syntax
<RemoveServicesFromReservation>
<reservationId>{reservationId}</reservationId>
<services>
<string>{string}</string>
</services>
</RemoveServicesFromReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | services | List of aliases. This list should contain the aliases for both the services and apps that should be removed. |
Example
<RemoveServicesFromReservation>
<reservationId>{reservationId}</reservationId>
<services>
<string>{string}</string>
</services>
</RemoveServicesFromReservation>
Output
<ResponseInfo/>
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
| Type | Name | Description |
|---|---|---|
| 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
<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>
SecureLogonLog in to the TestShell service using the AuthToken.
Logs in a user with a token. If no domain is specified, this method logs the user in to the global (default) domain.
Syntax
<SecureLogon>
<token>{token}</token>
<domainName>{domainName}</domainName>
</SecureLogon>
Parameters
| Type | Name | Description |
|---|---|---|
| string | token | Token to logon with. |
| string | domainName | Specify the name of the domain. If no domain is specified, it logs the user in to the global (default) domain. |
Example
<SecureLogon>
<token>xoV3libZzEG/ii7ZQqAuqw==</token>
<domainName>Global</domainName>
</SecureLogon>
Output
<ResponseInfo xsi:type="LogonResponseInfo">
<Domain Name="Global" Description="A domain that includes all available resources" DomainId="dbaf480c-09f7-46d3-a2e2-e35d3e374a16" />
<User Name="admin" IsAdmin="false" IsActive="false" IsDomainAdmin="false" />
<Token Token="Yzhumq0qVkyIwyMkxzk7wQ==" />
</ResponseInfo>
SetAttributeValueSet an attribute value.
Sets the value of the specified attribute.
Syntax
<SetAttributeValue>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<attributeName>{attributeName}</attributeName>
<attributeValue>{attributeValue}</attributeValue>
</SetAttributeValue>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | attributeName | Specify the attribute name. |
| string | attributeValue | Specify the attribute’s value. |
Example
<SetAttributeValue>
<resourceFullPath>Router 1234</resourceFullPath>
<attributeName>SW_Version</attributeName>
<attributeValue>1.3</attributeValue>
</SetAttributeValue>
AddValueToLookupAttributeAdds a value to an existing lookup attribute.
Adds a value to an existing lookup attribute.
Syntax
<AddValueToLookupAttribute>
<attributeName>{attributeName}</attributeName>
<newValue>{newValue}</newValue>
<makeDefault>{makeDefault}</makeDefault>
</AddValueToLookupAttribute>
Parameters
| Type | Name | Description |
|---|---|---|
| string | attributeName | Specify the attribute's name. |
| string | newValue | Specify the value to add to the attribute. |
| string | makeDefault | Set the new value as the attribute's default value. |
Example
<AddValueToLookupAttribute>
<attributeName>SW_Version</attributeName>
<newValue>1.3</newValue>
<makeDefault>True</makeDefault>
</AddValueToLookupAttribute>
RemoveValueFromLookupAttributeRemoves an existing value from a given lookup attribute.
Removes an existing value from a given lookup attribute.
Syntax
<RemoveValueFromLookupAttribute>
<attributeName>{attributeName}</attributeName>
<removeValue>{removeValue}</removeValue>
<defaultValue>{defaultValue}</defaultValue>
</RemoveValueFromLookupAttribute>
Parameters
| Type | Name | Description |
|---|---|---|
| string | attributeName | Specify the lookup attribute name. |
| string | removeValue | Specify the attribute value to remove from the attribute. |
| string | defaultValue | Specify the new default value for this attribute (required if removing the attribute's current default value). |
Example
<RemoveValueFromLookupAttribute>
<attributeName>SW_Version</attributeName>
<removeValue>1.3</removeValue>
<defaultValue>1.2</defaultValue>
</RemoveValueFromLookupAttribute>
GetValuesForLookupAttributeRetrieve the values for a lookup attribute.
Retrieve the list of existing values for a lookup attribute.
Syntax
<GetValuesForLookupAttribute>
<attributeName>{attributeName}</attributeName>
</GetValuesForLookupAttribute>
Parameters
| Type | Name | Description |
|---|---|---|
| string | attributeName | Specify the lookup attribute name. |
Example
<GetValuesForLookupAttribute>
<attributeName>My Lookup Attribute</attributeName>
</GetValuesForLookupAttribute>
SetAttributesValuesSets new attribute values for the specified resources.
Sets new attribute values for the specified resources.
Syntax
<SetAttributesValues>
<resourcesAttributesUpdateRequests>
<ResourceAttributesUpdateRequest>
<ResourceFullName>{ResourceFullName}</ResourceFullName>
<AttributeNamesValues>
<AttributeNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</AttributeNameValue>
</AttributeNamesValues>
</ResourceAttributesUpdateRequest>
</resourcesAttributesUpdateRequests>
</SetAttributesValues>
Parameters
| Type | Name | Description |
|---|---|---|
| list | resourcesAttributesUpdateRequests | Specify a list of resources, attribute names, and new attribute values (up to 10000 rows). |
Example
<SetAttributesValues>
<resourcesAttributesUpdateRequests>
<ResourceAttributesUpdateRequest>
<ResourceFullName>L1 Switch 1234</ResourceFullName>
<AttributeNamesValues>
<AttributeNameValue>
<Name>Protocol</Name>
<Value>Ethernet</Value>
</AttributeNameValue>
</AttributeNamesValues>
</ResourceAttributesUpdateRequest>
</resourcesAttributesUpdateRequests>
</SetAttributesValues>
SetSandboxDataSet the sandbox data
Sets the SandboxData. Provide a key:value input. If the key exists it will override the value, if the key doesn't exist a new key will be created. The value is a string.
Syntax
<SetSandboxData>
<reservationId>{reservationId}</reservationId>
<sandboxDataKeyValues>
<SandboxDataKeyValue>
<Key>{Key}</Key>
<Value>{Value}</Value>
</SandboxDataKeyValue>
</sandboxDataKeyValues>
</SetSandboxData>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | sandboxDataKeyValues | sandboxDataKeyValues |
Example
<SetSandboxData>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<sandboxDataKeyValues>
<SandboxDataKeyValue>
<Key>ExampleKey</Key>
<Value>ExampleValue</Value>
</SandboxDataKeyValue>
</sandboxDataKeyValues>
</SetSandboxData>
GetSandboxDataGet the sandbox data
Get the SandboxData content. Returns the whole list in a key:value format.
Syntax
<GetSandboxData>
<reservationId>{reservationId}</reservationId>
</GetSandboxData>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<GetSandboxData>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
</GetSandboxData>
ClearSandboxDataClear the sandbox data
Clears the SandboxData content. Clears the whole list.
Syntax
<ClearSandboxData>
<reservationId>{reservationId}</reservationId>
</ClearSandboxData>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<ClearSandboxData>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
</ClearSandboxData>
SetBaudRateSet console port baud rate.
Sets the baud rate for one or more console ports.
Syntax
<SetBaudRate>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<consolePortsFullPath>
<string>{string}</string>
</consolePortsFullPath>
<baudRate>{baudRate}</baudRate>
</SetBaudRate>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<SetBaudRate>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<consolePortsFullPath>
<string>GenericResource 1234/ConsolePort 21</string>
</consolePortsFullPath>
<baudRate>9600</baudRate>
</SetBaudRate>
Output
<ResponseInfo Output=""/>SetConsoleForXModemSet a console for Xmodem.
Sets one or more consoles for Xmodem.
Syntax
<SetConsoleForXModem>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<consolePortsFullPath>
<string>{string}</string>
</consolePortsFullPath>
<baudRate>{baudRate}</baudRate>
</SetConsoleForXModem>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<SetConsoleForXModem>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234</resourceFullPath>
<consolePortsFullPath>
<string>GenericResource 1234/ConsolePort 21</string>
</consolePortsFullPath>
<baudRate>9600</baudRate>
</SetConsoleForXModem>
Output
<ResponseInfo Output=""/>SetResourceLiveStatusSets the live status of a resource.
Sets the live status of the resource
Syntax
<SetResourceLiveStatus>
<resourceFullName>{resourceFullName}</resourceFullName>
<liveStatusName>{liveStatusName}</liveStatusName>
<additionalInfo>{additionalInfo}</additionalInfo>
</SetResourceLiveStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullName | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA. |
| string | liveStatusName | Resource live status name |
| string | additionalInfo | Resource live status additional info |
Example
<SetResourceLiveStatus>
<resourceFullName>myResourceName</resourceFullName>
<liveStatusName>Online</liveStatusName>
<additionalInfo>Resource was responding to pings at 12/12/2013 10:35 AM</additionalInfo>
</SetResourceLiveStatus>
SetReservationLiveStatusSets the live status of the reservation.
Sets the live status of the reservation
Syntax
<SetReservationLiveStatus>
<reservationId>{reservationId}</reservationId>
<liveStatusName>{liveStatusName}</liveStatusName>
<additionalInfo>{additionalInfo}</additionalInfo>
</SetReservationLiveStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specifies the string that represents the reservation’s unique identifier. |
| string | liveStatusName | Reservation live status name |
| string | additionalInfo | Reservation live status additional info |
Example
<SetReservationLiveStatus>
<reservationId>344c2d21-578c-4653-a826-54c2035ff998</reservationId>
<liveStatusName>Pass</liveStatusName>
<additionalInfo>Resource was responding to pings at 12/12/2013 10:35 AM</additionalInfo>
</SetReservationLiveStatus>
SetResourceSharedStateSet the resource sharing state.
Sets the resource sharing state.
Syntax
<SetResourceSharedState>
<reservationId>{reservationId}</reservationId>
<resourcesFullName>
<string>{string}</string>
</resourcesFullName>
<isShared>{isShared}</isShared>
</SetResourceSharedState>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | resourcesFullName | Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName |
| boolean | isShared | Specify whether to allow sharing of the resource. |
Example
<SetResourceSharedState>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourcesFullName>
<string>Router 1234</string>
</resourcesFullName>
<isShared>1</isShared>
</SetResourceSharedState>
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
| Type | Name | Description |
|---|---|---|
| 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>
SetRouteAttributesViaAliasSet a route's attributes.
Sets attributes and associated values for a route specified via its alias.
Syntax
<SetRouteAttributesViaAlias>
<reservationId>{reservationId}</reservationId>
<routeAlias>{routeAlias}</routeAlias>
<applyChangesTo>{applyChangesTo}</applyChangesTo>
<attributeRequests>
<string>{string}</string>
</attributeRequests>
</SetRouteAttributesViaAlias>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | routeAlias | Specify the route’s alias. |
| string | applyChangesTo | Specify on which resources to apply the attribute changes: Source/Target/All.Source refers to the resource connected to the source endpoint of the route. Target refers to the resource connected to the target endpoint of the route. All encompasses all route resources. Use 0 for Source, 1 for Target and 2 for All. |
| list | attributeRequests | Specify an array of attributes and associated attribute values. |
Example
<SetRouteAttributesViaAlias>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<routeAlias>route1</routeAlias>
<applyChangesTo>2</applyChangesTo>
<attributeRequests>
<string>SW_Version</string>
<string>1.3</string>
</attributeRequests>
</SetRouteAttributesViaAlias>
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
| Type | Name | Description |
|---|---|---|
| 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>
SetConnectorAttributesViaAliasSet a connector's attributes.
Sets attributes and associated values for a connector specified via its alias.
Syntax
<SetConnectorAttributesViaAlias>
<reservationId>{reservationId}</reservationId>
<connectorAlias>{connectorAlias}</connectorAlias>
<attributeRequests>
<AttributeNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</AttributeNameValue>
</attributeRequests>
</SetConnectorAttributesViaAlias>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | connectorAlias | Specify the connector’s alias. |
| list | attributeRequests | Specify a matrix of attributes and associated attribute values. |
Example
<SetConnectorAttributesViaAlias>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<connectorAlias>connector1</connectorAlias>
<attributeRequests>
<AttributeNameValue>
<Name>Part Number</Name>
<Value>123</Value>
</AttributeNameValue>
</attributeRequests>
</SetConnectorAttributesViaAlias>
SetGroupDomainPermissionsSet the permission level of a group in domain.
Set the permission level of a group in domain.
Syntax
<SetGroupDomainPermissions>
<domainName>{domainName}</domainName>
<groupName>{groupName}</groupName>
<viewOnly>{viewOnly}</viewOnly>
</SetGroupDomainPermissions>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
| string | groupName | Specify the group name. |
| boolean | viewOnly | Specify if the group should be have view only permissions. |
Example
<SetGroupDomainPermissions>
<domainName>Global</domainName>
<groupName>QA_Users</groupName>
<viewOnly>true</viewOnly>
</SetGroupDomainPermissions>
SetConnectorsInReservationReserve specified connectors.
Adds connectors between source and target or update existing ones.
Syntax
<SetConnectorsInReservation>
<reservationId>{reservationId}</reservationId>
<connectors>
<SetConnectorRequest>
<SourceResourceFullName>{SourceResourceFullName}</SourceResourceFullName>
<TargetResourceFullName>{TargetResourceFullName}</TargetResourceFullName>
<Direction>{Direction}</Direction>
<Alias>{Alias}</Alias>
</SetConnectorRequest>
</connectors>
</SetConnectorsInReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | connectors | List of connectors to set in the reservation. |
Example
<SetConnectorsInReservation>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<connectors>
<SetConnectorRequest>
<SourceResourceFullName>bridge1/port1</SourceResourceFullName>
<TargetResourceFullName>bridge2/port1</TargetResourceFullName>
<Direction>bi</Direction>
<Alias>some alias</Alias>
</SetConnectorRequest>
</connectors>
</SetConnectorsInReservation>
Output
<ResponseInfo>
<Connectors>
<Connector Alias="some alias" Type="Default" ResourceMappingType="bi" Source="bridge1/port1" Target="bridge2/port1"></Connector>
</Connectors>
</ResponseInfo>
SetTopologyCategorySets a category to a topology.
Set a category to given topology
Syntax
<SetTopologyCategory>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
<categoryName>{categoryName}</categoryName>
<categoryValue>{categoryValue}</categoryValue>
</SetTopologyCategory>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyFullPath | Specify the topology (name or full path), to associate the category to. For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| string | categoryName | Specify the category's name which we want to set |
| string | categoryValue | Specify the category's value |
Example
<SetTopologyCategory>
<topologyFullPath>dir1/myTopology</topologyFullPath>
<categoryName>lookUpCategory</categoryName>
<categoryValue>bonjour</categoryValue>
</SetTopologyCategory>
SyncResourceFromDeviceUpdate a resource with current device settings and mappings.
Synchronizes the specified resource with current device settings and mappings.
Syntax
<SyncResourceFromDevice>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</SyncResourceFromDevice>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<SyncResourceFromDevice>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
</SyncResourceFromDevice>
SyncResourceToDeviceUpdate device settings and mappings from the resource.
Updates device settings and mappings from the specified resource.
Syntax
<SyncResourceToDevice>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</SyncResourceToDevice>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<SyncResourceToDevice>
<resourceFullPath>L1 Switch 1234</resourceFullPath>
</SyncResourceToDevice>
SetReservationResourcePositionSet resource position in a reservation.
Sets the location of a specified resource in the reservation diagram.
Syntax
<SetReservationResourcePosition>
<reservationId>{reservationId}</reservationId>
<resourceFullName>{resourceFullName}</resourceFullName>
<x>{x}</x>
<y>{y}</y>
</SetReservationResourcePosition>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | resourceFullName | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName. |
| string | x | Specify the x coordinate of the resource's top left corner. |
| string | y | Specify the y coordinate of the resource's top left corner. |
Example
<SetReservationResourcePosition>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourceFullName>bridge</resourceFullName>
<x>100</x>
<y>100</y>
</SetReservationResourcePosition>
Output
<ResponseInfo>
</ResponseInfo>
SetServiceDriverSets a service model driver.
Sets the driver for a specified service model, if empty, removes its driver.
Syntax
<SetServiceDriver>
<serviceName>{serviceName}</serviceName>
<driverName>{driverName}</driverName>
</SetServiceDriver>
Parameters
| Type | Name | Description |
|---|---|---|
| string | serviceName | Specify the name of the service model. |
| string | driverName | Specify the name of the driver. |
Example
<SetServiceDriver>
<serviceName>Example_service_model</serviceName>
<driverName>NewDriver</driverName>
</SetServiceDriver>
SetServiceLiveStatusSets the live status of a service.
Sets the live status of a service
Syntax
<SetServiceLiveStatus>
<reservationId>{reservationId}</reservationId>
<serviceAlias>{serviceAlias}</serviceAlias>
<liveStatusName>{liveStatusName}</liveStatusName>
<additionalInfo>{additionalInfo}</additionalInfo>
</SetServiceLiveStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation's unique identifier. |
| string | serviceAlias | Specify the string that represents the service's alias. |
| string | liveStatusName | Resource live status name |
| string | additionalInfo | Resource live status additional info |
Example
<SetServiceLiveStatus>
<reservationId>reservationId</reservationId>
<serviceAlias>serviceAlias</serviceAlias>
<liveStatusName>Online</liveStatusName>
<additionalInfo>Resource was responding to pings at 12/12/2013 10:35 AM</additionalInfo>
</SetServiceLiveStatus>
Output
<ResponseInfo/>
</Response>
SetServiceNameEdit Service alias name
Edit Service alias name
Syntax
<SetServiceName>
<reservationId>{reservationId}</reservationId>
<serviceName>{serviceName}</serviceName>
<newServiceName>{newServiceName}</newServiceName>
</SetServiceName>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation's unique identifier. |
| string | serviceName | Specify the string that represents the service's name. |
| string | newServiceName | Specify the string that represents the new service's name. |
Example
<SetServiceName>
<reservationId>reservationId</reservationId>
<serviceName>serviceName</serviceName>
<newServiceName>newServiceName</newServiceName>
</SetServiceName>
Output
<ResponseInfo/>
</Response>
SetReservationServicePositionSet service position in a reservation.
Sets the location of a specified service in the reservation diagram.
Syntax
<SetReservationServicePosition>
<reservationId>{reservationId}</reservationId>
<serviceAlias>{serviceAlias}</serviceAlias>
<x>{x}</x>
<y>{y}</y>
</SetReservationServicePosition>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | serviceAlias | Specify the alias of the service. |
| string | x | Specify the x coordinate of the resource's top left corner. |
| string | y | Specify the y coordinate of the resource's top left corner. |
Example
<SetReservationServicePosition>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<serviceAlias>bridge</serviceAlias>
<x>100</x>
<y>100</y>
</SetReservationServicePosition>
SetServiceAttributesValuesSet a resource's attributes.
Sets attributes and associated values for a specified resource.
Syntax
<SetServiceAttributesValues>
<reservationId>{reservationId}</reservationId>
<serviceAlias>{serviceAlias}</serviceAlias>
<attributeRequests>
<AttributeNameValue>
<Name>{Name}</Name>
<Value>{Value}</Value>
</AttributeNameValue>
</attributeRequests>
</SetServiceAttributesValues>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | serviceAlias | Specify the service name. |
| list | attributeRequests | Specify a matrix of attributes and associated attribute values. |
Example
<SetServiceAttributesValues>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<serviceAlias>service1</serviceAlias>
<attributeRequests>
<AttributeNameValue>
<Name>Part Number</Name>
<Value>123</Value>
</AttributeNameValue>
</attributeRequests>
</SetServiceAttributesValues>
TerminateReservationTerminate a reservation.
Terminates the specified reservation if the reservation is in a state of teardown.
Syntax
<TerminateReservation>
<reservationId>{reservationId}</reservationId>
</TerminateReservation>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<TerminateReservation>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</TerminateReservation>
UnlockResourceUnlock a resource.
Unlocks the specified resource.
Syntax
<UnlockResource>
<reservationId>{reservationId}</reservationId>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
</UnlockResource>
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
Example
<UnlockResource>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourceFullPath>GenericResource 1234/Port 1</resourceFullPath>
</UnlockResource>
UnlockResourcesUnlock multiple resources.
Unlocks multiple resources.
Syntax
<UnlockResources>
<reservationId>{reservationId}</reservationId>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
</UnlockResources>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
Example
<UnlockResources>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<resourcesFullPath>
<string>GenericResource 1234/Port 1</string>
<string>GenericResource 1234/Port 2</string>
</resourcesFullPath>
</UnlockResources>
UnMapPortsRemove mapping for a pair of mapped ports.
Removes existing mapping between a pair of physical (L1) switch ports.
Syntax
<UnMapPorts>
<portA>{portA}</portA>
<portB>{portB}</portB>
</UnMapPorts>
Parameters
| Type | Name | Description |
|---|---|---|
| string | portA | Specify the source port. (i.e. Folder1/Chassis1/Blade1/Port1). |
| string | portB | Specify the destination port. (i.e. Folder1/Chassis1/Blade1/Port1). |
Example
<UnMapPorts>
<portA>L1 Switch 1234/Blade 1/Port 1</portA>
<portB>L1 Switch 1234/Blade 1/Port 3</portB>
</UnMapPorts>
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
| Type | Name | Description |
|---|---|---|
| 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>
UpdateConnectionWeightUpdate the connection weight between two resources.
Sets a weight score on a physical connection between two resources. Weights are used to optimize route resolution in physical switch scenarios.
Syntax
<UpdateConnectionWeight>
<resourceAFullPath>{resourceAFullPath}</resourceAFullPath>
<resourceBFullPath>{resourceBFullPath}</resourceBFullPath>
<weight>{weight}</weight>
</UpdateConnectionWeight>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceAFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | resourceBFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| number | weight | Specify a number to represent the connection weight between the specified resources. |
Example
<UpdateConnectionWeight>
<resourceAFullPath>Router 1234/Port 1</resourceAFullPath>
<resourceBFullPath>L1 Switch 1234/Blade 1/Port 3</resourceBFullPath>
<weight>5</weight>
</UpdateConnectionWeight>
UpdateDomainTopologiesFolderUpdate the domain’s topologies folder.
Update the domain’s topologies folder.
Syntax
<UpdateDomainTopologiesFolder>
<domainName>{domainName}</domainName>
<topologiesFolder>{topologiesFolder}</topologiesFolder>
</UpdateDomainTopologiesFolder>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
| string | topologiesFolder | Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
Example
<UpdateDomainTopologiesFolder>
<domainName>Domain1</domainName>
<topologiesFolder>Domain Topologies</topologiesFolder>
</UpdateDomainTopologiesFolder>
UnarchiveDomainUn archive the domain
Unarchive a domain. New reservation can be created.
Syntax
<UnarchiveDomain>
<domainName>{domainName}</domainName>
</UnarchiveDomain>
Parameters
| Type | Name | Description |
|---|---|---|
| string | domainName | Specify the name of the domain. |
Example
<UnarchiveDomain>
<domainName>Domain1</domainName>
</UnarchiveDomain>
UpdateGroup
Modifies the group name and description.
Syntax
<UpdateGroup>
<groupName>{groupName}</groupName>
<newName>{newName}</newName>
<description>{description}</description>
<groupRole>{groupRole}</groupRole>
</UpdateGroup>
Parameters
| Type | Name | Description |
|---|---|---|
| string | groupName | Specify the name of the group. |
| string | newName | Specify the new group name. |
| string | description | Provide a short description of the group. |
| string | groupRole | Specify the role of the group, possible values: External, Regular, DomainAdmin or Ignore (to keep the current role). |
Example
<UpdateGroup>
<groupName>QA_Users</groupName>
<newName>QAUsers</newName>
<description>QA users group</description>
<groupRole>Regular</groupRole>
</UpdateGroup>
UpdatePhysicalConnectionDefine the physical connection between two resources.
Define a physical connection (cable link) between two resources.
Syntax
<UpdatePhysicalConnection>
<resourceAFullPath>{resourceAFullPath}</resourceAFullPath>
<resourceBFullPath>{resourceBFullPath}</resourceBFullPath>
<overrideExistingConnections>{overrideExistingConnections}</overrideExistingConnections>
</UpdatePhysicalConnection>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceAFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | resourceBFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. You may leave this parameter blank if you wish to disconnect the existing source resource connection. |
| boolean | overrideExistingConnections | Overriding existing connections will automatically remove existing physical connection if they conflict with the requested new connections. If set to 'No', an error message will be displayed if any port is already connected and the operation will be cancelled. |
Example
<UpdatePhysicalConnection>
<resourceAFullPath>Router 1234/Port 1</resourceAFullPath>
<resourceBFullPath>L1 Switch 1234/Blade 1/Port 3</resourceBFullPath>
<overrideExistingConnections>1</overrideExistingConnections>
</UpdatePhysicalConnection>
UpdatePhysicalConnectionsDefine physical connections between resources.
Define physical connections (cable links) between resources.
Syntax
<UpdatePhysicalConnections>
<physicalConnectionUpdateRequest>
<PhysicalConnectionUpdateRequest>
<ResourceAFullName>{ResourceAFullName}</ResourceAFullName>
<ResourceBFullName>{ResourceBFullName}</ResourceBFullName>
<ConnectionWeight>{ConnectionWeight}</ConnectionWeight>
</PhysicalConnectionUpdateRequest>
</physicalConnectionUpdateRequest>
<overrideExistingConnections>{overrideExistingConnections}</overrideExistingConnections>
</UpdatePhysicalConnections>
Parameters
| Type | Name | Description |
|---|---|---|
| list | physicalConnectionUpdateRequest | Specify a list of physical connections to update. |
| boolean | overrideExistingConnections | Overriding existing connections will automatically remove existing physical connection if they conflict with the requested new connections. If set to 'No', an error message will be displayed if any port is already connected and the operation will be cancelled. |
Example
<UpdatePhysicalConnections>
<physicalConnectionUpdateRequest>
<PhysicalConnectionUpdateRequest>
<ResourceAFullName>ResourceA</ResourceAFullName>
<ResourceBFullName>ResourceB</ResourceBFullName>
<ConnectionWeight>ConnectionWeight</ConnectionWeight>
</PhysicalConnectionUpdateRequest>
</physicalConnectionUpdateRequest>
<overrideExistingConnections>1</overrideExistingConnections>
</UpdatePhysicalConnections>
RemapConnectionsRemap connections between resources.
Remap connections between resources.
Syntax
<RemapConnections>
<reservationId>{reservationId}</reservationId>
<resourcesFullPath>
<string>{string}</string>
</resourcesFullPath>
<printOutput>{printOutput}</printOutput>
</RemapConnections>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | resourcesFullPath | Specify a list of resource names. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/ResourceName |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<RemapConnections>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<resourcesFullPath>
<string>Router 1234</string>
<string>GenericResource 1234</string>
</resourcesFullPath>
<printOutput>{printOutput}</printOutput>
</RemapConnections>
Output
<ResponseInfo>
</ResponseInfo>
UpdateReservationDescriptionChange a reservation description.
Modifies the description for a specified reservation.
Syntax
<UpdateReservationDescription>
<reservationId>{reservationId}</reservationId>
<description>{description}</description>
</UpdateReservationDescription>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation ID. |
| string | description | Provide an updated description of the reservation. This text will replace the current description. |
Example
<UpdateReservationDescription>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<description>New Description</description>
</UpdateReservationDescription>
UpdateReservationNameChange a reservation name.
Modifies the name for a specified reservation.
Syntax
<UpdateReservationName>
<reservationId>{reservationId}</reservationId>
<name>{name}</name>
</UpdateReservationName>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation ID. |
| string | name | Provide an updated name of the reservation. This text will replace the current name. |
Example
<UpdateReservationName>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<name>New Name</name>
</UpdateReservationName>
UpdateReservationGlobalInputsUpdates the unlinked global inputs in a specified reservation.
Updates the unlinked global inputs in a specified reservation.
Syntax
<UpdateReservationGlobalInputs>
<reservationId>{reservationId}</reservationId>
<globalInputs>
<UpdateTopologyGlobalInputsRequest>
<ParamName>{ParamName}</ParamName>
<Value>{Value}</Value>
</UpdateTopologyGlobalInputsRequest>
</globalInputs>
</UpdateReservationGlobalInputs>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation ID. |
| list | globalInputs | Global inputs associated with the specified reservation. |
Example
<UpdateReservationGlobalInputs>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<globalInputs>
<UpdateTopologyGlobalInputsRequest>
<ParamName>attribute</ParamName>
<Value>new value</Value>
</UpdateTopologyGlobalInputsRequest>
</globalInputs>
</UpdateReservationGlobalInputs>
ChangeReservationOwnerUpdates the owner in a specified reservation.
Updates the owner in a specified reservation.
Syntax
<ChangeReservationOwner>
<reservationId>{reservationId}</reservationId>
<ownerName>{ownerName}</ownerName>
</ChangeReservationOwner>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the reservation ID. |
| string | ownerName | New owner for the reservation. |
Example
<ChangeReservationOwner>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>\
<ownerName>admin</ownerName>
</ChangeReservationOwner>
UpdateResourceAddressUpdate a resource address.
Modifies the address for a specified resource.
Syntax
<UpdateResourceAddress>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<resourceAddress>{resourceAddress}</resourceAddress>
</UpdateResourceAddress>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | resourceAddress | Specify the resource’s new address. |
Example
<UpdateResourceAddress>
<resourceFullPath>Router 1234</resourceFullPath>
<resourceAddress>192.168.1.201</resourceAddress>
</UpdateResourceAddress>
UpdateResourceDescriptionChange a resource description.
Modifies the description for a specified resource.
Syntax
<UpdateResourceDescription>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<resourceDescription>{resourceDescription}</resourceDescription>
</UpdateResourceDescription>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | resourceDescription | Provide an updated description of the resource. This text will replace the current description. |
Example
<UpdateResourceDescription>
<resourceFullPath>Router 1234</resourceFullPath>
<resourceDescription>a new description for the resource</resourceDescription>
</UpdateResourceDescription>
UpdateResourceDriverUpdate a resource driver.
Updates the driver for a specified resource.
Syntax
<UpdateResourceDriver>
<resourceFullPath>{resourceFullPath}</resourceFullPath>
<driverName>{driverName}</driverName>
</UpdateResourceDriver>
Parameters
| Type | Name | Description |
|---|---|---|
| string | resourceFullPath | Specify the resource name. You can also include the full path from the root to the resource before the resource name, separated by slashes. For example: FolderName/RouterA/Port1. |
| string | driverName | Specify the name of the driver. |
Example
<UpdateResourceDriver>
<resourceFullPath>Router 1234</resourceFullPath>
<driverName>NewDriver</driverName>
</UpdateResourceDriver>
UpdateTopologyOwnerUpdate the topology owner.
Update the topology owner.
Syntax
<UpdateTopologyOwner>
<topologyName>{topologyName}</topologyName>
<ownerName>{ownerName}</ownerName>
</UpdateTopologyOwner>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyName | Specify the topology name. Include the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| string | ownerName | Specify the topology owner. |
Example
<UpdateTopologyOwner>
<topologyName>Temp Automation Resources/TP1</topologyName>
<ownerName>admin</ownerName>
</UpdateTopologyOwner>
UpdateTopologyDriverUpdate the topology driver.
Update the topology driver.
Syntax
<UpdateTopologyDriver>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
<driverName>{driverName}</driverName>
</UpdateTopologyDriver>
Parameters
| Type | Name | Description |
|---|---|---|
| string | topologyFullPath | Specify topology (name or full path). For full path, specify the full path from the root to the topology, separated by slashes. For example: FolderName/Topologies/TopologyName. |
| string | driverName | Specify the name of the driver. Leave empty to remove associated driver. |
Example
<UpdateTopologyDriver>
<topologyFullPath>Topologies/Topology1</topologyFullPath>
<driverName>Topology Driver</driverName>
</UpdateTopologyDriver>
RenameBlueprintRename a blueprint.
Rename a blueprint.
Syntax
<RenameBlueprint>
<topologyFullPath>{topologyFullPath}</topologyFullPath>
<newName>{newName}</newName>
</RenameBlueprint>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 | newName | Specify the name of the driver. Leave empty to remove associated driver. |
Example
<RenameBlueprint>
<topologyFullPath>Topologies/Topology1</topologyFullPath>
<newName>New Name</newName>
</RenameBlueprint>
UpdateUser
Configures a user's email and activity settings.
Syntax
<UpdateUser>
<username>{username}</username>
<email>{email}</email>
<isActive>{isActive}</isActive>
</UpdateUser>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | The username of the user you want to update. |
| string | The new email address to update to. | |
| boolean | isActive | Grant or deny active access to the application. |
Example
<UpdateUser>
<username>User1234</username>
<email>user1234@work.com</email>
<isActive>1</isActive>
</UpdateUser>
UpdateUsersLimitations
Update MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes and MaxOwnedBlueprints.
Syntax
<UpdateUsersLimitations>
<userUpdateRequests>
<UserUpdateRequest>
<Username>{Username}</Username>
<MaxConcurrentReservations>{MaxConcurrentReservations}</MaxConcurrentReservations>
<MaxReservationDuration>{MaxReservationDuration}</MaxReservationDuration>
<MaxSavedSandboxes>{MaxSavedSandboxes}</MaxSavedSandboxes>
<MaxScheduledSandboxes>{MaxScheduledSandboxes}</MaxScheduledSandboxes>
<MaxOwnedBlueprints>{MaxOwnedBlueprints}</MaxOwnedBlueprints>
</UserUpdateRequest>
</userUpdateRequests>
</UpdateUsersLimitations>
Parameters
| Type | Name | Description |
|---|---|---|
| list | userUpdateRequests | List of Username, MaxConcurrentReservations, MaxReservationDuration, MaxSavedSandboxes, MaxScheduledSandboxes, and MaxOwnedBlueprints of the users you wish to update. |
Example
<UpdateUsersLimitations>
<userUpdateRequests>
<UserUpdateRequest>
<Username>User1234</Username>
<MaxConcurrentReservations>100</MaxConcurrentReservations>
<MaxReservationDuration></MaxReservationDuration>
<MaxSavedSandboxes></MaxSavedSandboxes>
<MaxScheduledSandboxes></MaxScheduledSandboxes>
<MaxOwnedBlueprints>10</MaxOwnedBlueprints>
</UserUpdateRequest>
<UserUpdateRequest>
<Username>User5678</Username>
<MaxConcurrentReservations>100</MaxConcurrentReservations>
<MaxReservationDuration>100</MaxReservationDuration>
<MaxSavedSandboxes>100</MaxSavedSandboxes>
<MaxScheduledSandboxes>10</MaxScheduledSandboxes>
<MaxOwnedBlueprints>10</MaxOwnedBlueprints>
</UserUpdateRequest>
</userUpdateRequests>
</UpdateUsersLimitations>
UpdateUserGroupsModify a user's group memberships.
Update an existing user's groups (replaces existing user's groups).
Syntax
<UpdateUserGroups>
<username>{username}</username>
<groupsNames>
<string>{string}</string>
</groupsNames>
</UpdateUserGroups>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Specify the name of the user. |
| list | groupsNames | Use this method to update a user's group memberships. Activating this method will replace the user's memberships with the specified list of groups. |
Example
<UpdateUserGroups>
<username>User1234</username>
<groupsNames>
<string>QA_Users</string>
<string>Testers_Users</string>
</groupsNames>
</UpdateUserGroups>
UpdateUserPasswordModify a user's password.
Changes a user's password.
Syntax
<UpdateUserPassword>
<username>{username}</username>
<password>{password}</password>
</UpdateUserPassword>
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | Specify the name of the user. |
| string | password | Specify the user's new login password. |
Example
<UpdateUserPassword>
<username>User1234</username>
<password>Pass1234</password>
</UpdateUserPassword>
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
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specifies the string that represents the reservation’s unique identifier. |
| list | routeAliases | Specify a matrix of route source, route target and alias. |
Example
<UpdateRouteAliasesInReservation>
<reservationId>28cb2a71-c8fc-4f41-a22b-e65685ebed14</reservationId>
<routeAliases>
<UpdateRouteAliasRequest>
<SourceResourceName>SourceResourceName</SourceResourceName>
<TargetResourceName>TargetResourceName</TargetResourceName>
<Alias>Alias</Alias>
</UpdateRouteAliasRequest>
</routeAliases>
</UpdateRouteAliasesInReservation>
Output
<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>
UpdateDriverUpdate Driver
Uploads a new version of an existing driver
Syntax
<UpdateDriver>
<driverName>{driverName}</driverName>
<driverFile>{driverFile}</driverFile>
<driverFileName>{driverFileName}</driverFileName>
</UpdateDriver>
Parameters
| Type | Name | Description |
|---|---|---|
| string | driverName | Specify the driver name. |
| string | driverFile | Specify the driver file data (base64 file representation). |
| string | driverFileName | Specify the driver file name(optional). |
Example
<UpdateDriver>
<driverName>TestDriver</driverName>
<driverFile>234234234234..==</driverFile>
<driverFileName>Test_Driver_Update.zip</driverFileName>
</UpdateDriver>
UpdateScriptUpdate Script
Uploads a new version of an existing script
Syntax
<UpdateScript>
<scriptName>{scriptName}</scriptName>
<scriptFile>{scriptFile}</scriptFile>
<scriptFileName>{scriptFileName}</scriptFileName>
</UpdateScript>
Parameters
| Type | Name | Description |
|---|---|---|
| string | scriptName | Specify the script name. |
| string | scriptFile | Specify the script file data (base64 file representation). |
| string | scriptFileName | Specify the script file name(optional). |
Example
<UpdateScript>
<scriptName>TestScript</scriptName>
<scriptFile>234234234234..==</scriptFile>
<scriptFileName>Test_Script_Update.zip</scriptFileName>
</UpdateScript>
WriteMessageToReservationOutputAllows sending output to the command output window in a reservation.
Allows sending output to the command output window in a reservation.
Syntax
<WriteMessageToReservationOutput>
<reservationId>{reservationId}</reservationId>
<message>{message}</message>
</WriteMessageToReservationOutput>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | message | Output message to the command output window. |
Example
<WriteMessageToReservationOutput>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<message>this is an output from API</message>
</WriteMessageToReservationOutput>
SetSetupStage
Set the specified setup stage for the the sandbox.
Syntax
<SetSetupStage>
<setupStage>{setupStage}</setupStage>
<reservationId>{reservationId}</reservationId>
</SetSetupStage>
Parameters
| Type | Name | Description |
|---|---|---|
| string | setupStage | Specify the setup stage that will be set to the reservation. |
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<SetSetupStage>
<setupStage>Provisioning</setupStage>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</SetSetupStage>
ResetSandboxProvisioningStatus
Reset the status of the sandbox from Active (with error) to Active.
Syntax
<ResetSandboxProvisioningStatus>
<reservationId>{reservationId}</reservationId>
</ResetSandboxProvisioningStatus>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
Example
<ResetSandboxProvisioningStatus>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
</ResetSandboxProvisioningStatus>
SaveSandbox
Save the sandbox.
Syntax
<SaveSandbox>
<reservationId>{reservationId}</reservationId>
<savedSandboxName>{savedSandboxName}</savedSandboxName>
<savedSandboxDescription>{savedSandboxDescription}</savedSandboxDescription>
<owner>{owner}</owner>
</SaveSandbox>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| string | savedSandboxName | Specify the name of the saved sandbox |
| string | savedSandboxDescription | provide a short description for the saved sandbox |
| string | owner | Specify the owner of the saved sandbox |
| string | savedSandboxId | Returns the saved sandbox id |
Example
<SaveSandbox>
<reservationId>af626b88-458b-4e7a-9054-c03d8cffa260</reservationId>
<savedSandboxName>Example_Name</savedSandboxName>
<savedSandboxDescription>Example_Description</savedSandboxDescription>
<owner>admin</owner>
</SaveSandbox>
RestoreSavedSandbox
Restore a saved sandbox
Syntax
<RestoreSavedSandbox>
<reservationName>{reservationName}</reservationName>
<owner>{owner}</owner>
<durationInMinutes>{durationInMinutes}</durationInMinutes>
<notifyOnStart>{notifyOnStart}</notifyOnStart>
<notifyOnSetupComplete>{notifyOnSetupComplete}</notifyOnSetupComplete>
<notifyOnEnd>{notifyOnEnd}</notifyOnEnd>
<notificationMinutesBeforeEnd>{notificationMinutesBeforeEnd}</notificationMinutesBeforeEnd>
<savedSandboxId>{savedSandboxId}</savedSandboxId>
<startTime>{startTime}</startTime>
<endTime>{endTime}</endTime>
<isTerminationProtectionEnabled>{isTerminationProtectionEnabled}</isTerminationProtectionEnabled>
</RestoreSavedSandbox>
Parameters
| Type | Name | Description |
|---|---|---|
| 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 | savedSandboxId | Specify the saved sandbox id. |
| string | startTime | The start time of the restored sandbox. |
| string | endTime | The end time of the restored sandbox. |
| boolean | notifyOnSetupComplete | Indicate whether to notify the reservation owner when the reservation setup completes. |
| boolean | isTerminationProtectionEnabled | Indicate whether to protect the reservation from being terminated. |
| string | reservationId | Specifies the string that represents the reservation’s unique identifier. |
Example
<RestoreSavedSandbox>
<reservationName>restored reservation</reservationName>
<owner>admin</owner>
<durationInMinutes>0</durationInMinutes>
<notifyOnStart>0</notifyOnStart>
<notifyOnSetupComplete>0</notifyOnSetupComplete>
<notifyOnEnd>0</notifyOnEnd>
<notificationMinutesBeforeEnd>0</notificationMinutesBeforeEnd>
<isTerminationProtectionEnabled>False</isTerminationProtectionEnabled>
<savedSandboxId>af626b88-458b-4e7a-9054-c03d8cffa260</savedSandboxId>
<startTime>2015-01-01T10:00:00</startTime>
<endTime>2015-01-01T11:00:00</endTime>
</RestoreSavedSandbox>
GetSavedSandboxes
Get all saved sandboxes. CreateDate default timezone is UTC.
Syntax
<GetSavedSandboxes>
</GetSavedSandboxes>
Example
<GetSavedSandboxes>
</GetSavedSandboxes>
DeleteSavedSandbox
Delete a saved sandbox
Syntax
<DeleteSavedSandbox>
<savedSandboxId>{savedSandboxId}</savedSandboxId>
</DeleteSavedSandbox>
Parameters
| Type | Name | Description |
|---|---|---|
| string | savedSandboxId | Specify the saved sandbox id |
Example
<DeleteSavedSandbox>
<savedSandboxId>af626b88-458b-4e7a-9054-c03d8cffa260</savedSandboxId>
</DeleteSavedSandbox>
SetAppSecurityGroupsSet security groups for apps
Set security groups for apps.
Syntax
<SetAppSecurityGroups>
<reservationId>{ReservationId}</reservationId>
<securityGroups>
<SecurityGroup>
<Name>{AppName}</Name>
<SecurityGroupsConfigurations>
<SecurityGroupsConfiguration>
<SubnetId>{SubnetId}</SubnetId>
<Rules>
<SecurityGroupRule>
<FromPort>{FromPort}</FromPort>
<ToPort>{ToPort}</ToPort>
<Protocol>{Protocol}</Protocol>
<Source>{Source}</Source>
</SecurityGroupRule>
</Rules>
</SecurityGroupsConfiguration>
</SecurityGroupsConfigurations>
</SecurityGroup>
</securityGroups>
<printOutput>{printOutput}</printOutput>
</SetAppSecurityGroups>
Parameters
| Type | Name | Description |
|---|---|---|
| string | reservationId | Specify the string that represents the reservation’s unique identifier. |
| list | securityGroups | Security Groups |
| boolean | printOutput | Defines whether to print the command output in the reservation command output window. |
Example
<SetAppSecurityGroups>
<reservationId>f45bba4c-099c-4d27-987e-23aa54654336</reservationId>
<securityGroups>
<SecurityGroup>
<Name>AsafLinux i-0edb435d42bc9b0ef</Name>
<SecurityGroupsConfigurations>
<SecurityGroupsConfiguration>
<SubnetId>sn-f34r4rd4</SubnetId>
<Rules>
<SecurityGroupRule>
<FromPort>80</FromPort>
<ToPort>85</ToPort>
<Protocol>TCP</Protocol>
<Source>0.0.0.0/0</Source>
</SecurityGroupRule>
</Rules>
</SecurityGroupsConfiguration>
</SecurityGroupsConfigurations>
</SecurityGroup>
</securityGroups>
<printOutput>true</printOutput>
</SetAppSecurityGroups>
Output
<ResponseInfo>
<ResultItems>
<ResultItem AppName="Aws i-0f4e2454f1" Success="true" />
</ResultItems>
</ResponseInfo>