Querying Patterns
Querying a Pattern to Match (AAA|TACACS|RADIUS)
Querying a Pattern to Match (AAA|TACACS|RADIUS)
GET http://<IP_Address>/api/mo/sys/userext.json?rsp-subtree=full&rsp-prop-include=config-only
{
"totalCount": "1",
"imdata": [
{
"aaaUserEp": {
"attributes": {
"descr": "",
"dn": "sys/userext",
"name": "rootep",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"pwdMaxLength": "127",
"pwdMinLength": "8",
"pwdSecureMode": "yes",
"pwdStrengthCheck": "yes",
"svcPwdRecovery": "yes"
},
"children": [
{
"aaaUser": {
"attributes": {
"accountStatus": "active",
"allowExpired": "no",
"clearPwdHistory": "no",
"descr": "",
"email": "",
"expiration": "never",
"expires": "no",
"firstName": "",
"lastName": "",
"name": "admin",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"phone": "",
"pwdLifeTime": "no-password-expire",
"rn": "user-admin",
"unixUserId": "0"
},
"children": [
{
"aaaUserDomain": {
"attributes": {
"descr": "",
"name": "all",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "userdomain-all"
},
"children": [
{
"aaaUserRole": {
"attributes": {
"descr": "",
"name": "network-admin",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"privType": "noDataPriv",
"rn": "role-network-admin"
}}}]}}]}},{
"aaaRadiusEp": {
"attributes": {
"deadtime": "0",
"descr": "",
"key": "",
"keyEnc": "0",
"loggingLevel": "Error",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"retries": "1",
"rn": "radiusext",
"srcIf": "unspecified",
"timeout": "5"
},
"children": [
{
"aaaRadiusProviderGroup": {
"attributes": {
"deadtime": "0",
"descr": "",
"name": "radius",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "radiusprovidergroup-radius",
"srcIf": "unspecified",
"vrf": "default"
}}}]}},{
"pkiEp": {
"attributes": {
"descr": "",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "pkiext"
},
"children": [
{
"pkiDebugPluginChallenge": {
"attributes": {
"descr": "",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "dbgplgch"
}}},{
"pkiWebTokenData": {
"attributes": {
"descr": "",
"maximumValidityPeriod": "24",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "webtokendata",
"sessionRecordFlags": "login,logout,refresh",
"uiIdleTimeoutSeconds": "1200",
"webtokenTimeoutSeconds": "600"
}}},{
"pkiCsyncSharedKey": {
"attributes": {
"descr": "",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "csyncsharedkey"
}}}]}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "dev-ops",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-dev-ops",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-11",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-11",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-12",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-12",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "network-admin",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "admin",
"resetToFactory": "no",
"rn": "role-network-admin",
"rolePrivType": "writePriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-6",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-6",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "nxdb-operator",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "operator",
"resetToFactory": "no",
"rn": "role-nxdb-operator",
"rolePrivType": "readPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-1",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-1",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-7",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-7",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "vdc-admin",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "admin",
"resetToFactory": "no",
"rn": "role-vdc-admin",
"rolePrivType": "writePriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-9",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-9",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-4",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-4",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-14",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-14",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "network-operator",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "operator",
"resetToFactory": "no",
"rn": "role-network-operator",
"rolePrivType": "readPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "vdc-operator",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "operator",
"resetToFactory": "no",
"rn": "role-vdc-operator",
"rolePrivType": "readPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-5",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-5",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-15",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-15",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-8",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-8",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-3",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-3",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "nxdb-admin",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "admin",
"resetToFactory": "no",
"rn": "role-nxdb-admin",
"rolePrivType": "writePriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-13",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-13",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-0",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-0",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-10",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-10",
"rolePrivType": "noDataPriv"
}}},{
"aaaRole": {
"attributes": {
"allowedVLAN": "",
"allowedVRF": "",
"denyIntf": "no",
"denyVLAN": "no",
"denyVRF": "no",
"descr": "",
"name": "priv-2",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"priv": "",
"resetToFactory": "no",
"rn": "role-priv-2",
"rolePrivType": "noDataPriv"
}}},{
"aaaDomain": {
"attributes": {
"descr": "",
"name": "all",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "domain-all"
}}},{
"aaaPwdProfile": {
"attributes": {
"changeCount": "2",
"changeDuringInterval": "enable",
"changeInterval": "48",
"descr": "",
"expirationWarnTime": "15",
"historyCount": "5",
"name": "",
"noChangeInterval": "24",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "pwdprofile"
}}},{
"aaaPreLoginBanner": {
"attributes": {
"descr": "",
"guiMessage": "",
"message": "Welcome",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "preloginbanner"
}}},{
"aaaAuthRealm": {
"attributes": {
"defRolePolicy": "assign-default-role",
"descr": "",
"loggingLevel": "Error",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"radDirectedReq": "no",
"rn": "authrealm",
"tacDirectedReq": "no"
},
"children": [
{
"aaaDefaultAcc": {
"attributes": {
"accMethodNone": "no",
"descr": "",
"localRbac": "yes",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"realm": "local",
"rn": "defaultacc"
}}},{
"aaaDefaultAuth": {
"attributes": {
"authProtocol": "pap",
"descr": "",
"errEn": "no",
"fallback": "yes",
"local": "yes",
"name": "",
"none": "no",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"realm": "local",
"rn": "defaultauth"
}}},{
"aaaPkiSSHCertificate": {
"attributes": {
"descr": "",
"local": "no",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"realm": "local",
"rn": "pkisshcert"
}}},{
"aaaConsoleAuth": {
"attributes": {
"authProtocol": "pap",
"descr": "",
"errEn": "no",
"fallback": "yes",
"local": "no",
"name": "",
"none": "no",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "radius",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"realm": "local",
"rn": "consoleauth"
}}},{
"aaaPkiSSHPublicKey": {
"attributes": {
"descr": "",
"local": "no",
"name": "",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"realm": "local",
"rn": "pkisshpubkey"
}}},{
"aaaDefaultAuthor": {
"attributes": {
"authorMethodNone": "no",
"cmdType": "config",
"descr": "",
"localRbac": "yes",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"rn": "defaultauthor-config"
}}},{
"aaaDefaultAuthor": {
"attributes": {
"authorMethodNone": "no",
"cmdType": "exec",
"descr": "",
"localRbac": "yes",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"rn": "defaultauthor-exec"
}}},{
"aaaConsoleAuthor": {
"attributes": {
"authorMethodNone": "no",
"cmdType": "config",
"descr": "",
"localRbac": "yes",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"rn": "consoleauthor-config"
}}},{
"aaaConsoleAuthor": {
"attributes": {
"authorMethodNone": "no",
"cmdType": "exec",
"descr": "",
"localRbac": "yes",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"providerGroup": "",
"providerGroup2": "",
"providerGroup3": "",
"providerGroup4": "",
"providerGroup5": "",
"providerGroup6": "",
"providerGroup7": "",
"providerGroup8": "",
"rn": "consoleauthor-exec"
}}}]}}]}}]}
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/userext-items
<userext-items>
<authrealm-items>
<aaagroup-items>
<AaaServerGroup-list>
<name>radius</name>
<protocol>radius</protocol>
</AaaServerGroup-list>
</aaagroup-items>
<consoleauth-items>
<authProtocol>pap</authProtocol>
<errEn>false</errEn>
<fallback>yes</fallback>
<local>no</local>
<none>no</none>
<providerGroup>radius</providerGroup>
<realm>local</realm>
</consoleauth-items>
<consoleauthor-items>
<ConsoleAuthor-list>
<cmdType>config</cmdType>
<authorMethodNone>false</authorMethodNone>
<localRbac>true</localRbac>
<name>Author</name>
<realm>tacacs</realm>
</ConsoleAuthor-list>
<ConsoleAuthor-list>
<cmdType>exec</cmdType>
<authorMethodNone>false</authorMethodNone>
<localRbac>true</localRbac>
<name>Author</name>
<realm>tacacs</realm>
</ConsoleAuthor-list>
</consoleauthor-items>
<defRolePolicy>assign-default-role</defRolePolicy>
<defaultacc-items>
<accMethodNone>false</accMethodNone>
<localRbac>true</localRbac>
<name>Accounting</name>
<realm>local</realm>
</defaultacc-items>
<defaultauth-items>
<authProtocol>pap</authProtocol>
<errEn>false</errEn>
<fallback>yes</fallback>
<local>yes</local>
<none>no</none>
<realm>local</realm>
</defaultauth-items>
<defaultauthor-items>
<DefaultAuthor-list>
<cmdType>config</cmdType>
<authorMethodNone>false</authorMethodNone>
<localRbac>true</localRbac>
<name>Author</name>
<realm>tacacs</realm>
</DefaultAuthor-list>
<DefaultAuthor-list>
<cmdType>exec</cmdType>
<authorMethodNone>false</authorMethodNone>
<localRbac>true</localRbac>
<name>Author</name>
<realm>tacacs</realm>
</DefaultAuthor-list>
</defaultauthor-items>
<loggingLevel>Error</loggingLevel>
<pkisshcert-items>
<local>false</local>
<realm>local</realm>
</pkisshcert-items>
<pkisshpubkey-items>
<local>false</local>
<realm>local</realm>
</pkisshpubkey-items>
<radDirectedReq>no</radDirectedReq>
<tacDirectedReq>no</tacDirectedReq>
</authrealm-items>
<domain-items>
<Domain-list>
<name>all</name>
</Domain-list>
</domain-items>
<pkiext-items>
<csyncsharedkey-items>
<key/>
</csyncsharedkey-items>
<webtokendata-items>
<hashSecret/>
<initializationVector/>
<key/>
<maximumValidityPeriod>24</maximumValidityPeriod>
<sessionRecordFlags>login,logout,refresh</sessionRecordFlags>
<siteFingerprint/>
<uiIdleTimeoutSeconds>1200</uiIdleTimeoutSeconds>
<webtokenTimeoutSeconds>600</webtokenTimeoutSeconds>
</webtokendata-items>
</pkiext-items>
<preloginbanner-items>
<delimiter/>
<message>Testing Banner 123</message>
</preloginbanner-items>
<pwdMaxLength>127</pwdMaxLength>
<pwdMinLength>8</pwdMinLength>
<pwdSecureMode>yes</pwdSecureMode>
<pwdStrengthCheck>yes</pwdStrengthCheck>
<pwdprofile-items>
<changeCount>2</changeCount>
<changeDuringInterval>enable</changeDuringInterval>
<changeInterval>48</changeInterval>
<expirationWarnTime>15</expirationWarnTime>
<historyCount>5</historyCount>
<noChangeInterval>24</noChangeInterval>
</pwdprofile-items>
<radiusext-items>
<deadtime>0</deadtime>
<keyEnc>0</keyEnc>
<loggingLevel>Error</loggingLevel>
<radiusprovidergroup-items>
<RadiusProviderGroup-list>
<name>radius</name>
<deadtime>0</deadtime>
<snmpIndex>0</snmpIndex>
</RadiusProviderGroup-list>
</radiusprovidergroup-items>
<retries>1</retries>
<timeout>5</timeout>
</radiusext-items>
<role-items>
<Role-list>
<name>dev-ops</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-11</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-12</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>network-admin</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-6</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>nxdb-operator</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-1</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-7</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>vdc-admin</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-9</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-14</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-4</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>vdc-operator</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>network-operator</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-15</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-5</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-8</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-3</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>nxdb-admin</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-13</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-0</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-10</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
<Role-list>
<name>priv-2</name>
<denyIntf>no</denyIntf>
<denyVLAN>no</denyVLAN>
<denyVRF>no</denyVRF>
<resetToFactory>no</resetToFactory>
<roleIsBuiltin>no</roleIsBuiltin>
<rolePrivType>noDataPriv</rolePrivType>
</Role-list>
</role-items>
<rtfabricResUserEp-items>
<RtFabricResUserEp-list>
<tDn>UNRES:uni/fabric/secRelnHolder</tDn>
<tCl>fabricSecRelnHolder</tCl>
</RtFabricResUserEp-list>
</rtfabricResUserEp-items>
<svcPwdRecovery>yes</svcPwdRecovery>
<user-items>
<User-list>
<name>admin</name>
<accountStatus>active</accountStatus>
<allowExpired>no</allowExpired>
<clearPwdHistory>no</clearPwdHistory>
<encPwd/>
<expiration>never</expiration>
<expires>no</expires>
<isSnmpNotify>no</isSnmpNotify>
<oldPwdEncryptType/>
<pwd/>
<pwdEncryptType/>
<pwdLen/>
<pwdLifeTime>no-password-expire</pwdLifeTime>
<pwdSet>true</pwdSet>
<userdomain-items>
<UserDomain-list>
<name>all</name>
<role-items>
<UserRole-list>
<name>network-admin</name>
<privType>noDataPriv</privType>
</UserRole-list>
</role-items>
</UserDomain-list>
</userdomain-items>
</User-list>
</user-items>
</userext-items>
Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).
CLI Output switch# show running | section aaa|tacacs|radius
feature tacacs+
aaa authentication login console group radius
Note: The property information for this example was added in Release 9.3(3).
aaaUserEp Properties
The following table contains information about the aaaUserEp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
pwdMaxLength scalar:Uint16 Password max length RANGE: [0, 65535] pwdMinLength scalar:Uint16 Password min length RANGE: [0, 65535] pwdSecureMode aaa:Boolean
(scalar:Enum8)Password secure-mode SELECTION: pwdStrengthCheck aaa:Boolean
(scalar:Enum8)The password strength check, which specifies if the system enforces the strength of the user password. SELECTION: svcPwdRecovery aaa:Boolean
(scalar:Enum8)Service Password Recovery SELECTION:
aaaUser Properties
The following table contains information about the aaaUser properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values accountStatus aaa:AccountStatus
(scalar:Enum8)The status of the locally-authenticated user account. SELECTION: allowExpired aaa:Boolean
(scalar:Enum8)Allow expired user to be configured SELECTION: clearPwdHistory aaa:Clear
(scalar:Enum8)Allows the administrator to clear the password history of a locally-authenticated user. SELECTION: descr pol:Descr Description of the specified attribute email aaa:Email
(address:Email)The email address of the locally-authenticated user. expiration aaa:Date
(scalar:Date)Account Expiration Date DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z expires aaa:Boolean
(scalar:Enum8)A property to enable an expiration date for the locally-authenticated user account. SELECTION: firstName naming:Name256
(string:Basic)The first name of the locally-authenticated user. lastName naming:Name256
(string:Basic)The last name of the locally-authenticated user. name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
phone aaa:Phone
(address:Phone)The phone number of the locally-authenticated user. pwdLifeTime aaa:PwdLifeTime
(scalar:Uint32)The lifetime of the locally-authenticated user password. rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. unixUserId aaa:UnixUID
(scalar:Uint16)The UNIX identifier of the locally-authenticated user.
aaaUserDomain Properties
The following table contains information about the aaaUserDomain properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaUserRole Properties
The following table contains information about the aaaUserRole properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
privType aaa:UserRolePrivType
(scalar:Enum8)The privilege type for a user role. SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaRadiusEp Properties
The following table contains information about the aaaRadiusEp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values deadtime aaa:TimeMin
(scalar:Uint32)Duration for which non-reachable server is skipped descr pol:Descr Description of the specified attribute key aaa:EncKey
(string:Basic)Global RADIUS server shared secret keyEnc aaa:KeyEnc
(scalar:Enum8)Default key encryption SELECTION: loggingLevel aaa:LoggingLevel
(scalar:Enum8)Radius Logging level name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
retries aaa:Retries
(scalar:Uint32)The number of attempts that the authentication method is tried. rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. srcIf nw:IfId
(base:IfIndex)Source Interface Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 timeout aaa:TimeSec
(scalar:Uint32)The amount of time between authentication attempts.
aaaRadiusProviderGroup Properties
The following table contains information about the aaaRadiusProviderGroup properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values deadtime aaa:ProviderGroupDeadtime
(scalar:Uint32)Duration for which non-reachable server is skipped descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. srcIf nw:IfId
(base:IfIndex)Source Interface Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 vrf l3:VrfName
(string:Basic)VRF A sequence of characters
pkiEp Properties
The following table contains information about the pkiEp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr
naming:Descr
string:BasicSpecifies a description of the policy definition. RANGE:
Min: "0"
Max: "128" name
pol:ObjName
string:Basic RANGE:
Min: "0"
Max: "64" ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
pkiDebugPluginChallenge Properties
The following table contains information about the pkiDebugPluginChallenge properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr
naming:Descr
string:BasicSpecifies a description of the policy definition. RANGE:
Min: "0"
Max: "128" name
pol:ObjName
string:Basic RANGE:
Min: "0"
Max: "64" ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
pkiWebTokenData Properties
The following table contains information about the pkiWebTokenData properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr
naming:Descr
string:BasicSpecifies a description of the policy definition. RANGE:
Min: "0"
Max: "128" maximumValidityPeriod pki:WebTokenValidityPeriodType
(scalar:Uint16)Maximum Validity Period in hours name
pol:ObjName
string:Basic RANGE:
Min: "0"
Max: "64" ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. sessionRecordFlags pki:SessionRecordFlags
(scalar:Bitmask16)Session Recording Options SELECTION: uiIdleTimeoutSeconds pki:GuiIdleTimeoutType
(scalar:Uint16)The maximum interval time the GUI remains idle before login needs to be refreshed. webtokenTimeoutSeconds pki:WebTokenTimeoutType
(scalar:Uint16)The web token timeout interval.
pkiCsyncSharedKey Properties
The following table contains information about the pkiCsyncSharedKey properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr
naming:Descr
string:BasicSpecifies a description of the policy definition. RANGE:
Min: "0"
Max: "128" name
pol:ObjName
string:Basic RANGE:
Min: "0"
Max: "64" ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaRole Properties
The following table contains information about the aaaRole properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values allowedVLAN aaa:RuleEntityType
(string:Basic)mention the allowed VLAN if denyVLAN is set to yes allowedVRF aaa:RuleEntityType
(string:Basic)mention the allowed VRF if denyVRF is set to yes denyIntf aaa:Boolean
(scalar:Enum8)Deny all interfaces except allowed ones SELECTION: denyVLAN aaa:Boolean
(scalar:Enum8)Deny all VLAN except allowed ones SELECTION: denyVRF aaa:Boolean
(scalar:Enum8)Deny all VRF except allowed ones SELECTION: descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
priv aaa:Access The privilege bitmask for a role. resetToFactory aaa:Boolean
(scalar:Enum8)Trigger Reset to Factory settings SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. rolePrivType aaa:UserRolePrivType
(scalar:Enum8)Privilege Type SELECTION:
aaaDomain Properties
The following table contains information about the aaaDomain properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaPwdProfile Properties
The following table contains information about the aaaPwdProfile properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values changeCount aaa:PwdChangeCount
(scalar:UByte)The number of password changes allowed within the change interval. changeDuringInterval aaa:PwdPolicy
(scalar:Enum8)The change count/change interval policy selector. This property enables you to select an option for enforcing password change. SELECTION: changeInterval aaa:PwdChangeInterval
(scalar:Uint16)A time interval for limiting the number of password changes. descr pol:Descr Description of the specified attribute expirationWarnTime aaa:PwdExpWarnTime
(scalar:UByte)Password Expiration Warn Time in Days historyCount aaa:HistoryDepth
(scalar:UByte)How many retired passwords are stored in a user's password history. name pol:ObjName
(naming:Name256)Object name noChangeInterval aaa:PwdChangeInterval
(scalar:Uint16)A minimum period after a password change before the user can change the password again. ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaPreLoginBanner Properties
The following table contains information about the aaaPreLoginBanner properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute guiMessage aaa:BannerMsg
(string:CharBuffer)The login banner messsage to be displayed in the GUI. message aaa:BannerMsg
(string:CharBuffer)A message displayed in the banner. name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaAuthRealm Properties
The following table contains information about the aaaAuthRealm properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values defRolePolicy aaa:NoRolePolicy
(scalar:Enum8)The default role policy for the remote user with invalid CiscoAVPairs. CiscoAVPairs provide support for Remote Access Dial-In User Service attribute-value (AV) pairs. SELECTION: descr pol:Descr Description of the specified attribute loggingLevel aaa:LoggingLevel
(scalar:Enum8)AAA Logging level name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
radDirectedReq aaa:Boolean
(scalar:Enum8)Enable direct authentication requests to server SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. tacDirectedReq aaa:Boolean
(scalar:Enum8)Enable direct authentication requests to server SELECTION:
aaaDefaultAcc Properties
The following table contains information about the aaaDefaultAcc properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values accMethodNone scalar:Bool No accounting SELECTION: true or false descr pol:Descr Description of the specified attribute localRbac scalar:Bool Use Local SELECTION: true or false ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group realm aaa:Realm
(scalar:Enum8)Realm SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaDefaultAuth Properties
The following table contains information about the aaaDefaultAuth properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values authProtocol aaa:authenticationProtocol
(scalar:Enum8)Authentication Protocol SELECTION: descr pol:Descr Description of the specified attribute errEn scalar:Bool Enable display of error message on login failures SELECTION: true or false fallback aaa:Boolean
(scalar:Enum8)Fallback in case all AAA servers configured for remote authentication are unreachable SELECTION: local aaa:Boolean
(scalar:Enum8)Use local username authentication SELECTION: name pol:ObjName
(naming:Name256)Object name none aaa:Boolean
(scalar:Enum8)No authentication SELECTION: ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group realm aaa:Realm
(scalar:Enum8)Realm SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaPkiSSHCertificate Properties
The following table contains information about the aaaPkiSSHCertificate properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute local scalar:Bool Use Local RBAC based Authorization SELECTION: true or false name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group realm aaa:Realm
(scalar:Enum8)Realm SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaConsoleAuth Properties
The following table contains information about the aaaConsoleAuth properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values authProtocol aaa:authenticationProtocol
(scalar:Enum8)Authentication Protocol SELECTION: descr pol:Descr Description of the specified attribute errEn scalar:Bool Enable display of error message on login failures SELECTION: true or false fallback aaa:Boolean
(scalar:Enum8)Fallback in case all AAA servers configured for remote authentication are unreachable SELECTION: local aaa:Boolean
(scalar:Enum8)Use local username authentication SELECTION: name pol:ObjName
(naming:Name256)Object name none aaa:Boolean
(scalar:Enum8)No authentication SELECTION: ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group realm aaa:Realm
(scalar:Enum8)Realm SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaPkiSSHPublicKey Properties
The following table contains information about the aaaPkiSSHPublicKey properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute local scalar:Bool Use Local RBAC based Authorization SELECTION: true or false name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group realm aaa:Realm
(scalar:Enum8)Realm SELECTION: rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaDefaultAuthor Properties
The following table contains information about the aaaDefaultAuthor properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values authorMethodNone scalar:Bool No authorization SELECTION: true or false cmdType aaa:CmdType
(scalar:Enum8)Type of command for authorization SELECTION: descr pol:Descr Description of the specified attribute localRbac scalar:Bool Use Local RBAC based Authorization SELECTION: true or false ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
aaaConsoleAuthor Properties
The following table contains information about the aaaConsoleAuthor properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values authorMethodNone scalar:Bool No authorization SELECTION: true or false cmdType aaa:CmdType
(scalar:Enum8)Type of command for authorization SELECTION: descr pol:Descr Description of the specified attribute localRbac scalar:Bool Use Local RBAC based Authorization SELECTION: true or false ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
providerGroup aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup2 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup3 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup4 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup5 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup6 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup7 aaa:ProviderGroupName
(string:Basic)Provider Group providerGroup8 aaa:ProviderGroupName
(string:Basic)Provider Group rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Querying a Pattern to Match (Domain Name)
Querying Domain Names (Domain Name)
GET http://<IP_Address>/api/mo/sys/dns.json?rsp-subtree=full&rsp-prop-include=config-only
{
"totalCount": "1",
"imdata": [
{
"dnsEntity": {
"attributes": {
"adminSt": "enabled",
"dn": "sys/dns",
"name": "",
"persistentOnReload": "true"
},
"children": [
{
"dnsProf": {
"attributes": {
"descr": "",
"name": "management",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "prof-management"
},
"children": [
{
"dnsProvider": {
"attributes": {
"addr": "171.70.168.183",
"name": "",
"persistentOnReload": "true",
"rn": "prov-[171.70.168.183]"
}
}
},
{
"dnsDom": {
"attributes": {
"descr": "",
"name": "cisco.com",
"persistentOnReload": "true",
"rn": "domDom_Test"
}
}
}
]
}
},
{
"dnsProf": {
"attributes": {
"descr": "",
"name": "default",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "prof-default"
},
"children": [
{
"dnsVrf": {
"attributes": {
"name": "management",
"persistentOnReload": "true",
"rn": "vrf-[management]"
},
"children": [
{
"dnsProvider": {
"attributes": {
"addr": "64.102.6.247",
"name": "",
"persistentOnReload": "true",
"rn": "prov-[64.102.6.247]"
}
}
}
]
}
},
{
"dnsDom": {
"attributes": {
"descr": "",
"name": "cisco.com",
"persistentOnReload": "true",
"rn": "dom"
}
}
}
]
}
}
]
}
}
]
}
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/dns-items
<dns-items>
<adminSt>enabled</adminSt>
<operSt>enabled</operSt>
<prof-items>
<Prof-list>
<name>management</name>
<dom-items>
<name>cisco.com</name>
</dom-items>
<prov-items>
<Provider-list>
<addr>171.70.168.183</addr>
</Provider-list>
</prov-items>
</Prof-list>
<Prof-list>
<name>default</name>
<descr/>
<dom-items>
<name>cisco.com</name>
</dom-items>
<ownerKey/>
<ownerTag/>
<vrf-items>
<Vrf-list>
<name>management</name>
<prov-items>
<Provider-list>
<addr>64.102.6.247</addr>
</Provider-list>
</prov-items>
</Vrf-list>
</vrf-items>
</Prof-list>
</prof-items>
</dns-items>
Note: This example was added in Cisco NX-OS Release 9.2(1).
CLI Output Switch# show running | section domain-name
ip domain-name cisco.com
ip domain-name cisco.com
Note: The property information for this example was added in Release 9.3(3).
dnsEntity Properties
The following table contains information about the dnsEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt nw:AdminSt
(scalar:Enum8)The administrative state of the object or policy. SELECTION: dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
dnsProf Properties
The following table contains information about the dnsProf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsProvider Properties
The following table contains information about the dnsProvider properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values addr address:Ip IP address of the provider Value must match ipv4 or ipv6 known format name pol:ObjName
(naming:Name256)Object name persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsDom Properties
The following table contains information about the dnsDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsVrf Properties
The following table contains information about the dnsVrf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values name l3:VrfName
(string:Basic)Vrf Name A sequence of characters persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Querying a Pattern to Match (Line)
Querying a Pattern Match (Line)
GET http://<IP_Address>/api/mo/sys/terml/ln/cons/execTmeout.json
{
"terminalExecTimeout": {
"attributes": {
"dn": "sys/terml/ln/cons/execTmeout",
"modTs": "2018-06-07T12:01:32.069+00:00",
"persistentOnReload": "true",
"timeout": "0"
}
}
}
GET http://<IP_Address>/api/mo/sys/terml/ln/cons/speed.json
{
"terminalSpeed": {
"attributes": {
"dn": "sys/terml/ln/cons/speed",
"modTs": "2018-06-07T12:01:32.074+00:00",
"persistentOnReload": "true",
"speed": "115200",
}
}
}
GET http://<IP_Address>/api/mo/sys/terml/ln/vty/execTmeout.json
{
"terminalExecTimeout": {
"attributes": {
"dn": "sys/terml/ln/vty/execTmeout",
"modTs": "2018-06-07T12:01:32.092+00:00",
"persistentOnReload": "true",
"timeout": "0"
}
}
}
GET http://<IP_Address>/api/mo/sys/terml/ln/vty/lgoutWarning.json
{
"terminalLogoutWarning": {
"attributes": {
"dn": "sys/terml/ln/vty/lgoutWarning",
"lgtWarn": "30",
"modTs": "2018-06-13T19:20:20.931+00:00",
"persistentOnReload": "true",
}
}
}
<filter>
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<terml-items>
<ln-items>
<cons-items>
<execTmeout-items>
<timeout/>
</execTmeout-items>
<speed-items>
<speed/>
</speed-items>
</cons-items>
<vty-items>
<execTmeout-items>
<timeout/>
</execTmeout-items>
<lgoutWarning-items>
<lgtWarn/>
</lgoutWarning-items>
</vty-items>
</ln-items>
</terml-items>
</System>
</filter>
NETCONF Reply OK
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:924e3328-299f-42e6-ab74-2fda151c6790">
<data>
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<terml-items>
<ln-items>
<cons-items>
<execTmeout-items>
<timeout>0</timeout>
</execTmeout-items>
<speed-items>
<speed>115200</speed>
</speed-items>
</cons-items>
<vty-items>
<execTmeout-items>
<timeout>0</timeout>
</execTmeout-items>
<lgoutWarning-items>
<lgtWarn>30</lgtWarn>
</lgoutWarning-items>
</vty-items>
</ln-items>
</terml-items>
</System>
</data>
</rpc-reply>
The DME and YANG payloads correspond to the show running-config | section line command.
Note: This example was added in Cisco NX-OS Release 9.2(1).
CLI Output Switch (config)# show running-config | section line
line console
exec-timeout 0
speed 115200
line vty
exec-timeout 0
logout-warning 30
Note: The property information for this example was added in Release 9.3(3).
terminalExecTimeout Properties
The following table contains information about the terminalExecTimeout properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
timeout terminal:TimeoutT
(scalar:Uint32)Timeout
terminalSpeed Properties
The following table contains information about the terminalSpeed properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
speed scalar:Uint32 console speed
terminalLogoutWarning Properties
The following table contains information about the terminalLogoutWarning properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. lgtWarn terminal:Limit
(scalar:Uint32)Configure logout warning time modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Querying a Pattern to Match ("name-server|domain-lookup|host")
Querying a Pattern to Match ("name-server|domain-lookup|host")
GET http://<IP_Address>/api/mo/sys/dns.json?rsp-subtree=full&rsp-prop-include=config-only
{
"totalCount": "1",
"imdata": [
{
"dnsEntity": {
"attributes": {
"adminSt": "enabled",
"dn": "sys/dns",
"name": "",
"persistentOnReload": "true"
},
"children": [
{
"dnsProf": {
"attributes": {
"descr": "",
"name": "default",
"ownerKey": "",
"ownerTag": "",
"persistentOnReload": "true",
"rn": "prof-default"
},
"children": [
{
"dnsProvider": {
"attributes": {
"addr": "1.2.3.4",
"name": "",
"persistentOnReload": "true",
"preferred": "no",
"rn": "prov-[1.2.3.4]"
}}},{
"dnsProvider": {
"attributes": {
"addr": "2.4.6.8",
"name": "",
"persistentOnReload": "true",
"preferred": "no",
"rn": "prov-[2.4.6.8]"
}}},{
"dnsDom": {
"attributes": {
"descr": "",
"isDefault": "no",
"name": "Dom_Test",
"persistentOnReload": "true",
"rn": "dom"
}}},{
"dnsHost": {
"attributes": {
"name": "Host_1",
"persistentOnReload": "true",
"rn": "host-Host_1"
},
"children": [
{
"dnsIpv6Host": {
"attributes": {
"addr": "1:2::34",
"persistentOnReload": "true",
"rn": "ipv6host"
}}},{
"dnsIpv4Host": {
"attributes": {
"addr": "1.2.3.4",
"persistentOnReload": "true",
"rn": "ipv4host"
}}}]}}]}}]}}]}
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/dns-items
<dns-items>
<adminSt>enabled</adminSt>
<operErr/>
<operSt>enabled</operSt>
<prof-items>
<Prof-list>
<name>default</name>
<dom-items>
<isDefault>false</isDefault>
<name>Dom_Test</name>
</dom-items>
<host-items>
<Host-list>
<name>Host_1</name>
<ipv4host-items>
<addr>1.2.3.4</addr>
</ipv4host-items>
<ipv6host-items>
<addr>1:2::34</addr>
</ipv6host-items>
</Host-list>
</host-items>
<prov-items>
<Provider-list>
<addr>1.2.3.4</addr>
<preferred>false</preferred>
</Provider-list>
<Provider-list>
<addr>2.4.6.8</addr>
<preferred>false</preferred>
</Provider-list>
</prov-items>
</Prof-list>
</prof-items>
</dns-items>
The DME URL lists all the DNS related configurations. There is no single URL to retrieve only "name-server|domain-lookup|host."
Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).
CLI Output switch# show running | incl name-server|domain-lookup|host
ip domain-lookup
ip name-server 1.2.3.4 2.4.6.8
ip host Host_1 1.2.3.4
ipv6 host Host_1 1:2::34
Note: The property information for this example was added in Release 9.3(3).
dnsEntity Properties
The following table contains information about the dnsEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt nw:AdminSt
(scalar:Enum8)The administrative state of the object or policy. SELECTION: dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
dnsProf Properties
The following table contains information about the dnsProf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name ownerKey naming:Descr
(string:Basic)The key for enabling clients to own their data for entity correlation. ownerTag naming:Descr1024
(string:Basic)A tag for enabling clients to add their own data. For example, to indicate who created this object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsProvider Properties
The following table contains information about the dnsProvider properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values addr address:Ip IP address of the provider Value must match ipv4 or ipv6 known format name pol:ObjName
(naming:Name256)Object name persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
preferred scalar:Bool Specifies if this the preferred provider. Only one provider in the group should be preferred SELECTION: true or false rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsDom Properties
The following table contains information about the dnsDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute isDefault scalar:Bool A property used to indicate whether this domain is the default domain. Only one domain in the group can be the default. SELECTION: true or false name pol:ObjName
(naming:Name256)Object name persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsHost Properties
The following table contains information about the dnsHost properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values name string:Basic Host Name A sequence of characters persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsIpv6Host Properties
The following table contains information about the dnsIpv6Host properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values addr address:IPv6 IPv6 Address Of Hostname Value must match ipv6 format persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
dnsIpv4Host Properties
The following table contains information about the dnsIpv4Host properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values addr address:IPv4 IPv4 Address Of Hostname Value must match ipv4 format persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Querying a Pattern to Match (RMON)
Querying a Pattern to Match (RMON)
GET http://<IP_Address>/api/mo/sys/snmp/inst/rmon.json?rsp-subtree=full&rsp-prop-include=config-only
{
"totalCount": "1",
"imdata": [
{
"snmpRmon": {
"attributes": {
"dn": "sys/snmp/inst/rmon",
"persistentOnReload": "true"
},
"children": [
{
"snmpEvent": {
"attributes": {
"description": "CRITICAL(2)",
"log": "yes",
"num": "2",
"owner": "PMON@CRITICAL",
"persistentOnReload": "true",
"rn": "event-2",
"trap": "public"
}}},{
"snmpEvent": {
"attributes": {
"description": "INFORMATION(5)",
"log": "yes",
"num": "5",
"owner": "PMON@INFO",
"persistentOnReload": "true",
"rn": "event-5",
"trap": "public"
}}},{
"snmpEvent": {
"attributes": {
"description": "WARNING(4)",
"log": "yes",
"num": "4",
"owner": "PMON@WARNING",
"persistentOnReload": "true",
"rn": "event-4",
"trap": "public"
}}},{
"snmpEvent": {
"attributes": {
"description": "FATAL(1)",
"log": "yes",
"num": "1",
"owner": "PMON@FATAL",
"persistentOnReload": "true",
"rn": "event-1",
"trap": "public"
}}},{
"snmpEvent": {
"attributes": {
"description": "ERROR(3)",
"log": "yes",
"num": "3",
"owner": "PMON@ERROR",
"persistentOnReload": "true",
"rn": "event-3",
"trap": "public"
}}}]}}]}
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/snmp-items/inst-items/rmon-items
<rmon-items>
<deleteAlarms/>
<deleteEvents/>
<event-items>
<Event-list>
<num>2</num>
<description>CRITICAL(2)</description>
<log>yes</log>
<owner>PMON@CRITICAL</owner>
<trap>public</trap>
</Event-list>
<Event-list>
<num>5</num>
<description>INFORMATION(5)</description>
<log>yes</log>
<owner>PMON@INFO</owner>
<trap>public</trap>
</Event-list>
<Event-list>
<num>4</num>
<description>WARNING(4)</description>
<log>yes</log>
<owner>PMON@WARNING</owner>
<trap>public</trap>
</Event-list>
<Event-list>
<num>1</num>
<description>FATAL(1)</description>
<log>yes</log>
<owner>PMON@FATAL</owner>
<trap>public</trap>
</Event-list>
<Event-list>
<num>3</num>
<description>ERROR(3)</description>
<log>yes</log>
<owner>PMON@ERROR</owner>
<trap>public</trap>
</Event-list>
</event-items>
</rmon-items>
Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).
CLI Output switch# show running | section rmon
rmon event 1 log trap public description FATAL(1) owner PMON@FATAL
rmon event 2 log trap public description CRITICAL(2) owner PMON@CRITICAL
rmon event 3 log trap public description ERROR(3) owner PMON@ERROR
rmon event 4 log trap public description WARNING(4) owner PMON@WARNING
rmon event 5 log trap public description INFORMATION(5) owner PMON@INFO
Note: The property information for this example was added in Release 9.3(3).
snmpRmon Properties
The following table contains information about the snmpRmon properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
snmpEvent Properties
The following table contains information about the snmpEvent properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values description snmp:DescType
(string:Basic)rmon event description A sequence of characters log snmp:LogEnableType
(scalar:Enum8)Whether to generate / not log when alarm event is fired SELECTION: num snmp:EventNum
(scalar:Uint16)rmon event number owner snmp:OwnerType
(string:Basic)rmon event owner A sequence of characters persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. trap snmp:TrapCommType
(string:Basic)rmon event description A sequence of characters
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Querying a Pattern to Match (VRF)
Querying a Pattern to Match (VRF)
GET http://<IP_Address>/api/mo/sys.json?query-target=children&target-subtree-class=l3Inst&rsp-subtree=full&rsp-prop-include=config-only
{
"totalCount": "8",
"imdata": [
{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-default",
"encap": "unknown",
"name": "default",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "default",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-default"
}}},{
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/lb-[lo1]]",
"tDn": "sys/intf/lb-[lo1]"
}}},{
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/lb-[lo0]]",
"tDn": "sys/intf/lb-[lo0]"
}}},{
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/phys-[eth1/6]]",
"tDn": "sys/intf/phys-[eth1/6]"
}}},{
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/lb-[lo2]]",
"tDn": "sys/intf/lb-[lo2]"
}}}, {
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/phys-[eth1/7]]",
"tDn": "sys/intf/phys-[eth1/7]"
}}}, {
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/phys-[eth1/1]]",
"tDn": "sys/intf/phys-[eth1/1]"
}}}, {
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/intf/phys-[eth1/2]]",
"tDn": "sys/intf/phys-[eth1/2]"
}}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-management",
"encap": "unknown",
"name": "management",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "management",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-management"
}}}, {
"l3RsVrfMbr": {
"attributes": {
"persistentOnReload": "true",
"rn": "rsvrfMbr-[sys/mgmt-[mgmt0]]",
"tDn": "sys/mgmt-[mgmt0]"
}}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-VRF_1",
"encap": "unknown",
"name": "VRF_1",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "VRF_1",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-VRF_1"
},
"children": [
{
"rtctrlDomAf": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "af-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlAfCtrl": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "ctrl-ipv4-mvpn",
"type": "ipv4-mvpn"
},
"children": [
{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-import",
"type": "import"
},
"children": [
{
"rtctrlRttEntry": {
"attributes": {
"persistentOnReload": "true",
"rn": "ent-route-target:as2-nn2:1:2",
"rtt": "route-target:as2-nn2:1:2"
}}}]}}]}},{
"rtctrlAfCtrl": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "ctrl-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-import",
"type": "import"
},
"children": [
{
"rtctrlMapP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rtctrlmap",
"rtMap": "map1"
}}}]}},{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-export",
"type": "export"
},
"children": [
{
"rtctrlRttEntry": {
"attributes": {
"persistentOnReload": "true",
"rn": "ent-route-target:as2-nn2:1:2",
"rtt": "route-target:as2-nn2:1:2"
}}},{
"rtctrlMapP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rtctrlmap",
"rtMap": "map1"
}}},{
"rtctrlDomDefMapP": {
"attributes": {
"allowVpn": "no",
"descr": "",
"name": "",
"persistentOnReload": "true",
"pfxLimit": "0",
"rn": "rtctrldefmap",
"rtMap": "map1"
}}}]}}]}}]}}]}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-VRF_2",
"encap": "unknown",
"name": "VRF_2",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "VRF_2",
"persistentOnReload": "true",
"rd": "rd:as2-nn2:1:2",
"rn": "dom-VRF_2"
},
"children": [
{
"rtctrlDomAf": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "af-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlAfCtrl": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "ctrl-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-export",
"type": "export"
},
"children": [
{
"rtctrlMapP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rtctrlmap",
"rtMap": "map1"
}}},{
"rtctrlDomDefMapP": {
"attributes": {
"allowVpn": "yes",
"descr": "",
"name": "",
"persistentOnReload": "true",
"pfxLimit": "0",
"rn": "rtctrldefmap",
"rtMap": "map1"
}}}]}}]}}]}}]}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-foo",
"encap": "unknown",
"name": "foo",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "foo",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-foo"
},
"children": [
{
"rtctrlDomAf": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "af-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlAfCtrl": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "ctrl-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-export",
"type": "export"
},
"children": [
{
"rtctrlDomDefMapP": {
"attributes": {
"allowVpn": "yes",
"descr": "",
"name": "",
"persistentOnReload": "true",
"pfxLimit": "0",
"rn": "rtctrldefmap",
"rtMap": "map1"
}}}]}}]}}]}}]}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-switchpool-default",
"encap": "unknown",
"name": "switchpool-default",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "switchpool-default",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-switchpool-default"
}}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-test1",
"encap": "unknown",
"name": "test1",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "test1",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-test1"
},
"children": [
{
"rtctrlDomAf": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "af-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlAfCtrl": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "ctrl-ipv4-mvpn",
"type": "ipv4-mvpn"
},
"children": [
{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-import",
"type": "import"
},
"children": [
{
"rtctrlRttEntry": {
"attributes": {
"persistentOnReload": "true",
"rn": "ent-route-target:as2-nn2:1:2",
"rtt": "route-target:as2-nn2:1:2"
}}}]}}]}}]}}]}}]}},{
"l3Inst": {
"attributes": {
"adminState": "admin-up",
"ctrlrId": "0",
"descr": "",
"dn": "sys/inst-v1",
"encap": "unknown",
"name": "v1",
"persistentOnReload": "true"
},
"children": [
{
"rtctrlDom": {
"attributes": {
"name": "v1",
"persistentOnReload": "true",
"rd": "unknown:unknown:0:0",
"rn": "dom-v1"
},
"children": [
{
"rtctrlDomAf": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "af-ipv4-ucast",
"type": "ipv4-ucast"
},
"children": [
{
"rtctrlAfCtrl": {
"attributes": {
"name": "",
"persistentOnReload": "true",
"rn": "ctrl-ipv4-mvpn",
"type": "ipv4-mvpn"
},
"children": [
{
"rtctrlRttP": {
"attributes": {
"descr": "",
"name": "",
"persistentOnReload": "true",
"rn": "rttp-import",
"type": "import"
},
"children": [
{
"rtctrlRttEntry": {
"attributes": {
"persistentOnReload": "true",
"rn": "ent-route-target:as2-nn2:1:2",
"rtt": "route-target:as2-nn2:1:2"
}}}]}}]}}]}}]}}]}}]}
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/inst-items?content=config
<inst-items>
<Inst-list>
<name>test1</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>test1</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<ctrl-items>
<AfCtrl-list>
<type>ipv4-mvpn</type>
<rttp-items>
<RttP-list>
<type>import</type>
<ent-items>
<RttEntry-list>
<rtt>route-target:as2-nn2:1:2</rtt>
</RttEntry-list>
</ent-items>
</RttP-list>
</rttp-items>
</AfCtrl-list>
</ctrl-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</Inst-list>
<Inst-list>
<name>default</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>default</name>
</Dom-list>
</dom-items>
<rsvrfMbr-items>
<RsVrfMbr-list>
<tDn>/System/intf-items/LbRtdIf-list[id='lo1']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
<RsVrfMbr-list>
<tDn>/System/intf-items/LbRtdIf-list[id='lo0']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
<RsVrfMbr-list>
<tDn>/System/intf-items/PhysIf-list[id='eth1/6']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
<RsVrfMbr-list>
<tDn>/System/intf-items/LbRtdIf-list[id='lo2']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
<RsVrfMbr-list>
<tDn>/System/intf-items/PhysIf-list[id='eth1/7']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
<RsVrfMbr-list>
<tDn>/System/intf-items/PhysIf-list[id='eth1/1']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
<RsVrfMbr-list>
<tDn>/System/intf-items/PhysIf-list[id='eth1/2']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
</rsvrfMbr-items>
</Inst-list>
<Inst-list>
<name>VRF_2</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>VRF_2</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<ctrl-items>
<AfCtrl-list>
<type>ipv4-ucast</type>
<rttp-items>
<RttP-list>
<type>export</type>
<rtctrldefmap-items>
<allowVpn>true</allowVpn>
<pfxLimit>0</pfxLimit>
<rtMap>map1</rtMap>
</rtctrldefmap-items>
<rtctrlmap-items>
<rtMap>map1</rtMap>
</rtctrlmap-items>
</RttP-list>
</rttp-items>
</AfCtrl-list>
</ctrl-items>
</DomAf-list>
</af-items>
<rd>rd:as2-nn2:1:2</rd>
</Dom-list>
</dom-items>
</Inst-list>
<Inst-list>
<name>switchpool-default</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>switchpool-default</name>
</Dom-list>
</dom-items>
</Inst-list>
<Inst-list>
<name>foo</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>foo</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<ctrl-items>
<AfCtrl-list>
<type>ipv4-ucast</type>
<rttp-items>
<RttP-list>
<type>export</type>
<rtctrldefmap-items>
<allowVpn>true</allowVpn>
<pfxLimit>0</pfxLimit>
<rtMap>map1</rtMap>
</rtctrldefmap-items>
</RttP-list>
</rttp-items>
</AfCtrl-list>
</ctrl-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</Inst-list>
<Inst-list>
<name>VRF_1</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<ctrl-items>
<AfCtrl-list>
<type>ipv4-mvpn</type>
<rttp-items>
<RttP-list>
<type>import</type>
<ent-items>
<RttEntry-list>
<rtt>route-target:as2-nn2:1:2</rtt>
</RttEntry-list>
</ent-items>
</RttP-list>
</rttp-items>
</AfCtrl-list>
<AfCtrl-list>
<type>ipv4-ucast</type>
<rttp-items>
<RttP-list>
<type>export</type>
<ent-items>
<RttEntry-list>
<rtt>route-target:as2-nn2:1:2</rtt>
</RttEntry-list>
</ent-items>
<rtctrldefmap-items>
<allowVpn>false</allowVpn>
<pfxLimit>0</pfxLimit>
<rtMap>map1</rtMap>
</rtctrldefmap-items>
<rtctrlmap-items>
<rtMap>map1</rtMap>
</rtctrlmap-items>
</RttP-list>
<RttP-list>
<type>import</type>
<rtctrlmap-items>
<rtMap>map1</rtMap>
</rtctrlmap-items>
</RttP-list>
</rttp-items>
</AfCtrl-list>
</ctrl-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</Inst-list>
<Inst-list>
<name>management</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>management</name>
</Dom-list>
</dom-items>
<rsvrfMbr-items>
<RsVrfMbr-list>
<tDn>/System/MgmtAddr-list[addr='mgmt0']</tDn>
<tCl>nwIf</tCl>
</RsVrfMbr-list>
</rsvrfMbr-items>
</Inst-list>
<Inst-list>
<name>v1</name>
<adminState>admin-up</adminState>
<ctrlrId>0</ctrlrId>
<dom-items>
<Dom-list>
<name>v1</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<ctrl-items>
<AfCtrl-list>
<type>ipv4-mvpn</type>
<rttp-items>
<RttP-list>
<type>import</type>
<ent-items>
<RttEntry-list>
<rtt>route-target:as2-nn2:1:2</rtt>
</RttEntry-list>
</ent-items>
</RttP-list>
</rttp-items>
</AfCtrl-list>
</ctrl-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).
CLI Output switch# show running | section vrf
limit-resource vrf minimum 2 maximum 4096
use-vrf test_vrf
vrf context VRF_1
address-family ipv4 unicast
route-target import 1:2 mvpn
route-target export 1:2
export map map1
import map map1
export vrf default map map1
vrf context VRF_2
rd 1:2
address-family ipv4 unicast
export map map1
export vrf default map map1 allow-vpn
vrf context foo
address-family ipv4 unicast
export vrf default map map1 allow-vpn
vrf context management
ip route 0.0.0.0/0 172.27.122.1
vrf context switchpool-default
vrf context test1
address-family ipv4 unicast
route-target import 1:2 mvpn
vrf context v1
address-family ipv4 unicast
route-target import 1:2 mvpn
vrf member management
vrf VRF_2
router-id 3.6.9.12
Note: The property information for this example was added in Release 9.3(3).
l3Inst Properties
The following table contains information about the l3Inst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminState l3:VrfAdminState
(scalar:Enum8)vrf Admin State SELECTION: ctrlrId aggregate:ControllerID
(scalar:Uint32)Controller ID descr string:Basic Description A sequence of characters dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. encap base:Encap Encap for this Context SELECTION: unknown, vlan-%d or vxlan-%d name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rtctrlDom Properties
The following table contains information about the rtctrlDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rd base:Community Route Distinguisher rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
l3RsVrfMbr Properties
The following table contains information about the l3RsVrfMbr properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. tDn
reln:Dn
reference:BinRefThe distinguished name of the target.
rtctrlDomAf Properties
The following table contains information about the rtctrlDomAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. type bgp:AfT
(scalar:Enum8)Type SELECTION:
rtctrlAfCtrl Properties
The following table contains information about the rtctrlAfCtrl properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. type bgp:AfT
(scalar:Enum8)Type SELECTION:
rtctrlRttP Properties
The following table contains information about the rtctrlRttP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr
naming:Descr
string:BasicThe description of this configuration item. RANGE:
Min: "0"
Max: "128" name
pol:ObjName
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "64" persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. type rtctrl:RttPType
(scalar:Enum8)Type SELECTION:
rtctrlRttEntry Properties
The following table contains information about the rtctrlRttEntry properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. rtt base:Community Route Target
rtctrlMapP Properties
The following table contains information about the rtctrlMapP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values descr pol:Descr Description of the specified attribute name pol:ObjName
(naming:Name256)Object name persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. rtMap string:Basic Route Map A sequence of characters
rtctrlDomDefMapP Properties
The following table contains information about the rtctrlDomDefMapP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values allowVpn scalar:Bool Allow VPN to be considered for route leaking SELECTION: true or false descr
naming:Descr
string:BasicThe description of this configuration item. RANGE:
Min: "0"
Max: "128" name
pol:ObjName
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "64" persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
pfxLimit scalar:Uint32 Default Vrf Prefix Limit rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. rtMap string:Basic Route Map A sequence of characters
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Querying a Pattern to Match (VTP)
Querying a Pattern to Match (VTP)
GET http://<IP_Address>/api/mo/sys/vtp.json?rsp-subtree=full
{
"totalCount": "1",
"imdata": [
{
"vtpEntity": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"dn": "sys/vtp",
"modTs": "2018-05-30T22:31:14.151+00:00",
"name": "",
"operErr": "",
"operSt": "enabled",
"persistentOnReload": "true",
"status": ""
},
"children": [
{
"vtpInst": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"ctrl": "",
"domain": "123",
"filePath": "bootflash:/vlan.dat",
"modTs": "2018-05-30T22:41:46.197+00:00",
"name": "",
"operErr": "",
"password": "vtp_passwd",
"persistentOnReload": "true",
"rn": "inst",
"status": "",
"version": "1"
}
}
}
]
}
}
]
}
GET: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/vtp-items
<vtp-items>
<adminSt>enabled</adminSt>
<inst-items>
<adminSt>enabled</adminSt>
<domain>123</domain>
<filePath>bootflash:/vlan.dat</filePath>
<operErr/>
<password>vtp_passwd</password>
<version>1</version>
</inst-items>
<operErr/>
<operSt>enabled</operSt>
</vtp-items>
Note: This example was added in Cisco NX-OS Release 9.2(1).
CLI Output Switch# show running | incl vtp
feature vtp
vtp domain 123
Note: The property information for this example was added in Release 9.3(3).
vtpEntity Properties
The following table contains information about the vtpEntity properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt nw:AdminSt
(scalar:Enum8)The administrative state of the object or policy. SELECTION: childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: name naming:Name256
(string:Basic)The name of the object. operErr nw:OperErrQual
(scalar:Bitmask64)Operational Errors Qualifier SELECTION: operSt nw:EntOperSt
(scalar:Enum8)The runtime state of the object or policy. SELECTION: persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
status mo:ModificationStatus
(scalar:Bitmask32)The upgrade status. This property is for internal use only. SELECTION:
vtpInst Properties
The following table contains information about the vtpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt nw:AdminSt
(scalar:Enum8)The administrative state of the object or policy. SELECTION: childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
ctrl
nw:InstCtrl
scalar:Bitmask64The control state. SELECTION:
domain string:Basic domain A sequence of characters filePath string:Basic file A sequence of characters modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: name
naming:Name256
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "128" operErr nw:OperErrQual
(scalar:Bitmask64)Operational Errors Qualifier SELECTION: password string:Basic password A sequence of characters persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)The upgrade status. This property is for internal use only. SELECTION: version scalar:Uint32 version
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide: