Cisco VNMC XML API メソッド
これらのメソッドは、GUI コンソールからも呼び出されます。ここでは、API メソッド、構文(要求および応答)、使用例について説明します。Cisco VNMC の API メソッドは次のように定義されます。
aaaGetRemoteUserRoles
この例は、リモート ロケーションのユーザ特権を返します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
inRemoteUserName="adminuser"
応答
commCookie="11/15/0/2964"
srcExtSys="10.193.33.109"
destExtSys="10.193.33.109"
destSvc="mgmt-controller_dme"
outRemoteUserPriv="admin">
aaaGetUserLocales
この例は、認可されたユーザ ロケーションのリストを返します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
commCookie="11/15/0/2962"
srcExtSys="10.193.33.109"
destExtSys="10.193.33.109"
destSvc="mgmt-controller_dme"
outUserLocales="TestSanity">
aaaKeepAlive
この例では、デフォルトのセッション時間が経過し、メソッド呼び出しの後で同じ Cookie が使用されるまでセッションがアクティブなままになります。
要求構文
<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: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"/>
例
要求
cookie="<real_cookie>" />
応答
commCookie="11/15/0/2969"
srcExtSys="10.193.33.109"
destExtSys="10.193.33.109"
destSvc="mgmt-controller_dme"
aaaLogin
この例は、セッションを開始するために必要で、クライアントと VNMC 間で認証された HTTPS セッションを確立するログイン プロセスを示しています。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
outCookie="<real_cookie>"
outVersion="1.0(0.39938)">
aaaLogout
次に、現在のセッションを終了するログアウト プロセスの例を示します。デフォルトのセッション時間が経過すると、このプロセスは自動的に呼び出されます。
要求構文
<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: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"/>
aaaRefresh
セッションはユーザ アクティビティによってアクティブに保つことができます(デフォルトのセッション時間枠内)。デフォルトでは、アクティビティがない時点から 7200 秒カウントダウンされます。7200 秒が経過すると、Cisco VNMC はスリープ モードを開始し、再度サインインを要求します。これにより、カウント ダウンが再起動されます。セッションは同じセッション ID を使用し続けます。
(注) このメソッドを使用すると、以前の Cookie の有効期限が切れ、新しい Cookie が発行されます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
inCookie="<real_cookie>"/>
応答
commCookie="" srcExtSys="0.0.0.0"
outCookie="<real_cookie>"
configConfFiltered
次に、設定されたポリシーに基づいて、データおよびアクティビティが制限されている例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
descr="HR (Human Resources- new Descr)"/>
応答
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
次に、単一のサブツリー(DN など)で、指定された管理対象オブジェクトを設定する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
basedn="dc=pasadena,dc=cisco,dc=com"
filter="sAMAccountName=$userid"
応答
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
次に、設定されたポリシーに基づいて、管理対象オブジェクトのグループを設定する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
(注) orgDataCenter(org-root/org-Cisco および org-root/org-Cola 下)の descr プロパティが変更されます。descr プロパティは暗黙的でないため、変更できます。暗黙的な場合、変更は適用されず、新しい orgDataCenter が作成されます。
要求
<dn value="org-root/org-Cisco" />
<dn value="org-root/org-Cola" />
descr="HR (Human Resources)"/>
応答
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
次に、複数のサブツリーで DN を使用して管理対象オブジェクトを設定する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
<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>
応答
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
次に、識別名を検索し、クラス ID でソートされた識別名を返す例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
cookie="<real_cookie>" />
応答
<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
次に、指定された管理対象オブジェクトに対する変更イベントを返す例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
lastPollTs="2010-11-12T20:33:51.071"
応答
outSystemTime="2010-11-12T20:34:19.630">
outSystemTime="2010-11-12T20:34:19.630">
configResolveChildren
次に、管理対象情報ツリーで特定の DN 下にある管理対象オブジェクトの子を取得する例を示します。返される子の数を減らすためにフィルタを使用できます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
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
次に、該当するクラスの要求された管理対象オブジェクトを返す例を示します。inHierarchical が true の場合は、オブジェクトに子が含まれます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
commCookie="11/15/0/2a5b"
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
destSvc="mgmt-controller_dme"
configResolveClasses
次に、複数のクラスの要求された管理対象オブジェクトを返す例を示します。inHierarchical が true の場合は、オブジェクトに子が含まれます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
<Id value="computeBlade"/>
<Id value="equipmentChassis"/>
応答
(この応答は、省略されています)。
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
次に、指定された DN について単一の管理対象オブジェクトを取得する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
dn="vmmEp/vm-mgr-vcenter1" />
応答
<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
次に、DN のリストについて管理対象オブジェクトを取得する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
<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" />
応答
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
次に、指定された DN について管理対象オブジェクトの親を取得する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
dn="sys/chassis-1/blade-1/adaptor-1">
応答
<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
次に、管理対象オブジェクトとその設定に関する詳細を返す例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
<configScope dn="org-root"
srcExtSys="10.193.33.120"
destExtSys="10.193.33.120"
destSvc="service-reg_dme"
dn="org-root/org-counter"
eventSendHeartbeat
次に、現在のセッションがまだアクティブであることを示すイベントを送信する例を示します。
要求構文
<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: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"/>
例
要求
クライアント アプリケーションが eventSubscribeApps または eventSubscribe を使用してイベントをサブスクライブする場合、Cisco VNMC は eventSendHeartbeat を定期的(デフォルトでは 120 秒)に送信します。
応答
<eventSendHeartbeat cookie="0/0/0/2a76"
outSystemTime="2010-11-12T20:38:19.630">
eventSubscribe
次に、アクティビティに対するサブスクライブ要求を送信する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
NO RESPONSE OR ACKNOWELDGEMENT.
eventSubscribeApps
次に、指定されたアプリケーションのアクティビティに対するサブスクライブ要求の例を示します。クライアント アプリケーションは、さまざまなアプリケーションからイベントを受け取るために Cisco VNMC システムをサブスクライブできます。eventApplication では、ip はアプリケーション(DME)が実行されている VM の IP アドレスです。クライアント アプリケーションは Cisco VSG からのイベントも受け取るようサブスクライブできます。この場合、ip は Cisco VSG の IP アドレスである必要があり、タイプは管理対象エンドポイントです。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
IF SUCCESSFUL, NO RESPONSE OR ACKNOWELDGEMENT.
faultAckFault
次に、障害が記録されたときに確認応答を送信する例を示します。
要求構文
<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: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"/>
例
要求
応答
srcExtSys="10.193.33.214"
destExtSys="10.193.33.214"
destSvc="resource-mgr_dme"
faultAckFaults
次に、複数の障害が記録されたときに確認応答を送信する例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
destExtSys="10.193.34.70"
destSvc="mgmt-controller_dme"
faultResolveFault
次に、障害が解決されたときに応答を送信する例を示します。
要求構文
<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: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"/>
例
要求
応答
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
次に、DME からイベント ID を取得する例を示します。
要求構文
<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: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"/>
methodVessel
次に、単一のペイロードに複数の configMoChangeEvent を含むバッチ イベント通知の例を示します。
要求構文
<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"/>
応答構文
<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"/>
例
要求
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)"
応答
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
この例では、指定された DN 内で、クエリー フィルタを満たす管理対象オブジェクトが取得され、組織(オプションでは子組織)で開始された管理対象オブジェクトが検索されます。
この DN を持つ組織がない場合は、空のマップが返されます。この DN を持つ組織がある場合は、指定されたクラスとフィルタで管理対象オブジェクトが検索されます。
inHierarchical が true の場合は、一致するすべてのオブジェクトとその子孫が返されます。false の場合は、一致するオブジェクトだけが返されます。inSingleLevel が true の場合は、検索が組織レベルで停止します。false の場合は、子組織を含めます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
inClass="policyPolicySet"
応答
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
次に、システムが、該当する DN を持つ組織と親組織(オプション)をルートまで再帰的に検索する例を示します。組織がない場合は、空のマップが返されます。組織がある場合は、指定されたクラスとフィルタですべてのプールが検索されます。
(注) inSingleLevel が false の場合は、親組織が、ルート ディレクトリまで検索されます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
inClass="policyVirtualNetworkServiceProfile"
<eq class="policyVirtualNetworkServiceProfile"
応答
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
この例は、システムが、指定された DN を持つ論理的な親をルート ディレクトリまでどのように検索するかを示しています。
要求構文
<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"/>
応答構文
<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"/>
例
要求
<orgResolveLogicalParents
dn="org-root/org-Cisco/org-HR/zone-clients"
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
</orgResolveLogicalParents>
応答
<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
この例では、管理対象オブジェクト(MO)が取得され、この変更により影響を受ける MO のリストが返されます。これは、ポリシー変更(作成、変更、または削除)の影響度を推定するために使用します。
MO に影響を与える可能性があるポリシー変更は次のとおりです。
• 名前参照が変更されています(つまり、解決された名前が変更されます)。
• 削除時に、このオブジェクトを参照する別のオブジェクト参照を、ツリーの上部にある同じ名前の異なるオブジェクト(または、デフォルトのオブジェクト)に解決できるようになりました。
• 作成時に、オブジェクト参照は新しく作成されたオブジェクトを参照できます。応答では、outDeleteAllowed パラメータは、指定されたオブジェクトを削除できるかどうかを示します。削除できる場合は、このオブジェクトを参照する名前参照はツリーの上部の別のオブジェクトを参照します。
• 指定されたオブジェクトがオブジェクト参照の参照されたオブジェクトであり、これをオーバーライドする他のオブジェクトがツリーにない場合は、指定されたオブジェクトを削除できません。
要求構文
- Method: policy:EstimateImpact
<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"/>
応答構文
- Method: policyEstimateImpact
<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="outDeleteAllowed">
<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="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
例
要求
cookie="1309385844/5d9899e6-5b5b-4ab0-b12c-cb6e50b5a7db"
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
destSvc="policy-mgr_dme">
dn="org-root/org-tenant0/pset-myPolicySet1"
status="deleted,modified"/>
応答
cookie="1309385844/5d9899e6-5b5b-4ab0-b12c-cb6e50b5a7db"
srcExtSys="10.193.33.221"
destExtSys="10.193.33.221"
<pair key="org-root/org-tenant0/vnsp-VNSP1">
<policyVirtualNetworkServiceProfile
dn="org-root/org-tenant0/vnsp-VNSP1"
policySetNameRef="myPolicySet1"
poolResolveInScope
次に、システムが、該当する DN があるプールと親プール(オプション)をルートまで再帰的に検索する例を示します。プールがない場合は、空のマップが返されます。プールがある場合は、指定されたクラスとフィルタですべてのプールが検索されます。
(注) inSingleLevel が false の場合は、親プールがルート ディレクトリまで検索されます。
要求構文
<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"/>
応答構文
<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"/>
例
要求
応答
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"