Table Of Contents
VNMC XML API Method Descriptions
VNMC XML API Methods
aaaGetRemoteUserRoles
Request syntax
Response syntax
Examples
aaaGetUserLocales
Request syntax
Response syntax
Examples
aaaKeepAlive
Request syntax
Response syntax
Examples
aaaLogin
Request syntax
Response syntax
Examples
aaaLogout
Request syntax
Response syntax
Examples
aaaRefresh
Request syntax
Response syntax
Examples
configConfFiltered
Request syntax
Response syntax
Examples
configConfMo
Request syntax
Response syntax
Examples
configConfMoGroup
Request syntax
Response syntax
Examples
configConfMos
Request syntax
Response syntax
Examples
configFindDnsByClassId
Request syntax
Response syntax
Examples
configMoChangeEvent
Request syntax
Response syntax
Examples
configResolveChildren
Request syntax
Response syntax
Examples
configResolveClass
Request syntax
Response syntax
Examples
configResolveClasses
Request syntax
Response syntax
Examples
configResolveDn
Request syntax
Response syntax
Examples
configResolveDns
Request syntax
Response syntax
Examples
configResolveParent
Request syntax
Response syntax
Examples
configScope
Request syntax
Response syntax
Examples
eventSendHeartbeat
Request syntax
Response syntax
Examples
eventSubscribe
Request syntax
Response syntax
Examples
eventSubscribeApps
Request syntax
Response syntax
Examples
faultAckFault
Request syntax
Response syntax
Examples
faultAckFaults
Request syntax
Response syntax
Examples
faultResolveFault
Request syntax
Response syntax
Examples
loggingSyncOcns
Request syntax
Response syntax
Examples
methodVessel
Request syntax
Response syntax
Examples
orgResolveElements
Request syntax
Response syntax
Examples
orgResolveInScope
Request syntax
Response syntax
Examples
orgResolveLogicalParents
Request syntax
Response syntax
Examples
policyEstimateImpact
Request syntax
Response syntax
Examples
poolResolveInScope
Request syntax
Response syntax
Examples
VNMC XML API Method Descriptions
This chapter includes the following:
•VNMC XML API Methods
API method details are provided below.
VNMC XML API Methods
These methods are also called from the GUI console. This section provides API method descriptions, syntax (request and response), and a usage example. The API methods for VNMC are defined as follows.
aaaGetRemoteUserRoles
(core - authentication) This returns user privileges for the remote location.
Request syntax
<xs:element name="aaaGetRemoteUserRoles" type="aaaGetRemoteUserRoles"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetRemoteUserRoles" mixed="true">
<xs:attribute name="inRemoteUserName">
<xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z][a-zA-Z0-9_.@-]{0,31}"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="aaaGetRemoteUserRoles" type="aaaGetRemoteUserRoles"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetRemoteUserRoles" mixed="true">
<xs:attribute name="outRemoteUserPriv">
<xs:restriction base="xs:string">
<xs:pattern
value="((policy|aaa|read-only|admin|tenant|operations|res-config|fault),){0,7}(policy|aaa|
read-only|admin|tenant|operations|res-config|fault){0,1}"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
inRemoteUserName="adminuser"
Response
commCookie="11/15/0/2964"
srcExtSys="10.193.33.109"
destExtSys="10.193.33.109"
destSvc="mgmt-controller_dme"
outRemoteUserPriv="admin">
aaaGetUserLocales
(core - query) This returns a list of authorized user locales.
Request syntax
<xs:element name="aaaGetUserLocales" type="aaaGetUserLocales"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetUserLocales" mixed="true">
<xs:attribute name="inUserName">
<xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z][a-zA-Z0-9_.@-]{0,31}"/>
<xs:attribute name="inIsUserRemote">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="aaaGetUserLocales" type="aaaGetUserLocales"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetUserLocales" mixed="true">
<xs:attribute name="outUserLocales">
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="512"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
commCookie="11/15/0/2962"
srcExtSys="10.193.33.109"
destExtSys="10.193.33.109"
destSvc="mgmt-controller_dme"
outUserLocales="TestSanity">
aaaKeepAlive
(generic - authentication) This keeps the session active until the default session time expires. This uses the same cookie after the method call.
Request syntax
<xs:element name="aaaKeepAlive" type="aaaKeepAlive" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaKeepAlive" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="aaaKeepAlive" type="aaaKeepAlive" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaKeepAlive" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
cookie="<real_cookie>" />
Response
commCookie="11/15/0/2969"
srcExtSys="10.193.33.109"
destExtSys="10.193.33.109"
destSvc="mgmt-controller_dme"
aaaLogin
(generic - authentication) This is the login process. This is required to begin a session. This establishes an authenticated https session between the client and the VNMC.
Request syntax
<xs:element name="aaaLogin" type="aaaLogin" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogin" mixed="true">
<xs:attribute name="inName">
<xs:restriction base="xs:string">
<xs:pattern value="[\-\.:_a-zA-Z0-9]{0,16}"/>
<xs:attribute name="inPassword">
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="512"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="aaaLogin" type="aaaLogin" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogin" mixed="true">
<xs:attribute name="outCookie" type="xs:string"/>
<xs:attribute name="outRefreshPeriod" type="xs:unsignedInt"/>
<xs:attribute name="outPriv">
<xs:restriction base="xs:string">
<xs:pattern
value="((policy|aaa|read-only|admin|tenant|operations|res-config|fault),){0,7}(policy|aaa|
read-only|admin|tenant|operations|res-config|fault){0,1}"/>
<xs:attribute name="outDomains" type="xs:string"/>
<xs:attribute name="outChannel">
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
<xs:attribute name="outEvtChannel">
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
<xs:attribute name="outSessionId">
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
<xs:maxLength value="64"/>
<xs:attribute name="outVersion" type="xs:string"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
outCookie="<real_cookie>"
outVersion="1.0(0.39938)">
aaaLogout
(generic - authentication) This is the logout process to end a current session. When the default session time period expires, this is called automatically.
Request syntax
<xs:element name="aaaLogout" type="aaaLogout" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogout" mixed="true">
<xs:attribute name="inCookie" type="xs:string"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="aaaLogout" type="aaaLogout" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogout" mixed="true">
<xs:attribute name="outStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="success"/>
<xs:enumeration value="failure"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
aaaRefresh
(generic - authentication) Sessions can be kept active (within the default session time frame) by user activity. There is a default of 7200 seconds that counts down when inactivity begins. If the 7200 seconds expire, VNMC enters a sleep mode. It requires signing back in, which restarts the countdown. It continues using the same session ID.
Note Using this method will expire the previous cookie and issue a new cookie.
Request syntax
<xs:element name="aaaRefresh" type="aaaRefresh" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaRefresh" mixed="true">
<xs:attribute name="inName">
<xs:restriction base="xs:string">
<xs:pattern value="[\-\.:_a-zA-Z0-9]{0,16}"/>
<xs:attribute name="inPassword">
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="512"/>
<xs:attribute name="inCookie" type="xs:string"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="aaaRefresh" type="aaaRefresh" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaRefresh" mixed="true">
<xs:attribute name="outCookie" type="xs:string"/>
<xs:attribute name="outRefreshPeriod" type="xs:unsignedInt"/>
<xs:attribute name="outPriv">
<xs:restriction base="xs:string">
<xs:pattern
value="((policy|aaa|read-only|admin|tenant|operations|res-config|fault),){0,7}(policy|aaa|
read-only|admin|tenant|operations|res-config|fault){0,1}"/>
<xs:attribute name="outDomains" type="xs:string"/>
<xs:attribute name="outChannel">
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
<xs:attribute name="outEvtChannel">
<xs:restriction base="xs:string">
<xs:enumeration value="fullssl"/>
<xs:enumeration value="noencssl"/>
<xs:enumeration value="plain"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
inCookie="<real_cookie>"/>
Response
commCookie="" srcExtSys="0.0.0.0"
outCookie="<real_cookie>"
configConfFiltered
(generic - configuration) Data and activity is limited according to the configured policies.
Request syntax
<xs:element name="configConfFiltered" type="configConfFiltered"
substitutionGroup="externalMethod"/>
<xs:complexType name="configConfFiltered" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:element name="inConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="classId" type="namingClassId"/>
Response syntax
<xs:element name="configConfFiltered" type="configConfFiltered"
substitutionGroup="externalMethod"/>
<xs:complexType name="configConfFiltered" mixed="true">
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
Examples
Request
descr="HR (Human Resources- new Descr)"/>
Response
srcExtSys="10.193.33.206"
destExtSys="10.193.33.206"
destSvc="resource-mgr_dme"
descr="HR (Human Resources- new Descr)"
dn="org-root/org-Cisco/org-HR"
configConfMo
(generic - configuration) The configures the specified Managed Object in a single subtree (i.e., DN).
Request syntax
<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMo" mixed="true">
<xs:element name="inConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMo" mixed="true">
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
basedn="dc=pasadena,dc=cisco,dc=com"
filter="sAMAccountName=$userid"
Response
srcExtSys="10.193.33.101"
destExtSys="10.193.33.101"
destSvc="mgmt-controller_dme"
basedn="dc=pasadena,dc=cisco,dc=com"
childAction="deleteNonPresent"
filter="sAMAccountName=$userid"
fsmPrev="updateEpSuccess"
fsmStamp="2010-11-22T23:41:01.826"
configConfMoGroup
(generic - configuration) This configures groups of managed objects based upon the configured policies.
Request syntax
<xs:element name="configConfMoGroup" type="configConfMoGroup"
substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMoGroup" mixed="true">
<xs:element name="inDns" type="dnSet" minOccurs="0"/>
<xs:element name="inConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="configConfMoGroup" type="configConfMoGroup"
substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMoGroup" mixed="true">
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Note The 'descr' property of orgDataCenter (under org-root/org-Cisco and org-root/org-Cola) is modified. Since the 'descr' property is not implicit, it can be modified. If implicit, the modification would not apply and a new orgDataCenter would be created.
Request
<dn value="org-root/org-Cisco" />
<dn value="org-root/org-Cola" />
descr="HR (Human Resources)"/>
Response
srcExtSys="10.193.33.206"
destExtSys="10.193.33.206"
destSvc="resource-mgr_dme"
descr="HR (Human Resources)"
dn="org-root/org-Cola/org-HR"
descr="HR (Human Resources)"
dn="org-root/org-Cisco/org-HR"
configConfMos
(generic - configuration) This configures managed objects in multiple subtrees using DNs.
Request syntax
<xs:element name="configConfMos" type="configConfMos" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMos" mixed="true">
<xs:element name="inConfigs" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_2">
<xs:selector xpath="pair"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="configConfMos" type="configConfMos" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMos" mixed="true">
<xs:element name="outConfigs" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_4">
<xs:selector xpath="pair"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
<pair key="org-root/logprof-default">
<policyLogProfile dn="org-root/logprof-default"
<!-- Update Controller Device Profile -->
<pair key="org-root/controller-profile-default">
<policyControllerDeviceProfile
dn="org-root/controller-profile-default"
<commDnsProvider hostip="171.70.168.183" order="1"/>
<commDnsProvider hostip="171.68.226.120" order="2"/>
<commDnsProvider hostip="64.102.6.247" order="3"/>
</policyControllerDeviceProfile>
Response
destExtSys="10.193.34.70"
<pair key="org-root/logprof-default">
descr="the log level for every process"
dn="org-root/logprof-default"
<pair key="org-root/controller-profile-default">
<policyControllerDeviceProfile
descr="default profile for management server virtual machine"
dn="org-root/controller-profile-default"
logProfilePolicy="default"
configFindDnsByClassId
(generic - query) This finds distinguished names and returns them sorted by class ID.
Request syntax
<xs:element name="configFindDnsByClassId" type="configFindDnsByClassId"
substitutionGroup="externalMethod"/>
<xs:complexType name="configFindDnsByClassId" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="classId" type="namingClassId"/>
Response syntax
<xs:element name="configFindDnsByClassId" type="configFindDnsByClassId"
substitutionGroup="externalMethod"/>
<xs:complexType name="configFindDnsByClassId" mixed="true">
<xs:element name="outDns" type="dnSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
Examples
Request
cookie="<real_cookie>" />
Response
<dn value="sys/chassis-1/blade-7"/>
<dn value="sys/chassis-1/blade-5"/>
<dn value="sys/chassis-1/blade-3"/>
<dn value="sys/chassis-1/blade-1"/>
</configFindDnsByClassId>
configMoChangeEvent
(generic - event) This returns change events on the specified managed object.
Request syntax
<xs:element name="configMoChangeEvent" type="configMoChangeEvent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configMoChangeEvent" mixed="true">
<xs:element name="inConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="inEid" type="xs:unsignedLong"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="configMoChangeEvent" type="configMoChangeEvent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configMoChangeEvent" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
lastPollTs="2010-11-12T20:33:51.071"
Response
outSystemTime="2010-11-12T20:34:19.630">
outSystemTime="2010-11-12T20:34:19.630">
configResolveChildren
(generic - query) This method retrieves children of managed objects under a specific DN in the managed information tree. A filter can be used to reduce the number of children being returned.
Request syntax
<xs:element name="configResolveChildren" type="configResolveChildren"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveChildren" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="inDn" type="referenceObject"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="classId" type="namingClassId"/>
Response syntax
<xs:element name="configResolveChildren" type="configResolveChildren"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveChildren" mixed="true">
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
Examples
Request
Response
commCookie="11/15/0/2a59"
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
destSvc="mgmt-controller_dme"
<aaaUser descr="" dn="sys/user-ext/user-doe"
email="" expiration="never" expires="no" firstName="John" intId="12999"
lastName="Doe" name="doe" phone="" priv="admin,read-only" pwdSet="yes"/>
<aaaUser descr="" dn="sys/user-ext/user-jacks" email="" expiration="never"
expires="no" firstName="Play" intId="12734" lastName="Jacks" name="jacks"
phone="" priv="fault,operations,policy,read-only,res-config,tenant"
pwdSet="yes"/>
<aaaUser descr="" dn="sys/user-ext/user-admin" email="" expiration="never"
expires="no" firstName="" intId="10052" lastName="" name="admin" phone=""
priv="admin,read-only" pwdSet="yes"/>
<aaaUser descr="" dn="sys/user-ext/user-over" email="" expiration="never"
expires="no" firstName="Roll" intId="12711" lastName="Over" name="over"
phone="" priv="fault,operations,policy,read-only,res-config,tenant"
pwdSet="yes"/>
<aaaUser descr="" dn="sys/user-ext/user-fun" email="" expiration="never"
expires="no" firstName="Have" intId="12708" lastName="Fun" name="fun" phone=""
priv="read-only" pwdSet="yes"/>
<aaaUser descr="testuser" dn="sys/user-ext/user-aaa" email="" expiration="never"
expires="no" firstName="a" intId="10620" lastName="aa" name="aaa" phone=""
priv="aaa,read-only" pwdSet="no"/>
configResolveClass
(generic - query) Returns requested managed object in a given class. If inHierarchical=true, contains children.
Request syntax
<xs:element name="configResolveClass" type="configResolveClass"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClass" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="classId" type="namingClassId"/>
Response syntax
<xs:element name="configResolveClass" type="configResolveClass"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClass" mixed="true">
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
Examples
Request
Response
commCookie="11/15/0/2a5b"
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
destSvc="mgmt-controller_dme"
configResolveClasses
(generic - query) Returns requested managed objects in several classes. If inHierarchical=true, contains children.
Request syntax
<xs:element name="configResolveClasses" type="configResolveClasses"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClasses" mixed="true">
<xs:element name="inIds" type="classIdSet" minOccurs="0"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="configResolveClasses" type="configResolveClasses"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClasses" mixed="true">
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
<Id value="computeBlade"/>
<Id value="equipmentChassis"/>
Response
(This is an abbreviated response.)
dn="sys/chassis-1/blade-1"
dn="sys/chassis-1/blade-3"
dn="sys/chassis-1/blade-5"
dn="sys/chassis-1/blade-7" .
adminState="acknowledged"
configResolveDn
(generic - query) For a given DN, retrieves a single managed object.
Request syntax
<xs:element name="configResolveDn" type="configResolveDn"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDn" mixed="true">
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="configResolveDn" type="configResolveDn"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDn" mixed="true">
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
dn="vmmEp/vm-mgr-vcenter1" />
Response
<configResolveDn dn="vmmEp/vm-mgr-vcenter1"
destExtSys="10.193.34.70"
dn="vmmEp/vm-mgr-vcenter1"
fsmDescr="AG registration with
vCenter(FSM:sam:dme:VmManagerRegisterWithVCenter)"
fsmPrev="RegisterWithVCenterRegistering"
fsmStageDescr="AG registration with
vCenter(FSM-STAGE:sam:dme:VmManagerRegisterWithVCenter:Registering)"
fsmStamp="2010-11-11T21:37:15.696"
fsmStatus="RegisterWithVCenterRegistering"
hostName="savbu-vpod-dev-31.cisco.com"
configResolveDns
(generic - query) For a list of DNs, retrieves managed objects.
Request syntax
<xs:element name="configResolveDns" type="configResolveDns"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDns" mixed="true">
<xs:element name="inDns" type="dnSet" minOccurs="0"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="configResolveDns" type="configResolveDns"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDns" mixed="true">
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:element name="outUnresolved" type="dnSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
<dn value="sys/chassis-1" />
<dn value="sys/chassis-1/blade-1/board/cpu-1" />
<dn value="sys/chassis-1/blade-1/board/t-stats" />
Response
dn="sys/chassis-1/blade-1/board/cpu-1"
model="Intel(R) Xeon(R) CPU E5520 @ 2.27GHz"
vendor="Intel(R) Corporation"
adminState="acknowledged"
fabricEpDn="fabric/server/chassis-1"
fsmPrev="PsuPolicyConfigSuccess"
fsmStamp="2009-09-13T21:34:37"
lcTs="1969-12-31T16:00:00"
operQualifier="fabric-conn-problem"
operState="fabric-conn-problem"
vendor="Cisco Systems Inc"
<dn value="sys/chassis-1/blade-1/board/t-stats"/>
configResolveParent
(generic - query) For a given DN, retrieves the parent of the managed object.
Request syntax
<xs:element name="configResolveParent" type="configResolveParent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveParent" mixed="true">
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="configResolveParent" type="configResolveParent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveParent" mixed="true">
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
dn="sys/chassis-1/blade-1/adaptor-1">
Response
<configResolveParent dn="sys/chassis-1/blade-1/adaptor-1"
dn="sys/chassis-1/blade-1"
fsmPrev="DiscoverSuccess"
fsmStamp="2009-09-23T23:44:30"
lcTs="1969-12-31T16:00:00"
originalUuid="e3516842-d0a4-11dd-baad-000bab01bfd6"
uuid="e3516842-d0a4-11dd-baad-000bab01bfd6"
vendor="Cisco Systems Inc"/>
configScope
(generic - query) Returns managed objects and details about their configuration.
Request syntax
<xs:element name="configScope" type="configScope" substitutionGroup="externalMethod"/>
<xs:complexType name="configScope" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="inClass" type="namingClassId"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="inRecursive">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="configScope" type="configScope" substitutionGroup="externalMethod"/>
<xs:complexType name="configScope" mixed="true"> <xs:all>
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
Response
<configScope dn="org-root"
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
destSvc="service-reg_dme"
dn="org-root/org-counter"
eventSendHeartbeat
(generic - event) Sends an event the indicates the current session is still active.
Request syntax
<xs:element name="eventSendHeartbeat" type="eventSendHeartbeat"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSendHeartbeat" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="eventSendHeartbeat" type="eventSendHeartbeat"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSendHeartbeat" mixed="true">
<xs:attribute name="outSystemTime" type="dateTime"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
When the client application subscribes to an event or events via eventSubscribeApps or eventSubscribe, the VNMC will send eventSendHeartbeat periodically (default 120 seconds).
Response
<eventSendHeartbeat cookie="0/0/0/2a76"
outSystemTime="2010-11-12T20:38:19.630">
eventSubscribe
(generic - event) Subscribe request for activity.
Request syntax
<xs:element name="eventSubscribe" type="eventSubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribe" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="eventSubscribe" type="eventSubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribe" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
NO RESPONSE OR ACKNOWELDGEMENT.
eventSubscribeApps
(generic - event) Subscribe request for activity on specified applications. For the client application to subscribe to VNMC system to receive the events from different application. In eventApplication, "ip" is the ip address for the VM where the application (DME) is running. The client application can subscribe to receive events from VSG as well, where ip should be the IP address for VSG, and type is "managed-endpoint".
Request syntax
<xs:element name="eventSubscribeApps" type="eventSubscribeApps"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribeApps" mixed="true">
<xs:element name="inAppList" type="configSet" minOccurs="0"/>
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="eventSubscribeApps" type="eventSubscribeApps"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribeApps" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
IF SUCCESSFUL, NO RESPONSE OR ACKNOWELDGEMENT.
faultAckFault
(generic - event) Sends an acknowledgement when a fault is recorded.
Request syntax
<xs:element name="faultAckFault" type="faultAckFault" substitutionGroup="externalMethod"/>
<xs:complexType name="faultAckFault" mixed="true">
<xs:attribute name="inId" type="xs:unsignedLong"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="faultAckFault" type="faultAckFault" substitutionGroup="externalMethod"/>
<xs:complexType name="faultAckFault" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
srcExtSys="10.193.33.214"
destExtSys="10.193.33.214"
destSvc="resource-mgr_dme"
faultAckFaults
(generic - event) Sends an acknoweldgement when multiple faults are recorded.
Request syntax
<xs:element name="faultAckFaults" type="faultAckFaults"
substitutionGroup="externalMethod"/>
<xs:complexType name="faultAckFaults" mixed="true">
<xs:element name="inIds" type="idSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="faultAckFaults" type="faultAckFaults"
substitutionGroup="externalMethod"/>
<xs:complexType name="faultAckFaults" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
destExtSys="10.193.34.70"
destSvc="mgmt-controller_dme"
faultResolveFault
(generic - event) Sends a response when a fault has been resolved.
Request syntax
<xs:element name="faultResolveFault" type="faultResolveFault"
substitutionGroup="externalMethod"/>
<xs:complexType name="faultResolveFault" mixed="true">
<xs:attribute name="inId" type="xs:unsignedLong"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="faultResolveFault" type="faultResolveFault"
substitutionGroup="externalMethod"/>
<xs:complexType name="faultResolveFault" mixed="true">
<xs:element name="outFault" type="configConfig" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
srcExtSys="10.193.33.214"
destExtSys="10.193.33.214"
destSvc="resource-mgr_dme"
created="2010-11-19T11:02:41.568"
descr="Virtual Security Gateway pool default is empty"
dn="org-root/fwpool-default/fault-F0135"
lastTransition="2010-11-19T11:02:41.568"
loggingSyncOcns
(generic - query) This retrieves event IDs from DME.
Request syntax
<xs:element name="loggingSyncOcns" type="loggingSyncOcns"
substitutionGroup="externalMethod"/>
<xs:complexType name="loggingSyncOcns" mixed="true">
<xs:attribute name="inFromOrZero" type="xs:unsignedLong"/>
<xs:attribute name="inToOrZero" type="xs:unsignedLong"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="loggingSyncOcns" type="loggingSyncOcns"
substitutionGroup="externalMethod"/>
<xs:complexType name="loggingSyncOcns" mixed="true">
<xs:element name="outStimuli" type="MethodSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
Response
List of event IDs.
methodVessel
(generic - event) This is a batch event notification that contains multiple configMoChangeEvent in a single payload.
Request syntax
<xs:element name="methodVessel" type="methodVessel" substitutionGroup="externalMethod"/>
<xs:complexType name="methodVessel" mixed="true">
<xs:element name="inStimuli" type="MethodSet" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="methodVessel" type="methodVessel" substitutionGroup="externalMethod"/>
<xs:complexType name="methodVessel" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
<resstateNormalizedHealthState
dn="fw/inst-1010/normalized-health-state"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340/fault-F0117"
lc="flapping,soaking-clear"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
created="2010-11-19T18:32:02.622"
descr="[FSM:STAGE:REMOTE-ERROR]: WRONG STATE:Result: not-applicable Code:
unspecified Message: (sam:dme:FwInstanceAssociate:configPA)"
Response
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
<resstateNormalizedHealthState
dn="fw/inst-1010/normalized-health-state"
operState="config-failure"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
configState="failed-to-apply"
dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340/fault-F0117"
lastTransition="2010-11-19T18:32:02.680"
orgResolveElements
(generic - query) Within a specified DN, retrieves managed objects that satisfy a query filter. Searches managed objects starting at an organization, and optionally in the child organizations.
If there is no organization with that DN, an empty map is returned. If found, searches managed objects with specified class and filters.
If inHierarchical = true, all matching objects and descendants are returned. If false, only returns matching objects. If inSingleLevel = true, search stops at the organization level. If false, includes child organizations.
Request syntax
<xs:element name="orgResolveElements" type="orgResolveElements"
substitutionGroup="externalMethod"/>
<xs:complexType name="orgResolveElements" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="inClass" type="namingClassId"/>
<xs:attribute name="inSingleLevel">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="orgResolveElements" type="orgResolveElements"
substitutionGroup="externalMethod"/>
<xs:complexType name="orgResolveElements" mixed="true">
<xs:element name="outConfigs" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_5">
<xs:selector xpath="pair"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
inClass="policyPolicySet"
Response
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
<pair key="pset-default">
descr="The default Policy Set"
dn="org-root/pset-default"
<pair key="pset-myPolicySet3">
dn="org-root/org-Cola/pset-myPolicySet3"
<pair key="pset-policySetSanity">
dn="org-root/org-Cola/pset-policySetSanity"
<pair key="pset-pci_compliance_f">
dn="org-root/pset-pci_compliance_f"
name="pci_compliance_f"/>
<pair key="pset-pci_compliance_h">
dn="org-root/pset-pci_compliance_h"
name="pci_compliance_h"/>
orgResolveInScope
(generic - query) With the given DN, system looks up the organization, and (optional) parent organizations recursively to the root. If no organization, an empty map is returned. If found, searches all pools with specified class and filters.
Note If inSingleLevel = false, searches parent organizations up to the root directory.
Request syntax
<xs:element name="orgResolveInScope" type="orgResolveInScope"
substitutionGroup="externalMethod"/>
<xs:complexType name="orgResolveInScope" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="inClass" type="namingClassId"/>
<xs:attribute name="inSingleLevel">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="orgResolveInScope" type="orgResolveInScope"
substitutionGroup="externalMethod"/>
<xs:complexType name="orgResolveInScope" mixed="true">
<xs:element name="outConfigs" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_6">
<xs:selector xpath="pair"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
inClass="policyVirtualNetworkServiceProfile"
<eq class="policyVirtualNetworkServiceProfile"
Response
destExtSys="10.193.34.70"
<pair key="vnsp-spsanity">
<policyVirtualNetworkServiceProfile
childAction="deleteNonPresent"
dn="org-root/org-Cola/vnsp-spsanity"
policySetNameRef="policySetSanity"
childAction="deleteNonPresent"
childAction="deleteNonPresent"
<policyAttributeDesignator
childAction="deleteNonPresent"
</policyVirtualNetworkServiceProfile>
orgResolveLogicalParents
(generic - query) With the given DN, system looks up logical parents up to the root directory.
Request syntax
<xs:element name="orgResolveLogicalParents" type="orgResolveLogicalParents"
substitutionGroup="externalMethod"/>
<xs:complexType name="orgResolveLogicalParents" mixed="true">
<xs:attribute name="inSingleLevel">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="orgResolveLogicalParents" type="orgResolveLogicalParents"
substitutionGroup="externalMethod"/>
<xs:complexType name="orgResolveLogicalParents" mixed="true">
<xs:element name="outConfigs" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_7">
<xs:selector xpath="pair"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
<orgResolveLogicalParents
dn="org-root/org-Cisco/org-HR/zone-clients"
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
</orgResolveLogicalParents>
Response
<orgResolveLogicalParents
dn="org-root/org-Cisco/org-HR/zone-clients"
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
<pair key="org-root/org-Cisco/zone-clients">
dn="org-root/org-Cisco/zone-clients"
</orgResolveLogicalParents>
policyEstimateImpact
(core - query) This takes the DN and class ID of a policy managed object (MO) and returns a list of MOs impacted by this change. Use it to estimate any impacts of a policy change (created, modified, or deleted). The following are several examples:
•Modifying a name reference (that is, the resolved name will change)
•On a deletion, another object reference could refer to the nonexistent object
•On creation, an object reference can refer to a newly created object
Request syntax
<xs:element name="policyEstimateImpact" type="policyEstimateImpact"
substitutionGroup="externalMethod"/>
<xs:complexType name="policyEstimateImpact" mixed="true">
<xs:element name="inConfig" type="configConfig" minOccurs="0"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
Response syntax
<xs:element name="policyEstimateImpact" type="policyEstimateImpact"
substitutionGroup="externalMethod"/>
<xs:complexType name="policyEstimateImpact" mixed="true">
<xs:element name="outImpactedMoSet" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_8">
<xs:selector xpath="pair"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Examples
Request
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
destSvc="policy-mgr_dme">
dn="org-root/org-Cisco/pol-policySanity"
status="deleted,modified"/>
Response
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
<pair key="org-root/org-Cisco/vnsp-spsanity">
<policyVirtualNetworkServiceProfile
dn="org-root/org-Cisco/vnsp-spsanity"
policySetNameRef="policySetSanity"
<pair key="org-root/org-Cisco/pset-policySetSanity/polref-policySanity">
dn="org-root/org-Cisco/pset-policySetSanity/polref-policySanity"
policyName="policySanity"/>
poolResolveInScope
(generic - query) With the given DN, system looks up the pool, and (optional) parent pools recursively to the root. If no pool exists, an empty map is returned. If found, searches all pools with specified class and filters.
Note If inSingleLevel = false, searches parent pools up to the root directory.
Request syntax
<xs:element name="poolResolveInScope" type="poolResolveInScope"
substitutionGroup="externalMethod"/>
<xs:complexType name="poolResolveInScope" mixed="true">
<xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
<xs:attribute name="inClass" type="namingClassId"/>
<xs:attribute name="inSingleLevel">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="inHierarchical">
<xs:union memberTypes="xs:boolean">
<xs:restriction base="xs:string">
<xs:enumeration value="no"/>
<xs:enumeration value="yes"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="dn" type="referenceObject"/>
Response syntax
<xs:element name="poolResolveInScope" type="poolResolveInScope"
substitutionGroup="externalMethod"/>
<xs:complexType name="poolResolveInScope" mixed="true">
<xs:element name="outConfigs" type="configMap" minOccurs="0">
<xs:unique name="unique_map_key_9">
<xs:selector xpath="pair"/>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
Examples
Request
Response
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
destSvc="resource-mgr_dme"
<pair key="fwpool-default">
descr="Default Pool of Virtual Security Gateway resources"
dn="org-root/fwpool-default"