Configuring an IPv4 Standby Node and its Probe Under an ITD Device Group
Configuring a DNS Protocol Service Probe
Configuring a DNS Protocol Service Probe
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"ctrlStatusEnable": "disable",
"dnshost": "SampleString_123",
"frequency": "154140",
"httpGetStr": "",
"port": "0",
"probeIp": "1.2.3.4",
"protocol": "DNS",
"retryDownCount": "5",
"retryUpCount": "5",
"timeout": "1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items>
<ctrlStatusEnable>disable</ctrlStatusEnable>
<dnshost>SampleString_123</dnshost>
<frequency>154140</frequency>
<httpGetStr></httpGetStr>
<port>0</port>
<probeIp>1.2.3.4</probeIp>
<protocol>DNS</protocol>
<retryDownCount>5</retryDownCount>
<retryUpCount>5</retryUpCount>
<timeout>1</timeout>
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
probe dns host SampleString_123 timeout 1 retry-up-count 5 frequency 154140 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
| dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
| frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
| httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
| port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
| probeIp | address:IPv4 | Value must match ipv4 format | |
| protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
| retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting a DNS Protocol Service Probe
Deleting a DNS Protocol Service Probe
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items xc:operation="delete">
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
no probe dns host SampleString_123 timeout 1 retry-up-count 5 frequency 154140 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring an HTTP Protocol Service Probe
Configuring an HTTP Protocol Service Probe
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"ctrlStatusEnable": "disable",
"dnshost": "",
"frequency": "245630",
"httpGetStr": "SampleString_123",
"port": "0",
"probeIp": "1.2.3.4",
"protocol": "HTTP",
"retryDownCount": "5",
"retryUpCount": "5",
"timeout": "1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items>
<ctrlStatusEnable>disable</ctrlStatusEnable>
<dnshost></dnshost>
<frequency>245630</frequency>
<httpGetStr>SampleString_123</httpGetStr>
<port>0</port>
<probeIp>1.2.3.4</probeIp>
<protocol>HTTP</protocol>
<retryDownCount>5</retryDownCount>
<retryUpCount>5</retryUpCount>
<timeout>1</timeout>
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
probe http get SampleString_123 timeout 1 retry-up-count 5 frequency 245630 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
| dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
| frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
| httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
| port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
| probeIp | address:IPv4 | Value must match ipv4 format | |
| protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
| retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting an HTTP Protocol Service Probe
Deleting an HTTP Protocol Service Probe
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items xc:operation="delete">
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
no probe http get SampleString_123 timeout 1 retry-up-count 5 frequency 245630 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring an ICMP Protocol Service Probe at the Standby Node Level
Configuring an ICMP Protocol Service Probe at the Standby Node Level
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"ctrlStatusEnable": "disable",
"dnshost": "",
"frequency": "154140",
"httpGetStr": "",
"port": "0",
"probeIp": "1.2.3.4",
"protocol": "ICMP",
"retryDownCount": "5",
"retryUpCount": "5",
"timeout": "1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items>
<ctrlStatusEnable>disable</ctrlStatusEnable>
<dnshost></dnshost>
<frequency>154140</frequency>
<httpGetStr></httpGetStr>
<port>0</port>
<probeIp>1.2.3.4</probeIp>
<protocol>ICMP</protocol>
<retryDownCount>5</retryDownCount>
<retryUpCount>5</retryUpCount>
<timeout>1</timeout>
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
probe icmp timeout 1 retry-up-count 5 frequency 154140 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
| dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
| frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
| httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
| port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
| probeIp | address:IPv4 | Value must match ipv4 format | |
| protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
| retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting an ICMP Protocol Service Probe at the Standby Node Level
Deleting an ICMP Protocol Service Probe at the Standby Node Level
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items xc:operation="delete">
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 5 frequency 154140 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring a UDP Protocol Service Probe at the Standby Node Level
Configuring a UDP Protocol Service Probe at the Standby Node Level
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"ctrlStatusEnable": "enable",
"dnshost": "",
"frequency": "154140",
"httpGetStr": "",
"port": "22210",
"probeIp": "1.2.3.4",
"protocol": "UDP",
"retryDownCount": "5",
"retryUpCount": "5",
"timeout": "1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items>
<ctrlStatusEnable>enable</ctrlStatusEnable>
<dnshost></dnshost>
<frequency>154140</frequency>
<httpGetStr></httpGetStr>
<port>22210</port>
<probeIp>1.2.3.4</probeIp>
<protocol>UDP</protocol>
<retryDownCount>5</retryDownCount>
<retryUpCount>5</retryUpCount>
<timeout>1</timeout>
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
probe udp port 22210 control enable timeout 1 retry-up-count 5 frequency 154140 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
| dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
| frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
| httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
| port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
| probeIp | address:IPv4 | Value must match ipv4 format | |
| protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
| retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting a UDP Protocol Service Probe at the Standby Node Level
Deleting a UDP Protocol Service Probe at the Standby Node Level
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "deviceGroup_Name"
},
"children": [
{
"itdNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdStandbyNodev4": {
"attributes": {
"ip": "1.2.3.4"
},
"children": [
{
"itdProbe": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>deviceGroup_Name</dgName>
<nodev4-items>
<Nodev4-list>
<ip>1.2.3.4</ip>
<stbynodev4-items>
<StandbyNodev4-list>
<ip>1.2.3.4</ip>
<probe-items xc:operation="delete">
</probe-items>
</StandbyNodev4-list>
</stbynodev4-items>
</Nodev4-list>
</nodev4-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group deviceGroup_Name
node ip 1.2.3.4
standby ip 1.2.3.4
no probe udp port 22210 control enable timeout 1 retry-up-count 5 frequency 154140 retry-down-count 5 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdDeviceGroup | sys/itd/inst/devgrp-deviceGroup_Name |
| itdInst | sys/itd/inst |
| itdNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4 |
| itdStandbyNodev4 | sys/itd/inst/devgrp-deviceGroup_Name/nodev4-1.2.3.4/stbynodev4-1.2.3.4 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev4 Properties
The following table contains information about the itdNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdStandbyNodev4 Properties
The following table contains information about the itdStandbyNodev4 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 |
|---|---|---|---|
| ip | address:IPv4 | The IP address. | Value must match ipv4 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring IPv6 Standby Node
Configuring IPv6 Standby Node
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "dg_ipv6"
},
"children": [
{
"itdNodev6": {
"attributes": {
"ip": "1:2::3:4"
},
"children": [
{
"itdStandbyNodev6": {
"attributes": {
"ip": "11:2::3:4"
},
"children": [
{
"itdProbe": {
"attributes": {
"ctrlStatusEnable": "disable",
"dnshost": "",
"frequency": "0",
"httpGetStr": "",
"port": "308",
"probeIp": "1.2.3.4",
"protocol": "UDP",
"retryDownCount": "0",
"retryUpCount": "0",
"timeout": "0"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>dg_ipv6</dgName>
<nodev6-items>
<Nodev6-list>
<ip>1:2::3:4</ip>
<stbynodev6-items>
<StandbyNodev6-list>
<ip>11:2::3:4</ip>
<probe-items>
<ctrlStatusEnable>disable</ctrlStatusEnable>
<dnshost></dnshost>
<frequency>0</frequency>
<httpGetStr></httpGetStr>
<port>308</port>
<probeIp>1.2.3.4</probeIp>
<protocol>UDP</protocol>
<retryDownCount>0</retryDownCount>
<retryUpCount>0</retryUpCount>
<timeout>0</timeout>
</probe-items>
</StandbyNodev6-list>
</stbynodev6-items>
</Nodev6-list>
</nodev6-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group dg_ipv6
node ipv6 1:2::3:4
standby ipv6 11:2::3:4
probe udp port 308 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdInst | sys/itd/inst |
| itdDeviceGroup | sys/itd/inst/devgrp-dg_ipv6 |
| itdNodev6 | sys/itd/inst/devgrp-dg_ipv6/nodev6-1:2::3:4 |
| itdStandbyNodev6 | sys/itd/inst/devgrp-dg_ipv6/nodev6-1:2::3:4/stbynodev6-11:2::3:4 |
| itdProbe | sys/itd/inst/devgrp-dg_ipv6/nodev6-1:2::3:4/stbynodev6-11:2::3:4/probe |
| dnshost: |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
| dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
| frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
| httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
| port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
| probeIp | address:IPv4 | Value must match ipv4 format | |
| protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
| retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
| timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev6 Properties
The following table contains information about the itdNodev6 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 |
|---|---|---|---|
| ip | address:IPv6 | The IP address. | Value must match ipv6 format |
itdStandbyNodev6 Properties
The following table contains information about the itdStandbyNodev6 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 |
|---|---|---|---|
| ip | address:IPv6 | The IP address. | Value must match ipv6 format |
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:
Deleting IPv6 Standby Node
Deleting IPv6 Standby Node
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
"itdInst": {
"children": [
{
"itdDeviceGroup": {
"attributes": {
"dgName": "dg_ipv6"
},
"children": [
{
"itdNodev6": {
"attributes": {
"ip": "1:2::3:4"
},
"children": [
{
"itdStandbyNodev6": {
"attributes": {
"ip": "11:2::3:4"
},
"children": [
{
"itdProbe": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<itd-items>
<inst-items>
<devgrp-items>
<DeviceGroup-list>
<dgName>dg_ipv6</dgName>
<nodev6-items>
<Nodev6-list>
<ip>1:2::3:4</ip>
<stbynodev6-items>
<StandbyNodev6-list>
<ip>11:2::3:4</ip>
<probe-items nc:operation="delete">
</probe-items>
</StandbyNodev6-list>
</stbynodev6-items>
</Nodev6-list>
</nodev6-items>
</DeviceGroup-list>
</devgrp-items>
</inst-items>
</itd-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
itd device-group dg_ipv6
node ipv6 1:2::3:4
standby ipv6 11:2::3:4
no probe udp port 308 ip 1.2.3.4
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| itdInst | sys/itd/inst |
| itdDeviceGroup | sys/itd/inst/devgrp-dg_ipv6 |
| itdNodev6 | sys/itd/inst/devgrp-dg_ipv6/nodev6-1:2::3:4 |
| itdStandbyNodev6 | sys/itd/inst/devgrp-dg_ipv6/nodev6-1:2::3:4/stbynodev6-11:2::3:4 |
| itdProbe | sys/itd/inst/devgrp-dg_ipv6/nodev6-1:2::3:4/stbynodev6-11:2::3:4/probe |
itdDeviceGroup Properties
The following table contains information about the itdDeviceGroup 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 |
|---|---|---|---|
| dgName | itd:DevGrpNameType (string:Basic) | MAX SIZE: 31 |
itdNodev6 Properties
The following table contains information about the itdNodev6 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 |
|---|---|---|---|
| ip | address:IPv6 | The IP address. | Value must match ipv6 format |
itdStandbyNodev6 Properties
The following table contains information about the itdStandbyNodev6 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 |
|---|---|---|---|
| ip | address:IPv6 | The IP address. | Value must match ipv6 format |
itdProbe Properties
The following table contains information about the itdProbe 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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: