Cisco Cisco Prime Network Services Controller 3.0 Developer's Guide
Page 10
OL-28369-01
Accessing Prime Network Services Controller Services
You can access Prime Network Services Controller services using XML API requests over HTTPS protocol. The
HTTPS request URL format is:
HTTPS request URL format is:
where service-type is the type of the intended service provider as described in
. For example, to submit a request to the Policy Manager, use the service type policy-mgr as shown in
the following example:
Object Naming
You can identify a specific object by its distinguished name (DN) or by its relative name (RN) as described in the
following sections:
following sections:
●
●
Distinguished Name
A DN enables you to unambiguously identify a target object. DNs use the following format, which consists of a
series of relative names:
series of relative names:
dn = rn/rn/rn/rn...
For example, a series of relative names might resemble the following example:
org-root/org-tenant1/zone-trustedServers-0
In the following example, the DN provides a fully qualified path for a Zone (vZone in the GUI) object (zone-
trustedServers-0) from the top of the object tree to the object. The DN specifies the exact managed object on which
the API call is operating.
trustedServers-0) from the top of the object tree to the object. The DN specifies the exact managed object on which
the API call is operating.
< …dn = "org-root/org-tenant1/zone-trustedServers-0" />
Relative Name
An RN identifies an object within the context of its parent object. The DN of an object consists of the parent DN and
the RN in the following format:
the RN in the following format:
dn = parent-dn/rn
For example, a Zone (vZone in the GUI) object with the name trustedServers-0 that resides under the tenant
Tenant1 has the following related RN and DNs:
Tenant1 has the following related RN and DNs:
●
The object’s RN is zone-trustedServers-0.
●
The object’s parent tenant DN is org-root/org-Tenant1.
●
The object’s DN is org-root/org-Tenant1/zone-trustedServers-0.
API Method Categories
Four method categories are used to interact with Prime Network Services Controller. Each API is a method, and
each method corresponds to an XML document. The following sections describe method categories in more detail
and how to use query filters to retrieve the required information:
each method corresponds to an XML document. The following sections describe method categories in more detail
and how to use query filters to retrieve the required information:
●
●
●
●