GUI to API Mapping

This appendix maps the GUI operations to the corresponding APIs.

Note Support is not guaranteed for any mapping not listed.

Service Inventory Tab

 

Table A-1 Service Inventory Tab

GUI Operation
Corresponding APIs

Inventory and Connection Manager

See the “Inventory and Connection Manager” section.

Deployment Flow Manager
  • performBatchOperations
  • Create<service type>ServiceOrder

(where <service type> =MPLS, VPLS, L2VPN)

Device Console

– CreateTemplateServiceOrderDownload

– CreateTemplateServiceOrderDownloadTransient

– CreateTemplateData, ModifyTemplateData

– CreateTemplateDefn

Delete and View also supported.

  • Device Configuration Manager

– ViewConfiglet

– ViewConfiguration

  • Exec Commands

– CreateExecCommandServiceOrderDownload

  • Reload

– CreateConfigServiceOrderDownload

Inventory and Connection Manager

 

Table A-2 Inventory and Connection Manager Link

GUI Operation
Corresponding APIs

Service Requests

Create<service type>ServiceOrder

(where <service type> =MPLS, L2VPN, VPLS)

Delete, Modify, and View also supported. (see also Task Manager on the Monitoring Tab)

Traffic Engineering Management

Not supported.

Inventory Manager

See individual inventory items.

Topology Tool

GUI only.

Devices
  • CreateCiscoRouter
  • CreateCatIOS
  • CreateCatOS

– CreateVPNSM

  • CreateIE2100
  • CreateTerminalServer

Delete, Modify, and View also supported.

Device Groups

CreateDeviceGroup

Delete, Modify, and View also supported.

Customers

CreateOrganization

Delete, Modify, and View also supported.

Providers

CreateProvider

Delete, Modify, and View also supported.

Resource Pools
  • CreateRouteTarget
  • CreateRouteDistinguisher
  • CreateIPAddressPool
  • CreateMulticastAddrPool
  • CreateSiteOfOrigin
  • CreateVcIdPool
  • CreateVlanIdPool

Delete and View also supported.

CE Routing Communities
  • CreateCERC
  • CreateVPN_DefaultCerc

Delete, Modify, and View also supported.

VPNs

CreateVPN

Delete, Modify, and View also supported.

AAA Servers
  • CreateAAAServer
  • CreateAAAServerNTDomain
  • CreateAAAServerRADIUS
  • CreateAAAServerSDI
  • CreateAAAServerTACACS

Delete, Modify, and View also supported.

Named Physical Circuits
  • CreateNamedPhysicalCircuit
  • CreateNamedPhysicalCircuitRing
  • CreateNamedPhysicalCircuitRingExisting

Delete, Modify, and View also supported.

Service Design Tab

 

Table A-3 Service Design Tab

GUI Operation
Corresponding APIs

Policies

Create<service type>ServiceDefn

(where <service type> =MPLS, L2VPN)

Delete, Modify, and View also supported.

Templates
  • CreateTemplateData, ModifyTemplateData
  • CreateTemplateDefn
  • CreateTemplateServiceOrderDownload
  • CreateTemplateServiceOrderDownloadTransient

Delete and View also supported.

Protocols

Not supported.

Network Objects

CreateNetworkObject

Delete, Modify, and View also supported.

Monitoring Tab

 

Table A-4 Monitoring Tab
GUI Operation
Corresponding APIs

Task Manager
  • CreateTaskServiceOrderConfigAudit
  • CreateTaskServiceOrderCollection
  • CreateTaskServiceOrderDecommission
  • CreateTaskServiceOrderDeployment
  • CreateTaskServiceOrderMplsFuncAudit

Delete and View also supported.

Ping

CreateTaskServiceOrderMplsFuncAudit.xml

(Ping is part of an MPLS functional audit.)

SLA

For SLA Probes:

  • CreateSLAProbe, CreateSLAProbeServiceRequest

Delete, Modify and View also supported.

For SLA Reports:

  • execReport_SLAHttp, exexReport_SLAHttpCos
  • execReport_SLAJitter, execReport_SLAJitterCos
  • execReport_SLASummary, exectReport_SLASummaryCos

TE Performance Report

Not supported.

Administration Tab

 

Table A-5 Administration Tab
GUI Operation
Corresponding APIs

Security

GUI only.

Control Center
  • Hosts—Not supported.
  • Collection Zones

– CreateCollectionZone

Delete, Modify, and View also supported

  • Licensing—N/A

Active Users

N/A

User Access Log

N/A

Manage TIBCO Rendezvous

N/A