Cisco VNMC XML API Reference Guide, Release 1.3
VNMC XML API Method Descriptions
Downloads: This chapterpdf (PDF - 453.0KB) The complete bookPDF (PDF - 2.28MB) | Feedback

Cisco VNMC XML API Method Descriptions

Table Of Contents

Cisco VNMC XML API Method Descriptions

Cisco 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


Cisco VNMC XML API Method Descriptions


This chapter includes the following:

Cisco VNMC XML API Methods

API method details are provided below.

Cisco 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 the Cisco VNMC are defined as follows:


aaaGetRemoteUserRoles

This example 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:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:pattern value="[a-zA-Z][a-zA-Z0-9_.@-]{0,31}"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

Response Syntax

<xs:element name="aaaGetRemoteUserRoles" type="aaaGetRemoteUserRoles" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="aaaGetRemoteUserRoles" mixed="true">
            <xs:attribute name="outRemoteUserPriv">
            <xs:simpleType>
                <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:restriction>
            </xs:simpleType>
            </xs:attribute>
            <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:complexType>

Examples

Request

<aaaGetRemoteUserRoles 
	cookie="<real_cookie>" 
	inRemoteUserName="adminuser" 
	outRemoteUserPriv/> 

Response

<aaaGetRemoteUserRoles 
	cookie="<real_cookie>" 
	commCookie="11/15/0/2964" 
	srcExtSys="10.193.33.109" 
	destExtSys="10.193.33.109" 
	srcSvc="sam_extXMLApi" 
	destSvc="mgmt-controller_dme" 
	response="yes" 
	outRemoteUserPriv="admin">
</aaaGetRemoteUserRoles>
 
   

aaaGetUserLocales

This example 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:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:pattern value="[a-zA-Z][a-zA-Z0-9_.@-]{0,31}"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inIsUserRemote">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

Response Syntax

<xs:element name="aaaGetUserLocales" type="aaaGetUserLocales" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="aaaGetUserLocales" mixed="true">
            <xs:attribute name="outUserLocales">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:minLength value="0"/>
                         <xs:maxLength value="512"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <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:complexType>

Examples

Request

<aaaGetUserLocales 
	cookie="<real_cookie>" 
	inUserName="john" 
	inIsUserRemote="no" 
	outUserLocales/> 

Response

<aaaGetUserLocales 
	cookie="<real_cookie>" 
	commCookie="11/15/0/2962" 
	srcExtSys="10.193.33.109" 
	destExtSys="10.193.33.109" 
	srcSvc="sam_extXMLApi" 
	destSvc="mgmt-controller_dme" 
	response="yes" 
	outUserLocales="TestSanity">
</aaaGetUserLocales>

aaaKeepAlive

This example keeps the session active until the default session time expires and 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"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<aaaKeepAlive 
	cookie="<real_cookie>" /> 

Response

<aaaKeepAlive 
	cookie="<real_cookie>" 
	commCookie="11/15/0/2969" 
	srcExtSys="10.193.33.109" 
	destExtSys="10.193.33.109" 
	srcSvc="sam_extXMLApi" 
	destSvc="mgmt-controller_dme" 
	response="yes">
</aaaKeepAlive>

aaaLogin

This example shows the login process that is required to begin a session and which 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:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:pattern value="[\-\.:_a-zA-Z0-9]{0,16}"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inPassword">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:minLength value="0"/>
                         <xs:maxLength value="512"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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:simpleType>
                <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:restriction>
            </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="outDomains" type="xs:string"/>
            <xs:attribute name="outChannel">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:enumeration value="fullssl"/>
                         <xs:enumeration value="noencssl"/>
                         <xs:enumeration value="plain"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="outEvtChannel">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:enumeration value="fullssl"/>
                         <xs:enumeration value="noencssl"/>
                         <xs:enumeration value="plain"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="outSessionId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:minLength value="1"/>
                         <xs:maxLength value="64"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <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"/>
        </xs:complexType>

Examples

Request

<aaaLogin 
	inName="admin" 
	inPassword="Nbv12345"/>
 
   

Response

<aaaLogin cookie="" 
	commCookie="" 
	srcExtSys="0.0.0.0" 
	destExtSys="0.0.0.0" 
	srcSvc="" destSvc="" 
	response="yes" 
	outCookie="<real_cookie>" 
	outRefreshPeriod="600" 
	outPriv="admin" 
	outDomains="" 
	outChannel="fullssl" 
	outEvtChannel="fullssl" 
	outSessionId="web_49019" 
	outVersion="1.0(0.39938)"> 
</aaaLogin>

aaaLogout

This example shows the logout process to end a current session. When the default session time period expires, the process 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"/>
        </xs:complexType>

Response Syntax

<xs:element name="aaaLogout" type="aaaLogout" substitutionGroup="externalMethod"/>
        <xs:complexType name="aaaLogout" mixed="true">
            <xs:attribute name="outStatus">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:enumeration value="success"/>
                         <xs:enumeration value="failure"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <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:complexType>

Examples

Request

<aaaLogout 
	inCookie="<real_cookie>" 
	outStatus/> 

Response

<aaaLogout cookie="" 
	commCookie="" 
	srcExtSys="0.0.0.0" 
	destExtSys="0.0.0.0" 
	srcSvc="" 
	destSvc="" 
	response="yes" 
	outStatus="success"> 
</aaaLogout>

aaaRefresh

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, the Cisco VNMC enters a sleep mode and requires signing back in, which restarts the countdown. The session continues using the same session ID.


Note Using this method expires the previous cookie and issues a new cookie.


Request Syntax

<xs:element name="aaaRefresh" type="aaaRefresh" substitutionGroup="externalMethod"/>
        <xs:complexType name="aaaRefresh" mixed="true">
            <xs:attribute name="inName">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:pattern value="[\-\.:_a-zA-Z0-9]{0,16}"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inPassword">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:minLength value="0"/>
                         <xs:maxLength value="512"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inCookie" type="xs:string"/>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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:simpleType>
                <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:restriction>
            </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="outDomains" type="xs:string"/>
            <xs:attribute name="outChannel">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:enumeration value="fullssl"/>
                         <xs:enumeration value="noencssl"/>
                         <xs:enumeration value="plain"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="outEvtChannel">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                         <xs:enumeration value="fullssl"/>
                         <xs:enumeration value="noencssl"/>
                         <xs:enumeration value="plain"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:attribute>
            <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:complexType>

Examples

Request

<aaaRefresh 
	cookie="<real_cookie>"
	inName="admin" 
	inPassword="Nbv12345" 
	inCookie="<real_cookie>"/>
 

Response

<aaaRefresh 
	cookie="<real_cookie>" 
	commCookie="" srcExtSys="0.0.0.0" 
	destExtSys="0.0.0.0" 
	srcSvc="" 
	destSvc="" 
	response="yes" 
	outCookie="<real_cookie>" 
	outRefreshPeriod="600" 
	outPriv="admin" 
	outDomains="" 
	outChannel="fullssl" 
	outEvtChannel="fullssl"> 
</aaaRefresh>

configConfFiltered

This example shows how data and activity are limited according to the configured policies.

Request Syntax

<xs:element name="configConfFiltered" type="configConfFiltered" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfFiltered" mixed="true">
            <xs:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
                <xs:element name="inConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="classId" type="namingClassId"/>
        </xs:complexType>

Response Syntax

<xs:element name="configConfFiltered" type="configConfFiltered" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfFiltered" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configSet" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configConfFiltered 
	cookie="<real_cookie>" 
	inHierarchical="false" 
	classId="orgTenant">
	<inFilter>
		<eq class="orgTenant" 
			property="name" 
			value="Cisco" />
	</inFilter>
	<inConfig>
		<orgDatacenter 
			dn="org-HR" 
			descr="HR (Human Resources- new Descr)"/>
	</inConfig>
</configConfFiltered> 

Response

<configConfFiltered
	cookie="<real_cookie>"
	commCookie="5/15/0/617"
	srcExtSys="10.193.33.206"
	destExtSys="10.193.33.206"
	srcSvc="sam_extXMLApi"
	destSvc="resource-mgr_dme"
	response="yes"
	classId="orgTenant">
	<outConfigs>
		<orgDatacenter
			descr="HR (Human Resources- new Descr)"
			dn="org-root/org-Cisco/org-HR"
			fltAggr="0"
			level="2"
			name="HR"
			status="modified"/>
	</outConfigs>
</configConfFiltered>

configConfMo

This example shows how the specified Managed Object is configured in a single subtree (for example, DN).

Request Syntax

<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfMo" mixed="true">
            <xs:all>
                <xs:element name="inConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

Response Syntax

<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfMo" mixed="true">
            <xs:all>
                <xs:element name="outConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configConfMo
	dn=""  
	cookie="<real_cookie>" 
	inHierarchical="false">
	<inConfig>
		<aaaLdapEp
			attribute="CiscoAvPair"
			basedn="dc=pasadena,dc=cisco,dc=com"   
			descr=""
			dn="sys/ldap-ext"
			filter="sAMAccountName=$userid"
			retries="1"   
			status="modified"
			timeout="30"/>
    </inConfig>
</configConfMo> 

Response

<configConfMo
	dn=""
	cookie="<real_cookie>"
	commCookie="11/15/0/28"
	srcExtSys="10.193.33.101"
	destExtSys="10.193.33.101"
	srcSvc="sam_extXMLApi"
	destSvc="mgmt-controller_dme"
	response="yes">
	<outConfig>
		<aaaLdapEp
			attribute="CiscoAvPair"
			basedn="dc=pasadena,dc=cisco,dc=com"
			childAction="deleteNonPresent"
			descr=""
			dn="sys/ldap-ext"
			filter="sAMAccountName=$userid"
			fsmDescr=""
			fsmPrev="updateEpSuccess"
			fsmProgr="100"
			fsmStageDescr=""
			fsmStamp="2010-11-22T23:41:01.826"
			fsmStatus="nop"
			fsmTry="0"
			intId="10027"
			name=""
			retries="1"
			status="modified"
			timeout="30"/>
	</outConfig>
</configConfMo>
 
   

configConfMoGroup

This example shows how groups of managed objects are configured based upon the configured policies.

Request Syntax

<xs:element name="configConfMoGroup" type="configConfMoGroup" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfMoGroup" mixed="true">
            <xs:all>
                <xs:element name="inDns" type="dnSet" minOccurs="0"/>
                <xs:element name="inConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

Response Syntax

<xs:element name="configConfMoGroup" type="configConfMoGroup" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfMoGroup" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configSet" minOccurs="0"/>
            </xs:all>
            <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:complexType>

Examples


Note The descr property of orgDataCenter (under org-root/org-Cisco and org-root/org-Cola) is modified. Because the descr property is not implicit, it can be modified. If implicit, the modification does not apply and a new orgDataCenter is created.


Request

<configConfMoGroup 
	cookie="<real_cookie>" 
	inHierarchical="false">
    <inDns>
		<dn value="org-root/org-Cisco" />
		<dn value="org-root/org-Cola" />
	</inDns>
	<inConfig>
		<orgDatacenter 
			dn="org-HR" 
			descr="HR (Human Resources)"/>
	</inConfig>
</configConfMoGroup> 

Response

<configConfMoGroup
	cookie="<real_cookie>"
	commCookie="5/15/0/600"
	srcExtSys="10.193.33.206"
	destExtSys="10.193.33.206"
	srcSvc="sam_extXMLApi"
	destSvc="resource-mgr_dme"
	response="yes">
	<outConfigs>
		<orgDatacenter
			descr="HR (Human Resources)"
			dn="org-root/org-Cola/org-HR"
			fltAggr="0"
			level="2"
			name="HR"
			status="modified"/>
		<orgDatacenter
			descr="HR (Human Resources)"
			dn="org-root/org-Cisco/org-HR"
			fltAggr="0"
			level="2"
			name="HR"
			status="modified"/>
	</outConfigs>
</configConfMoGroup>

configConfMos

This example shows how to configure managed objects in multiple subtrees using DNs.

Request Syntax

<xs:element name="configConfMos" type="configConfMos" substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfMos" mixed="true">
            <xs:all>
                <xs:element name="inConfigs" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_2">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

Response Syntax

<xs:element name="configConfMos" type="configConfMos" substitutionGroup="externalMethod"/>
        <xs:complexType name="configConfMos" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_4">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
            <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:complexType>

Examples

Request

<configConfMos
	cookie="<real_cookie>">
	<inConfigs>
		<pair key="org-root/logprof-default">
			<policyLogProfile dn="org-root/logprof-default"
				name="default"
	        			level="debug1"
	       	 		size="10000000"
				backupCount="4"/>
		</pair>
 
   
	<!-- Update Controller Device Profile -->
		<pair key="org-root/controller-profile-default">
	 		<policyControllerDeviceProfile
  				dn="org-root/controller-profile-default"
  				adminState="enabled">
  			
		  		<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>
		</pair>
	</inConfigs>
</configConfMos>
 
   

Response

<configConfMos
	cookie="<real_cookie>"
	commCookie="7/15/0/1a74"
	srcExtSys="10.193.34.70"
	destExtSys="10.193.34.70"
	srcSvc="sam_extXMLApi"
	destSvc="policy-mgr_dme"
	response="yes">
	<outConfigs>
		<pair key="org-root/logprof-default">
			<policyLogProfile
				adminState="enabled"
				backupCount="4"
				descr="the log level for every process"
				dn="org-root/logprof-default"
				intId="10065"
				level="debug1"
				name="default"
				size="10000000"/>
		</pair>
		<pair key="org-root/controller-profile-default">
			<policyControllerDeviceProfile
				adminState="enabled"
				coreFilePolicy=""
				descr="default profile for management server virtual machine"
				dn="org-root/controller-profile-default"
				dnsPolicy=""
				faultPolicy="default"
				httpPolicy="default"
				httpsPolicy="default"
				intId="10057"
				logProfilePolicy="default"
				name="default"
				snmpPolicy=""
				syslogPolicy=""
				telnetPolicy=""
				timezone=""/>
		</pair>
	</outConfigs>
</configConfMos>

configFindDnsByClassId

This example shows how to find distinguished names and return them sorted by class ID.

Request Syntax

<xs:element name="configFindDnsByClassId" type="configFindDnsByClassId" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configFindDnsByClassId" mixed="true">
            <xs:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="classId" type="namingClassId"/>
        </xs:complexType>

Response Syntax

<xs:element name="configFindDnsByClassId" type="configFindDnsByClassId" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configFindDnsByClassId" mixed="true">
            <xs:all>
                <xs:element name="outDns" type="dnSet" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configFindDnsByClassId 
	classId="computeBlade" 
	cookie="<real_cookie>" /> 

Response

<configFindDnsByClassId 
	cookie="<real_cookie>" 
	response="yes" 
	classId="computeBlade">
	<outDns>
		<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"/>
	</outDns>
</configFindDnsByClassId>

configMoChangeEvent

This example shows how to return change events on the specified managed object.

Request Syntax

<xs:element name="configMoChangeEvent" type="configMoChangeEvent" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configMoChangeEvent" mixed="true">
            <xs:all>
                <xs:element name="inConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inEid" type="xs:unsignedLong"/>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<configMoChangeEvent
	cookie=""
	commCookie=""
	srcExtSys="10.193.33.120"
	destExtSys="10.193.33.120"
	srcSvc="service-reg_dme"
	destSvc="sam_extXMLApi"
	inEid="71449">
	<inConfig>
		<extpolRegistry
			dn="extpol/reg"
			lastPollTs="2010-11-12T20:33:51.071"
			status="modified"/>
	</inConfig>
</configMoChangeEvent>
 
   

Response

Event (12:35:20:675):
<eventSendHeartbeat 
	cookie="0/0/0/2a74" 
	commCookie="" 
	srcExtSys="0.0.0.0" 
	destExtSys="0.0.0.0" 
	srcSvc="" destSvc="" 
	response="yes" 
	outSystemTime="2010-11-12T20:34:19.630"> 
</eventSendHeartbeat>
 
   
Event (12:35:20:690):
<eventSendHeartbeat 
	cookie="0/0/0/2a74" 
	commCookie="" 
	srcExtSys="0.0.0.0" 
	destExtSys="0.0.0.0" 
	srcSvc="" destSvc="" 
	response="yes" 
	outSystemTime="2010-11-12T20:34:19.630"> 
</eventSendHeartbeat>

configResolveChildren

This example shows how to retrieve 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:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inDn" type="referenceObject"/>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="classId" type="namingClassId"/>
        </xs:complexType>

Response Syntax

<xs:element name="configResolveChildren" type="configResolveChildren" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveChildren" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configSet" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configResolveChildren
	cookie="<real_cookie>"
	classId="aaaUser"
	inDn="sys/user-ext"
	inHierarchical="false">
    <inFilter>
    </inFilter>
</configResolveChildren>
 
   

Response

<configResolveChildren 
	cookie="<real_cookie>" 
	commCookie="11/15/0/2a59" 
	srcExtSys="10.193.33.120" 
	destExtSys="10.193.33.120" 
	srcSvc="sam_extXMLApi" 
	destSvc="mgmt-controller_dme" 
	response="yes" 
	classId="aaaUser">
	<outConfigs>
		<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"/>
	</outConfigs>
</configResolveChildren>
 
   

configResolveClass

This example shows how to return the requested managed object in a given class. If inHierarchical = true, the object contains children.

Request Syntax

<xs:element name="configResolveClass" type="configResolveClass" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveClass" mixed="true">
            <xs:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="classId" type="namingClassId"/>
        </xs:complexType>

Response Syntax

<xs:element name="configResolveClass" type="configResolveClass" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveClass" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configSet" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configResolveClass
	cookie="<real_cookie>"
	classId="pkiEp"
	inHierarchical="false">
	<inFilter>
	</inFilter>
</configResolveClass>
 
   

Response

<configResolveClass 
	cookie="<real_cookie>" 
	commCookie="11/15/0/2a5b" 
	srcExtSys="10.193.33.120" 
	destExtSys="10.193.33.120" 
	srcSvc="sam_extXMLApi" 
	destSvc="mgmt-controller_dme" 
	response="yes" 
	classId="pkiEp">
	<outConfigs>
		<pkiEp descr="" 
			dn="sys/pki-ext" 
			intId="10037" 
			name=""/>
	</outConfigs>
</configResolveClass>

configResolveClasses

This example shows how to return requested managed objects in several classes. If inHierarchical = true, the object contains children.

Request Syntax

<xs:element name="configResolveClasses" type="configResolveClasses" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveClasses" mixed="true">
            <xs:all>
                <xs:element name="inIds" type="classIdSet" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

Response Syntax

<xs:element name="configResolveClasses" type="configResolveClasses" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveClasses" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configSet" minOccurs="0"/>
            </xs:all>
            <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:complexType>

Examples

Request

<configResolveClasses 
	cookie="<real_cookie>"  
	inHierarchical="false">
	<inIds>
		<Id value="computeBlade"/>
		<Id value="equipmentChassis"/>
	</inIds>
</configResolveClasses> 

Response

(This is an abbreviated response.)

<configResolveClasses 
	cookie="<real_cookie>" 
	response="yes"> 
	<outConfigs>
		<computeBlade
			adminPower="policy"
			adminState="in-service"
			dn="sys/chassis-1/blade-1"
			.
			.
		<computeBlade
			adminPower="policy"
			adminState="in-service"
			dn="sys/chassis-1/blade-3"
			.
			.
		<computeBlade
			adminPower="policy"
			adminState="in-service"
			dn="sys/chassis-1/blade-5"
			.
			.
		<computeBlade
			adminPower="policy"
			adminState="in-service"
			dn="sys/chassis-1/blade-7"			.
			.
			.
		<equipmentChassis
			adminState="acknowledged"
			configState="ok"
			.
			.
	</outConfigs>
</configResolveClasses>

configResolveDn

This example shows how to retrieve a single managed object for a specified DN.

Request Syntax

<xs:element name="configResolveDn" type="configResolveDn" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveDn" mixed="true">
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

Response Syntax

<xs:element name="configResolveDn" type="configResolveDn" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveDn" mixed="true">
            <xs:all>
                <xs:element name="outConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configResolveDn 
	cookie="<real_cookie>" 
	dn="vmmEp/vm-mgr-vcenter1" />
 
   

Response

<configResolveDn dn="vmmEp/vm-mgr-vcenter1"
	cookie="<real_cookie>"
	commCookie="9/15/0/1c0d"
	srcExtSys="10.193.34.70"
	destExtSys="10.193.34.70"
	srcSvc="sam_extXMLApi"
	destSvc="vm-mgr_dme"
	response="yes">
	<outConfig>
		<vmManager
			adminState="enable"
			descr=""
			dn="vmmEp/vm-mgr-vcenter1"
			fltAggr="0"
			fsmDescr="AG registration with 
vCenter(FSM:sam:dme:VmManagerRegisterWithVCenter)"
			fsmPrev="RegisterWithVCenterRegistering"
			fsmProgr="13"
			fsmRmtInvErrCode="none"
			fsmRmtInvErrDescr=""
			fsmRmtInvRslt=""
			fsmStageDescr="AG registration with 
vCenter(FSM-STAGE:sam:dme:VmManagerRegisterWithVCenter:Registering)"
			fsmStamp="2010-11-11T21:37:15.696"
			fsmStatus="RegisterWithVCenterRegistering"
			fsmTry="1"
			hostName="savbu-vpod-dev-31.cisco.com"
			intId="21959"
			name="vcenter1"
			operState="unknown"
			stateQual=""
			type="vmware"
			version=""/>
	</outConfig>
</configResolveDn>

configResolveDns

This example shows how to retrieve managed objects for a list of DNs.

Request Syntax

<xs:element name="configResolveDns" type="configResolveDns" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveDns" mixed="true">
            <xs:all>
                <xs:element name="inDns" type="dnSet" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

Response Syntax

<xs:element name="configResolveDns" type="configResolveDns" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveDns" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configSet" minOccurs="0"/>
                <xs:element name="outUnresolved" type="dnSet" minOccurs="0"/>
            </xs:all>
            <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:complexType>

Examples

Request

<configResolveDns 
	cookie="<real_cookie>" 
	inHierarchical="false">
	<inDns>
		<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" />
	</inDns>
</configResolveDns> 

Response

<configResolveDns 
	cookie="<real_cookie>" 
	response="yes"> 
	<outConfigs>
		<processorUnit
			arch="Xeon"
			cores="4"
			dn="sys/chassis-1/blade-1/board/cpu-1"
			id="1"
			model="Intel(R) Xeon(R) CPU E5520 @ 2.27GHz"
			operState="operable"
			operability="operable"
			perf="not-supported"
			power="not-supported"
			presence="equipped"
			revision="0"
			serial=""
			socketDesignation="CPU1"
			speed="2.266000"
			stepping="5"
			thermal="ok"
			threads="8"
			vendor="Intel(R) Corporation"
			voltage="ok"/> 
		<equipmentChassis
			adminState="acknowledged"
			configState="ok"
			connPath="A,B"
			connStatus="A,B"
			dn="sys/chassis-1"
			fabricEpDn="fabric/server/chassis-1"
			fltAggr="2"
			fsmDescr=""
			fsmPrev="PsuPolicyConfigSuccess"
			fsmProgr="100"
			fsmRmtInvErrCode="none"
			fsmRmtInvErrDescr=""
			fsmRmtInvRslt=""
			fsmStageDescr=""
			fsmStamp="2009-09-13T21:34:37"
			fsmStatus="nop"
			fsmTry="0"
			id="1"
			lcTs="1969-12-31T16:00:00"
			managingInst="A"
			model="N20-C6508"
			operQualifier="fabric-conn-problem"
			operState="fabric-conn-problem"
			operability="operable"
			power="ok"
			presence="unknown"
			revision="0"
			serial="FOX1252GG84"
			thermal="ok"
			vendor="Cisco Systems Inc"
			versionHolder="yes"/> 
	</outConfigs>
	<outUnresolved> 
		<dn value="sys/chassis-1/blade-1/board/t-stats"/> 
	</outUnresolved>
</configResolveDns>

configResolveParent

This example shows how to retrieve the parent of the managed object for a specified DN.

Request Syntax

<xs:element name="configResolveParent" type="configResolveParent" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveParent" mixed="true">
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

Response Syntax

<xs:element name="configResolveParent" type="configResolveParent" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="configResolveParent" mixed="true">
            <xs:all>
                <xs:element name="outConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configResolveParent
	cookie="<real_cookie>"
	inHierarchical="false"
	dn="sys/chassis-1/blade-1/adaptor-1">
</configResolveParent> 

Response

<configResolveParent dn="sys/chassis-1/blade-1/adaptor-1" 
	cookie="<real_cookie>"
	response="yes">
	<outConfig>
		<computeBlade
			adminPower="policy"
			adminState="in-service"
			assignedToDn=""
			association="none"
			availability="available"
			availableMemory="10240"
			chassisId="1"
			checkPoint="discovered"
			connPath="A,B"
			connStatus="A,B"
			descr=""
			diagnostics="complete"
			discovery="complete"
			dn="sys/chassis-1/blade-1"
			fltAggr="0"
			fsmDescr=""
			fsmFlags=""
			fsmPrev="DiscoverSuccess"
			fsmProgr="100"
			fsmRmtInvErrCode="none"
			fsmRmtInvErrDescr=""
			fsmRmtInvRslt=""
			fsmStageDescr=""
			fsmStamp="2009-09-23T23:44:30"
			fsmStatus="nop"
			fsmTry="0"
			intId="768052"
			lc="discovered"
			lcTs="1969-12-31T16:00:00"
			managingInst="B"
			model="N20-B6620-1"
			name=""
			numOfAdaptors="1"
			numOfCores="8"
			numOfCpus="2"
			numOfEthHostIfs="2"
			numOfFcHostIfs="0"
			numOfThreads="16"
			operPower="off"
			operQualifier=""
			operState="unassociated"
			operability="operable"
			originalUuid="e3516842-d0a4-11dd-baad-000bab01bfd6"
			presence="equipped"
			revision="0"
			serial="QCI12520024"
			slotId="1"
			totalMemory="10240"
			uuid="e3516842-d0a4-11dd-baad-000bab01bfd6"
			vendor="Cisco Systems Inc"/>
	</outConfig>
</configResolveParent>

configScope

This example shows how to return managed objects and details about their configuration.

Request Syntax

<xs:element name="configScope" type="configScope" substitutionGroup="externalMethod"/>
        <xs:complexType name="configScope" mixed="true">
            <xs:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inClass" type="namingClassId"/>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inRecursive">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
 
   
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

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:all>
            <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"/>
        </xs:complexType>

Examples

Request

<configScope
	dn="org-root"
	cookie="<real_cookie>"
	inClass="orgOrgRes"
	inHierarchical="false"
	inRecursive="false">
	<inFilter>
	</inFilter>
</configScope> 

Response

<configScope dn="org-root" 
	cookie="<real_cookie>" 
	commCookie="2/15/0/2a53" 
	srcExtSys="10.193.33.120" 
	destExtSys="10.193.33.120" 
	srcSvc="sam_extXMLApi" 
	destSvc="service-reg_dme" 
	response="yes">
	<outConfigs>
		<orgOrgCaps 
			dn="org-root/org-caps" 
			org="512" 
			tenant="64"/>
		<orgOrgCounts 
			dn="org-root/org-counter" 
			org="36" 
			tenant="7"/>
	</outConfigs>
</configScope>

eventSendHeartbeat

This example shows how to send an event that 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"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

When the client application subscribes to an event or events using eventSubscribeApps or eventSubscribe, the Cisco VNMC sensd eventSendHeartbeat periodically (default 120 seconds).

Response

<eventSendHeartbeat cookie="0/0/0/2a76" 
	commCookie="" 
	srcExtSys="0.0.0.0" 
	destExtSys="0.0.0.0" 
	srcSvc="" 
	destSvc="" 
	response="yes" 
	outSystemTime="2010-11-12T20:38:19.630"> 
</eventSendHeartbeat>

eventSubscribe

This example shows how to send a subscribe request for activity.

Request Syntax

<xs:element name="eventSubscribe" type="eventSubscribe" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="eventSubscribe" mixed="true">
            <xs:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<eventSubscribe
	cookie="<real_cookie>">
    <inFilter>
    </inFilter>
</eventSubscribe> 

Response

NO RESPONSE OR ACKNOWELDGEMENT.

eventSubscribeApps

This example shows a subscribe request for activity on specified applications. The client application can subscribe to the Cisco VNMC system to receive events from different applications. 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 the Cisco VSG as well, where ip should be the IP address for the Cisco VSG, and type is managed-endpoint.

Request Syntax

<xs:element name="eventSubscribeApps" type="eventSubscribeApps" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="eventSubscribeApps" mixed="true">
            <xs:all>
                <xs:element name="inAppList" type="configSet" minOccurs="0"/>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<eventSubscribeApps
	cookie="<real_cookie>"
	commCookie=""
	srcExtSys="0.0.0.0"
	destExtSys="0.0.0.0"
	srcSvc=""
	destSvc="">
	<inAppList>
		<eventApplication
			ip="10.193.33.101"
			type="service-reg"/>
			<eventApplication
			ip="10.193.33.101"
			type="policy-mgr"/>
		<eventApplication
			ip="10.193.33.101"
			type="mgmt-controller"/>
	</inAppList>
	<inFilter>
	</inFilter>
</eventSubscribeApps> 

Response

IF SUCCESSFUL, NO RESPONSE OR ACKNOWELDGEMENT.

faultAckFault

This example shows how to send 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"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<faultAckFault 
	inHierarchical="false" 
	cookie="<real_cookie>" 
	inId="10120" /> 

Response

<faultAckFault
	cookie="<real_cookie>"
	commCookie="5/15/0/6c"
	srcExtSys="10.193.33.214"
	destExtSys="10.193.33.214"
	srcSvc="sam_extXMLApi"
	destSvc="resource-mgr_dme"
	response="yes">
</faultAckFault>

faultAckFaults

This example shows how to send an acknoweldgement when multiple faults are recorded.

Request Syntax

<xs:element name="faultAckFaults" type="faultAckFaults" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="faultAckFaults" mixed="true">
            <xs:all>
                <xs:element name="inIds" type="idSet" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<faultAckFaults 
	cookie="<real_cookie>">
	<inIds>
		<id value="10656"/>
		<id value="10660"/>
	</inIds>
</faultAckFaults>
 
   

Response

<faultAckFaults
	cookie="<real_cookie>"
	commCookie="11/15/0/505"
	srcExtSys="10.193.34.70"
	destExtSys="10.193.34.70"
	srcSvc="sam_extXMLApi"
	destSvc="mgmt-controller_dme"
	response="yes">
</faultAckFaults>

faultResolveFault

This example shows how to send 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"/>
        </xs:complexType>

Response Syntax

<xs:element name="faultResolveFault" type="faultResolveFault" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="faultResolveFault" mixed="true">
            <xs:all>
                <xs:element name="outFault" type="configConfig" minOccurs="0"/>
            </xs:all>
            <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:complexType>

Examples

Request

<faultResolveFault 
	inHierarchical="false" 
	cookie="<real_cookie>" 
	inId="10120" /> 

Response

<faultResolveFault
	cookie="<real_cookie>"
	commCookie="5/15/0/6a"
	srcExtSys="10.193.33.214"
	destExtSys="10.193.33.214"
	srcSvc="sam_extXMLApi"
	destSvc="resource-mgr_dme"
	response="yes">
	<outFault>
		<faultInst
			ack="yes"
			cause="empty-pool"
			changeSet=""
			code="F0135"
			created="2010-11-19T11:02:41.568"
			descr="Virtual Security Gateway pool default is empty"
			dn="org-root/fwpool-default/fault-F0135"
			highestSeverity="minor"
			id="10120"
			lastTransition="2010-11-19T11:02:41.568"
			lc=""
			occur="1"
			origSeverity="minor"
			prevSeverity="minor"
			rule="fw-pool-empty"
			severity="minor"
			tags=""
			type="equipment"/>
	</outFault>
</faultResolveFault>

loggingSyncOcns

This example shows how to retrieve 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"/>
        </xs:complexType>

Response Syntax

<xs:element name="loggingSyncOcns" type="loggingSyncOcns" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="loggingSyncOcns" mixed="true">
            <xs:all>
                <xs:element name="outStimuli" type="MethodSet" minOccurs="0"/>
            </xs:all>
            <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:complexType>

Examples

Request

<loggingSyncOcns 
	cookie="<real_cookie>"
	inFromOrZero="0"  
	inToOrZero="4567000"/> 

Response

List of event IDs.

methodVessel

This example shows 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:all>
                <xs:element name="inStimuli" type="MethodSet" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
        </xs:complexType>

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"/>
        </xs:complexType>

Examples

Request

<methodVessel
	cookie=""
	commCookie=""
	srcExtSys="10.193.77.66"
	destExtSys="10.193.77.66"
	srcSvc="resource-mgr_dme"
	destSvc="sam_extXMLApi">
	<inStimuli>
		<configMoChangeEvent
			cookie=""
			commCookie=""
			srcExtSys="10.193.77.66"
			destExtSys="10.193.77.66"
			srcSvc="resource-mgr_dme"
			destSvc="sam_extXMLApi"
			inEid="434920">
		<inConfig>
			<resstateNormalizedHealthState
				dn="fw/inst-1010/normalized-health-state"
				operState="config"
				status="modified"/>
		</inConfig>
	</configMoChangeEvent>
 
   
	<configMoChangeEvent
		cookie=""
		commCookie=""
		srcExtSys="10.193.77.66"
		destExtSys="10.193.77.66"
		srcSvc="resource-mgr_dme"
		destSvc="sam_extXMLApi"
		inEid="434921">
		<inConfig>
			<fwComputeFirewall
				configState="applying"
				dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340"
				status="modified"/>
		</inConfig>
	</configMoChangeEvent>
 
   
	<configMoChangeEvent
		cookie=""
		commCookie=""
		srcExtSys="10.193.77.66"
		destExtSys="10.193.77.66"
		srcSvc="resource-mgr_dme"
		destSvc="sam_extXMLApi"
		inEid="434922">
		<inConfig>
			<faultInst
				dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340/fault-F0117"
				lc="flapping,soaking-clear"
				status="modified"/>
		</inConfig>
	</configMoChangeEvent>
	</inStimuli>
</methodVessel>
Event (10:32:2:807):
 
   
<methodVessel
cookie=""
commCookie=""
srcExtSys="10.193.77.66"
destExtSys="10.193.77.66"
srcSvc="resource-mgr_dme"
destSvc="sam_extXMLApi">
  <inStimuli>
 
   
	<configMoChangeEvent
		cookie=""
		commCookie=""
		srcExtSys="10.193.77.66"
		destExtSys="10.193.77.66"
		srcSvc="resource-mgr_dme"
		destSvc="sam_extXMLApi"
		inEid="434923">
	<inConfig>
		<eventLog
			dn="event-log"
			size="1412"
			status="modified"/>
	</inConfig>
	</configMoChangeEvent>
 
   
	<configMoChangeEvent
		cookie=""
		commCookie=""
		srcExtSys="10.193.77.66"
		destExtSys="10.193.77.66"
		srcSvc="resource-mgr_dme"
		destSvc="sam_extXMLApi"
		inEid="434924">
		<inConfig>
			<eventRecord
				affected="fw/inst-1009"
				cause="transition"
				changeSet=""
				code="E4194509"
				created="2010-11-19T18:32:02.622"
				descr="[FSM:STAGE:REMOTE-ERROR]: WRONG STATE:Result: not-applicable Code: 
unspecified Message: (sam:dme:FwInstanceAssociate:configPA)"
				dn="event-log/83081"
				id="83081"
				ind="state-transition"
				severity="info"
				status="created"
				trig="special"
				txId="219376"
				user="internal"/>
		</inConfig>
	</configMoChangeEvent>
	</inStimuli>
</methodVessel>
 
   

Response

<methodVessel
	cookie=""
	commCookie=""
	srcExtSys="10.193.77.66"
	destExtSys="10.193.77.66"
	srcSvc="resource-mgr_dme"
	destSvc="sam_extXMLApi">
	<inStimuli>
		<configMoChangeEvent
			cookie=""
			commCookie=""
			srcExtSys="10.193.77.66"
			destExtSys="10.193.77.66"
			srcSvc="resource-mgr_dme"
			destSvc="sam_extXMLApi"
			inEid="434925">
			<inConfig>
				<resstateNormalizedHealthState
				dn="fw/inst-1010/normalized-health-state"
				operState="config-failure"
				status="modified"/>
			</inConfig>
		</configMoChangeEvent>
 
   
	<configMoChangeEvent
		cookie=""
		commCookie=""
		srcExtSys="10.193.77.66"
		destExtSys="10.193.77.66"
		srcSvc="resource-mgr_dme"
		destSvc="sam_extXMLApi"
		inEid="434926">
		<inConfig>
			<fwComputeFirewall
			configState="failed-to-apply"
			dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340"
			status="modified"/>
		</inConfig>
	</configMoChangeEvent>
 
   
	<configMoChangeEvent
		cookie=""
		commCookie=""
		srcExtSys="10.193.77.66"
		destExtSys="10.193.77.66"
		srcSvc="resource-mgr_dme"
		destSvc="sam_extXMLApi"
		inEid="434927">
		<inConfig>
			<faultInst
			dn="org-root/org-tenant_d3337/org-dc1/cfw-vsn-d3340/fault-F0117"
			lastTransition="2010-11-19T18:32:02.680"
			lc="flapping"
			status="modified"/>
		</inConfig>
	</configMoChangeEvent>
	</inStimuli>
</methodVessel>

orgResolveElements

Within a specified DN, this example retrieves managed objects that satisfy a query filter and 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, it searches managed objects with specified class and filters.

If inHierarchical = true, all matching objects and descendants are returned. If false, it returns only 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:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inClass" type="namingClassId"/>
            <xs:attribute name="inSingleLevel">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
		</xs:complexType>

Response Syntax

<xs:element name="orgResolveElements" type="orgResolveElements" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="orgResolveElements" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_5">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
            <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"/>
		</xs:complexType>

Examples

Request

<orgResolveElements
	dn="org-root/org-Cola"
	cookie="<real_cookie>"
	commCookie="7/15/0/19"
	srcExtSys="10.193.33.221"
	destExtSys="10.193.33.221"
	srcSvc="sam_extXMLApi"
	destSvc="policy-mgr_dme"
	inClass="policyPolicySet"
	inSingleLevel="no"
	inHierarchical="no">
	<inFilter>
	</inFilter>
</orgResolveElements> 

Response

<orgResolveElements
	dn="org-root/org-Cola"
	cookie="<real_cookie>"
	commCookie="7/15/0/19"
	srcExtSys="10.193.33.221"
	destExtSys="10.193.33.221"
	srcSvc="sam_extXMLApi"
	destSvc="policy-mgr_dme"
	response="yes"
	errorCode="0"
	errorDescr="">
	<outConfigs>
	 	<pair key="pset-default">
   			<policyPolicySet
   			adminState="enabled"
   			descr="The default Policy Set"
   			dn="org-root/pset-default"
   			intId="10082"
   			name="default"/>
 		</pair>
 		<pair key="pset-myPolicySet3">
   			<policyPolicySet
			adminState="enabled"
	 		descr=""
   			dn="org-root/org-Cola/pset-myPolicySet3"
			intId="12289"
	 		name="myPolicySet3"/>
 		</pair>
 		<pair key="pset-policySetSanity">
   			<policyPolicySet
   			adminState="enabled"
	 		descr=""
   			dn="org-root/org-Cola/pset-policySetSanity"
   			intId="24627"
   			name="policySetSanity"/>
		</pair>
	 	<pair key="pset-pci_compliance_f">
   			<policyPolicySet
			adminState="enabled"
	 		descr=""
   			dn="org-root/pset-pci_compliance_f"
   			intId="24539"
			name="pci_compliance_f"/>
	 	</pair>
		<pair key="pset-pci_compliance_h">
   			<policyPolicySet
			adminState="enabled"
	 		descr=""
   			dn="org-root/pset-pci_compliance_h"
   			intId="24541"
   			name="pci_compliance_h"/>
		</pair>
	</outConfigs>
 </orgResolveElements>

orgResolveInScope

This example shows how the system looks up the organization with the given DN, and (optional) parent organizations recursively to the root. If no organization, an empty map is returned. If found, it searches all pools with specified class and filters.


Note If inSingleLevel = false, the system 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:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inClass" type="namingClassId"/>
            <xs:attribute name="inSingleLevel">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

Response Syntax

<xs:element name="orgResolveInScope" type="orgResolveInScope" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="orgResolveInScope" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_6">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<orgResolveInScope 
	cookie="<real_cookie>"
	dn="org-root/org-Cola"
	inClass="policyVirtualNetworkServiceProfile"
	inHierarchical="true"
	InSingleLevel="false" >
	<inFilter>
		<eq class="policyVirtualNetworkServiceProfile" 
		property="name" 
		value="spsanity" />
	</inFilter>
</orgResolveInScope> 

Response

<orgResolveInScope
	dn="org-root/org-Cola"
	cookie="<real_cookie>"
	commCookie="7/15/0/1c35"
	srcExtSys="10.193.34.70"
	destExtSys="10.193.34.70"
	srcSvc="sam_extXMLApi"
	destSvc="policy-mgr_dme"
	response="yes">
	<outConfigs>
		<pair key="vnsp-spsanity">
			<policyVirtualNetworkServiceProfile
				childAction="deleteNonPresent"
				descr=""
				dn="org-root/org-Cola/vnsp-spsanity"
				intId="82018"
				name="spsanity"
				policySetNameRef="policySetSanity"
				vnspId="41">
			<policyVnspAVPair
				childAction="deleteNonPresent"
				descr=""
				id="1"
				intId="82019"
				name=""
				rn="vnsp-avp-1">
				<policyAttributeValue
					childAction="deleteNonPresent"
					id="1"
					rn="attr-val1"
					value="DEV"/>
				<policyAttributeDesignator
					attrName="dept"
					childAction="deleteNonPresent"
					rn="attr-ref"/>
		 		</policyVnspAVPair>
			</policyVirtualNetworkServiceProfile>
		</pair>
	</outConfigs>
</orgResolveInScope>

orgResolveLogicalParents

This example shows how the system looks up logical parents with the specified DN 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:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

Response Syntax

<xs:element name="orgResolveLogicalParents" type="orgResolveLogicalParents" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="orgResolveLogicalParents" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_7">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<orgResolveLogicalParents
	dn="org-root/org-Cisco/org-HR/zone-clients"
	cookie="<real_cookie>"
	commCookie="7/15/0/12"
	srcExtSys="10.193.33.221"
	destExtSys="10.193.33.221"
	srcSvc="sam_extXMLApi"
	destSvc="policy-mgr_dme"
	inSingleLevel="no"
	inHierarchical="no">
</orgResolveLogicalParents> 

Response

<orgResolveLogicalParents
	dn="org-root/org-Cisco/org-HR/zone-clients"
	cookie="<real_cookie>"
	commCookie="7/15/0/12"
	srcExtSys="10.193.33.221"
	destExtSys="10.193.33.221"
	srcSvc="sam_extXMLApi"
	destSvc="policy-mgr_dme"
	response="yes"
	errorCode="0"
	errorDescr="">
	<outConfigs>
		<pair key="org-root/org-Cisco/zone-clients">
			<policyZone
	 			descr=""
				dn="org-root/org-Cisco/zone-clients"
				intId="24841"
 				name="clients"/>
		</pair>
	</outConfigs>

</orgResolveLogicalParents>

policyEstimateImpact

This example takes a 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).

Policy changes that can impact the MOs include the following:

Modifying a name reference (that is, the resolved name is changed)

On a deletion, another object reference referring to this object may now resolve to a different object with the same name higher up in the tree or may resolve to a default object.

On creation, an object reference can refer to a newly created object. In the response, the outDeleteAllowed parameter indicates if the specified object can be deleted and, in such a case, potential name references referring to this object refer to another object higher up in the tree.

The specified object cannot be deleted if it is a referred object in an object reference and there is no other object in the tree that can override this.

Request Syntax

<!-- 
           - Method: policy:EstimateImpact
         -->
        <xs:element name="policyEstimateImpact" type="policyEstimateImpact" 
substitutionGroup="externalMethod"/>
 
   
        <xs:complexType name="policyEstimateImpact" mixed="true">
            <xs:all>
                <xs:element name="inConfig" type="configConfig" minOccurs="0"/>
            </xs:all>
 
   
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
 
   
        </xs:complexType>
 
   

Response Syntax

<!-- 
           - Method: policyEstimateImpact
         -->
        <xs:element name="policyEstimateImpact" type="policyEstimateImpact" 
substitutionGroup="externalMethod"/>
 
   
        <xs:complexType name="policyEstimateImpact" mixed="true">
            <xs:all>
                <xs:element name="outImpactedMoSet" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_8">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
 
   
            <xs:attribute name="outDeleteAllowed">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
 
   
            <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:complexType>

Examples

Request

<policyEstimateImpact
   cookie="1309385844/5d9899e6-5b5b-4ab0-b12c-cb6e50b5a7db"
   commCookie="7/12/0/1d18"
   srcExtSys="10.193.33.221"
   destExtSys="10.193.33.221"
   srcSvc="sam_extXMLApi"
   destSvc="policy-mgr_dme">
     <inConfig>
     <policyRuleBasedPolicy
     dn="org-root/org-tenant0/pset-myPolicySet1"
     status="deleted,modified"/>
     </inConfig>
   </policyEstimateImpact>
 
   

Response

<policyEstimateImpact
 cookie="1309385844/5d9899e6-5b5b-4ab0-b12c-cb6e50b5a7db"
 commCookie="7/12/0/1d18"
 srcExtSys="10.193.33.221"
 destExtSys="10.193.33.221"
 srcSvc="sam_extXMLApi"
 destSvc="policy-mgr_dme"
 response="yes"
 errorCode="0"
 errorDescr=""
 outDeleteAllowed="yes">
   <outImpactedMoSet>
 <pair key="org-root/org-tenant0/vnsp-VNSP1">
   <policyVirtualNetworkServiceProfile
   descr=""
   dn="org-root/org-tenant0/vnsp-VNSP1"
   intId="40930"
   name="VNSP1"
   policySetNameRef="myPolicySet1"
   vnspId="17"/>
 </pair>
   </outImpactedMoSet>
 </policyEstimateImpact>

poolResolveInScope

This example shows how the system looks up the pool with the given DN,, and (optional) parent pools recursively to the root. If no pool exists, an empty map is returned. If found, the system searches all pools with the specified class and filters.


Note If inSingleLevel = false, the system 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:all>
                <xs:element name="inFilter" type="filterFilter" minOccurs="0"/>
            </xs:all>
            <xs:attribute name="inClass" type="namingClassId"/>
            <xs:attribute name="inSingleLevel">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="inHierarchical">
                <xs:simpleType>
                    <xs:union memberTypes="xs:boolean">
                         <xs:simpleType>
                             <xs:restriction base="xs:string">
                                 <xs:enumeration value="no"/>
                                 <xs:enumeration value="yes"/>
                             </xs:restriction>
                         </xs:simpleType>
                    </xs:union>
                </xs:simpleType>
            </xs:attribute>
            <xs:attribute name="cookie" type="xs:string"/>
            <xs:attribute name="response" type="YesOrNo"/>
            <xs:attribute name="dn" type="referenceObject"/>
        </xs:complexType>

Response Syntax

<xs:element name="poolResolveInScope" type="poolResolveInScope" 
substitutionGroup="externalMethod"/>
        <xs:complexType name="poolResolveInScope" mixed="true">
            <xs:all>
                <xs:element name="outConfigs" type="configMap" minOccurs="0">
                    <xs:unique name="unique_map_key_9">
                         <xs:selector xpath="pair"/>
                         <xs:field xpath="@key"/>
                    </xs:unique>
                </xs:element>
            </xs:all>
            <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"/>
        </xs:complexType>

Examples

Request

<poolResolveInScope 
	dn="org-root/org-Cisco"
	cookie="<real_cookie>"
	class=fwPool /> 

Response

<poolResolveInScope
	dn="org-root/org-Cisco"
	cookie="<real_cookie>"
	commCookie="5/15/0/5bf"
	srcExtSys="10.193.33.221"
	destExtSys="10.193.33.221"
	srcSvc="sam_extXMLApi"
	destSvc="resource-mgr_dme"
	response="yes">
	<outConfigs>
		<pair key="fwpool-default">
			<fwPool
				assigned="0"
				descr="Default Pool of Virtual Security Gateway resources"
				dn="org-root/fwpool-default"
				fltAggr="65536"
				id="	1"
				intId="10065"
				name="default"
				size="0"/>
		</pair>
</poolResolveInScope>